Package org.apache.flink.metrics.reporter

Class AbstractReporter

java.lang.Object

org.apache.flink.metrics.reporter.AbstractReporter

All Implemented Interfaces:

CharacterFilter, MetricReporter

Direct Known Subclasses:

Slf4jReporter, StatsDReporter

@Public
public abstract class AbstractReporter
extends Object
implements MetricReporter, CharacterFilter

Base interface for custom metric reporters.

Field Summary

Fields

Modifier and Type	Field	Description
protected Map<Counter,String>	counters
protected Map<Gauge<?>,String>	gauges
protected Map<Histogram,String>	histograms
protected org.slf4j.Logger	log
protected Map<Meter,String>	meters

Fields inherited from interface org.apache.flink.metrics.CharacterFilter

NO_OP_FILTER

Constructor Summary

Constructors

Constructor	Description
AbstractReporter()

Method Summary

Modifier and Type	Method	Description
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.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.flink.metrics.CharacterFilter

filterCharacters

Methods inherited from interface org.apache.flink.metrics.reporter.MetricReporter

close, open

Field Detail

log

protected final org.slf4j.Logger log

gauges

protected final Map<Gauge<?>,String> gauges

counters

protected final Map<Counter,String> counters

histograms

protected final Map<Histogram,String> histograms

meters

protected final Map<Meter,String> meters

Constructor Detail

AbstractReporter

public AbstractReporter()

Method Detail

notifyOfAddedMetric

public void notifyOfAddedMetric(Metric metric,
                                String metricName,
                                MetricGroup group)

Description copied from interface: MetricReporter

Called when a new Metric was added.

Specified by:

notifyOfAddedMetric in interface MetricReporter

Parameters:

metric - the metric that was added

metricName - the name of the metric

group - the group that contains the metric

notifyOfRemovedMetric

public void notifyOfRemovedMetric(Metric metric,
                                  String metricName,
                                  MetricGroup group)

Description copied from interface: MetricReporter

Called when a Metric was removed.

Specified by:

notifyOfRemovedMetric in interface MetricReporter

Parameters:

metric - the metric that should be removed

metricName - the name of the metric

group - the group that contains the metric