org.springframework.boot.actuate.metrics.writer

Class CodahaleMetricWriter

java.lang.Object

org.springframework.boot.actuate.metrics.writer.CodahaleMetricWriter

All Implemented Interfaces:

MetricWriter

public class CodahaleMetricWriter
extends Object
implements MetricWriter

A MetricWriter that send data to a Codahale MetricRegistry based on a naming convention:

• Updates to increment(Delta) with names in "meter.*" are treated as Meter events
• Other deltas are treated as simple Counter values
• Inputs to set(Metric) with names in "histogram.*" are treated as Histogram updates
• Inputs to set(Metric) with names in "timer.*" are treated as Timer updates
• Other metrics are treated as simple Gauge values (single valued measurements of type double)

Author:

Dave Syer

Constructor Summary

Constructors

Constructor and Description
CodahaleMetricWriter(MetricRegistry registry) Create a new CodahaleMetricWriter instance.

Method Summary

Methods

Modifier and Type	Method and Description
void	increment(Delta<?> delta) Increment the value of a metric (or decrement if the delta is negative).
void	reset(String metricName) Reset the value of a metric, usually to zero value.
void	set(Metric<?> value) Set the value of a metric.

Methods inherited from class java.lang.Object

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

Constructor Detail

CodahaleMetricWriter

public CodahaleMetricWriter(MetricRegistry registry)

Create a new CodahaleMetricWriter instance.

Parameters:

registry - the underlying metric registry

Method Detail

increment

public void increment(Delta<?> delta)

Description copied from interface: MetricWriter

Increment the value of a metric (or decrement if the delta is negative). The name of the delta is the name of the metric to increment.

Specified by:

increment in interface MetricWriter

Parameters:

delta - the amount to increment by

set

public void set(Metric<?> value)

Description copied from interface: MetricWriter

Set the value of a metric.

Specified by:

set in interface MetricWriter

reset

public void reset(String metricName)

Description copied from interface: MetricWriter

Reset the value of a metric, usually to zero value. Implementations can discard the old values if desired, but may choose not to.

Specified by:

reset in interface MetricWriter

Parameters:

metricName - the name to reset