blasd.apex.core.jvm

Class GCInspector

java.lang.Object

blasd.apex.core.jvm.GCInspector

All Implemented Interfaces:

IGCInspector, IApexMemoryConstants, EventListener, NotificationListener, org.springframework.beans.factory.DisposableBean, org.springframework.beans.factory.InitializingBean

@ManagedResource
public class GCInspector
extends Object
implements NotificationListener, org.springframework.beans.factory.InitializingBean, org.springframework.beans.factory.DisposableBean, IGCInspector

This class registers itself as listener on GC events. It will produce a thread-dump when long GC pauses happens

Since:

Oracle Java 7 update 4 JVM

Author:

Benoit Lacelle

Field Summary

Fields

Modifier and Type	Field and Description
protected IApexThreadDumper	apexThreadDumper
static float	BETWEEN_MINUS_ONE_AND_ZERO
static long	DEFAULT_GCDURATION_MILLIS_INFO_LOG Any time a GC lasts longer than this duration, we log details about the GC
static long	DEFAULT_MARKSWEEP_MILLIS_HEAPHISTOGRAM
static long	DEFAULT_MARKSWEEP_MILLIS_THREADDUMP If a MarkSweep GC lasts more than this duration, we log a ThreadDump
static long	DEFAULT_MAX_HEAP_GB_HEAPHISTOGRAM
protected AtomicLong	firstGcNotZero Remember the length of the first GC, which is used as heuristic to know if GC times are expressed in ms or ns
static Set<String>	FULL_GC_NAMES
protected long	gcDurationMillisForInfoLog
protected AtomicReference<org.joda.time.LocalDateTime>	latestThreadDump
protected static org.slf4j.Logger	LOGGER
protected long	marksweepDurationMillisForHeapHistogram
protected long	marksweepDurationMillisForThreadDump
protected static long	MAX_FIRST_PAUSE_MS If the first GC pause is bigger than this size, we expect GC pauses are expressed in NS
protected long	maxHeapGbForHeapHistogram
protected static MBeanServer	MBEAN_SERVER
protected static List<MemoryPoolMXBean>	MEMORY_POOLS_MBEAN
static int	NS_TO_MS Deprecated. One should use TimeUnit.NANOSECONDS.toMillis(timeInNs)
protected static OperatingSystemMXBean	OS_MBEAN
protected static ThreadMXBean	THREAD_MBEAN

Fields inherited from interface blasd.apex.core.jvm.IGCInspector

BARRIER_FOR_SIZE_IN_LOG

Fields inherited from interface blasd.apex.core.memory.IApexMemoryConstants

CHAR, DOUBLE, FLOAT, GB, INT, KB, KB_INT, LONG, MB, MB_INT, OBJECT, TB

Constructor Summary

Constructors

Constructor and Description
GCInspector(IApexThreadDumper apexThreadDumper)

Method Summary

