Class ThreadHistoryMonitorHelper

java.lang.Object

org.jboss.byteman.rule.helper.Helper

org.jboss.byteman.sample.helper.ThreadHistoryMonitorHelper

All Implemented Interfaces:

ThreadHistoryMonitorHelperMXBean

public class ThreadHistoryMonitorHelper
extends Helper
implements ThreadHistoryMonitorHelperMXBean

Helper class used by ThreadHistoryMonitorHelper script to trace thread operations. This is essentially an extension of the ThreadMonitorHelper which uses maps to store the thread history rather than writing it out.

The helper also implements ThreadHistoryMonitorHelperMXBean to allow this class to be registered as an mbean @see #registerHelperMBean(String).

Field Summary

Fields

Modifier and Type	Field	Description
private static final Queue<ThreadMonitorEvent>	callList
private static final Queue<ThreadMonitorEvent>	createList
private static boolean	DEBUG	org.jboss.byteman.sample.helper.debug system property debug mode flag
private static final Queue<ThreadMonitorEvent>	exitList
private static ThreadHistoryMonitorHelper	INSTANCE	The first instance of ThreadHistoryMonitorHelper that will be used as the mbean by registerHelperMBean(String).
private static final Queue<ThreadMonitorEvent>	interruptedList
private static final Map<ThreadMonitored, ThreadMonitored>	monitoredThreads
private static final Queue<ThreadMonitorEvent>	runList
private static final Queue<ThreadMonitorEvent>	startList

Fields inherited from class Helper

rule

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ThreadHistoryMonitorHelper(Rule rule)

Method Summary

Modifier and Type	Method	Description
static void	activated()	Looks to the org.jboss.byteman.sample.helper.debug system property to set the class DEBUG mode flag.
private void	doWriteAllEvents(String path)
ThreadMonitorEvent[]	getCallEvents()
ThreadMonitorEvent[]	getCreateEvents()	Get the array of thread creation events.
String	getEventReport()	Get a string description of all thread events.
ThreadMonitorEvent[]	getExitEvents()	Get the array of thread exit events.
private ThreadMonitored	getMonitoredThread(Thread thread)	Returning monitored thread belonging to the provided thread object.
ThreadMonitorEvent[]	getRunEvents()	Get the array of Runnable.run events.
ThreadMonitorEvent[]	getStartEvents()	Get the array of thread start events.
private Map<ThreadMonitored, ThreadMonitorEvent>	getThreadEventMap(Iterable<ThreadMonitorEvent> events)
static void	installed(Rule rule)
ThreadMonitorEvent	newThreadEvent(ThreadMonitored threadMonitored, Thread thread, ThreadMonitorEventType eventType)	Common ThreadMonitorEvent creation method.
void	registerHelperMBean(String name)	Register the INSTANCE as an mbean under the given name.
void	traceCreate(Thread thread, int depth)	trace creation of the supplied thread to System.out this should only be triggered from the Thread constructor
void	traceExit(Thread thread)	trace exit of the supplied thread to System.out this should only be triggered from the call to Thread exit method
void	traceInterrupt(Thread thread)	trace interrupted of the supplied thread to System.out this should only be triggered from the call to Thread.interrupt()
void	traceRun(Runnable runnable)	trace run of the supplied Runnable to System.out this should only be triggered from a call to an implementation of Runnable.run()
void	traceRun(Callable callable)	trace run of the supplied Callable to System.out this should only be triggered from a call to an implementation of Callable.call()
void	traceStart(Thread thread)	trace start of the supplied thread to System.out this should only be triggered from the call to java.lang.Thread.start"
void	writeAllEventsToFile(String path)	Write all events to the file given by path
void	writeAllEventsToFile(String path, int sampleCount)	Write all events to the file given by path, repeating sampleCount times at 5 second intervals.
void	writeEventsToFile(String type, String path)	Write a report of all events of the indicated type to the given path.
private void	writeFullEvents(Formatter fw, String title, Collection<ThreadMonitorEvent> events)
private void	writeThreadNames(Formatter fw, String title, Collection<ThreadMonitorEvent> events)

Methods inherited from class Helper

