Tomcat 10.1.19 · org.apache.tomcat.util.Diagnostics · APIdia, the JavaDoc alternative

Field Summary

Modifier and Type	Field and Description
private static final ClassLoadingMXBean	classLoadingMXBean
private static final CompilationMXBean	compilationMXBean
private static final String	CRLF
private static final List<GarbageCollectorMXBean>	garbageCollectorMXBeans
private static final String	INDENT1
private static final String	INDENT2
private static final String	INDENT3
private static final Log	log
private static final PlatformLoggingMXBean	loggingMXBean
private static final List<MemoryManagerMXBean>	memoryManagerMXBeans
private static final MemoryMXBean	memoryMXBean
private static final List<MemoryPoolMXBean>	memoryPoolMXBeans
private static final OperatingSystemMXBean	operatingSystemMXBean
private static final String	PACKAGE
private static final RuntimeMXBean	runtimeMXBean
private static final StringManager	sm
private static final ThreadMXBean	threadMXBean
private static final SimpleDateFormat	timeformat
private static final String	vminfoSystemProperty

Constructor Summary

Access	Constructor and Description
public	Diagnostics()

Method Summary

Modifier and Type	Method and Description
public static String	Returns: a deadlock message and the formatted thread dump of the deadlocked threads findDeadlock() Check if any threads are deadlocked.
private static String	Returns: the formatted contents formatMemoryUsage(String a text prefix used in formatting name, MemoryUsage the MemoryUsage object to format usage) Format contents of a MemoryUsage object.
public static void	gc() Initiate garbage collection via MX Bean
private static String	Returns: the formatted thread dump getThreadDump(ThreadInfo the ThreadInfo describing the thread ti) Formats the thread dump for one thread.
private static String	Returns: the formatted thread dump getThreadDump(ThreadInfo[] the ThreadInfo array describing the thread list tinfos) Formats the thread dump for a list of threads.
public static String	Returns: the formatted JVM thread dump getThreadDump() Retrieves a formatted JVM thread dump.
public static String	Returns: the formatted JVM thread dump getThreadDump(Enumeration<Locale> list of locales to use requestedLocales) Retrieves a formatted JVM thread dump.
public static String	Returns: the formatted JVM thread dump getThreadDump(StringManager the StringManager to use requestedSm) Retrieve a JVM thread dump formatted using the given StringManager.
private static String	Returns: the formatted thread dump header getThreadDumpHeader(ThreadInfo the ThreadInfo describing the thread ti) Formats the thread dump header for one thread.
public static String	Returns: the formatted JVM information text getVMInfo() Retrieves a formatted JVM information text.
public static String	Returns: the formatted JVM information text getVMInfo(Enumeration<Locale> list of locales to use requestedLocales) Retrieves a formatted JVM information text.
public static String	Returns: the formatted JVM information text getVMInfo(StringManager the StringManager to use requestedSm) Retrieve a JVM information text formatted using the given StringManager.
public static boolean	Returns: true if thread contention monitoring is enabled isThreadContentionMonitoringEnabled() Check whether thread contention monitoring is enabled.
public static boolean	Returns: true if thread cpu time measurement is enabled isThreadCpuTimeEnabled() Check whether thread cpu time measurement is enabled.
public static void	resetPeakThreadCount() Reset peak thread count in ThreadMXBean
public static void	resetPeakUsage(String name of the MemoryPoolMXBean or "all" name) Reset peak memory usage data in MemoryPoolMXBean
public static boolean	Returns: true if setting the threshold succeeded setCollectionUsageThreshold(String name of the MemoryPoolMXBean name, long the collection threshold to set threshold) Set collection usage threshold in MemoryPoolMXBean
public static void	setLoggerLevel(String the name of the logger loggerName, String the level to set levelName) Set logger level
public static void	setThreadContentionMonitoringEnabled(boolean whether to enable thread contention monitoring enable) Enable or disable thread contention monitoring via the ThreadMxMXBean.
public static void	setThreadCpuTimeEnabled(boolean whether to enable thread cpu time measurement enable) Enable or disable thread cpu time measurement via the ThreadMxMXBean.
public static boolean	Returns: true if setting the threshold succeeded setUsageThreshold(String name of the MemoryPoolMXBean name, long the threshold to set threshold) Set usage threshold in MemoryPoolMXBean
public static void	setVerboseClassLoading(boolean whether to enable verbose class loading verbose) Set verbose class loading
public static void	setVerboseGarbageCollection(boolean whether to enable verbose gc logging verbose) Set verbose garbage collection logging

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

