Class HeapDumpWebEndpoint
- java.lang.Object
- org.springframework.boot.actuate.management.HeapDumpWebEndpoint
@WebEndpoint(id="heapdump") public class HeapDumpWebEndpoint extends Object
WebEndpoint
to expose heap dumps.- Since:
- 2.0.0
Nested Class Summary
Nested Classes Modifier and Type Class 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 theHeapDumpWebEndpoint.HeapDumper
cannot be created.protected static class
HeapDumpWebEndpoint.HotSpotDiagnosticMXBeanHeapDumper
HeapDumpWebEndpoint.HeapDumper
that usescom.sun.management.HotSpotDiagnosticMXBean
available on Oracle and OpenJDK to dump the heap to a file.
Constructor Summary
Constructors Modifier Constructor Description HeapDumpWebEndpoint()
protected
HeapDumpWebEndpoint(long timeout)
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected HeapDumpWebEndpoint.HeapDumper
createHeapDumper()
Factory method used to create theHeapDumpWebEndpoint.HeapDumper
.WebEndpointResponse<org.springframework.core.io.Resource>
heapDump(Boolean live)
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 theHeapDumpWebEndpoint.HeapDumper
.- Returns:
- the heap dumper to use
- Throws:
HeapDumpWebEndpoint.HeapDumperUnavailableException
- if the heap dumper cannot be created