org.apache.hadoop.hbase.monitoring

Class MonitoredTaskImpl

java.lang.Object

org.apache.hadoop.hbase.monitoring.MonitoredTaskImpl

All Implemented Interfaces:

Cloneable, MonitoredTask

Direct Known Subclasses:

MonitoredRPCHandlerImpl

@InterfaceAudience.Private
class MonitoredTaskImpl
extends Object
implements MonitoredTask

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	MonitoredTaskImpl.StatusJournalEntryImpl

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
private String	description
private static org.apache.hbase.thirdparty.com.google.gson.Gson	GSON
private List<MonitoredTask.StatusJournalEntry>	journal
private boolean	journalEnabled
private long	startTime
protected MonitoredTask.State	state
private long	stateTime
private String	status
private long	statusTime
private long	warnTime

Constructor Summary

Constructors

Constructor and Description
MonitoredTaskImpl()

Method Summary

Modifier and Type	Method and Description
void	abort(String msg)
void	cleanup() Explicitly mark this status as able to be cleaned up, even though it might not be complete.
MonitoredTaskImpl	clone() Public exposure of Object.clone() in order to allow clients to easily capture current state.
void	disableStatusJournal()
void	enableStatusJournal(boolean includeCurrentStatus) Enables journaling of this monitored task, the first invocation will lazily initialize the journal.
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()
long	getWarnTime()
void	markComplete(String status)
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

startTime

private long startTime

statusTime

private long statusTime

stateTime

private long stateTime

warnTime

private long warnTime

status

private volatile String status

description

private volatile String description

state

protected volatile MonitoredTask.State state

journalEnabled

private boolean journalEnabled

journal

private List<MonitoredTask.StatusJournalEntry> journal

GSON

private static final org.apache.hbase.thirdparty.com.google.gson.Gson GSON

Constructor Detail

MonitoredTaskImpl

public MonitoredTaskImpl()

Method Detail

clone

public 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

markComplete

public void markComplete(String status)

Specified by:

markComplete 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

abort

public void abort(String msg)

Specified by:

abort 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

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

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

enableStatusJournal

public void enableStatusJournal(boolean includeCurrentStatus)

Enables journaling of this monitored task, the first invocation will lazily initialize the journal. The journal implementation itself and this method are not thread safe

Specified by:

enableStatusJournal in interface MonitoredTask

Parameters:

includeCurrentStatus - whether to include the current set status in the journal

disableStatusJournal

public void disableStatusJournal()

Specified by:

disableStatusJournal in interface MonitoredTask

prettyPrintJournal

public String prettyPrintJournal()

Specified by:

prettyPrintJournal in interface MonitoredTask