org.apache.flink.runtime.scheduler.metrics

Class DeploymentStateTimeMetrics

java.lang.Object

org.apache.flink.runtime.scheduler.metrics.DeploymentStateTimeMetrics

All Implemented Interfaces:

ExecutionStateUpdateListener, MetricsRegistrar, StateTimeMetric

public class DeploymentStateTimeMetrics
extends Object
implements ExecutionStateUpdateListener, StateTimeMetric, MetricsRegistrar

Metrics that capture how long a job was deploying tasks.

These metrics differentiate between batch & streaming use-cases:

Batch: Measures from the start of the first deployment until the first task has been deployed. From that point the job is making progress.

Streaming: Measures from the start of the first deployment until all tasks have been deployed. From that point on checkpoints can be triggered, and thus progress be made.

Constructor Summary

Constructors

Constructor and Description
DeploymentStateTimeMetrics(JobType semantic, org.apache.flink.configuration.MetricOptions.JobStatusMetricsSettings stateTimeMetricsSettings)

Method Summary

Modifier and Type	Method and Description
long	getBinary() Returns 1 if we are in the targeted state, otherwise 0.
long	getCurrentTime() Returns the time, in milliseconds, that have elapsed since we transitioned to the targeted state.
long	getTotalTime() Returns the total time, in milliseconds, that we have spent in the targeted state.
void	onStateUpdate(ExecutionAttemptID execution, ExecutionState previousState, ExecutionState newState)
void	registerMetrics(org.apache.flink.metrics.MetricGroup metricGroup)

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.runtime.scheduler.metrics.StateTimeMetric

getCurrentTimeMetricName, getStateMetricName, getTotalTimeMetricName, register

Constructor Detail

DeploymentStateTimeMetrics

public DeploymentStateTimeMetrics(JobType semantic,
                                  org.apache.flink.configuration.MetricOptions.JobStatusMetricsSettings stateTimeMetricsSettings)

Method Detail

getCurrentTime

public long getCurrentTime()

Description copied from interface: StateTimeMetric

Returns the time, in milliseconds, that have elapsed since we transitioned to the targeted state. Returns 0 if we are not in the targeted state.

Specified by:

getCurrentTime in interface StateTimeMetric

getTotalTime

public long getTotalTime()

Description copied from interface: StateTimeMetric

Returns the total time, in milliseconds, that we have spent in the targeted state.

Specified by:

getTotalTime in interface StateTimeMetric

getBinary

public long getBinary()

Description copied from interface: StateTimeMetric

Returns 1 if we are in the targeted state, otherwise 0.

Specified by:

getBinary in interface StateTimeMetric

registerMetrics

public void registerMetrics(org.apache.flink.metrics.MetricGroup metricGroup)

Specified by:

registerMetrics in interface MetricsRegistrar

onStateUpdate

public void onStateUpdate(ExecutionAttemptID execution,
                          ExecutionState previousState,
                          ExecutionState newState)

Specified by:

onStateUpdate in interface ExecutionStateUpdateListener