org.apache.flink.runtime.metrics

Class MetricRegistry

java.lang.Object

org.apache.flink.runtime.metrics.MetricRegistry

public class MetricRegistry
extends Object

A MetricRegistry keeps track of all registered Metrics. It serves as the connection between MetricGroups and MetricReporters.

Constructor Summary

Constructors

Constructor and Description
MetricRegistry(org.apache.flink.configuration.Configuration config) Creates a new MetricRegistry and starts the configured reporter.

Method Summary

Modifier and Type	Method and Description
char	getDelimiter()
List<org.apache.flink.metrics.reporter.MetricReporter>	getReporters()
ScopeFormats	getScopeFormats()
void	register(org.apache.flink.metrics.Metric metric, String metricName, org.apache.flink.metrics.MetricGroup group) Registers a new Metric with this registry.
void	shutdown() Shuts down this registry and the associated MetricReporter.
void	unregister(org.apache.flink.metrics.Metric metric, String metricName, org.apache.flink.metrics.MetricGroup group) Un-registers the given Metric with this registry.

Methods inherited from class java.lang.Object

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

Constructor Detail

MetricRegistry

public MetricRegistry(org.apache.flink.configuration.Configuration config)

Creates a new MetricRegistry and starts the configured reporter.

Method Detail

getDelimiter

public char getDelimiter()

getReporters

public List<org.apache.flink.metrics.reporter.MetricReporter> getReporters()

shutdown

public void shutdown()

Shuts down this registry and the associated MetricReporter.

getScopeFormats

public ScopeFormats getScopeFormats()

register

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

Registers a new Metric with this registry.

Parameters:

metric - the metric that was added

metricName - the name of the metric

group - the group that contains the metric

unregister

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

Un-registers the given Metric with this registry.

Parameters:

metric - the metric that should be removed

metricName - the name of the metric

group - the group that contains the metric