Package com.codahale.metrics

Class CsvReporter.Builder

java.lang.Object

com.codahale.metrics.CsvReporter.Builder

Enclosing class:

CsvReporter

public static class CsvReporter.Builder
extends Object

A builder for CsvReporter 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 TimeUnit	durationUnit
private MetricFilter	filter
private Locale	locale
private TimeUnit	rateUnit
private final MetricRegistry	registry

Constructor Summary

Constructors

Modifier	Constructor	Description
private	Builder(MetricRegistry registry)

Method Summary

Modifier and Type	Method	Description
CsvReporter	build(File directory)	Builds a CsvReporter with the given properties, writing .csv files to the given directory.
CsvReporter.Builder	convertDurationsTo(TimeUnit durationUnit)	Convert durations to the given time unit.
CsvReporter.Builder	convertRatesTo(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(Locale locale)	Format numbers for the given Locale.
CsvReporter.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

Field Details

registry

private final MetricRegistry registry

locale

private Locale locale

rateUnit

private TimeUnit rateUnit

durationUnit

private TimeUnit durationUnit

clock

private Clock clock

filter

private MetricFilter filter

Constructor Details

Builder

private Builder(MetricRegistry registry)

Method Details

formatFor

public CsvReporter.Builder formatFor(Locale locale)

Format numbers for the given Locale.

Parameters:

locale - a Locale

Returns:

this

convertRatesTo

public CsvReporter.Builder convertRatesTo(TimeUnit rateUnit)

Convert rates to the given time unit.

Parameters:

rateUnit - a unit of time

Returns:

this

convertDurationsTo

public CsvReporter.Builder convertDurationsTo(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 given Clock instance for the time.

Parameters:

clock - a Clock instance

Returns:

this

filter

public CsvReporter.Builder filter(MetricFilter filter)

Only report metrics which match the given filter.

Parameters:

filter - a MetricFilter

Returns:

this

build

public CsvReporter build(File directory)

Builds a CsvReporter 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