Modifier and Type	Method and Description
protected void	addShutdownHook() Deprecated.
protected void	adjustWithReference(com.google.common.util.concurrent.AtomicLongMap<String> currentHeapToAdjust, Map<? extends String,? extends Long> reference)
void	afterPropertiesSet()
protected void	appendCPU(StringBuilder sb)
protected void	appendCurrentGCDuration(StringBuilder sb, com.sun.management.GarbageCollectionNotificationInfo info, long duration)
protected void	appendDetailsAboutMove(StringBuilder sb, long totalAfterMinusbefore, long totalHeapUsedBefore)
protected void	appendDirectMemoryAndThreads(StringBuilder sb)
protected void	appendHeap(StringBuilder sb, long totalHeapUsedAfter)
protected void	appendMovedMemory(StringBuilder sb, String key, MemoryUsage before, MemoryUsage after)
protected void	appendPercentage(StringBuilder sb, long numerator, long denominator)
static void	appendSize(StringBuilder sb, long size)
void	clearAllocatedHeapReference()
protected long	computeDurationMs(com.sun.management.GarbageCollectionNotificationInfo info)
static <T> Map<T,String>	convertByteValueToString(Map<T,Long> threadNameToAllocatedHeap)
void	destroy() Clean the MBean registration.
protected BufferPoolMXBean	directMemoryStatus()
protected void	doLog(com.sun.management.GarbageCollectionNotificationInfo info)
protected void	executeDuringShutdown()
String	getAllThreads(boolean withoutMonitors)
String	getAllThreadsSmart(boolean withoutMonitors)
String	getAndLogCurrentMemoryStatus()
protected Map<? extends String,? extends Long>	getAndSetByThreadRef(Map<? extends String,? extends Long> immutableCurrentHeapByThread)
protected String	getCurrentMemoryStatusMessage()
String	getHeapHistogram()
static String	getHeapHistogramAsString(int nbRows)
Date	getLatestThreadDump()
long	getMarksweepDurationMillisForHeapHistogram()
long	getMarksweepDurationMillisForThreadDump()
protected static long	getMaxDirectMemorySize()
protected long	getMaxHeap()
long	getMaxHeapGbForHeapHistogram()
static String	getNiceBytes(long size)
protected NavigableSet<String>	getSortedGCKeys(com.sun.management.GarbageCollectionNotificationInfo info)
Map<String,String>	getThreadGroupsToAllocatedHeapNiceString()
protected Map<? extends String,? extends Long>	getThreadNameToAllocatedHeap()
Map<String,String>	getThreadNameToAllocatedHeapNiceString()
protected long	getUsedHeap()
protected com.google.common.util.concurrent.AtomicLongMap<String>	groupThreadNames(Map<String,Long> threadNameToAllocatedHeap)
void	handleNotification(Notification notification, Object handback)
static boolean	inUnitTest()
protected boolean	isFullGC(com.sun.management.GarbageCollectionNotificationInfo info)
protected boolean	isOverThreashold(long heapUsed, long heapMax)
protected void	logIfMemoryOverCap()
protected String	makeGCMessage(com.sun.management.GarbageCollectionNotificationInfo info)
void	markNowAsAllocatedHeapReference()
protected void	onFullGC(com.sun.management.GarbageCollectionNotificationInfo info)
protected void	onMemoryBackUnderThreshold(long heapUsed, long heapMax)
protected void	onOverHeapAlertSinceTooLong(org.joda.time.LocalDateTime overThresholdSince)
protected void	printHeapHistogram(int nbRows)
protected void	printSmartThreadDump()
protected void	printThreadDump()
protected void	removeNotificationListener()
long	saveHeapDump(String path, boolean gzipped)
void	setMarksweepDurationMillisForHeapHistogram(long marksweepDurationMillisForHeapHistogram)
void	setMarksweepDurationMillisForThreadDump(long marksweepDurationMillisForThreadDump)
void	setMaxHeapGbForHeapHistogram(long maxHeapGbForHeapHistogram)
static void	streamHeapHistogram(OutputStream os, int nbRows)

Methods inherited from class java.lang.Object

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

Field Detail

LOGGER

protected static final org.slf4j.Logger LOGGER

firstGcNotZero

protected final AtomicLong firstGcNotZero

Remember the length of the first GC, which is used as heuristic to know if GC times are expressed in ms or ns

MAX_FIRST_PAUSE_MS

protected static final long MAX_FIRST_PAUSE_MS

If the first GC pause is bigger than this size, we expect GC pauses are expressed in NS

See Also:

Constant Field Values

NS_TO_MS

@Deprecated
public static final int NS_TO_MS

Deprecated. One should use TimeUnit.NANOSECONDS.toMillis(timeInNs)

See Also:

Constant Field Values

BETWEEN_MINUS_ONE_AND_ZERO

public static final float BETWEEN_MINUS_ONE_AND_ZERO

See Also:

Constant Field Values

DEFAULT_GCDURATION_MILLIS_INFO_LOG

public static final long DEFAULT_GCDURATION_MILLIS_INFO_LOG

Any time a GC lasts longer than this duration, we log details about the GC

See Also:

Constant Field Values

gcDurationMillisForInfoLog

protected long gcDurationMillisForInfoLog

DEFAULT_MARKSWEEP_MILLIS_THREADDUMP

public static final long DEFAULT_MARKSWEEP_MILLIS_THREADDUMP

If a MarkSweep GC lasts more than this duration, we log a ThreadDump

See Also:

Constant Field Values

marksweepDurationMillisForThreadDump

protected long marksweepDurationMillisForThreadDump

DEFAULT_MARKSWEEP_MILLIS_HEAPHISTOGRAM

public static final long DEFAULT_MARKSWEEP_MILLIS_HEAPHISTOGRAM

See Also:

Constant Field Values

marksweepDurationMillisForHeapHistogram

protected long marksweepDurationMillisForHeapHistogram

DEFAULT_MAX_HEAP_GB_HEAPHISTOGRAM

public static final long DEFAULT_MAX_HEAP_GB_HEAPHISTOGRAM

