Class HeapDumpWebEndpoint
- java.lang.Object
- org.springframework.boot.actuate.management.HeapDumpWebEndpoint
@WebEndpoint(id="heapdump") public class HeapDumpWebEndpoint extends Object
WebEndpointto expose heap dumps.- Since:
- 2.0.0
Nested Class Summary
Nested Classes Modifier and Type Class Description protected static interfaceHeapDumpWebEndpoint.HeapDumperStrategy interface used to dump the heap to a file.protected static classHeapDumpWebEndpoint.HeapDumperUnavailableExceptionException to be thrown if theHeapDumpWebEndpoint.HeapDumpercannot be created.protected static classHeapDumpWebEndpoint.HotSpotDiagnosticMXBeanHeapDumperHeapDumpWebEndpoint.HeapDumperthat usescom.sun.management.HotSpotDiagnosticMXBeanavailable on Oracle and OpenJDK to dump the heap to a file.
Constructor Summary
Constructors Modifier Constructor Description HeapDumpWebEndpoint()protectedHeapDumpWebEndpoint(long timeout)
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected HeapDumpWebEndpoint.HeapDumpercreateHeapDumper()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