ratpack.codahale.metrics

Class CodaHaleMetricsModule.Config.Slf4j

java.lang.Object

ratpack.codahale.metrics.CodaHaleMetricsModule.Config.Slf4j

Enclosing class:

CodaHaleMetricsModule.Config

public static class CodaHaleMetricsModule.Config.Slf4j
extends Object

Constructor Summary

Constructors

Constructor and Description
Slf4j()

Method Summary

Modifier and Type	Method and Description
CodaHaleMetricsModule.Config.Slf4j	durationUnit(TimeUnit durationUnit) Convert durations to the given time unit.
CodaHaleMetricsModule.Config.Slf4j	enable(boolean enabled) Set the state of the Slf4j publisher.
CodaHaleMetricsModule.Config.Slf4j	excludeFilter(String excludeFilter) Set the exclude metric filter expression of the reporter.
TimeUnit	getDurationUnit() The state of the duration time unit.
String	getExcludeFilter() The exclude metric filter expression of the reporter.
String	getIncludeFilter() The include metric filter expression of the reporter.
Logger	getLogger() The state of the logger.
com.codahale.metrics.Slf4jReporter.LoggingLevel	getLogLevel() The state of the logging level.
Marker	getMarker() The state of the marker.
String	getPrefix() The logger prefix.
TimeUnit	getRateUnit() The state of the rate time unit.
Duration	getReporterInterval() The interval between metrics reports.
CodaHaleMetricsModule.Config.Slf4j	includeFilter(String includeFilter) Set the include metric filter of the reporter.
boolean	isEnabled() The state of the Slf4j publisher.
CodaHaleMetricsModule.Config.Slf4j	logger(Logger logger) Log metrics to the given logger.
CodaHaleMetricsModule.Config.Slf4j	logLevel(com.codahale.metrics.Slf4jReporter.LoggingLevel logLevel) Use Logging Level when reporting.
CodaHaleMetricsModule.Config.Slf4j	marker(Marker marker) Mark all logged metrics with the given marker.
CodaHaleMetricsModule.Config.Slf4j	prefix(String prefix) Prefix all metric names with the given string.
CodaHaleMetricsModule.Config.Slf4j	rateUnit(TimeUnit rateUnit) Convert rates to the given time unit.
CodaHaleMetricsModule.Config.Slf4j	reporterInterval(Duration reporterInterval) Configure the interval between metrics reports.

Methods inherited from class java.lang.Object

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

Constructor Detail

Slf4j

public Slf4j()

Method Detail

getMarker

public Marker getMarker()

The state of the marker.

Returns:

the marker instance

marker

public CodaHaleMetricsModule.Config.Slf4j marker(Marker marker)

Mark all logged metrics with the given marker.

Parameters:

marker - an SLF4J Marker

Returns:

this

getPrefix

public String getPrefix()

The logger prefix.

Returns:

the prefix text

prefix

public CodaHaleMetricsModule.Config.Slf4j prefix(String prefix)

Prefix all metric names with the given string.

Parameters:

prefix - the prefix for all metric names

Returns:

this

getDurationUnit

public TimeUnit getDurationUnit()

The state of the duration time unit.

Returns:

the duration unit instance

durationUnit

public CodaHaleMetricsModule.Config.Slf4j durationUnit(TimeUnit durationUnit)

Convert durations to the given time unit.

Parameters:

durationUnit - a unit of time

Returns:

this

getRateUnit

public TimeUnit getRateUnit()

The state of the rate time unit.

Returns:

the rate unit instance

rateUnit

public CodaHaleMetricsModule.Config.Slf4j rateUnit(TimeUnit rateUnit)

Convert rates to the given time unit.

Parameters:

rateUnit - a unit of time

Returns:

this

getLogLevel

public com.codahale.metrics.Slf4jReporter.LoggingLevel getLogLevel()

The state of the logging level.

Returns:

the log level instance

logLevel

public CodaHaleMetricsModule.Config.Slf4j logLevel(com.codahale.metrics.Slf4jReporter.LoggingLevel logLevel)

Use Logging Level when reporting.

Parameters:

logLevel - a (@link LoggingLevel}

Returns:

this

getLogger

public Logger getLogger()

The state of the logger.

Returns:

the logger instance

logger

public CodaHaleMetricsModule.Config.Slf4j logger(Logger logger)

Log metrics to the given logger.

Parameters:

logger - an SLF4J Logger

Returns:

this

isEnabled

public boolean isEnabled()

The state of the Slf4j publisher.

Returns:

the state of the Console publisher

enable

public CodaHaleMetricsModule.Config.Slf4j enable(boolean enabled)

Set the state of the Slf4j publisher.

Parameters:

enabled - True if metrics are published to the logger. False otherwise

Returns:

this

getIncludeFilter

public String getIncludeFilter()

The include metric filter expression of the reporter.

Returns:

the include filter

includeFilter

public CodaHaleMetricsModule.Config.Slf4j includeFilter(String includeFilter)

Set the include metric filter of the reporter.

Parameters:

includeFilter - the regular expression to match on.

Returns:

this

getExcludeFilter

public String getExcludeFilter()

The exclude metric filter expression of the reporter.

Returns:

the exclude filter

excludeFilter

public CodaHaleMetricsModule.Config.Slf4j excludeFilter(String excludeFilter)

Set the exclude metric filter expression of the reporter.

Parameters:

excludeFilter - the regular expression to match on.

Returns:

this

getReporterInterval

public Duration getReporterInterval()

The interval between metrics reports.

Returns:

the interval between metrics reports

reporterInterval

public CodaHaleMetricsModule.Config.Slf4j reporterInterval(Duration reporterInterval)

Configure the interval between metrics reports.

Parameters:

reporterInterval - the report interval

Returns:

this