Package org.springframework.boot.actuate.management

Class HeapDumpWebEndpoint.HotSpotDiagnosticMXBeanHeapDumper

java.lang.Object

org.springframework.boot.actuate.management.HeapDumpWebEndpoint.HotSpotDiagnosticMXBeanHeapDumper

All Implemented Interfaces:

HeapDumpWebEndpoint.HeapDumper

Enclosing class:

HeapDumpWebEndpoint

protected static class HeapDumpWebEndpoint.HotSpotDiagnosticMXBeanHeapDumper
extends Object
implements HeapDumpWebEndpoint.HeapDumper

HeapDumpWebEndpoint.HeapDumper that uses com.sun.management.HotSpotDiagnosticMXBean, available on Oracle and OpenJDK, to dump the heap to a file.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	HotSpotDiagnosticMXBeanHeapDumper()

Method Summary

Modifier and Type	Method	Description
File	dumpHeap(Boolean live)	Dump the current heap to a file.

Methods inherited from class java.lang.Object

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

Constructor Details

HotSpotDiagnosticMXBeanHeapDumper

protected HotSpotDiagnosticMXBeanHeapDumper()

Method Details

dumpHeap

public File dumpHeap(Boolean live)
              throws IOException

Description copied from interface: HeapDumpWebEndpoint.HeapDumper

Dump the current heap to a file.

Specified by:

dumpHeap in interface HeapDumpWebEndpoint.HeapDumper

Parameters:

live - if only live objects (i.e. objects that are reachable from others) should be dumped. May be null to use a JVM-specific default.

Returns:

the file containing the heap dump

Throws:

IOException - on IO error