org.apache.flink.runtime.rest.handler.util

Class MutableIOMetrics

java.lang.Object

org.apache.flink.runtime.executiongraph.IOMetrics

org.apache.flink.runtime.rest.handler.util.MutableIOMetrics

All Implemented Interfaces:

Serializable

public class MutableIOMetrics
extends IOMetrics

This class is a mutable version of the IOMetrics class that allows adding up IO-related metrics.

For finished jobs these metrics are stored in the ExecutionGraph as another IOMetrics. For running jobs these metrics are retrieved using the MetricFetcher.

This class provides a common interface to handle both cases, reducing complexity in various handlers (like the JobVertexDetailsHandler).

See Also:

Serialized Form

Field Summary

Fields inherited from class org.apache.flink.runtime.executiongraph.IOMetrics

numBytesInLocal, numBytesInLocalPerSecond, numBytesInRemote, numBytesInRemotePerSecond, numBytesOut, numBytesOutPerSecond, numRecordsIn, numRecordsInPerSecond, numRecordsOut, numRecordsOutPerSecond

Constructor Summary

Constructors

Constructor and Description
MutableIOMetrics()

Method Summary

Modifier and Type	Method and Description
void	addIOMetrics(AccessExecution attempt, MetricFetcher fetcher, String jobID, String taskID) Adds the IO metrics for the given attempt to this object.
boolean	isNumBytesInLocalComplete()
boolean	isNumBytesInRemoteComplete()
boolean	isNumBytesOutComplete()
boolean	isNumRecordsInComplete()
boolean	isNumRecordsOutComplete()
void	writeIOMetricsAsJson(org.apache.flink.shaded.jackson2.com.fasterxml.jackson.core.JsonGenerator gen) Writes the IO metrics contained in this object to the given JsonGenerator.

Methods inherited from class org.apache.flink.runtime.executiongraph.IOMetrics

getNumBytesInLocal, getNumBytesInLocalPerSecond, getNumBytesInRemote, getNumBytesInRemotePerSecond, getNumBytesInTotal, getNumBytesOut, getNumBytesOutPerSecond, getNumRecordsIn, getNumRecordsInPerSecond, getNumRecordsOut, getNumRecordsOutPerSecond

Methods inherited from class java.lang.Object

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

Constructor Detail

MutableIOMetrics

public MutableIOMetrics()

Method Detail

isNumBytesInLocalComplete

public boolean isNumBytesInLocalComplete()

isNumBytesInRemoteComplete

public boolean isNumBytesInRemoteComplete()

isNumBytesOutComplete

public boolean isNumBytesOutComplete()

isNumRecordsInComplete

public boolean isNumRecordsInComplete()

isNumRecordsOutComplete

public boolean isNumRecordsOutComplete()

addIOMetrics

public void addIOMetrics(AccessExecution attempt,
                         @Nullable
                         MetricFetcher fetcher,
                         String jobID,
                         String taskID)

Adds the IO metrics for the given attempt to this object. If the AccessExecution is in a terminal state the contained IOMetrics object is added. Otherwise the given MetricFetcher is used to retrieve the required metrics.

Parameters:

attempt - Attempt whose IO metrics should be added

fetcher - MetricFetcher to retrieve metrics for running jobs

jobID - JobID to which the attempt belongs

taskID - TaskID to which the attempt belongs

writeIOMetricsAsJson

public void writeIOMetricsAsJson(org.apache.flink.shaded.jackson2.com.fasterxml.jackson.core.JsonGenerator gen)
                          throws IOException

Writes the IO metrics contained in this object to the given JsonGenerator.

The JSON structure written is as follows: "metrics": { "read-bytes": 1, "read-bytes-complete": true, "write-bytes": 2, "write-bytes-complete": true, "read-records": 3, "read-records-complete": true, "write-records": 4, "write-records-complete": true }

Parameters:

gen - JsonGenerator to which the metrics should be written

Throws:

IOException