Package com.codahale.metrics
Class CsvReporter.Builder
- java.lang.Object
-
- com.codahale.metrics.CsvReporter.Builder
-
- Enclosing class:
- CsvReporter
public static class CsvReporter.Builder extends java.lang.Object
A builder forCsvReporter
instances. Defaults to using the default locale, 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.util.concurrent.TimeUnit
rateUnit
private MetricRegistry
registry
-
Constructor Summary
Constructors Modifier Constructor Description private
Builder(MetricRegistry registry)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description CsvReporter
build(java.io.File directory)
Builds aCsvReporter
with the given properties, writing.csv
files to the given directory.CsvReporter.Builder
convertDurationsTo(java.util.concurrent.TimeUnit durationUnit)
Convert durations to the given time unit.CsvReporter.Builder
convertRatesTo(java.util.concurrent.TimeUnit rateUnit)
Convert rates to the given time unit.CsvReporter.Builder
filter(MetricFilter filter)
Only report metrics which match the given filter.CsvReporter.Builder
formatFor(java.util.Locale locale)
Format numbers for the givenLocale
.CsvReporter.Builder
withClock(Clock clock)
Use the givenClock
instance for the time.
-
-
-
Field Detail
-
registry
private final MetricRegistry registry
-
locale
private java.util.Locale locale
-
rateUnit
private java.util.concurrent.TimeUnit rateUnit
-
durationUnit
private java.util.concurrent.TimeUnit durationUnit
-
clock
private Clock clock
-
filter
private MetricFilter filter
-
-
Constructor Detail
-
Builder
private Builder(MetricRegistry registry)
-
-
Method Detail
-
formatFor
public CsvReporter.Builder formatFor(java.util.Locale locale)
Format numbers for the givenLocale
.- Parameters:
locale
- aLocale
- Returns:
this
-
convertRatesTo
public CsvReporter.Builder convertRatesTo(java.util.concurrent.TimeUnit rateUnit)
Convert rates to the given time unit.- Parameters:
rateUnit
- a unit of time- Returns:
this
-
convertDurationsTo
public CsvReporter.Builder convertDurationsTo(java.util.concurrent.TimeUnit durationUnit)
Convert durations to the given time unit.- Parameters:
durationUnit
- a unit of time- Returns:
this
-
withClock
public CsvReporter.Builder withClock(Clock clock)
Use the givenClock
instance for the time.- Parameters:
clock
- aClock
instance- Returns:
this
-
filter
public CsvReporter.Builder filter(MetricFilter filter)
Only report metrics which match the given filter.- Parameters:
filter
- aMetricFilter
- Returns:
this
-
build
public CsvReporter build(java.io.File directory)
Builds aCsvReporter
with the given properties, writing.csv
files to the given directory.- Parameters:
directory
- the directory in which the.csv
files will be created- Returns:
- a
CsvReporter
-
-