net.centro.rtb.monitoringcenter.config

Class GraphiteReporterConfig

java.lang.Object

net.centro.rtb.monitoringcenter.config.GraphiteReporterConfig

public class GraphiteReporterConfig
extends Object

This class encompasses the configuration parameters for the Graphite push reporter. By default, this reporter is not configured--that is, it not enabled in the MonitoringCenter, unless explicitly indicated in the config file or programmatically. All configuration parameters in this class can be reloaded dynamically, if the reloading is enabled (i.e., a config file was used).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GraphiteReporterConfig.Builder

Method Summary

Modifier and Type	Method and Description
static GraphiteReporterConfig.Builder	builder()
boolean	equals(Object o)
HostAndPort	getAddress() Retrieves the address (host and port) of the Graphite instance to push metrics to.
Set<String>	getBlockedStartsWithFilters() Retrieves the filters to apply to metrics in order to decide which metrics should not be reported to Graphite.
long	getReportingIntervalInSeconds() Retrieves the reporting interval in seconds.
Set<String>	getStartsWithFilters() Retrieves the filters to apply to metrics in order to decide which metrics should be reported to Graphite.
int	hashCode()
boolean	isEnableBatching() Indicates whether the Graphite reporter should employ batching or not.
boolean	isEnableReporter() Indicates whether the reporter should be enabled or not.
boolean	isReportOnShutdown() Indicates whether metrics should be published to Graphite prior to shutting down the reporter or not.
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

isEnableReporter

public boolean isEnableReporter()

Indicates whether the reporter should be enabled or not. By default, the reporter is enabled, if configured.

Returns:

whether the reporter should be enabled or not.

getAddress

public HostAndPort getAddress()

Retrieves the address (host and port) of the Graphite instance to push metrics to. This field is guaranteed to be non-null.

Returns:

the address (host and port) of the Graphite instance to push metrics to.

getReportingIntervalInSeconds

public long getReportingIntervalInSeconds()

Retrieves the reporting interval in seconds. By default, this interval is GraphiteReporterConfig.Builder.DEFAULT_REPORTING_INTERVAL_IN_SECONDS.

Returns:

the reporting interval in seconds.

isEnableBatching

public boolean isEnableBatching()

Indicates whether the Graphite reporter should employ batching or not. By default, batching is enabled.

Returns:

whether the Graphite reporter should employ batching or not.

isReportOnShutdown

public boolean isReportOnShutdown()

Indicates whether metrics should be published to Graphite prior to shutting down the reporter or not. By default, this feature is enabled. One may want to disable this feature to avoid inconsistencies when Carbon aggregations are enabled on the Graphite side.

Returns:

whether metrics should be reported prior to shutting down or not.

getStartsWithFilters

public Set<String> getStartsWithFilters()

Retrieves the filters to apply to metrics in order to decide which metrics should be reported to Graphite. If no filters are specified, an empty set is returned.

Returns:

the whitelist filters to apply to metrics.

getBlockedStartsWithFilters

public Set<String> getBlockedStartsWithFilters()

Retrieves the filters to apply to metrics in order to decide which metrics should not be reported to Graphite. If no filters are specified, an empty set is returned.

Returns:

the blacklist filters to apply to metrics.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

builder

public static GraphiteReporterConfig.Builder builder()