org.springframework.boot.actuate.endpoint.mvc

Class HeapdumpMvcEndpoint

java.lang.Object

org.springframework.boot.actuate.endpoint.mvc.AbstractMvcEndpoint

org.springframework.boot.actuate.endpoint.mvc.AbstractNamedMvcEndpoint

org.springframework.boot.actuate.endpoint.mvc.HeapdumpMvcEndpoint

All Implemented Interfaces:

Aware, MvcEndpoint, NamedMvcEndpoint, EnvironmentAware, WebMvcConfigurer

@ConfigurationProperties(prefix="endpoints.heapdump")
 @HypermediaDisabled
public class HeapdumpMvcEndpoint
extends AbstractNamedMvcEndpoint

MvcEndpoint to expose heap dumps.

Since:

1.4.0

Author:

Lari Hotari, Phillip Webb, Raja Kolli

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static interface	HeapdumpMvcEndpoint.HeapDumper Strategy interface used to dump the heap to a file.
protected static class	HeapdumpMvcEndpoint.HeapDumperUnavailableException Exception to be thrown if the HeapdumpMvcEndpoint.HeapDumper cannot be created.
protected static class	HeapdumpMvcEndpoint.HotSpotDiagnosticMXBeanHeapDumper HeapdumpMvcEndpoint.HeapDumper that uses com.sun.management.HotSpotDiagnosticMXBean available on Oracle and OpenJDK to dump the heap to a file.

Field Summary

Fields inherited from interface org.springframework.boot.actuate.endpoint.mvc.MvcEndpoint

DISABLED_RESPONSE

Constructor Summary

Constructors

Modifier	Constructor and Description
	HeapdumpMvcEndpoint()
protected	HeapdumpMvcEndpoint(long timeout)

Method Summary

Modifier and Type	Method and Description
protected HeapdumpMvcEndpoint.HeapDumper	createHeapDumper() Factory method used to create the HeapdumpMvcEndpoint.HeapDumper.
protected void	handle(File heapDumpFile, HttpServletRequest request, HttpServletResponse response) Handle the heap dump file and respond.
void	invoke(boolean live, HttpServletRequest request, HttpServletResponse response)

Methods inherited from class org.springframework.boot.actuate.endpoint.mvc.AbstractNamedMvcEndpoint

getName

Methods inherited from class org.springframework.boot.actuate.endpoint.mvc.AbstractMvcEndpoint

getEndpointType, getEnvironment, getPath, isEnabled, isSensitive, setEnabled, setEnvironment, setPath, setSensitive

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.boot.actuate.endpoint.mvc.MvcEndpoint

getEndpointType, getPath, isSensitive

Methods inherited from interface org.springframework.web.servlet.config.annotation.WebMvcConfigurer

addArgumentResolvers, addCorsMappings, addFormatters, addInterceptors, addResourceHandlers, addReturnValueHandlers, addViewControllers, configureAsyncSupport, configureContentNegotiation, configureDefaultServletHandling, configureHandlerExceptionResolvers, configureMessageConverters, configurePathMatch, configureViewResolvers, extendHandlerExceptionResolvers, extendMessageConverters, getMessageCodesResolver, getValidator

Constructor Detail

HeapdumpMvcEndpoint

public HeapdumpMvcEndpoint()

HeapdumpMvcEndpoint

protected HeapdumpMvcEndpoint(long timeout)

Method Detail

invoke

@RequestMapping(method=GET,
                produces="application/octet-stream")
public void invoke(@RequestParam(defaultValue="true")
                                                                                                    boolean live,
                                                                                                    HttpServletRequest request,
                                                                                                    HttpServletResponse response)
                                                                                             throws IOException,
                                                                                                    ServletException

Throws:

IOException

ServletException

createHeapDumper

protected HeapdumpMvcEndpoint.HeapDumper createHeapDumper()
                                                   throws HeapdumpMvcEndpoint.HeapDumperUnavailableException

Factory method used to create the HeapdumpMvcEndpoint.HeapDumper.

Returns:

the heap dumper to use

Throws:

HeapdumpMvcEndpoint.HeapDumperUnavailableException - if the heap dumper cannot be created

handle

protected void handle(File heapDumpFile,
                      HttpServletRequest request,
                      HttpServletResponse response)
               throws ServletException,
                      IOException

Handle the heap dump file and respond. By default this method will return the response as a GZip stream.

Parameters:

heapDumpFile - the generated dump file

request - the HTTP request

response - the HTTP response

Throws:

ServletException - on servlet error

IOException - on IO error