net.centro.rtb.monitoringcenter.config

Class GraphiteReporterConfig.Builder

java.lang.Object

net.centro.rtb.monitoringcenter.config.GraphiteReporterConfig.Builder

Enclosing class:

GraphiteReporterConfig

public static class GraphiteReporterConfig.Builder
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
static long	DEFAULT_REPORTING_INTERVAL_IN_SECONDS

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
GraphiteReporterConfig.Builder	address(String host, int port) Sets the host and port for connecting to the Graphite instance.
GraphiteReporterConfig.Builder	blockedStartsWithFilters(Set<String> blockedStartsWithFilters) Sets the blacklist filters to be applied to metric names.
GraphiteReporterConfig	build()
GraphiteReporterConfig.Builder	enableBatching(boolean enableBatching) Indicates whether batching should be enabled or not.
GraphiteReporterConfig.Builder	enableReporter(boolean enableReporter) Indicates whether the reporter should be enabled or not.
GraphiteReporterConfig.Builder	reportingInterval(long period, TimeUnit timeUnit) Sets the reporting interval.
GraphiteReporterConfig.Builder	reportOnShutdown(boolean reportOnShutdown) Indicates whether metrics should be published to Graphite prior to shutting down the reporter or not.
GraphiteReporterConfig.Builder	startsWithFilters(Set<String> startsWithFilters) Sets the whitelist filters to be applied to metric names.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_REPORTING_INTERVAL_IN_SECONDS

public static final long DEFAULT_REPORTING_INTERVAL_IN_SECONDS

Constructor Detail

Builder

public Builder()

Method Detail

enableReporter

public GraphiteReporterConfig.Builder enableReporter(boolean enableReporter)

Indicates whether the reporter should be enabled or not. By default, the reporter will be enabled.

Parameters:

enableReporter - indicates whether the reporter should be enabled or not.

Returns:

this builder.

address

public GraphiteReporterConfig.Builder address(String host,
                                              int port)

Sets the host and port for connecting to the Graphite instance. This is a required field.

Parameters:

host - a hostname or IP address.

port - a port number.

Returns:

this builder.

Throws:

IllegalArgumentException - if host is blank.

IllegalArgumentException - if port is outside of the valid range of [0, 65535].

reportingInterval

public GraphiteReporterConfig.Builder reportingInterval(long period,
                                                        TimeUnit timeUnit)

Sets the reporting interval. By default, the reporting interval is 1 minute.

Parameters:

period - an interval at which to push data to Graphite.

timeUnit - the unit for period.

Returns:

this builder.

Throws:

IllegalArgumentException - if period is less than or equal to 0.

NullPointerException - if timeUnit is null.

enableBatching

public GraphiteReporterConfig.Builder enableBatching(boolean enableBatching)

Indicates whether batching should be enabled or not. By default, batching is enabled.

Parameters:

enableBatching - indicates whether batching should be enabled or not.

Returns:

this builder.

reportOnShutdown

public GraphiteReporterConfig.Builder reportOnShutdown(boolean reportOnShutdown)

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.

Parameters:

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

Returns:

this builder.

startsWithFilters

public GraphiteReporterConfig.Builder startsWithFilters(Set<String> startsWithFilters)

Sets the whitelist filters to be applied to metric names. These filters can include the MetricNamingUtil.SEPARATOR and multiple wildcards denoted as *.

Parameters:

startsWithFilters - whitelist filters to be applied to metric names.

Returns:

this builder.

blockedStartsWithFilters

public GraphiteReporterConfig.Builder blockedStartsWithFilters(Set<String> blockedStartsWithFilters)

Sets the blacklist filters to be applied to metric names. These filters can include the MetricNamingUtil.SEPARATOR and multiple wildcards denoted as *.

Parameters:

blockedStartsWithFilters - blacklist filters to be applied to metric names.

Returns:

this builder.

build

public GraphiteReporterConfig build()