Package org.apache.tomcat.util
Class Diagnostics
- java.lang.Object
- 
- org.apache.tomcat.util.Diagnostics
 
- 
 public class Diagnostics extends java.lang.Object
- 
- 
Constructor SummaryConstructors Constructor Description Diagnostics()
 - 
Method SummaryAll Methods Static Methods Concrete Methods Modifier and Type Method Description static java.lang.StringfindDeadlock()Check if any threads are deadlocked.static voidgc()Initiate garbage collection via MX Beanstatic java.lang.StringgetThreadDump()Retrieves a formatted JVM thread dump.static java.lang.StringgetThreadDump(java.util.Enumeration<java.util.Locale> requestedLocales)Retrieves a formatted JVM thread dump.static java.lang.StringgetThreadDump(StringManager requestedSm)Retrieve a JVM thread dump formatted using the given StringManager.static java.lang.StringgetVMInfo()Retrieves a formatted JVM information text.static java.lang.StringgetVMInfo(java.util.Enumeration<java.util.Locale> requestedLocales)Retrieves a formatted JVM information text.static java.lang.StringgetVMInfo(StringManager requestedSm)Retrieve a JVM information text formatted using the given StringManager.static booleanisThreadContentionMonitoringEnabled()Check whether thread contention monitoring is enabled.static booleanisThreadCpuTimeEnabled()Check whether thread cpu time measurement is enabled.static voidresetPeakThreadCount()Reset peak thread count in ThreadMXBeanstatic voidresetPeakUsage(java.lang.String name)Reset peak memory usage data in MemoryPoolMXBeanstatic booleansetCollectionUsageThreshold(java.lang.String name, long threshold)Set collection usage threshold in MemoryPoolMXBeanstatic voidsetLoggerLevel(java.lang.String loggerName, java.lang.String levelName)Set logger levelstatic voidsetThreadContentionMonitoringEnabled(boolean enable)Enable or disable thread contention monitoring via the ThreadMxMXBean.static voidsetThreadCpuTimeEnabled(boolean enable)Enable or disable thread cpu time measurement via the ThreadMxMXBean.static booleansetUsageThreshold(java.lang.String name, long threshold)Set usage threshold in MemoryPoolMXBeanstatic voidsetVerboseClassLoading(boolean verbose)Set verbose class loadingstatic voidsetVerboseGarbageCollection(boolean verbose)Set verbose garbage collection logging
 
- 
- 
- 
Method Detail- 
isThreadContentionMonitoringEnabledpublic static boolean isThreadContentionMonitoringEnabled() Check whether thread contention monitoring is enabled.- Returns:
- true if thread contention monitoring is enabled
 
 - 
setThreadContentionMonitoringEnabledpublic static void setThreadContentionMonitoringEnabled(boolean enable) Enable or disable thread contention monitoring via the ThreadMxMXBean.- Parameters:
- enable- whether to enable thread contention monitoring
 
 - 
isThreadCpuTimeEnabledpublic static boolean isThreadCpuTimeEnabled() Check whether thread cpu time measurement is enabled.- Returns:
- true if thread cpu time measurement is enabled
 
 - 
setThreadCpuTimeEnabledpublic static void setThreadCpuTimeEnabled(boolean enable) Enable or disable thread cpu time measurement via the ThreadMxMXBean.- Parameters:
- enable- whether to enable thread cpu time measurement
 
 - 
resetPeakThreadCountpublic static void resetPeakThreadCount() Reset peak thread count in ThreadMXBean
 - 
setVerboseClassLoadingpublic static void setVerboseClassLoading(boolean verbose) Set verbose class loading- Parameters:
- verbose- whether to enable verbose class loading
 
 - 
setLoggerLevelpublic static void setLoggerLevel(java.lang.String loggerName, java.lang.String levelName)Set logger level- Parameters:
- loggerName- the name of the logger
- levelName- the level to set
 
 - 
setVerboseGarbageCollectionpublic static void setVerboseGarbageCollection(boolean verbose) Set verbose garbage collection logging- Parameters:
- verbose- whether to enable verbose gc logging
 
 - 
gcpublic static void gc() Initiate garbage collection via MX Bean
 - 
resetPeakUsagepublic static void resetPeakUsage(java.lang.String name) Reset peak memory usage data in MemoryPoolMXBean- Parameters:
- name- name of the MemoryPoolMXBean or "all"
 
 - 
setUsageThresholdpublic static boolean setUsageThreshold(java.lang.String name, long threshold)Set usage threshold in MemoryPoolMXBean- Parameters:
- name- name of the MemoryPoolMXBean
- threshold- the threshold to set
- Returns:
- true if setting the threshold succeeded
 
 - 
setCollectionUsageThresholdpublic static boolean setCollectionUsageThreshold(java.lang.String name, long threshold)Set collection usage threshold in MemoryPoolMXBean- Parameters:
- name- name of the MemoryPoolMXBean
- threshold- the collection threshold to set
- Returns:
- true if setting the threshold succeeded
 
 - 
findDeadlockpublic static java.lang.String findDeadlock() Check if any threads are deadlocked. If any, print the thread dump for those threads.- Returns:
- a deadlock message and the formatted thread dump of the deadlocked threads
 
 - 
getThreadDumppublic static java.lang.String getThreadDump() Retrieves a formatted JVM thread dump. The default StringManager will be used.- Returns:
- the formatted JVM thread dump
 
 - 
getThreadDumppublic static java.lang.String getThreadDump(java.util.Enumeration<java.util.Locale> requestedLocales) Retrieves a formatted JVM thread dump. The given list of locales will be used to retrieve a StringManager.- Parameters:
- requestedLocales- list of locales to use
- Returns:
- the formatted JVM thread dump
 
 - 
getThreadDumppublic static java.lang.String getThreadDump(StringManager requestedSm) Retrieve a JVM thread dump formatted using the given StringManager.- Parameters:
- requestedSm- the StringManager to use
- Returns:
- the formatted JVM thread dump
 
 - 
getVMInfopublic static java.lang.String getVMInfo() Retrieves a formatted JVM information text. The default StringManager will be used.- Returns:
- the formatted JVM information text
 
 - 
getVMInfopublic static java.lang.String getVMInfo(java.util.Enumeration<java.util.Locale> requestedLocales) Retrieves a formatted JVM information text. The given list of locales will be used to retrieve a StringManager.- Parameters:
- requestedLocales- list of locales to use
- Returns:
- the formatted JVM information text
 
 - 
getVMInfopublic static java.lang.String getVMInfo(StringManager requestedSm) Retrieve a JVM information text formatted using the given StringManager.- Parameters:
- requestedSm- the StringManager to use
- Returns:
- the formatted JVM information text
 
 
- 
 
-