classLoadingMXBean	back to summary
private static final ClassLoadingMXBean classLoadingMXBean

compilationMXBean	back to summary
private static final CompilationMXBean compilationMXBean

CRLF	back to summary
private static final String CRLF

garbageCollectorMXBeans	back to summary
private static final List<GarbageCollectorMXBean> garbageCollectorMXBeans

INDENT1	back to summary
private static final String INDENT1

INDENT2	back to summary
private static final String INDENT2

INDENT3	back to summary
private static final String INDENT3

log	back to summary
private static final Log log

loggingMXBean	back to summary
private static final PlatformLoggingMXBean loggingMXBean

memoryManagerMXBeans	back to summary
private static final List<MemoryManagerMXBean> memoryManagerMXBeans

memoryMXBean	back to summary
private static final MemoryMXBean memoryMXBean

memoryPoolMXBeans	back to summary
private static final List<MemoryPoolMXBean> memoryPoolMXBeans

operatingSystemMXBean	back to summary
private static final OperatingSystemMXBean operatingSystemMXBean

PACKAGE	back to summary
private static final String PACKAGE

runtimeMXBean	back to summary
private static final RuntimeMXBean runtimeMXBean

sm	back to summary
private static final StringManager sm

threadMXBean	back to summary
private static final ThreadMXBean threadMXBean

timeformat	back to summary
private static final SimpleDateFormat timeformat

vminfoSystemProperty	back to summary
private static final String vminfoSystemProperty

Constructor Detail

Diagnostics	back to summary
public Diagnostics()

Method Detail

findDeadlock	back to summary
public static String findDeadlock() Check if any threads are deadlocked. If any, print the thread dump for those threads. Returns:String a deadlock message and the formatted thread dump of the deadlocked threads

findDeadlock

back to summary

public static String findDeadlock()

Check if any threads are deadlocked. If any, print the thread dump for those threads.

Returns:String: a deadlock message and the formatted thread dump of the deadlocked threads

formatMemoryUsage	back to summary
private static String formatMemoryUsage(String name, MemoryUsage usage) Format contents of a MemoryUsage object. Parameters name:String a text prefix used in formatting usage:MemoryUsage the MemoryUsage object to format Returns:String the formatted contents

formatMemoryUsage

back to summary

private static String formatMemoryUsage(String name, MemoryUsage usage)

Format contents of a MemoryUsage object.

Parameters

name:String: a text prefix used in formatting
usage:MemoryUsage: the MemoryUsage object to format

Returns:String

the formatted contents

gc	back to summary
public static void gc() Initiate garbage collection via MX Bean

getThreadDump	back to summary
private static String getThreadDump(ThreadInfo ti) Formats the thread dump for one thread. Parameters ti:ThreadInfo the ThreadInfo describing the thread Returns:String the formatted thread dump

getThreadDump

back to summary

private static String getThreadDump(ThreadInfo ti)

Formats the thread dump for one thread.

Parameters

ti:ThreadInfo: the ThreadInfo describing the thread

Returns:String

the formatted thread dump

getThreadDump	back to summary
private static String getThreadDump(ThreadInfo[] tinfos) Formats the thread dump for a list of threads. Parameters tinfos:ThreadInfo[] the ThreadInfo array describing the thread list Returns:String the formatted thread dump

getThreadDump

back to summary

private static String getThreadDump(ThreadInfo[] tinfos)

Formats the thread dump for a list of threads.

Parameters

tinfos:ThreadInfo[]: the ThreadInfo array describing the thread list

