org.springframework.boot.actuate.metrics.writer

Class MessageChannelMetricWriter

java.lang.Object

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

All Implemented Interfaces:

CounterWriter, GaugeWriter, 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

See Also:

MetricWriterMessageHandler

Constructor Summary

Constructors

Constructor and Description
MessageChannelMetricWriter(org.springframework.messaging.MessageChannel channel)

Method Summary

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(org.springframework.messaging.MessageChannel channel)

Method Detail

increment

public void increment(Delta<?> delta)

Description copied from interface: CounterWriter

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 CounterWriter

Parameters:

delta - the amount to increment by

set

public void set(Metric<?> value)

Description copied from interface: GaugeWriter

Set the value of a metric.

Specified by:

set in interface GaugeWriter

Parameters:

value - the value

reset

public void reset(String metricName)

Description copied from interface: CounterWriter

Reset the value of a metric, usually to zero value. Implementations can discard the old values if desired, but may choose not to. This operation is optional (some implementations may not be able to fulfill the contract, in which case they should simply do nothing).

Specified by:

reset in interface CounterWriter

Parameters:

metricName - the name to reset