org.apache.flink.runtime.metrics

Interface MetricRegistry

All Known Implementing Classes:

MetricRegistryImpl, NoOpMetricRegistry

public interface MetricRegistry

Interface for a metric registry.

Method Summary

Modifier and Type	Method and Description
char	getDelimiter() Returns the global delimiter.
char	getDelimiter(int index) Returns the configured delimiter for the reporter with the given index.
String	getMetricQueryServicePath() Returns the path of the MetricQueryService or null, if none is started.
int	getNumberReporters() Returns the number of registered reporters.
ScopeFormats	getScopeFormats() Returns the scope formats.
void	register(org.apache.flink.metrics.Metric metric, String metricName, AbstractMetricGroup group) Registers a new Metric with this registry.
void	unregister(org.apache.flink.metrics.Metric metric, String metricName, AbstractMetricGroup group) Un-registers the given Metric with this registry.

Method Detail

getDelimiter

char getDelimiter()

Returns the global delimiter.

Returns:

global delimiter

getDelimiter

char getDelimiter(int index)

Returns the configured delimiter for the reporter with the given index.

Parameters:

index - index of the reporter whose delimiter should be used

Returns:

configured reporter delimiter, or global delimiter if index is invalid

getNumberReporters

int getNumberReporters()

Returns the number of registered reporters.

register

void register(org.apache.flink.metrics.Metric metric,
              String metricName,
              AbstractMetricGroup 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

void unregister(org.apache.flink.metrics.Metric metric,
                String metricName,
                AbstractMetricGroup 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

getScopeFormats

ScopeFormats getScopeFormats()

Returns the scope formats.

Returns:

scope formats

getMetricQueryServicePath

@Nullable
String getMetricQueryServicePath()

Returns the path of the MetricQueryService or null, if none is started.

Returns:

Path of the MetricQueryService or null, if none is started