addCountDown, callerCheck, callerEquals, callerEquals, callerEquals, callerEquals, callerEquals, callerEquals, callerEquals, callerEquals, callerEquals, callerMatches, callerMatches, callerMatches, callerMatches, callerMatches, callerMatches, callerMatches, callerMatches, callerMatches, clear, clearLinks, clearLinks, closeTrace, countDown, createCountDown, createCounter, createCounter, createJoin, createLinkMap, createRendezvous, createRendezvous, createTimer, deactivated, debug, decrementCounter, delay, deleteCounter, deleteLinkMap, deleteRendezvous, deleteTimer, err, errTraceException, flag, flagged, formatAllStacks, formatAllStacks, formatAllStacks, formatAllStacks, formatStack, formatStack, formatStack, formatStack, formatStackBetween, formatStackBetween, formatStackBetween, formatStackBetween, formatStackBetween, formatStackBetween, formatStackBetweenMatches, formatStackBetweenMatches, formatStackBetweenMatches, formatStackBetweenMatches, formatStackBetweenMatches, formatStackBetweenMatches, formatStackMatching, formatStackMatching, formatStackMatching, formatStackMatching, formatStackMatching, formatStackMatching, formatStackRange, formatThreadStack, formatThreadStack, formatThreadStack, formatThreadStack, getCountDown, getElapsedTimeFromTimer, getObjectSize, getRendezvous, getStack, incrementCounter, incrementCounter, isCountDown, isJoin, isRendezvous, joinEnlist, joinWait, joinWait, killJVM, killJVM, killThread, link, link, linked, linked, linkNames, linkNames, linkValues, linkValues, matchIndex, noisy, noisyTraceException, openTrace, openTrace, out, outTraceException, printFrame, printlnFrame, readCounter, readCounter, rendezvous, rendezvous, resetTimer, setTriggering, signalKill, signalKill, signalThrow, signalThrow, signalWake, signalWake, toString, trace, trace, traceAllStacks, traceAllStacks, traceAllStacks, traceAllStacks, traceAllStacks, traceAllStacks, traceClose, traceln, traceln, traceOpen, traceOpen, traceStack, traceStack, traceStack, traceStack, traceStack, traceStack, traceStackBetween, traceStackBetween, traceStackBetween, traceStackBetween, traceStackBetween, traceStackBetween, traceStackBetween, traceStackBetween, traceStackBetween, traceStackBetweenMatches, traceStackBetweenMatches, traceStackBetweenMatches, traceStackBetweenMatches, traceStackBetweenMatches, traceStackBetweenMatches, traceStackBetweenMatches, traceStackBetweenMatches, traceStackBetweenMatches, traceStackMatching, traceStackMatching, traceStackMatching, traceStackMatching, traceStackMatching, traceStackMatching, traceStackMatching, traceStackMatching, traceStackMatching, traceStackRange, traceThreadStack, traceThreadStack, traceThreadStack, traceThreadStack, traceThreadStack, traceThreadStack, triggerIndex, uninstalled, unlink, unlink, verbose, verboseTraceException, waitFor, waitFor, waiting

Methods inherited from class Object

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

Field Details

monitoredThreads

private static final Map<ThreadMonitored, ThreadMonitored> monitoredThreads

createList

private static final Queue<ThreadMonitorEvent> createList

startList

private static final Queue<ThreadMonitorEvent> startList

exitList

private static final Queue<ThreadMonitorEvent> exitList

runList

private static final Queue<ThreadMonitorEvent> runList

callList

private static final Queue<ThreadMonitorEvent> callList

interruptedList

private static final Queue<ThreadMonitorEvent> interruptedList

INSTANCE

private static ThreadHistoryMonitorHelper INSTANCE

The first instance of ThreadHistoryMonitorHelper that will be used as the mbean by registerHelperMBean(String).

DEBUG

private static boolean DEBUG

org.jboss.byteman.sample.helper.debug system property debug mode flag

Constructor Details

ThreadHistoryMonitorHelper

protected ThreadHistoryMonitorHelper(Rule rule)

Method Details

activated

public static void activated()

Looks to the org.jboss.byteman.sample.helper.debug system property to set the class DEBUG mode flag.

installed

public static void installed(Rule rule)

registerHelperMBean

public void registerHelperMBean(String name)

Register the INSTANCE as an mbean under the given name.

Parameters:

name - - the object name string to register the INSTANCE under

traceCreate

public void traceCreate(Thread thread,
 int depth)

trace creation of the supplied thread to System.out this should only be triggered from the Thread constructor

Parameters:

thread - the newly created thread

depth - unused

traceStart

public void traceStart(Thread thread)

trace start of the supplied thread to System.out this should only be triggered from the call to java.lang.Thread.start"

Parameters:

thread - the newly starting thread

traceExit

public void traceExit(Thread thread)

trace exit of the supplied thread to System.out this should only be triggered from the call to Thread exit method

Parameters:

thread - the exiting thread

traceInterrupt

public void traceInterrupt(Thread thread)

trace interrupted of the supplied thread to System.out this should only be triggered from the call to Thread.interrupt()

Parameters:

thread - the interrupting thread

traceRun

public void traceRun(Runnable runnable)

trace run of the supplied Runnable to System.out this should only be triggered from a call to an implementation of Runnable.run()

Parameters:

