@Public public interface MetricReporter
Metrics
to an external backend.
Metric reporters are instantiated via a MetricReporterFactory
.
Modifier and Type | Method and Description |
---|---|
void |
close()
Closes this reporter.
|
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 removed. |
void |
open(MetricConfig config)
Configures this reporter.
|
void open(MetricConfig config)
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.
config
- A properties object that contains all parameters set for this reporter.void close()
void notifyOfAddedMetric(Metric metric, String metricName, MetricGroup group)
Metric
was added.metric
- the metric that was addedmetricName
- the name of the metricgroup
- the group that contains the metricvoid notifyOfRemovedMetric(Metric metric, String metricName, MetricGroup group)
Metric
was removed.metric
- the metric that should be removedmetricName
- the name of the metricgroup
- the group that contains the metricCopyright © 2014–2024 The Apache Software Foundation. All rights reserved.