org.apache.hadoop.hbase.monitoring

Class TaskGroup

java.lang.Object

org.apache.hadoop.hbase.monitoring.TaskGroup

All Implemented Interfaces:

Cloneable, MonitoredTask

@InterfaceAudience.Private
public class TaskGroup
extends Object

The TaskGroup can be seen as a big MonitoredTask, which contains a list of sub monitored tasks. The monitored tasks in the group are still be managed by the TaskMonitor, but whether to clear/expire the monitored tasks in a task group is optional. Since the monitored task already has journals, which mark the phases in a task, we still also need a task group to monitor a big task/process because the journals in a task is serial but the tasks in the task group can be parallel, then we have more flexible ability to monitor the process. Grouping the tasks is not strictly necessary but it is cleaner for presentation to operators. We might want to display the tasks in a group in a list view where each task can be collapsed (probably by default) or expanded.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.hadoop.hbase.monitoring.MonitoredTask

MonitoredTask.State, MonitoredTask.StatusJournalEntry

Field Summary

Fields

Modifier and Type	Field and Description
protected MonitoredTask.State	state

Constructor Summary

Constructors

Constructor and Description
TaskGroup(boolean ignoreSubTasksInTaskMonitor, String description)

Method Summary

Modifier and Type	Method and Description
void	abort(String msg)
MonitoredTask	addTask(String description)
MonitoredTask	addTask(String description, boolean withCompleteLast) Add a new task to the group, and before that might complete the last task in the group
void	cleanup() Explicitly mark this status as able to be cleaned up, even though it might not be complete.
org.apache.hadoop.hbase.monitoring.MonitoredTaskImpl	clone() Public exposure of Object.clone() in order to allow clients to easily capture current state.
void	expireNow() Force the completion timestamp backwards so that it expires now.
long	getCompletionTimestamp()
String	getDescription()
long	getStartTime()
MonitoredTask.State	getState()
long	getStateTime()
String	getStatus()
List<MonitoredTask.StatusJournalEntry>	getStatusJournal() Returns the status journal.
long	getStatusTime()
Collection<MonitoredTask>	getTasks()
long	getWarnTime()
void	markComplete(String msg)
void	pause(String msg)
String	prettyPrintJournal()
void	resume(String msg)
void	setDescription(String description)
protected void	setState(MonitoredTask.State state)
void	setStatus(String status)
void	setWarnTime(long t)
String	toJSON() Creates a JSON object for parseable exposure of monitored tasks.
Map<String,Object>	toMap() Creates a string map of internal details for extensible exposure of monitored tasks.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

state

protected volatile MonitoredTask.State state

Constructor Detail

TaskGroup

public TaskGroup(boolean ignoreSubTasksInTaskMonitor,
                 String description)

Method Detail

addTask

public MonitoredTask addTask(String description)

addTask

public MonitoredTask addTask(String description,
                             boolean withCompleteLast)

Add a new task to the group, and before that might complete the last task in the group

Parameters:

description - the description of the new task

withCompleteLast - whether to complete the last task in the group

Returns:

the added new task

getTasks

public Collection<MonitoredTask> getTasks()

abort

public void abort(String msg)

Specified by:

abort in interface MonitoredTask

markComplete

public void markComplete(String msg)

Specified by:

markComplete in interface MonitoredTask

cleanup

public void cleanup()

Description copied from interface: MonitoredTask

Explicitly mark this status as able to be cleaned up, even though it might not be complete.

Specified by:

cleanup in interface MonitoredTask

clone

public org.apache.hadoop.hbase.monitoring.MonitoredTaskImpl clone()

Description copied from interface: MonitoredTask

Public exposure of Object.clone() in order to allow clients to easily capture current state.

Specified by:

clone in interface MonitoredTask

Overrides:

clone in class Object

Returns:

a copy of the object whose references will not change

getStartTime

public long getStartTime()

Specified by:

getStartTime in interface MonitoredTask

getDescription

public String getDescription()

Specified by:

getDescription in interface MonitoredTask

getStatus

public String getStatus()

Specified by:

getStatus in interface MonitoredTask

getStatusTime

public long getStatusTime()

Specified by:

getStatusTime in interface MonitoredTask

getState

public MonitoredTask.State getState()

Specified by:

getState in interface MonitoredTask

getStateTime

public long getStateTime()

Specified by:

getStateTime in interface MonitoredTask

getWarnTime

public long getWarnTime()

Specified by:

getWarnTime in interface MonitoredTask

getCompletionTimestamp

public long getCompletionTimestamp()

Specified by:

getCompletionTimestamp in interface MonitoredTask

pause

public void pause(String msg)

Specified by:

pause in interface MonitoredTask

resume

public void resume(String msg)

Specified by:

resume in interface MonitoredTask

setStatus

public void setStatus(String status)

Specified by:

setStatus in interface MonitoredTask

setState

protected void setState(MonitoredTask.State state)

setDescription

public void setDescription(String description)

Specified by:

setDescription in interface MonitoredTask

setWarnTime

public void setWarnTime(long t)

Specified by:

setWarnTime in interface MonitoredTask

expireNow

public void expireNow()

Force the completion timestamp backwards so that it expires now.

Specified by:

expireNow in interface MonitoredTask

toMap

public Map<String,Object> toMap()

Description copied from interface: MonitoredTask

Creates a string map of internal details for extensible exposure of monitored tasks.

Specified by:

toMap in interface MonitoredTask

Returns:

A Map containing information for this task.

toJSON

public String toJSON()
              throws IOException

Description copied from interface: MonitoredTask

Creates a JSON object for parseable exposure of monitored tasks.

Specified by:

toJSON in interface MonitoredTask

Returns:

An encoded JSON object containing information for this task.

Throws:

IOException

toString

public String toString()

Overrides:

toString in class Object

getStatusJournal

public List<MonitoredTask.StatusJournalEntry> getStatusJournal()

Returns the status journal. This implementation of status journal is not thread-safe. Currently we use this to track various stages of flushes and compactions where we can use this/pretty print for post task analysis, by which time we are already done changing states (writing to journal)

Specified by:

getStatusJournal in interface MonitoredTask

prettyPrintJournal

public String prettyPrintJournal()

Specified by:

prettyPrintJournal in interface MonitoredTask