Returns:String

the formatted thread dump

getThreadDump	back to summary
public static String getThreadDump() Retrieves a formatted JVM thread dump. The default StringManager will be used. Returns:String the formatted JVM thread dump

getThreadDump

back to summary

public static String getThreadDump()

Retrieves a formatted JVM thread dump. The default StringManager will be used.

Returns:String: the formatted JVM thread dump

getThreadDump	back to summary
public static String getThreadDump(Enumeration<Locale> requestedLocales) Retrieves a formatted JVM thread dump. The given list of locales will be used to retrieve a StringManager. Parameters requestedLocales:Enumeration<Locale> list of locales to use Returns:String the formatted JVM thread dump

getThreadDump

back to summary

public static String getThreadDump(Enumeration<Locale> requestedLocales)

Retrieves a formatted JVM thread dump. The given list of locales will be used to retrieve a StringManager.

Parameters

requestedLocales:Enumeration<Locale>: list of locales to use

Returns:String

the formatted JVM thread dump

getThreadDump	back to summary
public static String getThreadDump(StringManager requestedSm) Retrieve a JVM thread dump formatted using the given StringManager. Parameters requestedSm:StringManager the StringManager to use Returns:String the formatted JVM thread dump

getThreadDump

back to summary

public static String getThreadDump(StringManager requestedSm)

Retrieve a JVM thread dump formatted using the given StringManager.

Parameters

requestedSm:StringManager: the StringManager to use

Returns:String

the formatted JVM thread dump

getThreadDumpHeader	back to summary
private static String getThreadDumpHeader(ThreadInfo ti) Formats the thread dump header for one thread. Parameters ti:ThreadInfo the ThreadInfo describing the thread Returns:String the formatted thread dump header

getThreadDumpHeader

back to summary

private static String getThreadDumpHeader(ThreadInfo ti)

Formats the thread dump header for one thread.

Parameters

ti:ThreadInfo: the ThreadInfo describing the thread

Returns:String

the formatted thread dump header

getVMInfo	back to summary
public static String getVMInfo() Retrieves a formatted JVM information text. The default StringManager will be used. Returns:String the formatted JVM information text

getVMInfo

back to summary

public static String getVMInfo()

Retrieves a formatted JVM information text. The default StringManager will be used.

Returns:String: the formatted JVM information text

getVMInfo	back to summary
public static String getVMInfo(Enumeration<Locale> requestedLocales) Retrieves a formatted JVM information text. The given list of locales will be used to retrieve a StringManager. Parameters requestedLocales:Enumeration<Locale> list of locales to use Returns:String the formatted JVM information text

getVMInfo

back to summary

public static String getVMInfo(Enumeration<Locale> requestedLocales)

Retrieves a formatted JVM information text. The given list of locales will be used to retrieve a StringManager.

Parameters

requestedLocales:Enumeration<Locale>: list of locales to use

Returns:String

the formatted JVM information text

getVMInfo	back to summary
public static String getVMInfo(StringManager requestedSm) Retrieve a JVM information text formatted using the given StringManager. Parameters requestedSm:StringManager the StringManager to use Returns:String the formatted JVM information text

getVMInfo

back to summary

public static String getVMInfo(StringManager requestedSm)

Retrieve a JVM information text formatted using the given StringManager.

Parameters

requestedSm:StringManager: the StringManager to use

Returns:String

the formatted JVM information text

isThreadContentionMonitoringEnabled	back to summary
public static boolean isThreadContentionMonitoringEnabled() Check whether thread contention monitoring is enabled. Returns:boolean true if thread contention monitoring is enabled

isThreadContentionMonitoringEnabled

back to summary

public static boolean isThreadContentionMonitoringEnabled()

Check whether thread contention monitoring is enabled.

Returns:boolean: true if thread contention monitoring is enabled

isThreadCpuTimeEnabled	back to summary
public static boolean isThreadCpuTimeEnabled() Check whether thread cpu time measurement is enabled. Returns:boolean true if thread cpu time measurement is enabled

isThreadCpuTimeEnabled

