Package org.apache.hadoop.hbase.monitoring

Class TaskGroup

java.lang.Object

org.apache.hadoop.hbase.monitoring.MonitoredTaskImpl

org.apache.hadoop.hbase.monitoring.TaskGroup

All Implemented Interfaces:

Cloneable, MonitoredTask

@Private
public class TaskGroup
extends MonitoredTaskImpl

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	Description
private final MonitoredTask	delegate	Used to track this task group in TaskMonitor
private boolean	ignoreSubTasksInTaskMonitor	Whether to ignore to track(e.g.
private static final org.slf4j.Logger	LOG
private final ConcurrentLinkedDeque<MonitoredTask>	tasks	Sub-tasks in the group

Fields inherited from class org.apache.hadoop.hbase.monitoring.MonitoredTaskImpl

state

Constructor Summary

Constructors

Constructor	Description
TaskGroup(boolean ignoreSubTasksInTaskMonitor, String description)

Method Summary

Modifier and Type	Method	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.
Collection<MonitoredTask>	getTasks()
void	markComplete(String msg)

Methods inherited from class org.apache.hadoop.hbase.monitoring.MonitoredTaskImpl

clone, expireNow, getCompletionTimestamp, getDescription, getStartTime, getState, getStateTime, getStatus, getStatusJournal, getStatusTime, getWarnTime, pause, prettyPrintJournal, resume, setDescription, setState, setStatus, setWarnTime, toJSON, toMap, toString

Methods inherited from class java.lang.Object

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

Field Details

LOG

private static final org.slf4j.Logger LOG

tasks

private final ConcurrentLinkedDeque<MonitoredTask> tasks

Sub-tasks in the group

ignoreSubTasksInTaskMonitor

private boolean ignoreSubTasksInTaskMonitor

Whether to ignore to track(e.g. show/clear/expire) in the singleton TaskMonitor

delegate

private final MonitoredTask delegate

Used to track this task group in TaskMonitor

Constructor Details

TaskGroup

public TaskGroup(boolean ignoreSubTasksInTaskMonitor,
 String description)

Method Details

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

Overrides:

abort in class MonitoredTaskImpl

markComplete

public void markComplete(String msg)

Specified by:

markComplete in interface MonitoredTask

Overrides:

markComplete in class MonitoredTaskImpl

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

Overrides:

cleanup in class MonitoredTaskImpl