Package io.dropwizard.metrics.common

Class CsvReporterFactory

java.lang.Object

io.dropwizard.metrics.common.BaseReporterFactory

io.dropwizard.metrics.common.BaseFormattedReporterFactory

io.dropwizard.metrics.common.CsvReporterFactory

All Implemented Interfaces:

Discoverable, ReporterFactory

public class CsvReporterFactory
extends BaseFormattedReporterFactory

A factory for configuring and building CsvReporter instances.

Configuration Parameters:

Name	Default	Description
file	No default. You must define a directory.	The directory where the csv metrics will be written. If the directory does not exist on startup, an attempt will be made to create it and any parent directories as necessary. If this operation fails dropwizard will fail on startup, but it may have succeeded in creating some of the necessary parent directories.
See BaseFormattedReporterFactory for more options.
See BaseReporterFactory for more options.

Constructor Summary

Constructors

Constructor	Description
CsvReporterFactory()

Method Summary

Modifier and Type	Method	Description
com.codahale.metrics.ScheduledReporter	build(com.codahale.metrics.MetricRegistry registry)	Configures and builds a ScheduledReporter instance for the given registry.
@Nullable File	getFile()
void	setFile(@Nullable File file)

Methods inherited from class io.dropwizard.metrics.common.BaseFormattedReporterFactory

getLocale, setLocale

Methods inherited from class io.dropwizard.metrics.common.BaseReporterFactory

getDisabledAttributes, getDurationUnit, getExcludes, getExcludesAttributes, getFilter, getFrequency, getIncludes, getIncludesAttributes, getRateUnit, getUseRegexFilters, getUseSubstringMatching, setDurationUnit, setExcludes, setExcludesAttributes, setFrequency, setIncludes, setIncludesAttributes, setRateUnit, setUseRegexFilters, setUseSubstringMatching

Methods inherited from class java.lang.Object

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

Constructor Detail

CsvReporterFactory

public CsvReporterFactory()

Method Detail

getFile

public @Nullable File getFile()

setFile

public void setFile(@Nullable File file)

build

public com.codahale.metrics.ScheduledReporter build(com.codahale.metrics.MetricRegistry registry)

Description copied from interface: ReporterFactory

Configures and builds a ScheduledReporter instance for the given registry.

Parameters:

registry - the metrics registry to report metrics from.

Returns:

a reporter configured for the given metrics registry.