runnable - the runnable being run

traceRun

public void traceRun(Callable callable)

trace run of the supplied Callable to System.out this should only be triggered from a call to an implementation of Callable.call()

Parameters:

callable - the callable being call

getCreateEvents

public ThreadMonitorEvent[] getCreateEvents()

Description copied from interface: ThreadHistoryMonitorHelperMXBean

Get the array of thread creation events.

Specified by:

getCreateEvents in interface ThreadHistoryMonitorHelperMXBean

Returns:

the array of thread creation events in the order of occurrence.

getStartEvents

public ThreadMonitorEvent[] getStartEvents()

Description copied from interface: ThreadHistoryMonitorHelperMXBean

Get the array of thread start events.

Specified by:

getStartEvents in interface ThreadHistoryMonitorHelperMXBean

Returns:

the array of thread start events in the order of occurrence.

getExitEvents

public ThreadMonitorEvent[] getExitEvents()

Description copied from interface: ThreadHistoryMonitorHelperMXBean

Get the array of thread exit events.

Specified by:

getExitEvents in interface ThreadHistoryMonitorHelperMXBean

Returns:

the array of thread exit events in the order of occurrence.

getRunEvents

public ThreadMonitorEvent[] getRunEvents()

Description copied from interface: ThreadHistoryMonitorHelperMXBean

Get the array of Runnable.run events.

Specified by:

getRunEvents in interface ThreadHistoryMonitorHelperMXBean

Returns:

the array of Runnable.run events in the order of occurrence.

getCallEvents

public ThreadMonitorEvent[] getCallEvents()

getEventReport

public String getEventReport()
                      throws IOException

Description copied from interface: ThreadHistoryMonitorHelperMXBean

Get a string description of all thread events. This is the same event information written by ThreadHistoryMonitorHelperMXBean.writeAllEventsToFile(String).

Specified by:

getEventReport in interface ThreadHistoryMonitorHelperMXBean

Returns:

a formatted text description of all thread events.

Throws:

IOException - if an io error occurs

writeEventsToFile

public void writeEventsToFile(String type,
 String path)
                       throws IOException

Description copied from interface: ThreadHistoryMonitorHelperMXBean

Write a report of all events of the indicated type to the given path.

Specified by:

writeEventsToFile in interface ThreadHistoryMonitorHelperMXBean

Parameters:

type - - one of create, start, exit, run; case insensitive

path - - the pathname of the file to write the event report to.

Throws:

IOException - if an io error occurs

writeAllEventsToFile

public void writeAllEventsToFile(String path)
                          throws IOException

Write all events to the file given by path

Specified by:

writeAllEventsToFile in interface ThreadHistoryMonitorHelperMXBean

Parameters:

path - path to file

Throws:

IOException - if an io error occurs

writeAllEventsToFile

public void writeAllEventsToFile(String path,
 int sampleCount)
                          throws IOException

Write all events to the file given by path, repeating sampleCount times at 5 second intervals. The actual filename of each sample report will be either path-n where n = [0,sampleCount] if path does not contain a suffix, for example: /tmp/report-0 /tmp/report-1 /tmp/report-3 or pathbase-n.suffix if there is a '.' delimited suffix (.txt), for example: /tmp/report-0.txt /tmp/report-1.txt /tmp/report-3.txt

Parameters:

path - - the path to the event report file

sampleCount - - the number of samples to take

Throws:

IOException - - thrown on any IO failure

doWriteAllEvents

private void doWriteAllEvents(String path)
                       throws IOException

Throws:

IOException

writeFullEvents

private void writeFullEvents(Formatter fw,
 String title,
 Collection<ThreadMonitorEvent> events)

writeThreadNames

private void writeThreadNames(Formatter fw,
 String title,
 Collection<ThreadMonitorEvent> events)

newThreadEvent

public ThreadMonitorEvent newThreadEvent(ThreadMonitored threadMonitored,
 Thread thread,
 ThreadMonitorEventType eventType)

Common ThreadMonitorEvent creation method.

Parameters:

thread - - the thread associated with the event

eventType - - the type of the event.

Returns:

the ThreadMonitorEvent instance for the event.

getMonitoredThread

private ThreadMonitored getMonitoredThread(Thread thread)

Returning monitored thread belonging to the provided thread object. If such monitored thread does not exist (is not known to ThreadHistoryMonitorHelper) then brand new ThreadMonitored object is created and is added to the list checked by the helper class.

Parameters:

thread - thread that belonging ThreadMonitorThread is search for

Returns:

ThreadMonitorThread which belongs to provided thread or null in no such known

getThreadEventMap

private Map<ThreadMonitored, ThreadMonitorEvent> getThreadEventMap(Iterable<ThreadMonitorEvent> events)