org.springframework.boot.actuate.metrics.writer

Interface MetricWriter

All Known Subinterfaces:

MetricRepository, RichGaugeRepository

All Known Implementing Classes:

CompositeMetricWriter, DropwizardMetricWriter, InMemoryMetricRepository, InMemoryRichGaugeRepository, JmxMetricWriter, MessageChannelMetricWriter, OpenTsdbMetricWriter, RedisMetricRepository, StatsdMetricWriter

public interface MetricWriter

Basic strategy for write operations on Metric data.

Author:

Dave Syer

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.

Method Detail

increment

void increment(Delta<?> delta)

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.

Parameters:

delta - the amount to increment by

set

void set(Metric<?> value)

Set the value of a metric.

Parameters:

value - the value

reset

void reset(String metricName)

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

Parameters:

metricName - the name to reset