org.apache.flink.metrics.groups

Interface SplitEnumeratorMetricGroup

All Superinterfaces:

MetricGroup, OperatorCoordinatorMetricGroup

All Known Implementing Classes:

InternalSplitEnumeratorMetricGroup

@PublicEvolving
public interface SplitEnumeratorMetricGroup
extends OperatorCoordinatorMetricGroup

Pre-defined metrics for SplitEnumerator.

You should only update the metrics in the main operator thread.

Method Summary

Modifier and Type	Method and Description
<G extends Gauge<Long>> G	setUnassignedSplitsGauge(G unassignedSplitsGauge) Sets an optional gauge for the number of splits that have been enumerated but not yet assigned.

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

addGroup, addGroup, addGroup, addSpan, counter, counter, counter, counter, gauge, gauge, getAllVariables, getMetricIdentifier, getMetricIdentifier, getScopeComponents, histogram, histogram, meter, meter

Method Detail

setUnassignedSplitsGauge

<G extends Gauge<Long>> G setUnassignedSplitsGauge(G unassignedSplitsGauge)

Sets an optional gauge for the number of splits that have been enumerated but not yet assigned. For example, this would be the number of files that are in the backlog.

Note that not every source can report this metric in an plausible and efficient way.

Returns:

the supplied gauge