com.librato.metrics

Class LibratoReporter.Builder

java.lang.Object

com.librato.metrics.LibratoReporter.Builder

Enclosing class:

LibratoReporter

public static class LibratoReporter.Builder
extends Object

A builder for the LibratoReporter class that requires things that cannot be inferred and uses sane default values for everything else.

Constructor Summary

Constructors

Constructor and Description
LibratoReporter.Builder(com.codahale.metrics.MetricRegistry registry, String username, String token, String source)

Method Summary

Methods

Modifier and Type	Method and Description
LibratoReporter	build() Build the LibratoReporter as configured by this Builder
LibratoReporter.Builder	setClock(com.codahale.metrics.Clock clock) use a custom clock
LibratoReporter.Builder	setDeleteIdleStats(boolean deleteIdleStats) Sets whether or not idle timers, meters, and histograms will be send to Librato or not.
LibratoReporter.Builder	setDurationUnit(TimeUnit durationUnit) Sets the time unit to which durations will be converted by the reporter.
LibratoReporter.Builder	setExpansionConfig(LibratoReporter.MetricExpansionConfig expansionConfig) Enables control over how the reporter generates 'expanded' metrics from meters and histograms, such as percentiles and rates.
LibratoReporter.Builder	setFilter(com.codahale.metrics.MetricFilter filter) Filter the metrics that this particular reporter publishes
LibratoReporter.Builder	setHttpPoster(com.librato.metrics.HttpPoster poster) Sets the HttpPoster which will send the payload to Librato
LibratoReporter.Builder	setName(String name) Specify a custom name for this reporter
LibratoReporter.Builder	setOmitComplexGauges(boolean omitComplexGauges) Sets whether or not complex gauges (includes mean, min, max) should be sent to Librato.
LibratoReporter.Builder	setPrefix(String prefix) Sets a prefix that will be prepended to all metric names
LibratoReporter.Builder	setPrefixDelimiter(String prefixDelimiter) Sets the delimiter which will separate the prefix from the metric name.
LibratoReporter.Builder	setRateUnit(TimeUnit rateUnit) Sets the time unit to which rates will be converted by the reporter.
LibratoReporter.Builder	setSanitizer(com.librato.metrics.Sanitizer sanitizer) Use a custom sanitizer.
LibratoReporter.Builder	setSourceRegex(Pattern sourceRegex) Sets the source regular expression to be applied against metric names to determine dynamic sources.
LibratoReporter.Builder	setTimeout(long timeout) Sets the timeout for POSTs to Librato
LibratoReporter.Builder	setTimeout(long timeout, TimeUnit timeoutUnit) set the HTTP timeout for a publishing attempt
LibratoReporter.Builder	setTimeoutUnit(TimeUnit timeoutUnit) Sets the timeout time unit for POSTs to Librato

Methods inherited from class java.lang.Object

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

Constructor Detail

LibratoReporter.Builder

public LibratoReporter.Builder(com.codahale.metrics.MetricRegistry registry,
                       String username,
                       String token,
                       String source)

Method Detail

setOmitComplexGauges

public LibratoReporter.Builder setOmitComplexGauges(boolean omitComplexGauges)

Sets whether or not complex gauges (includes mean, min, max) should be sent to Librato. Only applies to Timers and Histograms.

Parameters:

omitComplexGauges - if the complex gauges should be elided

Returns:

itself

setDeleteIdleStats

public LibratoReporter.Builder setDeleteIdleStats(boolean deleteIdleStats)

Sets whether or not idle timers, meters, and histograms will be send to Librato or not.

Parameters:

deleteIdleStats - true if idle metrics should be elided

Returns:

itself

setSourceRegex

public LibratoReporter.Builder setSourceRegex(Pattern sourceRegex)

Sets the source regular expression to be applied against metric names to determine dynamic sources.

Parameters:

sourceRegex - the regular expression

Returns:

itself

setTimeout

public LibratoReporter.Builder setTimeout(long timeout)

Sets the timeout for POSTs to Librato

Parameters:

timeout - the timeout

Returns:

itself

setTimeoutUnit

public LibratoReporter.Builder setTimeoutUnit(TimeUnit timeoutUnit)

Sets the timeout time unit for POSTs to Librato

Parameters:

timeoutUnit - the timeout unit

Returns:

itself

setPrefixDelimiter

public LibratoReporter.Builder setPrefixDelimiter(String prefixDelimiter)

Sets the delimiter which will separate the prefix from the metric name. Defaults to "."

Parameters:

prefixDelimiter - the delimiter

Returns:

itself

setPrefix

public LibratoReporter.Builder setPrefix(String prefix)

Sets a prefix that will be prepended to all metric names

Parameters:

prefix - the prefix

Returns:

itself

setHttpPoster

public LibratoReporter.Builder setHttpPoster(com.librato.metrics.HttpPoster poster)

Sets the HttpPoster which will send the payload to Librato

Parameters:

poster - the HttpPoster

Returns:

itself

setRateUnit

public LibratoReporter.Builder setRateUnit(TimeUnit rateUnit)

Sets the time unit to which rates will be converted by the reporter. The default value is TimeUnit.SECONDS

Parameters:

rateUnit - the rate

Returns:

itself

setDurationUnit

public LibratoReporter.Builder setDurationUnit(TimeUnit durationUnit)

Sets the time unit to which durations will be converted by the reporter. The default value is TimeUnit.MILLISECONDS

Parameters:

durationUnit - the time unit

Returns:

itself

setTimeout

public LibratoReporter.Builder setTimeout(long timeout,
                                 TimeUnit timeoutUnit)

set the HTTP timeout for a publishing attempt

Parameters:

timeout - duration to expect a response

timeoutUnit - unit for duration

Returns:

itself

setName

public LibratoReporter.Builder setName(String name)

Specify a custom name for this reporter

Parameters:

name - the name to be used

Returns:

itself

setSanitizer

public LibratoReporter.Builder setSanitizer(com.librato.metrics.Sanitizer sanitizer)

Use a custom sanitizer. All metric names are run through a sanitizer to ensure validity before being sent along. Librato places some restrictions on the characters allowed in keys, so all keys are ultimately run through APIUtil.lastPassSanitizer. Specifying an additional sanitizer (that runs before lastPassSanitizer) allows the user to customize what they want done about invalid characters and excessively long metric names.

Parameters:

sanitizer - the custom sanitizer to use (defaults to a noop sanitizer).

Returns:

itself

setFilter

public LibratoReporter.Builder setFilter(com.codahale.metrics.MetricFilter filter)

Filter the metrics that this particular reporter publishes

Parameters:

filter - the MetricFilter

Returns:

itself

setClock

public LibratoReporter.Builder setClock(com.codahale.metrics.Clock clock)

use a custom clock

Parameters:

clock - to be used

Returns:

itself

setExpansionConfig

public LibratoReporter.Builder setExpansionConfig(LibratoReporter.MetricExpansionConfig expansionConfig)

Enables control over how the reporter generates 'expanded' metrics from meters and histograms, such as percentiles and rates.

Parameters:

expansionConfig - the configuration

Returns:

itself

See Also:

ExpandedMetric}

build

public LibratoReporter build()

Build the LibratoReporter as configured by this Builder

Returns:

a fully configured LibratoReporter