See Also:

Constant Field Values

maxHeapGbForHeapHistogram

protected long maxHeapGbForHeapHistogram

MBEAN_SERVER

protected static final MBeanServer MBEAN_SERVER

OS_MBEAN

protected static final OperatingSystemMXBean OS_MBEAN

THREAD_MBEAN

protected static final ThreadMXBean THREAD_MBEAN

MEMORY_POOLS_MBEAN

protected static final List<MemoryPoolMXBean> MEMORY_POOLS_MBEAN

latestThreadDump

protected AtomicReference<org.joda.time.LocalDateTime> latestThreadDump

apexThreadDumper

protected final IApexThreadDumper apexThreadDumper

FULL_GC_NAMES

public static final Set<String> FULL_GC_NAMES

Constructor Detail

GCInspector

public GCInspector(IApexThreadDumper apexThreadDumper)

Method Detail

afterPropertiesSet

public void afterPropertiesSet()
                        throws MalformedObjectNameException,
                               InstanceNotFoundException

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

Throws:

MalformedObjectNameException

InstanceNotFoundException

addShutdownHook

@Deprecated
protected void addShutdownHook()

Deprecated.

executeDuringShutdown

protected void executeDuringShutdown()

inUnitTest

public static boolean inUnitTest()

destroy

public void destroy()
             throws Exception

Clean the MBean registration. Else, unit-test would register several GCInexpector (one for each Context loaded)

Specified by:

destroy in interface org.springframework.beans.factory.DisposableBean

Throws:

Exception

removeNotificationListener

protected void removeNotificationListener()
                                   throws MalformedObjectNameException,
                                          ListenerNotFoundException

Throws:

MalformedObjectNameException

ListenerNotFoundException

handleNotification

public void handleNotification(Notification notification,
                               Object handback)

Specified by:

handleNotification in interface NotificationListener

computeDurationMs

protected long computeDurationMs(com.sun.management.GarbageCollectionNotificationInfo info)

makeGCMessage

protected String makeGCMessage(com.sun.management.GarbageCollectionNotificationInfo info)

appendMovedMemory

protected void appendMovedMemory(StringBuilder sb,
                                 String key,
                                 MemoryUsage before,
                                 MemoryUsage after)

getSortedGCKeys

protected NavigableSet<String> getSortedGCKeys(com.sun.management.GarbageCollectionNotificationInfo info)

appendCurrentGCDuration

protected void appendCurrentGCDuration(StringBuilder sb,
                                       com.sun.management.GarbageCollectionNotificationInfo info,
                                       long duration)

appendHeap

protected void appendHeap(StringBuilder sb,
                          long totalHeapUsedAfter)

appendDetailsAboutMove

protected void appendDetailsAboutMove(StringBuilder sb,
                                      long totalAfterMinusbefore,
                                      long totalHeapUsedBefore)

getAndSetByThreadRef

protected Map<? extends String,? extends Long> getAndSetByThreadRef(Map<? extends String,? extends Long> immutableCurrentHeapByThread)

getCurrentMemoryStatusMessage

protected String getCurrentMemoryStatusMessage()

appendCPU

protected void appendCPU(StringBuilder sb)

appendDirectMemoryAndThreads

protected void appendDirectMemoryAndThreads(StringBuilder sb)

appendPercentage

protected void appendPercentage(StringBuilder sb,
                                long numerator,
                                long denominator)

appendSize

public static void appendSize(StringBuilder sb,
                              long size)

getNiceBytes

public static String getNiceBytes(long size)

doLog

protected void doLog(com.sun.management.GarbageCollectionNotificationInfo info)

onFullGC

protected void onFullGC(com.sun.management.GarbageCollectionNotificationInfo info)

logIfMemoryOverCap

protected void logIfMemoryOverCap()

isOverThreashold

protected boolean isOverThreashold(long heapUsed,
                                   long heapMax)

getUsedHeap

protected long getUsedHeap()

getMaxHeap

protected long getMaxHeap()

onMemoryBackUnderThreshold

protected void onMemoryBackUnderThreshold(long heapUsed,
                                          long heapMax)

onOverHeapAlertSinceTooLong

protected void onOverHeapAlertSinceTooLong(org.joda.time.LocalDateTime overThresholdSince)

isFullGC

protected boolean isFullGC(com.sun.management.GarbageCollectionNotificationInfo info)

printThreadDump

protected void printThreadDump()

printSmartThreadDump

