ratpack.codahale.metrics

Class Graphite

java.lang.Object

ratpack.codahale.metrics.Graphite

public class Graphite
extends java.lang.Object

A Configuration implementation to setup GraphiteReporter instances

Constructor Summary

Constructors

Constructor and Description
Graphite()

Method Summary

Modifier and Type	Method and Description
Graphite	disable() Disable the Graphite publisher.
Graphite	durationUnit(java.util.concurrent.TimeUnit durationUnit) Convert durations to the given time unit.
Graphite	enable() Enable the Graphite publisher.
Graphite	excludeFilter(java.lang.String excludeFilter) Do not report metrics which match the given filter.
java.util.concurrent.TimeUnit	getDurationUnit() The state of duration conversion
java.lang.String	getExcludeFilter() The state of the exclusion metric filter
java.lang.String	getIncludeFilter() The state of the inclusion metric filter
java.lang.String	getPrefix() The state of the metric name prefix
java.util.concurrent.TimeUnit	getRateUnit() The state of rate conversion
java.time.Duration	getReporterInterval() The interval between metrics reports.
com.codahale.metrics.graphite.GraphiteSender	getSender() The GraphiteSender instance.
Graphite	includeFilter(java.lang.String includeFilter) Only report metrics which match the given filter.
boolean	isEnabled() The state of the Graphite publisher.
Graphite	prefix(java.lang.String prefix) Prefix all metric names with the given string.
Graphite	rateUnit(java.util.concurrent.TimeUnit rateUnit) Convert rates to the given time unit.
Graphite	reporterInterval(java.time.Duration reporterInterval) Configure the interval between broadcasts.
Graphite	sender(com.codahale.metrics.graphite.GraphiteSender sender) Configure the GraphiteSender instance.

Methods inherited from class java.lang.Object

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

Constructor Detail

Graphite

public Graphite()

Method Detail

isEnabled

public boolean isEnabled()

The state of the Graphite publisher.

Returns:

the state of the Graphite publisher

enable

public Graphite enable()

Enable the Graphite publisher.

Returns:

this

disable

public Graphite disable()

Disable the Graphite publisher.

Returns:

this

getReporterInterval

public java.time.Duration getReporterInterval()

The interval between metrics reports.

Returns:

the interval between metrics reports

reporterInterval

public Graphite reporterInterval(java.time.Duration reporterInterval)

Configure the interval between broadcasts.

Parameters:

reporterInterval - the report interval

Returns:

this

getSender

public com.codahale.metrics.graphite.GraphiteSender getSender()

The GraphiteSender instance.

Returns:

the Graphite report sender

sender

public Graphite sender(com.codahale.metrics.graphite.GraphiteSender sender)

Configure the GraphiteSender instance.

Parameters:

sender - the report sender

Returns:

this

getIncludeFilter

public java.lang.String getIncludeFilter()

The state of the inclusion metric filter

Returns:

the inclusion filter

includeFilter

public Graphite includeFilter(java.lang.String includeFilter)

Only report metrics which match the given filter.

Parameters:

includeFilter - a MetricFilter

Returns:

this

getExcludeFilter

public java.lang.String getExcludeFilter()

The state of the exclusion metric filter

Returns:

the exclusion filter

excludeFilter

public Graphite excludeFilter(java.lang.String excludeFilter)

Do not report metrics which match the given filter.

Parameters:

excludeFilter - a MetricFilter

Returns:

this

getPrefix

public java.lang.String getPrefix()

The state of the metric name prefix

Returns:

the metric prefix value

prefix

public Graphite prefix(java.lang.String prefix)

Prefix all metric names with the given string.

Parameters:

prefix - the prefix for all metric names

Returns:

this

getRateUnit

public java.util.concurrent.TimeUnit getRateUnit()

The state of rate conversion

Returns:

the rate conversion unit

rateUnit

public Graphite rateUnit(java.util.concurrent.TimeUnit rateUnit)

Convert rates to the given time unit.

Parameters:

rateUnit - a unit of time

Returns:

this

getDurationUnit

public java.util.concurrent.TimeUnit getDurationUnit()

The state of duration conversion

Returns:

the duration conversion unit

durationUnit

public Graphite durationUnit(java.util.concurrent.TimeUnit durationUnit)

Convert durations to the given time unit.

Parameters:

durationUnit - a unit of time

Returns:

this