org.apache.spark

Class SparkStatusTracker

Object

org.apache.spark.SparkStatusTracker

public class SparkStatusTracker
extends Object

Low-level status reporting APIs for monitoring job and stage progress.

These APIs intentionally provide very weak consistency semantics; consumers of these APIs should be prepared to handle empty / missing information. For example, a job's stage ids may be known but the status API may not have any information about the details of those stages, so getStageInfo could potentially return None for a valid stage id.

To limit memory usage, these APIs only provide information on recent jobs / stages. These APIs will provide information for the last spark.ui.retainedStages stages and spark.ui.retainedJobs jobs.

NOTE: this class's constructor should be considered private and may be subject to change.

Method Summary

Modifier and Type	Method and Description
int[]	getActiveJobIds() Returns an array containing the ids of all active jobs.
int[]	getActiveStageIds() Returns an array containing the ids of all active stages.
SparkExecutorInfo[]	getExecutorInfos() Returns information of all known executors, including host, port, cacheSize, numRunningTasks and memory metrics.
int[]	getJobIdsForGroup(String jobGroup) Return a list of all known jobs in a particular job group.
int[]	getJobIdsForTag(String jobTag) Return a list of all known jobs with a particular tag.
scala.Option<SparkJobInfo>	getJobInfo(int jobId) Returns job information, or None if the job info could not be found or was garbage collected.
scala.Option<SparkStageInfo>	getStageInfo(int stageId) Returns stage information, or None if the stage info could not be found or was garbage collected.

Methods inherited from class Object

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

Method Detail

getActiveJobIds

public int[] getActiveJobIds()

Returns an array containing the ids of all active jobs.

This method does not guarantee the order of the elements in its result.

Returns:

(undocumented)

getActiveStageIds

public int[] getActiveStageIds()

Returns an array containing the ids of all active stages.

This method does not guarantee the order of the elements in its result.

Returns:

(undocumented)

getExecutorInfos

public SparkExecutorInfo[] getExecutorInfos()

Returns information of all known executors, including host, port, cacheSize, numRunningTasks and memory metrics. Note this include information for both the driver and executors.

Returns:

(undocumented)

getJobIdsForGroup

public int[] getJobIdsForGroup(String jobGroup)

Return a list of all known jobs in a particular job group. If jobGroup is null, then returns all known jobs that are not associated with a job group.

The returned list may contain running, failed, and completed jobs, and may vary across invocations of this method. This method does not guarantee the order of the elements in its result.

Parameters:

jobGroup - (undocumented)

Returns:

(undocumented)

getJobIdsForTag

public int[] getJobIdsForTag(String jobTag)

Return a list of all known jobs with a particular tag.

The returned list may contain running, failed, and completed jobs, and may vary across invocations of this method. This method does not guarantee the order of the elements in its result.

Parameters:

jobTag - (undocumented)

Returns:

(undocumented)

getJobInfo

public scala.Option<SparkJobInfo> getJobInfo(int jobId)

Returns job information, or None if the job info could not be found or was garbage collected.

Parameters:

jobId - (undocumented)

Returns:

(undocumented)

getStageInfo

public scala.Option<SparkStageInfo> getStageInfo(int stageId)

Returns stage information, or None if the stage info could not be found or was garbage collected.

Parameters:

stageId - (undocumented)

Returns:

(undocumented)