back to summary

public static boolean isThreadCpuTimeEnabled()

Check whether thread cpu time measurement is enabled.

Returns:boolean: true if thread cpu time measurement is enabled

resetPeakThreadCount	back to summary
public static void resetPeakThreadCount() Reset peak thread count in ThreadMXBean

resetPeakUsage	back to summary
public static void resetPeakUsage(String name) Reset peak memory usage data in MemoryPoolMXBean Parameters name:String name of the MemoryPoolMXBean or "all"

resetPeakUsage

back to summary

public static void resetPeakUsage(String name)

Reset peak memory usage data in MemoryPoolMXBean

Parameters

name:String: name of the MemoryPoolMXBean or "all"

setCollectionUsageThreshold	back to summary
public static boolean setCollectionUsageThreshold(String name, long threshold) Set collection usage threshold in MemoryPoolMXBean Parameters name:String name of the MemoryPoolMXBean threshold:long the collection threshold to set Returns:boolean true if setting the threshold succeeded

setCollectionUsageThreshold

back to summary

public static boolean setCollectionUsageThreshold(String name, long threshold)

Set collection usage threshold in MemoryPoolMXBean

Parameters

name:String: name of the MemoryPoolMXBean
threshold:long: the collection threshold to set

Returns:boolean

true if setting the threshold succeeded

setLoggerLevel	back to summary
public static void setLoggerLevel(String loggerName, String levelName) Set logger level Parameters loggerName:String the name of the logger levelName:String the level to set

setLoggerLevel

back to summary

public static void setLoggerLevel(String loggerName, String levelName)

Set logger level

Parameters

loggerName:String: the name of the logger
levelName:String: the level to set

setThreadContentionMonitoringEnabled	back to summary
public static void setThreadContentionMonitoringEnabled(boolean enable) Enable or disable thread contention monitoring via the ThreadMxMXBean. Parameters enable:boolean whether to enable thread contention monitoring

setThreadContentionMonitoringEnabled

back to summary

public static void setThreadContentionMonitoringEnabled(boolean enable)

Enable or disable thread contention monitoring via the ThreadMxMXBean.

Parameters

enable:boolean: whether to enable thread contention monitoring

setThreadCpuTimeEnabled	back to summary
public static void setThreadCpuTimeEnabled(boolean enable) Enable or disable thread cpu time measurement via the ThreadMxMXBean. Parameters enable:boolean whether to enable thread cpu time measurement

setThreadCpuTimeEnabled

back to summary

public static void setThreadCpuTimeEnabled(boolean enable)

Enable or disable thread cpu time measurement via the ThreadMxMXBean.

Parameters

enable:boolean: whether to enable thread cpu time measurement

setUsageThreshold	back to summary
public static boolean setUsageThreshold(String name, long threshold) Set usage threshold in MemoryPoolMXBean Parameters name:String name of the MemoryPoolMXBean threshold:long the threshold to set Returns:boolean true if setting the threshold succeeded

setUsageThreshold

back to summary

public static boolean setUsageThreshold(String name, long threshold)

Set usage threshold in MemoryPoolMXBean

Parameters

name:String: name of the MemoryPoolMXBean
threshold:long: the threshold to set

Returns:boolean

true if setting the threshold succeeded

setVerboseClassLoading	back to summary
public static void setVerboseClassLoading(boolean verbose) Set verbose class loading Parameters verbose:boolean whether to enable verbose class loading

setVerboseClassLoading

back to summary

public static void setVerboseClassLoading(boolean verbose)

Set verbose class loading

Parameters

verbose:boolean: whether to enable verbose class loading

setVerboseGarbageCollection	back to summary
public static void setVerboseGarbageCollection(boolean verbose) Set verbose garbage collection logging Parameters verbose:boolean whether to enable verbose gc logging

setVerboseGarbageCollection

back to summary

public static void setVerboseGarbageCollection(boolean verbose)

Set verbose garbage collection logging

Parameters

verbose:boolean: whether to enable verbose gc logging

public Class Diagnostics

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail