org.springframework.boot.actuate.management

Class HeapDumpWebEndpoint

java.lang.Object

org.springframework.boot.actuate.management.HeapDumpWebEndpoint

@Endpoint(id="heapdump",
          exposure=WEB)
public class HeapDumpWebEndpoint
extends Object

Web Endpoint to expose heap dumps.

Since:

2.0.0

Author:

Lari Hotari, Phillip Webb, Raja Kolli, Andy Wilkinson

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static interface	HeapDumpWebEndpoint.HeapDumper Strategy interface used to dump the heap to a file.
protected static class	HeapDumpWebEndpoint.HeapDumperUnavailableException Exception to be thrown if the HeapDumpWebEndpoint.HeapDumper cannot be created.
protected static class	HeapDumpWebEndpoint.HotSpotDiagnosticMXBeanHeapDumper 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 and Description
	HeapDumpWebEndpoint()
protected	HeapDumpWebEndpoint(long timeout)

Method Summary

Modifier and Type	Method and Description
protected HeapDumpWebEndpoint.HeapDumper	createHeapDumper() Factory method used to create the HeapDumpWebEndpoint.HeapDumper.
WebEndpointResponse<org.springframework.core.io.Resource>	heapDump(Boolean live)

Methods inherited from class java.lang.Object

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

Constructor Detail

HeapDumpWebEndpoint

public HeapDumpWebEndpoint()

HeapDumpWebEndpoint

protected HeapDumpWebEndpoint(long timeout)

Method Detail

heapDump

@ReadOperation
public WebEndpointResponse<org.springframework.core.io.Resource> heapDump(@Nullable
                                                                                         Boolean live)

createHeapDumper

protected HeapDumpWebEndpoint.HeapDumper createHeapDumper()
                                                   throws HeapDumpWebEndpoint.HeapDumperUnavailableException

Factory method used to create the HeapDumpWebEndpoint.HeapDumper.

Returns:

the heap dumper to use

Throws:

HeapDumpWebEndpoint.HeapDumperUnavailableException - if the heap dumper cannot be created