Package org.apache.beam.fn.harness.control

Class ExecutionStateSampler.ExecutionStateTracker

java.lang.Object

org.apache.beam.fn.harness.control.ExecutionStateSampler.ExecutionStateTracker

All Implemented Interfaces:

BundleProgressReporter

Enclosing class:

ExecutionStateSampler

public class ExecutionStateSampler.ExecutionStateTracker
extends java.lang.Object
implements BundleProgressReporter

Tracks the current state of a single execution thread.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.beam.fn.harness.control.BundleProgressReporter

BundleProgressReporter.InMemory, BundleProgressReporter.Registrar

Method Summary

Modifier and Type	Method	Description
ExecutionStateSampler.ExecutionState	create(java.lang.String shortId, java.lang.String ptransformId, java.lang.String ptransformUniqueName, java.lang.String stateName)	Returns an ExecutionStateSampler.ExecutionState bound to this tracker for the specified transform and processing state.
@Nullable java.lang.String	getCurrentThreadsPTransformId()	Returns the ptransform id of the currently executing thread.
org.apache.beam.sdk.metrics.MetricsContainer	getMetricsContainer()	Returns a MetricsContainer that delegates based upon the current execution state to the appropriate metrics container that is bound to the current ExecutionStateSampler.ExecutionState or to the unbound MetricsContainer if no execution state is currently running.
org.apache.beam.runners.core.metrics.MetricsContainerStepMap	getMetricsContainerRegistry()	Returns the MetricsContainerStepMap that is managed by this ExecutionStateSampler.ExecutionStateTracker.
@Nullable ExecutionStateSampler.ExecutionStateTrackerStatus	getStatus()	Returns status information related to this tracker or null if not tracking a bundle.
void	reset()	Stops tracking execution states allowing for the ExecutionStateSampler.ExecutionStateTracker to be re-used for another bundle.
void	start(java.lang.String processBundleId)	Starts tracking execution states for specified processBundleId.
void	updateFinalMonitoringData(java.util.Map<java.lang.String,org.apache.beam.vendor.grpc.v1p69p0.com.google.protobuf.ByteString> monitoringData)	Update the monitoring data for a bundle that has finished processing.
void	updateIntermediateMonitoringData(java.util.Map<java.lang.String,org.apache.beam.vendor.grpc.v1p69p0.com.google.protobuf.ByteString> monitoringData)	Update the monitoring data for a bundle that is currently being processed.

Methods inherited from class java.lang.Object

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

Method Detail

getMetricsContainerRegistry

public org.apache.beam.runners.core.metrics.MetricsContainerStepMap getMetricsContainerRegistry()

Returns the MetricsContainerStepMap that is managed by this ExecutionStateSampler.ExecutionStateTracker. This metrics container registry stores all the user counters associated for the current bundle execution.

getMetricsContainer

public org.apache.beam.sdk.metrics.MetricsContainer getMetricsContainer()

Returns a MetricsContainer that delegates based upon the current execution state to the appropriate metrics container that is bound to the current ExecutionStateSampler.ExecutionState or to the unbound MetricsContainer if no execution state is currently running.

create

public ExecutionStateSampler.ExecutionState create(java.lang.String shortId,
                                                   java.lang.String ptransformId,
                                                   java.lang.String ptransformUniqueName,
                                                   java.lang.String stateName)

Returns an ExecutionStateSampler.ExecutionState bound to this tracker for the specified transform and processing state.

getStatus

public @Nullable ExecutionStateSampler.ExecutionStateTrackerStatus getStatus()

Returns status information related to this tracker or null if not tracking a bundle.

getCurrentThreadsPTransformId

public @Nullable java.lang.String getCurrentThreadsPTransformId()

Returns the ptransform id of the currently executing thread.

start

public void start(java.lang.String processBundleId)

Starts tracking execution states for specified processBundleId.

Only invoked by the bundle processing thread.

updateIntermediateMonitoringData

public void updateIntermediateMonitoringData(java.util.Map<java.lang.String,org.apache.beam.vendor.grpc.v1p69p0.com.google.protobuf.ByteString> monitoringData)

Description copied from interface: BundleProgressReporter

Update the monitoring data for a bundle that is currently being processed.

Must be invoked while holding the ProcessBundleHandler.BundleProcessor.getProgressRequestLock().

Specified by:

updateIntermediateMonitoringData in interface BundleProgressReporter

updateFinalMonitoringData

public void updateFinalMonitoringData(java.util.Map<java.lang.String,org.apache.beam.vendor.grpc.v1p69p0.com.google.protobuf.ByteString> monitoringData)

Description copied from interface: BundleProgressReporter

Update the monitoring data for a bundle that has finished processing.

Must be invoked from the main bundle processing thread and while holding the ProcessBundleHandler.BundleProcessor.getProgressRequestLock().

Specified by:

updateFinalMonitoringData in interface BundleProgressReporter

reset

public void reset()

Stops tracking execution states allowing for the ExecutionStateSampler.ExecutionStateTracker to be re-used for another bundle.

Specified by:

reset in interface BundleProgressReporter