org.adroitlogic.x.management.tbsr.task

Class ThreadDumpTask

java.lang.Object

org.adroitlogic.x.management.tbsr.task.TaskBase

org.adroitlogic.x.management.tbsr.task.ThreadDumpTask

@TaskMeta(id="thread-dump",name="JVM Thread Dump",description="produces thread dumps of the JVM running the UltraESB instance",maskable=false,intensive=true,taskParameters={@TaskParamMeta(name="output",description="output filename of the temporary thread dump files",configurable=false,defaultValue="threads_[timestamp].txt"),@TaskParamMeta(name="count",description="number of thread dump samples",configurable=true,defaultValue="3"),@TaskParamMeta(name="period",description="period (in seconds) between thread dumps",configurable=true,defaultValue="5")})
public class ThreadDumpTask
extends TaskBase

Thread dump task for UltraESB troubleshoot report generation; threadInfo-to-String conversions were adapted from http://stackoverflow.com/questions/6827952/threadmxbean-dumpallthreads-maxdepth

Since:

17.01

Author:

Janaka

Field Summary

Fields

Modifier and Type	Field and Description
(package private) static int	DEFAULT_THREAD_DUMP_COUNT default run configurations
(package private) static int	DEFAULT_THREAD_DUMP_PERIOD
(package private) static String	THREAD_DUMP_COUNT
(package private) static String	THREAD_DUMP_PERIOD

Fields inherited from class org.adroitlogic.x.management.tbsr.task.TaskBase

serverConfig

Constructor Summary

Constructors

Constructor and Description
ThreadDumpTask()

Method Summary

Modifier and Type	Method and Description
Status	execute(String outputRoot, Map<String,String> parameters) Executes the core logic of the task.

Methods inherited from class org.adroitlogic.x.management.tbsr.task.TaskBase

getDescription, getId, getName, getParameterDetails, isIntensive, isMaskable, setDescription, setId, setIntensive, setMaskable, setName, setParameterDetails, setServerConfig, toView

Methods inherited from class java.lang.Object

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

Field Detail

THREAD_DUMP_COUNT

static final String THREAD_DUMP_COUNT

See Also:

Constant Field Values

THREAD_DUMP_PERIOD

static final String THREAD_DUMP_PERIOD

See Also:

Constant Field Values

DEFAULT_THREAD_DUMP_COUNT

static final int DEFAULT_THREAD_DUMP_COUNT

default run configurations

See Also:

Constant Field Values

DEFAULT_THREAD_DUMP_PERIOD

static final int DEFAULT_THREAD_DUMP_PERIOD

See Also:

Constant Field Values

Constructor Detail

ThreadDumpTask

public ThreadDumpTask()

Method Detail

execute

public Status execute(String outputRoot,
                      Map<String,String> parameters)
               throws Exception

Description copied from class: TaskBase

Executes the core logic of the task. This method should dump the output of the task to a preconfigured file on the instance, located at the location pointed to by the File.separator-terminated path defined by the outputRoot parameter. Any exceptions should be thrown to the base method, for maintaining proper exception notification.

Specified by:

execute in class TaskBase

Parameters:

outputRoot - root directory for task output file(s)

parameters - runtime parameters for the task

Returns:

final execution status of task

Throws:

Exception - in case of a failure to execute the task