org.apache.flink.runtime.profiling

Interface JobManagerProfiler

All Known Implementing Classes:

JobManagerProfilerImpl

public interface JobManagerProfiler

This interface must be implemented by profiling components for the job manager.

Method Summary

Methods

Modifier and Type	Method and Description
void	registerForProfilingData(JobID jobID, ProfilingListener profilingListener) Registers the given ProfilingListener object to receive profiling data for the job with the given job ID.
void	registerProfilingJob(ExecutionGraph executionGraph) Registers the given ExecutionGraph for profiling.
void	shutdown() Shuts done the job manager's profiling component and stops all its internal processes.
void	unregisterFromProfilingData(JobID jobID, ProfilingListener profilingListener) Unregisters the given ProfilingListener object from receiving profiling data issued by the job manager's profiling component.
void	unregisterProfilingJob(ExecutionGraph executionGraph) Unregisters the given ExecutionGraph from profiling.

Method Detail

registerProfilingJob

void registerProfilingJob(ExecutionGraph executionGraph)

Registers the given ExecutionGraph for profiling.

Parameters:

executionGraph - the ExecutionGraph to register for profiling

unregisterProfilingJob

void unregisterProfilingJob(ExecutionGraph executionGraph)

Unregisters the given ExecutionGraph from profiling. Calling this method will also unregister all of the job's registered listeners.

Parameters:

executionGraph - the ExecutionGraph to unregister.

registerForProfilingData

void registerForProfilingData(JobID jobID,
                            ProfilingListener profilingListener)

Registers the given ProfilingListener object to receive profiling data for the job with the given job ID.

Parameters:

jobID - the ID of the job to receive profiling data for

profilingListener - the ProfilingListener object to register

unregisterFromProfilingData

void unregisterFromProfilingData(JobID jobID,
                               ProfilingListener profilingListener)

Unregisters the given ProfilingListener object from receiving profiling data issued by the job manager's profiling component.

Parameters:

jobID - the ID of the job the ProfilingListener object has originally been registered for

profilingListener - the ProfilingListener object to unregister

shutdown

void shutdown()

Shuts done the job manager's profiling component and stops all its internal processes.