org.springframework.boot.actuate.metrics.writer

Class MessageChannelMetricWriter

java.lang.Object

org.springframework.boot.actuate.metrics.writer.MessageChannelMetricWriter

All Implemented Interfaces:

MetricWriter

public class MessageChannelMetricWriter
extends Object
implements MetricWriter

A MetricWriter that publishes the metric updates on a MessageChannel. The messages have the writer input (Delta or Metric) as payload, and carry an additional header "metricName" with the name of the metric in it.

Author:

Dave Syer

Constructor Summary

Constructors

Constructor and Description
MessageChannelMetricWriter(MessageChannel channel)

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

MessageChannelMetricWriter

public MessageChannelMetricWriter(MessageChannel channel)

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