org.apache.tez.dag.api

Class VertexManagerPlugin

java.lang.Object

org.apache.tez.dag.api.VertexManagerPlugin

@InterfaceStability.Unstable
@InterfaceAudience.Public
public abstract class VertexManagerPlugin
extends Object

Interface to plugin user logic into the VertexManager to implement runtime scheduling optimizations and graph reconfiguration. The plugin will be notified of interesting events in the vertex execution life cycle and can respond to them by via the context object

Constructor Summary

Constructors

Constructor and Description
VertexManagerPlugin(VertexManagerPluginContext context) Crete an instance of the VertexManagerPlugin.

Method Summary

Methods

Modifier and Type	Method and Description
VertexManagerPluginContext	getContext() Return ahe VertexManagerPluginContext for this specific instance of the vertex manager.
abstract void	initialize() Initialize the plugin.
abstract void	onRootVertexInitialized(String inputName, InputDescriptor inputDescriptor, List<Event> events) Notification that the inputs of this vertex have initialized
abstract void	onSourceTaskCompleted(String srcVertexName, Integer taskId) Notification of a source vertex completion.
abstract void	onVertexManagerEventReceived(VertexManagerEvent vmEvent) Notification of an event directly sent to this vertex manager
abstract void	onVertexStarted(Map<String,List<Integer>> completions) Notification that the vertex is ready to start running tasks
void	onVertexStateUpdated(VertexStateUpdate stateUpdate) Receive notifications on vertex state changes.

Methods inherited from class java.lang.Object

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

Constructor Detail

VertexManagerPlugin

public VertexManagerPlugin(VertexManagerPluginContext context)

Crete an instance of the VertexManagerPlugin. Classes extending this to create a VertexManagerPlugin, must provide the same constructor so that Tez can create an instance of the class at runtime.

Parameters:

context - vertex manager plugin context which can be used to access the payload, vertex properties, etc

Method Detail

initialize

public abstract void initialize()
                         throws Exception

Initialize the plugin. Called when the vertex is initializing. This happens after all source vertices and inputs have initialized

Throws:

Exception

onVertexStarted

public abstract void onVertexStarted(Map<String,List<Integer>> completions)
                              throws Exception

Notification that the vertex is ready to start running tasks

Parameters:

completions - Source vertices and all their tasks that have already completed

Throws:

Exception

onSourceTaskCompleted

public abstract void onSourceTaskCompleted(String srcVertexName,
                         Integer taskId)
                                    throws Exception

Notification of a source vertex completion.

Parameters:

srcVertexName -

taskId - Index of the task that completed

Throws:

Exception

onVertexManagerEventReceived

public abstract void onVertexManagerEventReceived(VertexManagerEvent vmEvent)
                                           throws Exception

Notification of an event directly sent to this vertex manager

Parameters:

vmEvent -

Throws:

Exception

onRootVertexInitialized

public abstract void onRootVertexInitialized(String inputName,
                           InputDescriptor inputDescriptor,
                           List<Event> events)
                                      throws Exception

Notification that the inputs of this vertex have initialized

Parameters:

inputName -

inputDescriptor -

events -

Throws:

Exception

getContext

public final VertexManagerPluginContext getContext()

Return ahe VertexManagerPluginContext for this specific instance of the vertex manager.

Returns:

the VertexManagerPluginContext for the input

onVertexStateUpdated

public void onVertexStateUpdated(VertexStateUpdate stateUpdate)
                          throws Exception

Receive notifications on vertex state changes.

State changes will be received based on the registration via VertexManagerPluginContext.registerForVertexStateUpdates(String, java.util.Set) . Notifications will be received for all registered state changes, and not just for the latest state update. They will be in order in which the state change occurred.

This method may be invoked concurrently with onVertexStarted(Map) etc. and multi-threading/concurrency implications must be considered.

Parameters:

stateUpdate - an event indicating the name of the vertex, and it's updated state. Additional information may be available for specific events, Look at the type hierarchy for VertexStateUpdate

Throws:

Exception