metrics_influxdb

Class InfluxdbReporter.Builder

java.lang.Object

metrics_influxdb.InfluxdbReporter.Builder

Enclosing class:

InfluxdbReporter

public static class InfluxdbReporter.Builder
extends java.lang.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

Modifier and Type	Method and Description
com.codahale.metrics.ScheduledReporter	build() Builds a ScheduledReporter with the given properties, sending metrics using the given InfluxDB.
InfluxdbReporter.Builder	convertDurationsTo(java.util.concurrent.TimeUnit durationUnit) Convert durations to the given time unit.
InfluxdbReporter.Builder	convertRatesTo(java.util.concurrent.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(java.lang.String prefix) Prefix all metric names with the given string.
InfluxdbReporter.Builder	protocol(InfluxdbProtocol protocol) Override the protocol to use.
InfluxdbReporter.Builder	skipIdleMetrics(boolean skipIdleMetrics) Only report metrics that have changed.
InfluxdbReporter.Builder	tag(java.lang.String tagKey, java.lang.String tagValue) Registers the given key/value as a default tag for the generated measurements.
InfluxdbReporter.Builder	transformer(MetricMeasurementTransformer transformer) Sets the metric2measurement transformer to be used.
InfluxdbReporter.Builder	v08() Operates with influxdb version less or equal than 08.
InfluxdbReporter.Builder	withAutoCreateDB(boolean autocreate) Automatically create the database if it does not exist.
InfluxdbReporter.Builder	withClock(com.codahale.metrics.Clock clock) Use the given Clock instance for the time.
InfluxdbReporter.Builder	withScheduler(java.util.concurrent.ScheduledExecutorService executor)

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

withAutoCreateDB

public InfluxdbReporter.Builder withAutoCreateDB(boolean autocreate)

Automatically create the database if it does not exist.

Parameters:

autocreate - a boolean

Returns:

this

withScheduler

public InfluxdbReporter.Builder withScheduler(java.util.concurrent.ScheduledExecutorService executor)

prefixedWith

public InfluxdbReporter.Builder prefixedWith(java.lang.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(java.util.concurrent.TimeUnit rateUnit)

Convert rates to the given time unit.

Parameters:

rateUnit - a unit of time

Returns:

this

convertDurationsTo

public InfluxdbReporter.Builder convertDurationsTo(java.util.concurrent.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 com.codahale.metrics.ScheduledReporter build()

Builds a ScheduledReporter with the given properties, sending metrics using the given InfluxDB.

Returns:

a ScheduledReporter

v08

public InfluxdbReporter.Builder v08()

Operates with influxdb version less or equal than 08.

Returns:

the builder itself

protocol

public InfluxdbReporter.Builder protocol(InfluxdbProtocol protocol)

Override the protocol to use.

Parameters:

protocol - a non null protocol

Returns:

transformer

public InfluxdbReporter.Builder transformer(MetricMeasurementTransformer transformer)

Sets the metric2measurement transformer to be used.

Parameters:

transformer - a non null transformer

Returns:

tag

public InfluxdbReporter.Builder tag(java.lang.String tagKey,
                                    java.lang.String tagValue)

Registers the given key/value as a default tag for the generated measurements.

Parameters:

tagKey - the key to register, cannot be null or empty

tagValue - the value to register against the given key, cannot be null or empty