net.centro.rtb.monitoringcenter.config

Class MonitoringCenterConfig.Builder

java.lang.Object

net.centro.rtb.monitoringcenter.config.MonitoringCenterConfig.Builder

Enclosing class:

MonitoringCenterConfig

public static class MonitoringCenterConfig.Builder
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
static String	DC_ENV_VARIABLE_NAME
static String	NODE_GROUP_ENV_VARIABLE_NAME
static String	NODE_ID_ENV_VARIABLE_NAME
static String	NONE

Method Summary

Modifier and Type	Method and Description
MonitoringCenterConfig.Builder	appendTypeToHealthCheckNames(boolean appendTypeToHealthCheckNames) Indicates whether "HealthCheck" should automatically be appended to health check names or not.
MonitoringCenterConfig.Builder	applicationName(String applicationName) Sets the application name to be used in the node-specific prefix for metrics.
MonitoringCenterConfig	build()
MonitoringCenterConfig.Builder	datacenterName(String datacenterName) Sets the data center name to be used in the node-specific prefix for metrics.
MonitoringCenterConfig.Builder	enableSystemMetrics(boolean enableSystemMetrics) Indicates whether the collection of system metrics should be enabled or not.
MonitoringCenterConfig.Builder	enableTomcatMetrics(boolean enableTomcatMetrics) Indicates whether Tomcat metrics should be collected or not.
MonitoringCenterConfig.Builder	graphiteReporterConfig(GraphiteReporterConfig graphiteReporterConfig) Sets the configuration for the GraphiteReporter.
MonitoringCenterConfig.Builder	metricNamePostfixPolicy(MetricNamePostfixPolicy metricNamePostfixPolicy) Sets the policy for appending metric types to metric names.
MonitoringCenterConfig.Builder	nodeGroupName(String nodeGroupName) Sets the node group name to be used in the node-specific prefix for metrics.
MonitoringCenterConfig.Builder	nodeId(String nodeId) Sets the node ID to be used in the node-specific prefix for metrics.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DC_ENV_VARIABLE_NAME

public static final String DC_ENV_VARIABLE_NAME

See Also:

Constant Field Values

NODE_GROUP_ENV_VARIABLE_NAME

public static final String NODE_GROUP_ENV_VARIABLE_NAME

See Also:

Constant Field Values

NODE_ID_ENV_VARIABLE_NAME

public static final String NODE_ID_ENV_VARIABLE_NAME

See Also:

Constant Field Values

NONE

public static final String NONE

See Also:

Constant Field Values

Method Detail

applicationName

public MonitoringCenterConfig.Builder applicationName(String applicationName)

Sets the application name to be used in the node-specific prefix for metrics. The application name will also be employed in the AppInfo. For instance, "bidder". This is a required field. Note that the passed in value will be sanitized using MetricNamingUtil.sanitize(String).

Parameters:

applicationName - application name.

Returns:

this builder.

Throws:

IllegalArgumentException - if applicationName is blank.

datacenterName

public MonitoringCenterConfig.Builder datacenterName(String datacenterName)

Sets the data center name to be used in the node-specific prefix for metrics. The data center name will also feature in the NodeInfo. For instance, "east".

If not specified, the value will be retrieved from an environment variable, whose name is held in the DC_ENV_VARIABLE_NAME constant. In case the environment variable is not specified, NONE will be used as the value. Note that the passed in value will be sanitized using MetricNamingUtil.sanitize(String).

Parameters:

datacenterName - data center name.

Returns:

this builder.

nodeGroupName

public MonitoringCenterConfig.Builder nodeGroupName(String nodeGroupName)

Sets the node group name to be used in the node-specific prefix for metrics. The node group name will also feature in the NodeInfo. For instance, "lb3.p2e" or "staging".

If not specified, the value will be retrieved from an environment variable, whose name is held in the NODE_GROUP_ENV_VARIABLE_NAME constant. In case the environment variable is not specified, NONE will be used as the value. Note that the passed in value will be sanitized using MetricNamingUtil.sanitize(String).

Parameters:

nodeGroupName - node group name.

Returns:

this builder.

nodeId

public MonitoringCenterConfig.Builder nodeId(String nodeId)

Sets the node ID to be used in the node-specific prefix for metrics. The node ID will also feature in the NodeInfo. For instance, "58" or "node59".

If not specified, the value will be retrieved from an environment variable, whose name is held in the NODE_ID_ENV_VARIABLE_NAME constant. In case the environment variable is not specified NONE will be used as the value. Note that the passed in value will be sanitized using MetricNamingUtil.sanitize(String).

Parameters:

nodeId - ID of the node.

Returns:

this builder.

metricNamePostfixPolicy

public MonitoringCenterConfig.Builder metricNamePostfixPolicy(MetricNamePostfixPolicy metricNamePostfixPolicy)

Sets the policy for appending metric types to metric names. By default, the policy will be set to MetricNamePostfixPolicy.ADD_COMPOSITE_TYPES, which will enforce metric types to be appended to names of composite metrics (i.e., timers, histograms, and meters).

If the metric name already ends with the type string, it will be left intact--e.g., a counter with name "errorCounter" will remain "errorCounter".

Parameters:

metricNamePostfixPolicy - the postfix policy to use for metric names.

Returns:

this builder.

appendTypeToHealthCheckNames

public MonitoringCenterConfig.Builder appendTypeToHealthCheckNames(boolean appendTypeToHealthCheckNames)

Indicates whether "HealthCheck" should automatically be appended to health check names or not. By default, this feature is disabled. For instance, for a health check named "factual", the resulting name would be "factualHealthCheck". If the health check name already ends with the type string, it will be left intact.

Parameters:

appendTypeToHealthCheckNames - whether type should be appended to health check names or not.

Returns:

this builder.

enableSystemMetrics

public MonitoringCenterConfig.Builder enableSystemMetrics(boolean enableSystemMetrics)

Indicates whether the collection of system metrics should be enabled or not. System metrics include JVM- and OS-level data points. By default, system metrics will not be collected.

Parameters:

enableSystemMetrics - whether the collection of system metrics should be enabled or not.

Returns:

this builder.

enableTomcatMetrics

public MonitoringCenterConfig.Builder enableTomcatMetrics(boolean enableTomcatMetrics)

Indicates whether Tomcat metrics should be collected or not. Such metrics will only be collected if Tomcat's JMX beans are available. By default, Tomcat metrics will not be collected.

Parameters:

enableTomcatMetrics - whether the collection of Tomcat metrics should be enabled or not.

Returns:

this builder.

graphiteReporterConfig

public MonitoringCenterConfig.Builder graphiteReporterConfig(GraphiteReporterConfig graphiteReporterConfig)

Sets the configuration for the GraphiteReporter. By default, the GraphiteReporter will not be configured.

Parameters:

graphiteReporterConfig - a Graphite reporter configuration.

Returns:

this builder.

build

public MonitoringCenterConfig build()