Package com.codahale.metrics
Class ConsoleReporter.Builder
- java.lang.Object
-
- com.codahale.metrics.ConsoleReporter.Builder
-
- Enclosing class:
- ConsoleReporter
public static class ConsoleReporter.Builder extends java.lang.Object
A builder forConsoleReporter
instances. Defaults to using the default locale and time zone, writing toSystem.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 java.util.concurrent.TimeUnit
durationUnit
private MetricFilter
filter
private java.util.Locale
locale
private java.io.PrintStream
output
private java.util.concurrent.TimeUnit
rateUnit
private MetricRegistry
registry
private java.util.TimeZone
timeZone
-
Constructor Summary
Constructors Modifier Constructor Description private
Builder(MetricRegistry registry)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ConsoleReporter
build()
Builds aConsoleReporter
with the given properties.ConsoleReporter.Builder
convertDurationsTo(java.util.concurrent.TimeUnit durationUnit)
Convert durations to the given time unit.ConsoleReporter.Builder
convertRatesTo(java.util.concurrent.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(java.util.Locale locale)
Format numbers for the givenLocale
.ConsoleReporter.Builder
formattedFor(java.util.TimeZone timeZone)
Use the givenTimeZone
for the time.ConsoleReporter.Builder
outputTo(java.io.PrintStream output)
Write to the givenPrintStream
.ConsoleReporter.Builder
withClock(Clock clock)
Use the givenClock
instance for the time.
-
-
-
Field Detail
-
registry
private final MetricRegistry registry
-
output
private java.io.PrintStream output
-
locale
private java.util.Locale locale
-
clock
private Clock clock
-
timeZone
private java.util.TimeZone timeZone
-
rateUnit
private java.util.concurrent.TimeUnit rateUnit
-
durationUnit
private java.util.concurrent.TimeUnit durationUnit
-
filter
private MetricFilter filter
-
-
Constructor Detail
-
Builder
private Builder(MetricRegistry registry)
-
-
Method Detail
-
outputTo
public ConsoleReporter.Builder outputTo(java.io.PrintStream output)
Write to the givenPrintStream
.- Parameters:
output
- aPrintStream
instance.- Returns:
this
-
formattedFor
public ConsoleReporter.Builder formattedFor(java.util.Locale locale)
Format numbers for the givenLocale
.- Parameters:
locale
- aLocale
- Returns:
this
-
withClock
public ConsoleReporter.Builder withClock(Clock clock)
Use the givenClock
instance for the time.- Parameters:
clock
- aClock
instance- Returns:
this
-
formattedFor
public ConsoleReporter.Builder formattedFor(java.util.TimeZone timeZone)
Use the givenTimeZone
for the time.- Parameters:
timeZone
- aTimeZone
- Returns:
this
-
convertRatesTo
public ConsoleReporter.Builder convertRatesTo(java.util.concurrent.TimeUnit rateUnit)
Convert rates to the given time unit.- Parameters:
rateUnit
- a unit of time- Returns:
this
-
convertDurationsTo
public ConsoleReporter.Builder convertDurationsTo(java.util.concurrent.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
- aMetricFilter
- Returns:
this
-
build
public ConsoleReporter build()
Builds aConsoleReporter
with the given properties.- Returns:
- a
ConsoleReporter
-
-