org.apache.samza.monitor

Class MonitorConfig

java.lang.Object

org.apache.samza.config.Config

org.apache.samza.config.MapConfig

org.apache.samza.monitor.MonitorConfig

All Implemented Interfaces:

java.util.Map<java.lang.String,java.lang.String>

public class MonitorConfig
extends org.apache.samza.config.MapConfig

Configurations for the Monitor implementations.

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

java.util.Map.Entry<K,V>

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CONFIG_MONITOR_FACTORY_CLASS
static java.lang.String	CONFIG_SCHEDULING_INTERVAL

Fields inherited from class org.apache.samza.config.Config

SENSITIVE_MASK, SENSITIVE_PREFIX

Constructor Summary

Constructors

Constructor and Description
MonitorConfig(org.apache.samza.config.Config config)

Method Summary

Modifier and Type	Method and Description
static java.util.Map<java.lang.String,MonitorConfig>	getMonitorConfigs(org.apache.samza.config.Config config) Groups configuration defined in the config object for each of the monitors into a MonitorConfig object
java.lang.String	getMonitorFactoryClass()
int	getSchedulingIntervalInMs()

Methods inherited from class org.apache.samza.config.MapConfig

containsKey, containsValue, entrySet, equals, get, hashCode, isEmpty, keySet, sanitize, size, toString, values

Methods inherited from class org.apache.samza.config.Config

clear, get, getBoolean, getBoolean, getClass, getDate, getDate, getDate, getDate, getDate, getDate, getDouble, getDouble, getInt, getInt, getList, getList, getLong, getLong, getNewInstance, getShort, getShort, put, putAll, regexSubset, remove, subset, subset

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Field Detail

CONFIG_SCHEDULING_INTERVAL

public static final java.lang.String CONFIG_SCHEDULING_INTERVAL

See Also:

Constant Field Values

CONFIG_MONITOR_FACTORY_CLASS

public static final java.lang.String CONFIG_MONITOR_FACTORY_CLASS

See Also:

Constant Field Values

Constructor Detail

MonitorConfig

public MonitorConfig(org.apache.samza.config.Config config)

Method Detail

getMonitorConfigs

public static java.util.Map<java.lang.String,MonitorConfig> getMonitorConfigs(org.apache.samza.config.Config config)

Groups configuration defined in the config object for each of the monitors into a MonitorConfig object

Parameters:

config - contains the entire configuration defined for all the monitors.

Returns:

a map of monitorName, MonitorConfig, where each MonitorConfig object contains all the configuration defined for the monitor named monitorName.

getMonitorFactoryClass

public java.lang.String getMonitorFactoryClass()

Returns:

the monitor config factory class name that will be used to create the monitor instances.

getSchedulingIntervalInMs

public int getSchedulingIntervalInMs()

Returns:

the periodic scheduling interval defined in the Config. If the configuration key is undefined, return the default value(DEFAULT_SCHEDULING_INTERVAL_IN_MS).