org.apache.flink.runtime.metrics.groups

Class TaskIOMetricGroup

java.lang.Object

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

org.apache.flink.runtime.metrics.groups.TaskIOMetricGroup

All Implemented Interfaces:

org.apache.flink.metrics.MetricGroup

public class TaskIOMetricGroup
extends ProxyMetricGroup<TaskMetricGroup>

Metric group that contains shareable pre-defined IO-related metrics. The metrics registration is forwarded to the parent task metric group.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	TaskIOMetricGroup.SizeSupplier<R> Supplier for sizes.

Field Summary

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

parentMetricGroup

Constructor Summary

Constructors

Constructor and Description
TaskIOMetricGroup(TaskMetricGroup parent)
TaskIOMetricGroup(TaskMetricGroup parent, org.apache.flink.util.clock.Clock clock)

Method Summary

Modifier and Type	Method and Description
IOMetrics	createSnapshot()
long	getAccumulatedBackPressuredTimeMs()
long	getBackPressuredTimeMsPerSecond()
TimerGauge	getChangelogBusyTimeMsPerSecond()
TimerGauge	getHardBackPressuredTimePerSecond()
TimerGauge	getIdleTimeMsPerSecond()
org.apache.flink.metrics.Histogram	getMailboxLatency()
org.apache.flink.metrics.Gauge<Integer>	getMailboxSize()
org.apache.flink.metrics.Meter	getMailboxThroughput()
org.apache.flink.metrics.Counter	getNumBuffersOutCounter()
org.apache.flink.metrics.Counter	getNumBytesInCounter()
org.apache.flink.metrics.Counter	getNumBytesOutCounter()
org.apache.flink.metrics.Counter	getNumFiredTimers()
org.apache.flink.metrics.Counter	getNumMailsProcessedCounter()
org.apache.flink.metrics.Counter	getNumRecordsInCounter()
org.apache.flink.metrics.Counter	getNumRecordsOutCounter()
TimerGauge	getSoftBackPressuredTimePerSecond()
long	getTaskInitializationDuration() Returns the duration of time required for a task's restoring/initialization, which reaches its maximum when the task begins running and remains constant throughout the task's running.
void	markTaskInitializationStarted()
void	markTaskStart()
void	registerBackPressureListener(TimerGauge.StartStopListener backPressureListener)
void	registerMailboxSizeSupplier(TaskIOMetricGroup.SizeSupplier<Integer> supplier)
void	registerResultPartitionBytesCounter(IntermediateResultPartitionID resultPartitionId, ResultPartitionBytesCounter resultPartitionBytesCounter)
void	reuseRecordsInputCounter(org.apache.flink.metrics.Counter numRecordsInCounter)
void	reuseRecordsOutputCounter(org.apache.flink.metrics.Counter numRecordsOutCounter)
void	setEnableBusyTime(boolean enabled)
void	unregisterBackPressureListener(TimerGauge.StartStopListener backPressureListener)

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, counter, counter, gauge, histogram, meter

Constructor Detail

TaskIOMetricGroup

public TaskIOMetricGroup(TaskMetricGroup parent)

TaskIOMetricGroup

public TaskIOMetricGroup(TaskMetricGroup parent,
                         org.apache.flink.util.clock.Clock clock)

Method Detail

createSnapshot

public IOMetrics createSnapshot()

getNumBytesInCounter

public org.apache.flink.metrics.Counter getNumBytesInCounter()

getNumBytesOutCounter

public org.apache.flink.metrics.Counter getNumBytesOutCounter()

getNumRecordsInCounter

public org.apache.flink.metrics.Counter getNumRecordsInCounter()

getNumRecordsOutCounter

public org.apache.flink.metrics.Counter getNumRecordsOutCounter()

getNumBuffersOutCounter

public org.apache.flink.metrics.Counter getNumBuffersOutCounter()

getNumFiredTimers

public org.apache.flink.metrics.Counter getNumFiredTimers()

getNumMailsProcessedCounter

public org.apache.flink.metrics.Counter getNumMailsProcessedCounter()

getIdleTimeMsPerSecond

public TimerGauge getIdleTimeMsPerSecond()

getSoftBackPressuredTimePerSecond

public TimerGauge getSoftBackPressuredTimePerSecond()

getHardBackPressuredTimePerSecond

public TimerGauge getHardBackPressuredTimePerSecond()

getChangelogBusyTimeMsPerSecond

public TimerGauge getChangelogBusyTimeMsPerSecond()

getBackPressuredTimeMsPerSecond

public long getBackPressuredTimeMsPerSecond()

getAccumulatedBackPressuredTimeMs

public long getAccumulatedBackPressuredTimeMs()

markTaskStart

public void markTaskStart()

markTaskInitializationStarted

public void markTaskInitializationStarted()

getTaskInitializationDuration

@VisibleForTesting
public long getTaskInitializationDuration()

Returns the duration of time required for a task's restoring/initialization, which reaches its maximum when the task begins running and remains constant throughout the task's running. Return 0 when the task is not in initialization/running status.

setEnableBusyTime

public void setEnableBusyTime(boolean enabled)

getMailboxThroughput

public org.apache.flink.metrics.Meter getMailboxThroughput()

getMailboxLatency

public org.apache.flink.metrics.Histogram getMailboxLatency()

getMailboxSize

public org.apache.flink.metrics.Gauge<Integer> getMailboxSize()

registerBackPressureListener

public void registerBackPressureListener(TimerGauge.StartStopListener backPressureListener)

unregisterBackPressureListener

public void unregisterBackPressureListener(TimerGauge.StartStopListener backPressureListener)

reuseRecordsInputCounter

public void reuseRecordsInputCounter(org.apache.flink.metrics.Counter numRecordsInCounter)

reuseRecordsOutputCounter

public void reuseRecordsOutputCounter(org.apache.flink.metrics.Counter numRecordsOutCounter)

registerResultPartitionBytesCounter

public void registerResultPartitionBytesCounter(IntermediateResultPartitionID resultPartitionId,
                                                ResultPartitionBytesCounter resultPartitionBytesCounter)

registerMailboxSizeSupplier

public void registerMailboxSizeSupplier(TaskIOMetricGroup.SizeSupplier<Integer> supplier)