public class JMXReporter extends Object implements 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
Modifier and Type | Class and 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.
|
Modifier and Type | Method and Description |
---|---|
void |
close()
Closes this reporter.
|
Optional<Integer> |
getPort() |
void |
notifyOfAddedMetric(Metric metric,
String metricName,
MetricGroup group)
Called when a new
Metric was added. |
void |
notifyOfRemovedMetric(Metric metric,
String metricName,
MetricGroup group)
Called when a
Metric was should be removed. |
void |
open(MetricConfig config)
Configures this reporter.
|
public void open(MetricConfig config)
MetricReporter
If the reporter was instantiated generically and hence parameter-less, this method is the place where the reporter sets it's basic fields based on configuration values. Otherwise, this method will typically be a no-op since resources can be acquired in the constructor.
This method is always called first on a newly instantiated reporter.
open
in interface MetricReporter
config
- A properties object that contains all parameters set for this reporter.public void close()
MetricReporter
close
in interface MetricReporter
public void notifyOfAddedMetric(Metric metric, String metricName, MetricGroup group)
MetricReporter
Metric
was added.notifyOfAddedMetric
in interface MetricReporter
metric
- the metric that was addedmetricName
- the name of the metricgroup
- the group that contains the metricpublic void notifyOfRemovedMetric(Metric metric, String metricName, MetricGroup group)
MetricReporter
Metric
was should be removed.notifyOfRemovedMetric
in interface MetricReporter
metric
- the metric that should be removedmetricName
- the name of the metricgroup
- the group that contains the metricCopyright © 2014–2020 The Apache Software Foundation. All rights reserved.