metrics_influxdb

Class InfluxdbReporter.Builder

java.lang.Object

metrics_influxdb.InfluxdbReporter.Builder

Enclosing class:

InfluxdbReporter

public static class InfluxdbReporter.Builder
extends Object

A builder for InfluxdbReporter instances. Defaults to not using a prefix, using the default clock, converting rates to events/second, converting durations to milliseconds, and not filtering metrics.

Method Summary

Methods

Modifier and Type	Method and Description
InfluxdbReporter	build(metrics_influxdb.Influxdb influxdb) Builds a InfluxdbReporter with the given properties, sending metrics using the given Influxdb client.
InfluxdbReporter.Builder	convertDurationsTo(TimeUnit durationUnit) Convert durations to the given time unit.
InfluxdbReporter.Builder	convertRatesTo(TimeUnit rateUnit) Convert rates to the given time unit.
InfluxdbReporter.Builder	filter(com.codahale.metrics.MetricFilter filter) Only report metrics which match the given filter.
InfluxdbReporter.Builder	prefixedWith(String prefix) Prefix all metric names with the given string.
InfluxdbReporter.Builder	skipIdleMetrics(boolean skipIdleMetrics) Only report metrics that have changed.
InfluxdbReporter.Builder	withClock(com.codahale.metrics.Clock clock) Use the given Clock instance for the time.

Methods inherited from class java.lang.Object

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

Method Detail

withClock

public InfluxdbReporter.Builder withClock(com.codahale.metrics.Clock clock)

Use the given Clock instance for the time.

Parameters:

clock - a Clock instance

Returns:

this

prefixedWith

public InfluxdbReporter.Builder prefixedWith(String prefix)

Prefix all metric names with the given string.

Parameters:

prefix - the prefix for all metric names

Returns:

this

convertRatesTo

public InfluxdbReporter.Builder convertRatesTo(TimeUnit rateUnit)

Convert rates to the given time unit.

Parameters:

rateUnit - a unit of time

Returns:

this

convertDurationsTo

public InfluxdbReporter.Builder convertDurationsTo(TimeUnit durationUnit)

Convert durations to the given time unit.

Parameters:

durationUnit - a unit of time

Returns:

this

filter

public InfluxdbReporter.Builder filter(com.codahale.metrics.MetricFilter filter)

Only report metrics which match the given filter.

Parameters:

filter - a MetricFilter

Returns:

this

skipIdleMetrics

public InfluxdbReporter.Builder skipIdleMetrics(boolean skipIdleMetrics)

Only report metrics that have changed.

Parameters:

skipIdleMetrics -

Returns:

this

build

public InfluxdbReporter build(metrics_influxdb.Influxdb influxdb)

Builds a InfluxdbReporter with the given properties, sending metrics using the given Influxdb client.

Parameters:

influxdb - a Influxdb client

Returns:

a InfluxdbReporter