org.apache.flink.runtime.protocols

Interface ExtendedManagementProtocol

All Superinterfaces:

JobManagementProtocol, VersionedProtocol

All Known Implementing Classes:

JobManager

public interface ExtendedManagementProtocol
extends JobManagementProtocol

This protocol provides extended management capabilities beyond the simple JobManagementProtocol. It can be used to retrieve internal scheduling information, the network topology, or profiling information about thread or instance utilization.

Method Summary

Methods

Modifier and Type	Method and Description
int	getAvailableSlots() Returns the number of available slots among the registered task managers
List<AbstractEvent>	getEvents(JobID jobID) Retrieves the collected events for the job with the given job ID.
ManagementGraph	getManagementGraph(JobID jobID) Retrieves the management graph for the job with the given ID.
NetworkTopology	getNetworkTopology(JobID jobID) Retrieves the current network topology for the job with the given ID.
List<RecentJobEvent>	getRecentJobs() Retrieves a list of jobs which have either running or have been started recently.
void	killInstance(StringRecord instanceName) Kills the instance with the given name (i.e.
void	killTask(JobID jobID, ManagementVertexID id) Kills the task with the given vertex ID.
void	logBufferUtilization(JobID jobID) Triggers all task managers involved in processing the job with the given job ID to write the utilization of their read and write buffers to their log files.

Methods inherited from interface org.apache.flink.runtime.protocols.JobManagementProtocol

cancelJob, getJobProgress, getRecommendedPollingInterval, submitJob

Method Detail

getManagementGraph

ManagementGraph getManagementGraph(JobID jobID)
                                   throws IOException

Retrieves the management graph for the job with the given ID.

Parameters:

jobID - the ID identifying the job

Returns:

the management graph for the job

Throws:

IOException - thrown if an error occurs while retrieving the management graph

getNetworkTopology

NetworkTopology getNetworkTopology(JobID jobID)
                                   throws IOException

Retrieves the current network topology for the job with the given ID.

Parameters:

jobID - the ID identifying the job

Returns:

the network topology for the job

Throws:

IOException - thrown if an error occurs while retrieving the network topology

getRecentJobs

List<RecentJobEvent> getRecentJobs()
                                   throws IOException

Retrieves a list of jobs which have either running or have been started recently.

Returns:

a (possibly) empty list of recent jobs

Throws:

IOException - thrown if an error occurs while retrieving the job list

getEvents

List<AbstractEvent> getEvents(JobID jobID)
                              throws IOException

Retrieves the collected events for the job with the given job ID.

Parameters:

jobID - the ID of the job to retrieve the events for

Returns:

a (possibly empty) list of events which occurred for that event and which are not older than the query interval

Throws:

IOException - thrown if an error occurs while retrieving the list of events

killTask

void killTask(JobID jobID,
            ManagementVertexID id)
              throws IOException

Kills the task with the given vertex ID.

Parameters:

jobID - the ID of the job the vertex to be killed belongs to

id - the vertex ID which identified the task be killed

Throws:

IOException - thrown if an error occurs while transmitting the kill request

killInstance

void killInstance(StringRecord instanceName)
                  throws IOException

Kills the instance with the given name (i.e. shuts down its task manager).

Parameters:

instanceName - the name of the instance to be killed

Throws:

IOException - thrown if an error occurs while transmitting the kill request

logBufferUtilization

void logBufferUtilization(JobID jobID)
                          throws IOException

Triggers all task managers involved in processing the job with the given job ID to write the utilization of their read and write buffers to their log files. This method is primarily for debugging purposes.

Parameters:

jobID - the ID of the job to print the buffer distribution for

Throws:

IOException - throws if an error occurs while transmitting the request

getAvailableSlots

int getAvailableSlots()
                      throws IOException

Returns the number of available slots among the registered task managers

Returns:

number of available slots

Throws:

IOException