Package org.apache.hadoop.hbase.monitoring

Class TaskMonitor

java.lang.Object

org.apache.hadoop.hbase.monitoring.TaskMonitor

@Private
public class TaskMonitor
extends Object

Singleton which keeps track of tasks going on in this VM. A Task here is anything which takes more than a few seconds and the user might want to inquire about the status

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private class	TaskMonitor.MonitorRunnable
private static class	TaskMonitor.PassthroughInvocationHandler<T>	An InvocationHandler that simply passes through calls to the original object.
private static class	TaskMonitor.TaskAndWeakRefPair	This class encapsulates an object as well as a weak reference to a proxy that passes through calls to that object.
private static interface	TaskMonitor.TaskFilter

Field Summary

Fields

Modifier and Type	Field	Description
static final long	DEFAULT_EXPIRATION_TIME
static final int	DEFAULT_MAX_TASKS
static final long	DEFAULT_MONITOR_INTERVAL
static final long	DEFAULT_RPC_WARN_TIME
static final String	EXPIRATION_TIME_KEY
private final long	expirationTime
private static TaskMonitor	instance
private static final org.slf4j.Logger	LOG
static final String	MAX_TASKS_KEY
private final int	maxTasks
static final String	MONITOR_INTERVAL_KEY
private final long	monitorInterval
private Thread	monitorThread
static final String	RPC_WARN_TIME_KEY
private final List<TaskMonitor.TaskAndWeakRefPair>	rpcTasks
private final long	rpcWarnTime
private final org.apache.hbase.thirdparty.org.apache.commons.collections4.queue.CircularFifoQueue<TaskMonitor.TaskAndWeakRefPair>	tasks

Constructor Summary

Constructors

Constructor	Description
TaskMonitor(org.apache.hadoop.conf.Configuration conf)

Method Summary

Modifier and Type	Method	Description
private boolean	canPurge(MonitoredTask stat)
MonitoredRPCHandler	createRPCStatus(String description)
MonitoredTask	createStatus(String description)
MonitoredTask	createStatus(String description, boolean ignore)
MonitoredTask	createStatus(String description, boolean ignore, boolean enableJournal)	Create a monitored task for users to inquire about the status
private static TaskMonitor.TaskFilter	createTaskFilter(String filter)	Create a task filter according to a given filter type.
static TaskGroup	createTaskGroup(boolean ignoreSubTasksInTaskMonitor, String description)	Create a task group which contains a series of monitored tasks for users to inquire about the status
void	dumpAsText(PrintWriter out)
static TaskMonitor	get()	Get singleton instance.
List<MonitoredTask>	getTasks()	Produces a list containing copies of the current state of all non-expired MonitoredTasks handled by this TaskMonitor.
List<MonitoredTask>	getTasks(String filter)	Produces a list containing copies of the current state of all non-expired MonitoredTasks handled by this TaskMonitor.
private static void	processTasks(Iterable<TaskMonitor.TaskAndWeakRefPair> tasks, TaskMonitor.TaskFilter filter, List<MonitoredTask> results)
private void	purgeExpiredTasks()
void	shutdown()
private void	warnStuckTasks()

Methods inherited from class java.lang.Object

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

Field Details

LOG

private static final org.slf4j.Logger LOG

MAX_TASKS_KEY

public static final String MAX_TASKS_KEY

See Also:

• Constant Field Values

DEFAULT_MAX_TASKS

public static final int DEFAULT_MAX_TASKS

See Also:

• Constant Field Values

RPC_WARN_TIME_KEY

public static final String RPC_WARN_TIME_KEY

See Also:

• Constant Field Values

DEFAULT_RPC_WARN_TIME

public static final long DEFAULT_RPC_WARN_TIME

See Also:

• Constant Field Values

EXPIRATION_TIME_KEY

public static final String EXPIRATION_TIME_KEY

See Also:

• Constant Field Values

DEFAULT_EXPIRATION_TIME

public static final long DEFAULT_EXPIRATION_TIME

See Also:

• Constant Field Values

MONITOR_INTERVAL_KEY

public static final String MONITOR_INTERVAL_KEY

See Also:

• Constant Field Values

DEFAULT_MONITOR_INTERVAL

public static final long DEFAULT_MONITOR_INTERVAL

See Also:

• Constant Field Values

instance

private static TaskMonitor instance

maxTasks

private final int maxTasks

rpcWarnTime

private final long rpcWarnTime

expirationTime

private final long expirationTime

tasks

private final org.apache.hbase.thirdparty.org.apache.commons.collections4.queue.CircularFifoQueue<TaskMonitor.TaskAndWeakRefPair> tasks

rpcTasks

private final List<TaskMonitor.TaskAndWeakRefPair> rpcTasks

monitorInterval

private final long monitorInterval

monitorThread

private Thread monitorThread

Constructor Details

TaskMonitor

TaskMonitor(org.apache.hadoop.conf.Configuration conf)

Method Details

get

public static TaskMonitor get()

Get singleton instance. TODO this would be better off scoped to a single daemon

createStatus

public MonitoredTask createStatus(String description)

createStatus

public MonitoredTask createStatus(String description,
 boolean ignore)

createStatus

public MonitoredTask createStatus(String description,
 boolean ignore,
 boolean enableJournal)

Create a monitored task for users to inquire about the status

Parameters:

description - description of the status

ignore - whether to ignore to track(e.g. show/clear/expire) the task in the TaskMonitor

enableJournal - enable when the task contains some stage journals

Returns:

a monitored task

createTaskGroup

public static TaskGroup createTaskGroup(boolean ignoreSubTasksInTaskMonitor,
 String description)

Create a task group which contains a series of monitored tasks for users to inquire about the status

Parameters:

ignoreSubTasksInTaskMonitor - whether to ignore to track(e.g. show/clear/expire) the task in the TaskMonitor

description - description of the status

Returns:

a group of monitored tasks

createRPCStatus

public MonitoredRPCHandler createRPCStatus(String description)

warnStuckTasks

private void warnStuckTasks()

purgeExpiredTasks

private void purgeExpiredTasks()

getTasks

public List<MonitoredTask> getTasks()

Produces a list containing copies of the current state of all non-expired MonitoredTasks handled by this TaskMonitor.

Returns:

A complete list of MonitoredTasks.

getTasks

public List<MonitoredTask> getTasks(String filter)

Produces a list containing copies of the current state of all non-expired MonitoredTasks handled by this TaskMonitor.

Parameters:

filter - type of wanted tasks

Returns:

A filtered list of MonitoredTasks.

createTaskFilter

private static TaskMonitor.TaskFilter createTaskFilter(String filter)

Create a task filter according to a given filter type.

Parameters:

filter - type of monitored task

Returns:

a task filter

processTasks

private static void processTasks(Iterable<TaskMonitor.TaskAndWeakRefPair> tasks,
 TaskMonitor.TaskFilter filter,
 List<MonitoredTask> results)

canPurge

private boolean canPurge(MonitoredTask stat)

dumpAsText

public void dumpAsText(PrintWriter out)

shutdown

public void shutdown()