org.springframework.boot.actuate.metrics.jmx

Class JmxMetricWriter

java.lang.Object

org.springframework.boot.actuate.metrics.jmx.JmxMetricWriter

All Implemented Interfaces:

CounterWriter, GaugeWriter, MetricWriter

@ManagedResource(description="MetricWriter for pushing metrics to JMX MBeans.")
public class JmxMetricWriter
extends Object
implements MetricWriter

A MetricWriter for MBeans. Each metric is registered as an individual MBean, so (for instance) it can be graphed and monitored. The object names are provided by an ObjectNamingStrategy, where the default is a DefaultMetricNamingStrategy which provides type, name and value keys by splitting up the metric name on periods.

Since:

1.3.0

Author:

Dave Syer

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JmxMetricWriter.MetricValue A single metric value.

Constructor Summary

Constructors

Constructor and Description
JmxMetricWriter(MBeanExporter exporter)

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	increment(String name, long value)
void	reset(String name) Reset the value of a metric, usually to zero value.
void	set(Metric<?> value) Set the value of a metric.
void	set(String name, double value)
void	setDomain(String domain)
void	setNamingStrategy(ObjectNamingStrategy namingStrategy)

Methods inherited from class java.lang.Object

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

Constructor Detail

JmxMetricWriter

public JmxMetricWriter(MBeanExporter exporter)

Method Detail

setNamingStrategy

public void setNamingStrategy(ObjectNamingStrategy namingStrategy)

setDomain

public void setDomain(String domain)

increment

@ManagedOperation
public void increment(String name,
                                        long value)

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

@ManagedOperation
public void set(String name,
                                  double value)

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

@ManagedOperation
public void reset(String name)

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:

name - the name to reset