io.greptime.common.util

Class MetricReporter.Builder

java.lang.Object

io.greptime.common.util.MetricReporter.Builder

Enclosing class:

MetricReporter

public static class MetricReporter.Builder
extends Object

A builder for MetricReporter instances. Defaults to using the default locale and time zone, writing to System.out, converting rates to events/second, converting durations to milliseconds, and not filtering metrics.

Method Summary

Modifier and Type	Method and Description
MetricReporter	build() Builds a MetricReporter with the given properties.
MetricReporter.Builder	convertDurationsTo(TimeUnit durationUnit) Convert durations to the given time unit.
MetricReporter.Builder	convertRatesTo(TimeUnit rateUnit) Convert rates to the given time unit.
MetricReporter.Builder	disabledMetricAttributes(Set<com.codahale.metrics.MetricAttribute> disabledMetricAttributes) Don't report the passed metric attributes for all metrics (e.g.
MetricReporter.Builder	filter(com.codahale.metrics.MetricFilter filter) Only report metrics which match the given filter.
MetricReporter.Builder	formattedFor(Locale locale) Format numbers for the given Locale.
MetricReporter.Builder	formattedFor(TimeZone timeZone) Use the given TimeZone for the time.
MetricReporter.Builder	outputTo(PrintStream output) Write to the given PrintStream.
MetricReporter.Builder	prefixedWith(String prefix) Prefix all metric names with the given string.
MetricReporter.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

prefixedWith

public MetricReporter.Builder prefixedWith(String prefix)

Prefix all metric names with the given string.

Parameters:

prefix - the prefix for all banner names

Returns:

this

outputTo

public MetricReporter.Builder outputTo(PrintStream output)

Write to the given PrintStream.

Parameters:

output - a PrintStream instance.

Returns:

this

formattedFor

public MetricReporter.Builder formattedFor(Locale locale)

Format numbers for the given Locale.

Parameters:

locale - a Locale

Returns:

this

withClock

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

Use the given Clock instance for the time.

Parameters:

clock - a Clock instance

Returns:

this

formattedFor

public MetricReporter.Builder formattedFor(TimeZone timeZone)

Use the given TimeZone for the time.

Parameters:

timeZone - a TimeZone

Returns:

this

convertRatesTo

public MetricReporter.Builder convertRatesTo(TimeUnit rateUnit)

Convert rates to the given time unit.

Parameters:

rateUnit - a unit of time

Returns:

this

convertDurationsTo

public MetricReporter.Builder convertDurationsTo(TimeUnit durationUnit)

Convert durations to the given time unit.

Parameters:

durationUnit - a unit of time

Returns:

this

filter

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

Only report metrics which match the given filter.

Parameters:

filter - a MetricFilter

Returns:

this

disabledMetricAttributes

public MetricReporter.Builder disabledMetricAttributes(Set<com.codahale.metrics.MetricAttribute> disabledMetricAttributes)

Don't report the passed metric attributes for all metrics (e.g. "p999", "stddev" or "m15"). See MetricAttribute.

Parameters:

disabledMetricAttributes - a MetricFilter

Returns:

this

build

public MetricReporter build()

Builds a MetricReporter with the given properties.

Returns:

a MetricReporter