protected void printSmartThreadDump()

printHeapHistogram

protected void printHeapHistogram(int nbRows)

getHeapHistogramAsString

public static String getHeapHistogramAsString(int nbRows)

streamHeapHistogram

public static void streamHeapHistogram(OutputStream os,
                                       int nbRows)

getMaxDirectMemorySize

protected static long getMaxDirectMemorySize()

Returns:

the maximum direct memory size

directMemoryStatus

protected BufferPoolMXBean directMemoryStatus()

getLatestThreadDump

@ManagedAttribute
public Date getLatestThreadDump()

setMarksweepDurationMillisForThreadDump

@ManagedAttribute
public void setMarksweepDurationMillisForThreadDump(long marksweepDurationMillisForThreadDump)

Specified by:

setMarksweepDurationMillisForThreadDump in interface IGCInspector

getMarksweepDurationMillisForThreadDump

@ManagedAttribute
public long getMarksweepDurationMillisForThreadDump()

Specified by:

getMarksweepDurationMillisForThreadDump in interface IGCInspector

setMarksweepDurationMillisForHeapHistogram

@ManagedAttribute
public void setMarksweepDurationMillisForHeapHistogram(long marksweepDurationMillisForHeapHistogram)

Specified by:

setMarksweepDurationMillisForHeapHistogram in interface IGCInspector

getMarksweepDurationMillisForHeapHistogram

@ManagedAttribute
public long getMarksweepDurationMillisForHeapHistogram()

Specified by:

getMarksweepDurationMillisForHeapHistogram in interface IGCInspector

setMaxHeapGbForHeapHistogram

@ManagedAttribute
public void setMaxHeapGbForHeapHistogram(long maxHeapGbForHeapHistogram)

Specified by:

setMaxHeapGbForHeapHistogram in interface IGCInspector

getMaxHeapGbForHeapHistogram

@ManagedAttribute
public long getMaxHeapGbForHeapHistogram()

Specified by:

getMaxHeapGbForHeapHistogram in interface IGCInspector

markNowAsAllocatedHeapReference

@ManagedOperation
public void markNowAsAllocatedHeapReference()

Specified by:

markNowAsAllocatedHeapReference in interface IGCInspector

clearAllocatedHeapReference

@ManagedOperation
public void clearAllocatedHeapReference()

Specified by:

clearAllocatedHeapReference in interface IGCInspector

getThreadNameToAllocatedHeap

protected Map<? extends String,? extends Long> getThreadNameToAllocatedHeap()

getThreadNameToAllocatedHeapNiceString

@ManagedAttribute
public Map<String,String> getThreadNameToAllocatedHeapNiceString()

Specified by:

getThreadNameToAllocatedHeapNiceString in interface IGCInspector

adjustWithReference

protected void adjustWithReference(com.google.common.util.concurrent.AtomicLongMap<String> currentHeapToAdjust,
                                   Map<? extends String,? extends Long> reference)

getThreadGroupsToAllocatedHeapNiceString

@ManagedAttribute
public Map<String,String> getThreadGroupsToAllocatedHeapNiceString()

Specified by:

getThreadGroupsToAllocatedHeapNiceString in interface IGCInspector

groupThreadNames

protected com.google.common.util.concurrent.AtomicLongMap<String> groupThreadNames(Map<String,Long> threadNameToAllocatedHeap)

convertByteValueToString

public static <T> Map<T,String> convertByteValueToString(Map<T,Long> threadNameToAllocatedHeap)

getAllThreads

@ManagedOperation
public String getAllThreads(boolean withoutMonitors)

Specified by:

getAllThreads in interface IGCInspector

Parameters:

withoutMonitors - JConsole will set withoutMonitors = true by default

Returns:

a formatted thread-dump

getAllThreadsSmart

@ManagedOperation
public String getAllThreadsSmart(boolean withoutMonitors)

Specified by:

getAllThreadsSmart in interface IGCInspector

Parameters:

withoutMonitors - JConsole will set withoutMonitors = true by default

getHeapHistogram

@ManagedOperation
public String getHeapHistogram()

Specified by:

getHeapHistogram in interface IGCInspector

saveHeapDump

public long saveHeapDump(String path,
                         boolean gzipped)

Specified by:

saveHeapDump in interface IGCInspector

getAndLogCurrentMemoryStatus

@ManagedOperation
public String getAndLogCurrentMemoryStatus()

Specified by:

getAndLogCurrentMemoryStatus in interface IGCInspector