org.apache.flink.metrics.groups

Interface SourceReaderMetricGroup

All Superinterfaces:

MetricGroup, OperatorMetricGroup

All Known Implementing Classes:

InternalSourceReaderMetricGroup

@PublicEvolving
public interface SourceReaderMetricGroup
extends OperatorMetricGroup

Pre-defined metrics for SourceReader.

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

Method Summary

Modifier and Type	Method and Description
Counter	getNumRecordsInErrorsCounter() The total number of record that failed to consume, process, or emit.
void	setPendingBytesGauge(Gauge<Long> pendingBytesGauge) Sets an optional gauge for the number of bytes that have not been fetched by the source.
void	setPendingRecordsGauge(Gauge<Long> pendingRecordsGauge) Sets an optional gauge for the number of records that have not been fetched by the source.

Methods inherited from interface org.apache.flink.metrics.groups.OperatorMetricGroup

getIOMetricGroup

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

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

Method Detail

getNumRecordsInErrorsCounter

Counter getNumRecordsInErrorsCounter()

The total number of record that failed to consume, process, or emit.

setPendingBytesGauge

void setPendingBytesGauge(Gauge<Long> pendingBytesGauge)

Sets an optional gauge for the number of bytes that have not been fetched by the source. e.g. the remaining bytes in a file after the file descriptor reading position.

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

setPendingRecordsGauge

void setPendingRecordsGauge(Gauge<Long> pendingRecordsGauge)

Sets an optional gauge for the number of records that have not been fetched by the source. e.g. the available records after the consumer offset in a Kafka partition.

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