Class ConsoleReporter.Builder

java.lang.Object

com.codahale.metrics.ConsoleReporter.Builder

Enclosing class:

ConsoleReporter

public static class ConsoleReporter.Builder
extends Object

A builder for ConsoleReporter 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.

Field Summary

Fields

Modifier and Type	Field	Description
private Clock	clock
private TimeUnit	durationUnit
private MetricFilter	filter
private Locale	locale
private PrintStream	output
private TimeUnit	rateUnit
private final MetricRegistry	registry
private TimeZone	timeZone

Constructor Summary

Constructors

Modifier	Constructor	Description
private	Builder(MetricRegistry registry)

Method Summary

Modifier and Type	Method	Description
ConsoleReporter	build()	Builds a ConsoleReporter with the given properties.
ConsoleReporter.Builder	convertDurationsTo(TimeUnit durationUnit)	Convert durations to the given time unit.
ConsoleReporter.Builder	convertRatesTo(TimeUnit rateUnit)	Convert rates to the given time unit.
ConsoleReporter.Builder	filter(MetricFilter filter)	Only report metrics which match the given filter.
ConsoleReporter.Builder	formattedFor(Locale locale)	Format numbers for the given Locale.
ConsoleReporter.Builder	formattedFor(TimeZone timeZone)	Use the given TimeZone for the time.
ConsoleReporter.Builder	outputTo(PrintStream output)	Write to the given PrintStream.
ConsoleReporter.Builder	withClock(Clock clock)	Use the given Clock instance for the time.

Methods inherited from class Object

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

Field Details

registry

private final MetricRegistry registry

output

private PrintStream output

locale

private Locale locale

clock

private Clock clock

timeZone

private TimeZone timeZone

rateUnit

private TimeUnit rateUnit

durationUnit

private TimeUnit durationUnit

filter

private MetricFilter filter

Constructor Details

Builder

private Builder(MetricRegistry registry)

Method Details

outputTo

public ConsoleReporter.Builder outputTo(PrintStream output)

Write to the given PrintStream.

Parameters:

output - a PrintStream instance.

Returns:

this

formattedFor

public ConsoleReporter.Builder formattedFor(Locale locale)

Format numbers for the given Locale.

Parameters:

locale - a Locale

Returns:

this

withClock

public ConsoleReporter.Builder withClock(Clock clock)

Use the given Clock instance for the time.

Parameters:

clock - a Clock instance

Returns:

this

formattedFor

public ConsoleReporter.Builder formattedFor(TimeZone timeZone)

Use the given TimeZone for the time.

Parameters:

timeZone - a TimeZone

Returns:

this

convertRatesTo

public ConsoleReporter.Builder convertRatesTo(TimeUnit rateUnit)

Convert rates to the given time unit.

Parameters:

rateUnit - a unit of time

Returns:

this

convertDurationsTo

public ConsoleReporter.Builder convertDurationsTo(TimeUnit durationUnit)

Convert durations to the given time unit.

Parameters:

durationUnit - a unit of time

Returns:

this

filter

public ConsoleReporter.Builder filter(MetricFilter filter)

Only report metrics which match the given filter.

Parameters:

filter - a MetricFilter

Returns:

this

build

public ConsoleReporter build()

Builds a ConsoleReporter with the given properties.

Returns:

a ConsoleReporter