org.apache.tez.dag.api.client

Class DAGClient

java.lang.Object

org.apache.tez.dag.api.client.DAGClient

All Implemented Interfaces:

Closeable, AutoCloseable

@InterfaceAudience.Public
public abstract class DAGClient
extends Object
implements Closeable

Class for monitoring the DAG running in a Tez DAG Application Master.

Constructor Summary

Constructors

Constructor and Description
DAGClient()

Method Summary

Modifier and Type	Method and Description
abstract String	getDagIdentifierString() Get the dag identifier for the currently executing dag.
abstract DAGStatus	getDAGStatus(Set<StatusGetOpts> statusOptions) Get the status of the specified DAG
abstract DAGStatus	getDAGStatus(Set<StatusGetOpts> statusOptions, long timeout) Get the status of the specified DAG when it reaches a final state, or the timeout expires.
abstract String	getExecutionContext() Gets DAG execution context for use with logging
abstract String	getSessionIdentifierString() Get the session identifier for the session in which this dag is running
abstract VertexStatus	getVertexStatus(String vertexName, Set<StatusGetOpts> statusOptions) Get the status of a Vertex of a DAG
abstract String	getWebUIAddress() Returns the Tez AM's web ui address if any.
abstract void	tryKillDAG() Kill a running DAG
abstract DAGStatus	waitForCompletion() Wait forever for DAG to complete without printing any vertex statuses
DAGStatus	waitForCompletion(long timeMs) Wait for DAG to complete without printing any vertex statuses
abstract DAGStatus	waitForCompletionWithStatusUpdates(Set<StatusGetOpts> statusGetOpts) Wait for DAG to complete and periodically print *all* vertices' status.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.io.Closeable

close

Constructor Detail

DAGClient

public DAGClient()

Method Detail

getExecutionContext

public abstract String getExecutionContext()

Gets DAG execution context for use with logging

Returns:

summary of DAG execution

getDAGStatus

public abstract DAGStatus getDAGStatus(@Nullable
                                       Set<StatusGetOpts> statusOptions)
                                throws IOException,
                                       TezException

Get the status of the specified DAG

Parameters:

statusOptions - Optionally, retrieve additional information based on specified options. To retrieve basic information, this can be null

Throws:

IOException

TezException

getDAGStatus

public abstract DAGStatus getDAGStatus(@Nullable
                                       Set<StatusGetOpts> statusOptions,
                                       long timeout)
                                throws IOException,
                                       TezException

Get the status of the specified DAG when it reaches a final state, or the timeout expires.

Parameters:

statusOptions - Optionally, retrieve additional information based on specified options. To retrieve basic information, this can be null

timeout - RPC call timeout. Value -1 waits for infinite and returns when DAG reaches final state

Returns:

DAG Status

Throws:

IOException

TezException

getVertexStatus

public abstract VertexStatus getVertexStatus(String vertexName,
                                             Set<StatusGetOpts> statusOptions)
                                      throws IOException,
                                             TezException

Get the status of a Vertex of a DAG

Parameters:

statusOptions - Optionally, retrieve additional information based on specified options

Throws:

IOException

TezException

getDagIdentifierString

public abstract String getDagIdentifierString()

Get the dag identifier for the currently executing dag. This is a string which represents this dag

Returns:

the dag identifier

getSessionIdentifierString

public abstract String getSessionIdentifierString()

Get the session identifier for the session in which this dag is running

Returns:

the session identifier

tryKillDAG

public abstract void tryKillDAG()
                         throws IOException,
                                TezException

Kill a running DAG

Throws:

IOException

TezException

waitForCompletion

public abstract DAGStatus waitForCompletion()
                                     throws IOException,
                                            TezException,
                                            InterruptedException

Wait forever for DAG to complete without printing any vertex statuses

Returns:

Final DAG Status

Throws:

IOException

TezException

InterruptedException

waitForCompletion

public DAGStatus waitForCompletion(long timeMs)
                            throws IOException,
                                   TezException,
                                   InterruptedException

Wait for DAG to complete without printing any vertex statuses

Parameters:

timeMs - Maximum wait duration

Returns:

Final DAG Status, or null on timeout or if DAG is no longer running

Throws:

IOException

TezException

InterruptedException

waitForCompletionWithStatusUpdates

public abstract DAGStatus waitForCompletionWithStatusUpdates(@Nullable
                                                             Set<StatusGetOpts> statusGetOpts)
                                                      throws IOException,
                                                             TezException,
                                                             InterruptedException

Wait for DAG to complete and periodically print *all* vertices' status.

Parameters:

statusGetOpts - : status get options. For example, to get counter pass EnumSet.of(StatusGetOpts.GET_COUNTERS)

Returns:

Final DAG Status

Throws:

IOException

TezException

InterruptedException

getWebUIAddress

public abstract String getWebUIAddress()
                                throws IOException,
                                       TezException

Returns the Tez AM's web ui address if any.

Returns:

The http web UI address

Throws:

IOException

TezException