Class JmxReporter

java.lang.Object

com.codahale.metrics.JmxReporter

All Implemented Interfaces:

Closeable, AutoCloseable

public class JmxReporter
extends Object
implements Closeable

A reporter which listens for new metrics and exposes them as namespaced MBeans.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static class	JmxReporter.AbstractBean
static class	JmxReporter.Builder	A builder for CsvReporter instances.
private static class	JmxReporter.JmxCounter
static interface	JmxReporter.JmxCounterMBean
private static class	JmxReporter.JmxGauge
static interface	JmxReporter.JmxGaugeMBean
private static class	JmxReporter.JmxHistogram
static interface	JmxReporter.JmxHistogramMBean
private static class	JmxReporter.JmxListener
private static class	JmxReporter.JmxMeter
static interface	JmxReporter.JmxMeterMBean
(package private) static class	JmxReporter.JmxTimer
static interface	JmxReporter.JmxTimerMBean
static interface	JmxReporter.MetricMBean
private static class	JmxReporter.MetricTimeUnits

Field Summary

Fields

Modifier and Type	Field	Description
private final JmxReporter.JmxListener	listener
private static final org.slf4j.Logger	LOGGER
private final MetricRegistry	registry

Constructor Summary

Constructors

Modifier	Constructor	Description
private	JmxReporter(MBeanServer mBeanServer, String domain, MetricRegistry registry, MetricFilter filter, JmxReporter.MetricTimeUnits timeUnits)

Method Summary

Modifier and Type	Method	Description
void	close()	Stops the reporter.
static JmxReporter.Builder	forRegistry(MetricRegistry registry)	Returns a new JmxReporter.Builder for JmxReporter.
void	start()	Starts the reporter.
void	stop()	Stops the reporter.

Methods inherited from class Object

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

Field Details

LOGGER

private static final org.slf4j.Logger LOGGER

registry

private final MetricRegistry registry

listener

private final JmxReporter.JmxListener listener

Constructor Details

JmxReporter

private JmxReporter(MBeanServer mBeanServer,
 String domain,
 MetricRegistry registry,
 MetricFilter filter,
 JmxReporter.MetricTimeUnits timeUnits)

Method Details

forRegistry

public static JmxReporter.Builder forRegistry(MetricRegistry registry)

Returns a new JmxReporter.Builder for JmxReporter.

Parameters:

registry - the registry to report

Returns:

a JmxReporter.Builder instance for a JmxReporter

start

public void start()

Starts the reporter.

stop

public void stop()

Stops the reporter.

close

public void close()

Stops the reporter.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable