org.apache.tez.dag.api.client

Class DAGClientTimelineImpl

java.lang.Object

org.apache.tez.dag.api.client.DAGClientInternal

org.apache.tez.dag.api.client.DAGClientTimelineImpl

All Implemented Interfaces:

Closeable, AutoCloseable

@InterfaceAudience.Private
public class DAGClientTimelineImpl
extends DAGClientInternal

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	DAGClientTimelineImpl.VertexTaskStats

Field Summary

Fields

Modifier and Type	Field and Description
protected String	baseUri

Constructor Summary

Constructors

Constructor and Description
DAGClientTimelineImpl(org.apache.hadoop.yarn.api.records.ApplicationId appId, String dagId, TezConfiguration conf, FrameworkClient frameworkClient, int connTimeout)

Method Summary

Modifier and Type	Method and Description
void	close()
protected org.apache.hadoop.yarn.api.records.ApplicationReport	getApplicationReportInternal()
protected com.sun.jersey.api.client.Client	getCachedHttpClient()
String	getDagIdentifierString() Get the dag identifier for the currently executing dag.
DAGStatus	getDAGStatus(Set<StatusGetOpts> statusOptions) Get the status of the specified DAG
DAGStatus	getDAGStatus(Set<StatusGetOpts> statusOptions, long timeout) Get the status of the specified DAG when it reaches a final state, or the timeout expires.
String	getExecutionContext() Gets DAG execution context for use with logging
protected org.codehaus.jettison.json.JSONObject	getJsonRootEntity(String url)
String	getSessionIdentifierString() Get the session identifier for the session in which this dag is running
VertexStatus	getVertexStatus(String vertexName, Set<StatusGetOpts> statusOptions) Get the status of a Vertex of a DAG
String	getWebUIAddress()
static boolean	isSupported()
protected Map<String,DAGClientTimelineImpl.VertexTaskStats>	parseTaskStatsForVertexes()
void	tryKillDAG() Kill a running DAG
DAGStatus	waitForCompletion() Wait for DAG to complete without printing any vertex statuses
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

Field Detail

baseUri

protected String baseUri

Constructor Detail

DAGClientTimelineImpl

public DAGClientTimelineImpl(org.apache.hadoop.yarn.api.records.ApplicationId appId,
                             String dagId,
                             TezConfiguration conf,
                             FrameworkClient frameworkClient,
                             int connTimeout)
                      throws TezException

Throws:

TezException

Method Detail

isSupported

public static boolean isSupported()

getExecutionContext

public String getExecutionContext()

Description copied from class: DAGClientInternal

Gets DAG execution context for use with logging

Specified by:

getExecutionContext in class DAGClientInternal

Returns:

summary of DAG execution

getApplicationReportInternal

protected org.apache.hadoop.yarn.api.records.ApplicationReport getApplicationReportInternal()

Specified by:

getApplicationReportInternal in class DAGClientInternal

getDAGStatus

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

Description copied from class: DAGClientInternal

Get the status of the specified DAG

Specified by:

getDAGStatus in class DAGClientInternal

Parameters:

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

Throws:

IOException

TezException

getVertexStatus

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

Description copied from class: DAGClientInternal

Get the status of a Vertex of a DAG

Specified by:

getVertexStatus in class DAGClientInternal

statusOptions - Optionally, retrieve additional information based on specified options

Throws:

IOException

TezException

getDagIdentifierString

public String getDagIdentifierString()

Description copied from class: DAGClientInternal

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

Specified by:

getDagIdentifierString in class DAGClientInternal

Returns:

the dag identifier

getSessionIdentifierString

public String getSessionIdentifierString()

Description copied from class: DAGClientInternal

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

Specified by:

getSessionIdentifierString in class DAGClientInternal

Returns:

the session identifier

tryKillDAG

public void tryKillDAG()
                throws IOException,
                       TezException

Description copied from class: DAGClientInternal

Kill a running DAG

Specified by:

tryKillDAG in class DAGClientInternal

Throws:

IOException

TezException

waitForCompletion

public DAGStatus waitForCompletion()
                            throws IOException,
                                   TezException,
                                   InterruptedException

Description copied from class: DAGClientInternal

Wait for DAG to complete without printing any vertex statuses

Specified by:

waitForCompletion in class DAGClientInternal

Returns:

Final DAG Status

Throws:

IOException

TezException

InterruptedException

waitForCompletionWithStatusUpdates

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

Description copied from class: DAGClientInternal

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

Specified by:

waitForCompletionWithStatusUpdates in class DAGClientInternal

Parameters:

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

Returns:

Final DAG Status

Throws:

IOException

TezException

InterruptedException

close

public void close()
           throws IOException

Throws:

IOException

parseTaskStatsForVertexes

protected Map<String,DAGClientTimelineImpl.VertexTaskStats> parseTaskStatsForVertexes()
                                                                               throws TezException,
                                                                                      org.codehaus.jettison.json.JSONException

Throws:

TezException

org.codehaus.jettison.json.JSONException

getJsonRootEntity

protected org.codehaus.jettison.json.JSONObject getJsonRootEntity(String url)
                                                           throws TezException

Throws:

TezException

getCachedHttpClient

protected com.sun.jersey.api.client.Client getCachedHttpClient()
                                                        throws IOException

Throws:

IOException

getDAGStatus

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

Description copied from class: DAGClientInternal

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

Specified by:

getDAGStatus in class DAGClientInternal

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

getWebUIAddress

public String getWebUIAddress()
                       throws IOException,
                              TezException

Specified by:

getWebUIAddress in class DAGClientInternal

Throws:

IOException

TezException