Package io.dropwizard.metrics.common

Class ConsoleReporterFactory

java.lang.Object

io.dropwizard.metrics.common.BaseReporterFactory

io.dropwizard.metrics.common.BaseFormattedReporterFactory

io.dropwizard.metrics.common.ConsoleReporterFactory

All Implemented Interfaces:

io.dropwizard.jackson.Discoverable, ReporterFactory

public class ConsoleReporterFactory
extends BaseFormattedReporterFactory

A factory for configuring and building ConsoleReporter instances.

Configuration Parameters:

Name	Default	Description
timeZone	UTC	The timezone to display dates/times for.
output	stdout	The stream to write to. One of stdout or stderr.
See BaseFormattedReporterFactory for more options.
See BaseReporterFactory for more options.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ConsoleReporterFactory.ConsoleStream

Constructor Summary

Constructors

Constructor	Description
ConsoleReporterFactory()

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.
ConsoleReporterFactory.ConsoleStream	getOutput()
TimeZone	getTimeZone()
void	setOutput(ConsoleReporterFactory.ConsoleStream stream)
void	setTimeZone(TimeZone timeZone)

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 Details

ConsoleReporterFactory

public ConsoleReporterFactory()

Method Details

getTimeZone

public TimeZone getTimeZone()

setTimeZone

public void setTimeZone(TimeZone timeZone)

getOutput

public ConsoleReporterFactory.ConsoleStream getOutput()

setOutput

public void setOutput(ConsoleReporterFactory.ConsoleStream stream)

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.