org.threadly.util.debug

Class ControlledThreadProfiler

java.lang.Object

org.threadly.util.debug.Profiler

org.threadly.util.debug.ControlledThreadProfiler

public class ControlledThreadProfiler
extends Profiler

This class functions very similar to the Profiler. The difference between the two is while the Profiler profiles all running threads on the VM. This implementation only profiles threads which you explicitly add to be profiled.

Since:

1.0.0

Constructor Summary

Constructors

Constructor and Description
ControlledThreadProfiler() Constructs a new profiler instance.
ControlledThreadProfiler(int pollIntervalInMs) Constructs a new profiler instance.

Method Summary

Modifier and Type	Method and Description
void	addProfiledThread(java.lang.Thread t) Adds a thread to be checked by the running profiler.
int	getProfiledThreadCount() Call to check how many threads are currently being checked by the profiler.
boolean	removedProfiledThread(java.lang.Thread t) Removed a thread from the set of tracked threads.

Methods inherited from class org.threadly.util.debug.Profiler

dump, dump, dump, dump, dump, dump, getCollectedSampleQty, getPollInterval, isRunning, reset, setPollInterval, start, start, start, start, stop

Methods inherited from class java.lang.Object

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

Constructor Detail

ControlledThreadProfiler

public ControlledThreadProfiler()

Constructs a new profiler instance. The only way to get results from this instance is to call #dump() with a provided output stream to get the results to.

ControlledThreadProfiler

public ControlledThreadProfiler(int pollIntervalInMs)

Constructs a new profiler instance. The only way to get results from this instance is to call #dump() with a provided output stream to get the results to.

Parameters:

pollIntervalInMs - frequency to check running threads

Method Detail

addProfiledThread

public void addProfiledThread(java.lang.Thread t)

Adds a thread to be checked by the running profiler.

If the thread is already included, or if the thread is null, this is a no-op.

Parameters:

t - Thread to add to the list of tracked threads

removedProfiledThread

public boolean removedProfiledThread(java.lang.Thread t)

Removed a thread from the set of tracked threads. It is good practice to remove a thread from the profiler if it is no longer alive. This profiler makes NO attempt to automatically remove dead threads.

Parameters:

t - Thread to remove from tracked set

Returns:

true if the thread was found and removed.

getProfiledThreadCount

public int getProfiledThreadCount()

Call to check how many threads are currently being checked by the profiler. Keep in mind that threads that are not alive may be skipped by the profiler, but will be included in this count.

Returns:

count of tracked threads.