org.apache.flink.runtime.checkpoint

Class TaskStateStats

java.lang.Object

org.apache.flink.runtime.checkpoint.TaskStateStats

All Implemented Interfaces:

Serializable

public class TaskStateStats
extends Object
implements Serializable

Statistics for a single task/operator that gathers all statistics of its subtasks and provides summary statistics about all subtasks.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TaskStateStats.TaskStateStatsSummary Summary of the subtask stats of a single task/operator.

Method Summary

Modifier and Type	Method and Description
long	getAlignmentBuffered() Returns the total buffered bytes during alignment over all subtasks.
long	getEndToEndDuration(long triggerTimestamp) Returns the duration of this checkpoint at the task/operator calculated as the time since triggering until the latest acknowledged subtask or -1 if no subtask was acknowledged yet.
JobVertexID	getJobVertexId() Returns the ID of the operator the statistics belong to.
SubtaskStateStats	getLatestAcknowledgedSubtaskStats() Returns the latest acknowledged subtask stats or null if none was acknowledged yet.
long	getLatestAckTimestamp() Returns the ack timestamp of the latest acknowledged subtask or -1 if none was acknowledged yet.
int	getNumberOfAcknowledgedSubtasks() Returns the number of acknowledged subtasks.
int	getNumberOfSubtasks() Returns the number of subtasks.
long	getStateSize() Returns the total checkpoint state size over all subtasks.
SubtaskStateStats[]	getSubtaskStats() Returns the stats for all subtasks.
TaskStateStats.TaskStateStatsSummary	getSummaryStats() Returns the summary of the subtask stats.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getJobVertexId

public JobVertexID getJobVertexId()

Returns the ID of the operator the statistics belong to.

Returns:

ID of the operator the statistics belong to.

getNumberOfSubtasks

public int getNumberOfSubtasks()

Returns the number of subtasks.

Returns:

Number of subtasks.

getNumberOfAcknowledgedSubtasks

public int getNumberOfAcknowledgedSubtasks()

Returns the number of acknowledged subtasks.

Returns:

Number of acknowledged subtasks.

getLatestAcknowledgedSubtaskStats

@Nullable
public SubtaskStateStats getLatestAcknowledgedSubtaskStats()

Returns the latest acknowledged subtask stats or null if none was acknowledged yet.

Returns:

The latest acknowledged subtask stats.

getLatestAckTimestamp

public long getLatestAckTimestamp()

Returns the ack timestamp of the latest acknowledged subtask or -1 if none was acknowledged yet.

Returns:

Ack timestamp of the latest acknowledged subtask or -1.

getStateSize

public long getStateSize()

Returns the total checkpoint state size over all subtasks.

Returns:

Total checkpoint state size over all subtasks.

getAlignmentBuffered

public long getAlignmentBuffered()

Returns the total buffered bytes during alignment over all subtasks.

Can return -1 if the runtime did not report this.

Returns:

Total buffered bytes during alignment over all subtasks.

getEndToEndDuration

public long getEndToEndDuration(long triggerTimestamp)

Returns the duration of this checkpoint at the task/operator calculated as the time since triggering until the latest acknowledged subtask or -1 if no subtask was acknowledged yet.

Returns:

Duration of this checkpoint at the task/operator or -1 if no subtask was acknowledged yet.

getSubtaskStats

public SubtaskStateStats[] getSubtaskStats()

Returns the stats for all subtasks.

Elements of the returned array are null if no stats are available yet for the respective subtask.

Note: The returned array must not be modified.

Returns:

Array of subtask stats (elements are null if no stats available yet).

getSummaryStats

public TaskStateStats.TaskStateStatsSummary getSummaryStats()

Returns the summary of the subtask stats.

Returns:

Summary of the subtask stats.