Package org.apache.flink.metrics.jmx

Class JMXReporter

java.lang.Object

org.apache.flink.metrics.jmx.JMXReporter

All Implemented Interfaces:

org.apache.flink.metrics.reporter.MetricReporter

public class JMXReporter
extends Object
implements org.apache.flink.metrics.reporter.MetricReporter

MetricReporter that exports Metrics via JMX.

Largely based on the JmxReporter class of the dropwizard metrics library https://github.com/dropwizard/metrics/blob/master/metrics-core/src/main/java/io/dropwizard/metrics/JmxReporter.java

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	JMXReporter.JmxCounterMBean	The MBean interface for an exposed counter.
static interface	JMXReporter.JmxGaugeMBean	The MBean interface for an exposed gauge.
static interface	JMXReporter.JmxHistogramMBean	The MBean interface for an exposed histogram.
static interface	JMXReporter.JmxMeterMBean	The MBean interface for an exposed meter.
static interface	JMXReporter.MetricMBean	The common MBean interface for all metrics.

Method Summary

Modifier and Type	Method	Description
void	close()
Optional<Integer>	getPort()
void	notifyOfAddedMetric(org.apache.flink.metrics.Metric metric, String metricName, org.apache.flink.metrics.MetricGroup group)
void	notifyOfRemovedMetric(org.apache.flink.metrics.Metric metric, String metricName, org.apache.flink.metrics.MetricGroup group)
void	open(org.apache.flink.metrics.MetricConfig config)

Methods inherited from class java.lang.Object

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

Method Details

open

public void open(org.apache.flink.metrics.MetricConfig config)

Specified by:

open in interface org.apache.flink.metrics.reporter.MetricReporter

close

public void close()

Specified by:

close in interface org.apache.flink.metrics.reporter.MetricReporter

getPort

public Optional<Integer> getPort()

notifyOfAddedMetric

public void notifyOfAddedMetric(org.apache.flink.metrics.Metric metric,
 String metricName,
 org.apache.flink.metrics.MetricGroup group)

Specified by:

notifyOfAddedMetric in interface org.apache.flink.metrics.reporter.MetricReporter

notifyOfRemovedMetric

public void notifyOfRemovedMetric(org.apache.flink.metrics.Metric metric,
 String metricName,
 org.apache.flink.metrics.MetricGroup group)

Specified by:

notifyOfRemovedMetric in interface org.apache.flink.metrics.reporter.MetricReporter