Package com.codahale.metrics

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.

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	disabledMetricAttributes(Set<MetricAttribute> disabledMetricAttributes)	Don't report the passed metric attributes for all metrics (e.g.
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	scheduleOn(ScheduledExecutorService executor)	Specifies the executor to use while scheduling reporting of metrics.
ConsoleReporter.Builder	shutdownExecutorOnStop(boolean shutdownExecutorOnStop)	Specifies whether or not, the executor (used for reporting) will be stopped with same time with reporter.
ConsoleReporter.Builder	withClock(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 Details

shutdownExecutorOnStop

public ConsoleReporter.Builder shutdownExecutorOnStop(boolean shutdownExecutorOnStop)

Specifies whether or not, the executor (used for reporting) will be stopped with same time with reporter. Default value is true. Setting this parameter to false, has the sense in combining with providing external managed executor via scheduleOn(ScheduledExecutorService).

Parameters:

shutdownExecutorOnStop - if true, then executor will be stopped in same time with this reporter

Returns:

this

scheduleOn

public ConsoleReporter.Builder scheduleOn(ScheduledExecutorService executor)

Specifies the executor to use while scheduling reporting of metrics. Default value is null. Null value leads to executor will be auto created on start.

Parameters:

executor - the executor to use while scheduling reporting of metrics.

Returns:

this

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

disabledMetricAttributes

public ConsoleReporter.Builder disabledMetricAttributes(Set<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 ConsoleReporter build()

Builds a ConsoleReporter with the given properties.

Returns:

a ConsoleReporter