org.apache.flink.runtime.rest.handler.legacy.backpressure

Interface BackPressureStatsTracker

All Known Implementing Classes:

BackPressureStatsTrackerImpl, VoidBackPressureStatsTracker

public interface BackPressureStatsTracker

Interface for a tracker of back pressure statistics for ExecutionJobVertex.

Method Summary

Modifier and Type	Method and Description
void	cleanUpOperatorStatsCache() Cleans up the operator stats cache if it contains timed out entries.
Optional<OperatorBackPressureStats>	getOperatorBackPressureStats(ExecutionJobVertex vertex) Returns back pressure statistics for a operator.
void	shutDown() Shuts the BackPressureStatsTracker down.

Method Detail

getOperatorBackPressureStats

Optional<OperatorBackPressureStats> getOperatorBackPressureStats(ExecutionJobVertex vertex)

Returns back pressure statistics for a operator. Automatically triggers stack trace sampling if statistics are not available or outdated.

Parameters:

vertex - Operator to get the stats for.

Returns:

Back pressure statistics for an operator

cleanUpOperatorStatsCache

void cleanUpOperatorStatsCache()

Cleans up the operator stats cache if it contains timed out entries.

The Guava cache only evicts as maintenance during normal operations. If this handler is inactive, it will never be cleaned.

shutDown

void shutDown()
       throws FlinkException

Shuts the BackPressureStatsTracker down.

Throws:

FlinkException - if the BackPressureStatsTracker could not be shut down