Package org.apache.flink.runtime.metrics.groups

Class InternalSplitEnumeratorMetricGroup

java.lang.Object

org.apache.flink.runtime.metrics.groups.ProxyMetricGroup<MetricGroup>

org.apache.flink.runtime.metrics.groups.InternalSplitEnumeratorMetricGroup

All Implemented Interfaces:

OperatorCoordinatorMetricGroup, SplitEnumeratorMetricGroup, MetricGroup

@Internal
public class InternalSplitEnumeratorMetricGroup
extends ProxyMetricGroup<MetricGroup>
implements SplitEnumeratorMetricGroup

Special MetricGroup representing an SplitEnumerator.

Field Summary

Fields inherited from class org.apache.flink.runtime.metrics.groups.ProxyMetricGroup

parentMetricGroup

Constructor Summary

Constructors

Constructor	Description
InternalSplitEnumeratorMetricGroup(MetricGroup parent)

Method Summary

Modifier and Type	Method	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 class org.apache.flink.runtime.metrics.groups.ProxyMetricGroup

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

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.MetricGroup

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

Constructor Detail

InternalSplitEnumeratorMetricGroup

public InternalSplitEnumeratorMetricGroup(MetricGroup parent)

Method Detail

setUnassignedSplitsGauge

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

Description copied from interface: SplitEnumeratorMetricGroup

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.

Specified by:

setUnassignedSplitsGauge in interface SplitEnumeratorMetricGroup

Returns:

the supplied gauge