com.github.sps.metrics

Class OpenTsdbReporter.Builder

java.lang.Object

com.github.sps.metrics.OpenTsdbReporter.Builder

Enclosing class:

OpenTsdbReporter

public static class OpenTsdbReporter.Builder
extends Object

A builder for OpenTsdbReporter 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
OpenTsdbReporter	build(OpenTsdb opentsdb) Builds a OpenTsdbReporter with the given properties, sending metrics using the given OpenTsdb client.
OpenTsdbReporter.Builder	convertDurationsTo(TimeUnit durationUnit) Convert durations to the given time unit.
OpenTsdbReporter.Builder	convertRatesTo(TimeUnit rateUnit) Convert rates to the given time unit.
OpenTsdbReporter.Builder	filter(com.codahale.metrics.MetricFilter filter) Only report metrics which match the given filter.
OpenTsdbReporter.Builder	prefixedWith(String prefix) Prefix all metric names with the given string.
OpenTsdbReporter.Builder	withBatchSize(int batchSize) specify number of metrics send in each request
OpenTsdbReporter.Builder	withClock(com.codahale.metrics.Clock clock) Use the given Clock instance for the time.
OpenTsdbReporter.Builder	withCounterGaugeDecorations(boolean withCounterGaugeDecorations) Enable decorating Counter metric names with .count and Gauge metric names with .value.
OpenTsdbReporter.Builder	withTags(Map<String,String> tags) Append tags to all reported metrics

Methods inherited from class java.lang.Object

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

Method Detail

withClock

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

Use the given Clock instance for the time.

Parameters:

clock - a Clock instance

Returns:

this

prefixedWith

public OpenTsdbReporter.Builder prefixedWith(String prefix)

Prefix all metric names with the given string.

Parameters:

prefix - the prefix for all metric names

Returns:

this

convertRatesTo

public OpenTsdbReporter.Builder convertRatesTo(TimeUnit rateUnit)

Convert rates to the given time unit.

Parameters:

rateUnit - a unit of time

Returns:

this

convertDurationsTo

public OpenTsdbReporter.Builder convertDurationsTo(TimeUnit durationUnit)

Convert durations to the given time unit.

Parameters:

durationUnit - a unit of time

Returns:

this

filter

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

Only report metrics which match the given filter.

Parameters:

filter - a MetricFilter

Returns:

this

withTags

public OpenTsdbReporter.Builder withTags(Map<String,String> tags)

Append tags to all reported metrics

Parameters:

tags -

Returns:

this

withCounterGaugeDecorations

public OpenTsdbReporter.Builder withCounterGaugeDecorations(boolean withCounterGaugeDecorations)

Enable decorating Counter metric names with .count and Gauge metric names with .value.

Parameters:

withCounterGaugeDecorations -

Returns:

this

withBatchSize

public OpenTsdbReporter.Builder withBatchSize(int batchSize)

specify number of metrics send in each request

Parameters:

batchSize -

Returns:

this

build

public OpenTsdbReporter build(OpenTsdb opentsdb)

Builds a OpenTsdbReporter with the given properties, sending metrics using the given OpenTsdb client.

Parameters:

opentsdb - a OpenTsdb client

Returns:

a OpenTsdbReporter