1. Overview

1.1. URLs

By default, all web endpoints are available beneath the path /actuator with URLs of
the form /actuator/{id}. The /actuator base path can be configured by using the
management.endpoints.web.base-path property, as shown in the following example:

management.endpoints.web.base-path=/manage

The preceding application.properties example changes the form of the endpoint URLs from
/actuator/{id} to /manage/{id}. For example, the URL info endpoint would become
/manage/info.

1.2. Timestamps

All timestamps that are consumed by the endpoints, either as query parameters or in the
request body, must be formatted as an offset date and time as specified in
ISO 8601.

2. Audit Events (auditevents)

The auditevents endpoint provides information about the application’s audit events.

2.1. Retrieving Audit Events

To retrieve the audit events, make a GET request to /actuator/auditevents, as shown
in the following curl-based example:

8.1.1. Response Structure

The response contains details of the health of the application. The following table
describes the structure of the response:

Path

Type

Description

status

String

Overall status of the application.

details

Object

Details of the health of the application. Presence is controlled by management.endpoint.health.show-details).

details.*.status

String

Status of a specific part of the application.

details.*.details

Object

Details of the health of a specific part of the application.

9. Heap Dump (heapdump)

The heapdump endpoint provides a heap dump from the application’s JVM.

9.1. Retrieving the Heap Dump

To retrieve the heap dump, make a GET request to /actuator/heapdump. The response
is binary data in
HPROF format and can be large. Typically, you should save the response to disk for
subsequent analysis. When using curl, this can be achieved by using the -O option,
as shown in the following example:

$ curl 'http://localhost:8080/actuator/heapdump' -O

The preceding example results in a file named heapdump being written to the current
working directory.

15.1.1. Response Structure

The response contains details of the application’s mappings. The items found in the
response depend on the type of web application (reactive or Servlet-based). The
following table describes the structure of the common elements of the response:

Path

Type

Description

contexts

Object

Application contexts keyed by id.

contexts.*.mappings

Object

Mappings in the context, keyed by mapping type.

contexts.*.mappings.dispatcherServlets

Object

Dispatcher servlet mappings, if any.

contexts.*.mappings.servletFilters

Array

Servlet filter mappings, if any.

contexts.*.mappings.servlets

Array

Servlet mappings, if any.

contexts.*.mappings.dispatcherHandlers

Object

Dispatcher handler mappings, if any.

contexts.*.parentId

String

Id of the parent application context, if any.

The entries that may be found in contexts.*.mappings are described in the
following sections.

15.1.2. Dispatcher Servlets Response Structure

When using Spring MVC, the response contains details of any DispatcherServlet
request mappings beneath contexts.*.mappings.dispatcherServlets. The following
table describes the structure of this section of the response:

Details of the method, if any, that will handle requests to this mapping.

*.[].details.handlerMethod.className

String

Fully qualified name of the class of the method.

*.[].details.handlerMethod.name

String

Name of the method.

*.[].details.handlerMethod.descriptor

String

Descriptor of the method as specified in the Java Language Specification.

*.[].details.requestMappingConditions

Object

Details of the request mapping conditions.

*.[].details.requestMappingConditions.consumes

Array

Details of the consumes condition

*.[].details.requestMappingConditions.consumes.[].mediaType

String

Consumed media type.

*.[].details.requestMappingConditions.consumes.[].negated

Boolean

Whether the media type is negated.

*.[].details.requestMappingConditions.headers

Array

Details of the headers condition.

*.[].details.requestMappingConditions.headers.[].name

String

Name of the header.

*.[].details.requestMappingConditions.headers.[].value

String

Required value of the header, if any.

*.[].details.requestMappingConditions.headers.[].negated

Boolean

Whether the value is negated.

*.[].details.requestMappingConditions.methods

Array

HTTP methods that are handled.

*.[].details.requestMappingConditions.params

Array

Details of the params condition.

*.[].details.requestMappingConditions.params.[].name

String

Name of the parameter.

*.[].details.requestMappingConditions.params.[].value

String

Required value of the parameter, if any.

*.[].details.requestMappingConditions.params.[].negated

Boolean

Whether the value is negated.

*.[].details.requestMappingConditions.patterns

Array

Patterns identifying the paths handled by the mapping.

*.[].details.requestMappingConditions.produces

Array

Details of the produces condition.

*.[].details.requestMappingConditions.produces.[].mediaType

String

Produced media type.

*.[].details.requestMappingConditions.produces.[].negated

Boolean

Whether the media type is negated.

15.1.3. Servlets Response Structure

When using the Servlet stack, the response contains details of any Servlet mappings
beneath contexts.*.mappings.servlets. The following table describes the structure of
this section of the response:

Path

Type

Description

[].mappings

Array

Mappings of the servlet.

[].name

String

Name of the servlet.

[].className

String

Class name of the servlet

15.1.4. Servlet Filters Response Structure

When using the Servlet stack, the response contains details of any Filter mappings
beneath contexts.*.mappings.servletFilters. The following table describes the
structure of this section of the response:

Path

Type

Description

[].servletNameMappings

Array

Names of the servlets to which the filter is mapped.

[].urlPatternMappings

Array

URL pattern to which the filter is mapped.

[].name

String

Name of the filter.

[].className

String

Class name of the filter

15.1.5. Dispatcher Handlers Response Structure

When using Spring WebFlux, the response contains details of any DispatcherHandler
request mappings beneath contexts.*.mappings.dispatcherHandlers. The following
table describes the structure of this section of the response:

The preceding example retrieves the jvm.memory.max metric, where the area tag has a
value of nonheap and the id attribute has a value of Compressed Class Space. The
resulting response is similar to the following: