This API documentation describes Spring Boot Actuators web endpoints.
1. Overview
Before you proceed, you should read the following topics:
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:
$ curl 'http://localhost:8080/actuator/auditevents?principal=alice&after=2019-10-02T14%3A30%3A25.351Z&type=logout' -i -X GET
The preceding example retrieves logout
events for the principal, alice
, that occurred after 09:37 on 7 November 2017 in the UTC timezone.
The resulting response is similar to the following:
HTTP/1.1 200 OK
Content-Type: application/vnd.spring-boot.actuator.v2+json;charset=UTF-8
Content-Length: 121
{
"events" : [ {
"timestamp" : "2019-10-02T14:30:25.352Z",
"principal" : "alice",
"type" : "logout"
} ]
}
2.1.1. Query Parameters
The endpoint uses query parameters to limit the events that it returns. The following table shows the supported query parameters:
Parameter | Description |
---|---|
|
Restricts the events to those that occurred after the given time. Optional. |
|
Restricts the events to those with the given principal. Optional. |
|
Restricts the events to those with the given type. Optional. |
2.1.2. Response Structure
The response contains details of all of the audit events that matched the query. The following table describes the structure of the response:
Path | Type | Description |
---|---|---|
|
|
An array of audit events. |
|
|
The timestamp of when the event occurred. |
|
|
The principal that triggered the event. |
|
|
The type of the event. |
3. Beans (beans
)
The beans
endpoint provides information about the application’s beans.
3.1. Retrieving the Beans
To retrieve the beans, make a GET
request to /actuator/beans
, as shown in the following curl-based example:
$ curl 'http://localhost:8080/actuator/beans' -i -X GET
The resulting response is similar to the following:
HTTP/1.1 200 OK
Content-Type: application/vnd.spring-boot.actuator.v2+json;charset=UTF-8
Content-Length: 1128
{
"contexts" : {
"application" : {
"beans" : {
"defaultServletHandlerMapping" : {
"aliases" : [ ],
"scope" : "singleton",
"type" : "org.springframework.web.servlet.HandlerMapping",
"resource" : "class path resource [org/springframework/boot/autoconfigure/web/servlet/WebMvcAutoConfiguration$EnableWebMvcConfiguration.class]",
"dependencies" : [ ]
},
"org.springframework.boot.autoconfigure.context.PropertyPlaceholderAutoConfiguration" : {
"aliases" : [ ],
"scope" : "singleton",
"type" : "org.springframework.boot.autoconfigure.context.PropertyPlaceholderAutoConfiguration$$EnhancerBySpringCGLIB$$49a5846e",
"dependencies" : [ ]
},
"org.springframework.boot.autoconfigure.web.servlet.DispatcherServletAutoConfiguration" : {
"aliases" : [ ],
"scope" : "singleton",
"type" : "org.springframework.boot.autoconfigure.web.servlet.DispatcherServletAutoConfiguration$$EnhancerBySpringCGLIB$$375166f2",
"dependencies" : [ ]
}
}
}
}
}
3.1.1. Response Structure
The response contains details of the application’s beans. The following table describes the structure of the response:
Path | Type | Description |
---|---|---|
|
|
Application contexts keyed by id. |
|
|
Id of the parent application context, if any. |
|
|
Beans in the application context keyed by name. |
|
|
Names of any aliases. |
|
|
Scope of the bean. |
|
|
Fully qualified type of the bean. |
|
|
Resource in which the bean was defined, if any. |
|
|
Names of any dependencies. |
4. Caches (caches
)
The caches
endpoint provides access to the application’s caches.
4.1. Retrieving All Caches
To retrieve the application’s caches, make a GET
request to /actuator/caches
, as shown in the following curl-based example:
$ curl 'http://localhost:8080/actuator/caches' -i -X GET
The resulting response is similar to the following:
HTTP/1.1 200 OK
Content-Type: application/vnd.spring-boot.actuator.v2+json;charset=UTF-8
Content-Length: 435
{
"cacheManagers" : {
"anotherCacheManager" : {
"caches" : {
"countries" : {
"target" : "java.util.concurrent.ConcurrentHashMap"
}
}
},
"cacheManager" : {
"caches" : {
"cities" : {
"target" : "java.util.concurrent.ConcurrentHashMap"
},
"countries" : {
"target" : "java.util.concurrent.ConcurrentHashMap"
}
}
}
}
}
4.1.1. Response Structure
The response contains details of the application’s caches. The following table describes the structure of the response:
Path | Type | Description |
---|---|---|
|
|
Cache managers keyed by id. |
|
|
Caches in the application context keyed by name. |
|
|
Fully qualified name of the native cache. |
4.2. Retrieving Caches by Name
To retrieve a cache by name, make a GET
request to /actuator/caches/{name}
, as shown in the following curl-based example:
$ curl 'http://localhost:8080/actuator/caches/cities' -i -X GET
The preceding example retrieves information about the cache named cities
.
The resulting response is similar to the following:
HTTP/1.1 200 OK
Content-Type: application/vnd.spring-boot.actuator.v2+json;charset=UTF-8
Content-Length: 113
{
"target" : "java.util.concurrent.ConcurrentHashMap",
"name" : "cities",
"cacheManager" : "cacheManager"
}
4.2.1. Query Parameters
If the requested name is specific enough to identify a single cache, no extra parameter is required.
Otherwise, the cacheManager
must be specified.
The following table shows the supported query parameters:
Parameter | Description |
---|---|
|
Name of the cacheManager to qualify the cache. May be omitted if the cache name is unique. |
4.2.2. Response Structure
The response contains details of the requested cache. The following table describes the structure of the response:
Path | Type | Description |
---|---|---|
|
|
Cache name. |
|
|
Cache manager name. |
|
|
Fully qualified name of the native cache. |
4.3. Evict All Caches
To clear all available caches, make a DELETE
request to /actuator/caches
as shown in the following curl-based example:
$ curl 'http://localhost:8080/actuator/caches' -i -X DELETE
4.4. Evict a Cache by Name
To evict a particular cache, make a DELETE
request to /actuator/caches/{name}
as shown in the following curl-based example:
$ curl 'http://localhost:8080/actuator/caches/countries?cacheManager=anotherCacheManager' -i -X DELETE
As there are two caches named countries , the cacheManager has to be provided to specify which Cache should be cleared.
|
4.4.1. Request Structure
If the requested name is specific enough to identify a single cache, no extra parameter is required.
Otherwise, the cacheManager
must be specified.
The following table shows the supported query parameters:
Parameter | Description |
---|---|
|
Name of the cacheManager to qualify the cache. May be omitted if the cache name is unique. |
5. Conditions Evaluation Report (conditions
)
The conditions
endpoint provides information about the evaluation of conditions on configuration and auto-configuration classes.
5.1. Retrieving the Report
To retrieve the report, make a GET
request to /actuator/conditions
, as shown in the following curl-based example:
$ curl 'http://localhost:8080/actuator/conditions' -i -X GET
The resulting response is similar to the following:
HTTP/1.1 200 OK
Content-Type: application/vnd.spring-boot.actuator.v2+json;charset=UTF-8
Content-Length: 3259
{
"contexts" : {
"application" : {
"positiveMatches" : {
"EndpointAutoConfiguration#endpointOperationParameterMapper" : [ {
"condition" : "OnBeanCondition",
"message" : "@ConditionalOnMissingBean (types: org.springframework.boot.actuate.endpoint.invoke.ParameterValueMapper; SearchStrategy: all) did not find any beans"
} ],
"EndpointAutoConfiguration#endpointCachingOperationInvokerAdvisor" : [ {
"condition" : "OnBeanCondition",
"message" : "@ConditionalOnMissingBean (types: org.springframework.boot.actuate.endpoint.invoker.cache.CachingOperationInvokerAdvisor; SearchStrategy: all) did not find any beans"
} ],
"WebEndpointAutoConfiguration" : [ {
"condition" : "OnWebApplicationCondition",
"message" : "@ConditionalOnWebApplication (required) found 'session' scope"
} ]
},
"negativeMatches" : {
"WebFluxEndpointManagementContextConfiguration" : {
"notMatched" : [ {
"condition" : "OnWebApplicationCondition",
"message" : "not a reactive web application"
} ],
"matched" : [ {
"condition" : "OnClassCondition",
"message" : "@ConditionalOnClass found required classes 'org.springframework.web.reactive.DispatcherHandler', 'org.springframework.http.server.reactive.HttpHandler'"
} ]
},
"GsonHttpMessageConvertersConfiguration.GsonHttpMessageConverterConfiguration" : {
"notMatched" : [ {
"condition" : "GsonHttpMessageConvertersConfiguration.PreferGsonOrJacksonAndJsonbUnavailableCondition",
"message" : "AnyNestedCondition 0 matched 2 did not; NestedCondition on GsonHttpMessageConvertersConfiguration.PreferGsonOrJacksonAndJsonbUnavailableCondition.JacksonJsonbUnavailable NoneNestedConditions 1 matched 1 did not; NestedCondition on GsonHttpMessageConvertersConfiguration.JacksonAndJsonbUnavailableCondition.JsonbPreferred @ConditionalOnProperty (spring.http.converters.preferred-json-mapper=jsonb) did not find property 'spring.http.converters.preferred-json-mapper'; NestedCondition on GsonHttpMessageConvertersConfiguration.JacksonAndJsonbUnavailableCondition.JacksonAvailable @ConditionalOnBean (types: org.springframework.http.converter.json.MappingJackson2HttpMessageConverter; SearchStrategy: all) found bean 'mappingJackson2HttpMessageConverter'; NestedCondition on GsonHttpMessageConvertersConfiguration.PreferGsonOrJacksonAndJsonbUnavailableCondition.GsonPreferred @ConditionalOnProperty (spring.http.converters.preferred-json-mapper=gson) did not find property 'spring.http.converters.preferred-json-mapper'"
} ],
"matched" : [ ]
},
"JsonbHttpMessageConvertersConfiguration" : {
"notMatched" : [ {
"condition" : "OnClassCondition",
"message" : "@ConditionalOnClass did not find required class 'javax.json.bind.Jsonb'"
} ],
"matched" : [ ]
}
},
"unconditionalClasses" : [ "org.springframework.boot.autoconfigure.context.PropertyPlaceholderAutoConfiguration", "org.springframework.boot.actuate.autoconfigure.endpoint.EndpointAutoConfiguration" ]
}
}
}
5.1.1. Response Structure
The response contains details of the application’s condition evaluation. The following table describes the structure of the response:
Path | Type | Description |
---|---|---|
|
|
Application contexts keyed by id. |
|
|
Classes and methods with conditions that were matched. |
|
|
Name of the condition. |
|
|
Details of why the condition was matched. |
|
|
Classes and methods with conditions that were not matched. |
|
|
Conditions that were matched. |
|
|
Name of the condition. |
|
|
Details of why the condition was not matched. |
|
|
Conditions that were matched. |
|
|
Name of the condition. |
|
|
Details of why the condition was matched. |
|
|
Names of unconditional auto-configuration classes if any. |
|
|
Id of the parent application context, if any. |
6. Configuration Properties (configprops
)
The configprops
endpoint provides information about the application’s @ConfigurationProperties
beans.
6.1. Retrieving the @ConfigurationProperties
Bean
To retrieve the @ConfigurationProperties
beans, make a GET
request to /actuator/configprops
, as shown in the following curl-based example:
$ curl 'http://localhost:8080/actuator/configprops' -i -X GET
The resulting response is similar to the following:
HTTP/1.1 200 OK
Content-Type: application/vnd.spring-boot.actuator.v2+json;charset=UTF-8
Content-Length: 1806
{
"contexts" : {
"application" : {
"beans" : {
"management.endpoints.web.cors-org.springframework.boot.actuate.autoconfigure.endpoint.web.CorsEndpointProperties" : {
"prefix" : "management.endpoints.web.cors",
"properties" : {
"allowedHeaders" : [ ],
"allowedMethods" : [ ],
"allowedOrigins" : [ ],
"maxAge" : {
"units" : [ "SECONDS", "NANOS" ]
},
"exposedHeaders" : [ ]
}
},
"management.endpoints.web-org.springframework.boot.actuate.autoconfigure.endpoint.web.WebEndpointProperties" : {
"prefix" : "management.endpoints.web",
"properties" : {
"pathMapping" : { },
"exposure" : {
"include" : [ "*" ],
"exclude" : [ ]
},
"basePath" : "/actuator"
}
},
"spring.resources-org.springframework.boot.autoconfigure.web.ResourceProperties" : {
"prefix" : "spring.resources",
"properties" : {
"addMappings" : true,
"chain" : {
"cache" : true,
"htmlApplicationCache" : false,
"compressed" : false,
"strategy" : {
"fixed" : {
"enabled" : false,
"paths" : [ "/**" ]
},
"content" : {
"enabled" : false,
"paths" : [ "/**" ]
}
}
},
"cache" : {
"cachecontrol" : { }
},
"staticLocations" : [ "classpath:/META-INF/resources/", "classpath:/resources/", "classpath:/static/", "classpath:/public/" ]
}
}
}
}
}
}
6.1.1. Response Structure
The response contains details of the application’s @ConfigurationProperties
beans.
The following table describes the structure of the response:
Path | Type | Description |
---|---|---|
|
|
Application contexts keyed by id. |
|
|
|
|
|
Prefix applied to the names of the bean’s properties. |
|
|
Properties of the bean as name-value pairs. |
|
|
Id of the parent application context, if any. |
7. Environment (env
)
The env
endpoint provides information about the application’s Environment
.
7.1. Retrieving the Entire Environment
To retrieve the entire environment, make a GET
request to /actuator/env
, as shown in the following curl-based example:
$ curl 'http://localhost:8080/actuator/env' -i -X GET
The resulting response is similar to the following:
HTTP/1.1 200 OK
Content-Type: application/vnd.spring-boot.actuator.v2+json;charset=UTF-8
Content-Length: 788
{
"activeProfiles" : [ ],
"propertySources" : [ {
"name" : "systemProperties",
"properties" : {
"java.runtime.name" : {
"value" : "OpenJDK Runtime Environment"
},
"java.vm.version" : {
"value" : "25.222-b10"
},
"java.vm.vendor" : {
"value" : "AdoptOpenJDK"
}
}
}, {
"name" : "systemEnvironment",
"properties" : {
"JAVA_HOME" : {
"value" : "/opt/openjdk",
"origin" : "System Environment Property \"JAVA_HOME\""
}
}
}, {
"name" : "applicationConfig: [classpath:/application.properties]",
"properties" : {
"com.example.cache.max-size" : {
"value" : "1000",
"origin" : "class path resource [application.properties]:1:29"
}
}
} ]
}
7.1.1. Response Structure
The response contains details of the application’s Environment
.
The following table describes the structure of the response:
Path | Type | Description |
---|---|---|
|
|
Names of the active profiles, if any. |
|
|
Property sources in order of precedence. |
|
|
Name of the property source. |
|
|
Properties in the property source keyed by property name. |
|
|
Value of the property. |
|
|
Origin of the property, if any. |
7.2. Retrieving a Single Property
To retrieve a single property, make a GET
request to /actuator/env/{property.name}
, as shown in the following curl-based example:
$ curl 'http://localhost:8080/actuator/env/com.example.cache.max-size' -i -X GET
The preceding example retrieves information about the property named com.example.cache.max-size
.
The resulting response is similar to the following:
HTTP/1.1 200 OK
Content-Disposition: inline;filename=f.txt
Content-Type: application/vnd.spring-boot.actuator.v2+json;charset=UTF-8
Content-Length: 445
{
"property" : {
"source" : "applicationConfig: [classpath:/application.properties]",
"value" : "1000"
},
"activeProfiles" : [ ],
"propertySources" : [ {
"name" : "systemProperties"
}, {
"name" : "systemEnvironment"
}, {
"name" : "applicationConfig: [classpath:/application.properties]",
"property" : {
"value" : "1000",
"origin" : "class path resource [application.properties]:1:29"
}
} ]
}
7.2.1. Response Structure
The response contains details of the requested property. The following table describes the structure of the response:
Path | Type | Description |
---|---|---|
|
|
Property from the environment, if found. |
|
|
Name of the source of the property. |
|
|
Value of the property. |
|
|
Names of the active profiles, if any. |
|
|
Property sources in order of precedence. |
|
|
Name of the property source. |
|
|
Property in the property source, if any. |
|
|
Value of the property. |
|
|
Origin of the property, if any. |
8. Flyway (flyway
)
The flyway
endpoint provides information about database migrations performed by Flyway.
8.1. Retrieving the Migrations
To retrieve the migrations, make a GET
request to /actuator/flyway
, as shown in the following curl-based example:
$ curl 'http://localhost:8080/actuator/flyway' -i -X GET
The resulting response is similar to the following:
HTTP/1.1 200 OK
Content-Type: application/vnd.spring-boot.actuator.v2+json;charset=UTF-8
Content-Length: 515
{
"contexts" : {
"application" : {
"flywayBeans" : {
"flyway" : {
"migrations" : [ {
"type" : "SQL",
"checksum" : -156244537,
"version" : "1",
"description" : "init",
"script" : "V1__init.sql",
"state" : "SUCCESS",
"installedBy" : "SA",
"installedOn" : "2019-10-02T14:30:30.708Z",
"installedRank" : 1,
"executionTime" : 1
} ]
}
}
}
}
}
8.1.1. Response Structure
The response contains details of the application’s Flyway migrations. The following table describes the structure of the response:
Path | Type | Description |
---|---|---|
|
|
Application contexts keyed by id |
|
|
Migrations performed by the Flyway instance, keyed by Flyway bean name. |
|
|
Checksum of the migration, if any. |
|
|
Description of the migration, if any. |
|
|
Execution time in milliseconds of an applied migration. |
|
|
User that installed the applied migration, if any. |
|
|
Timestamp of when the applied migration was installed, if any. |
|
|
Rank of the applied migration, if any. Later migrations have higher ranks. |
|
|
Name of the script used to execute the migration, if any. |
|
|
State of the migration. ( |
|
|
Type of the migration. ( |
|
|
Version of the database after applying the migration, if any. |
|
|
Id of the parent application context, if any. |
9. Health (health
)
The health
endpoint provides detailed information about the health of the application.
9.1. Retrieving the Health of the application
To retrieve the health of the application, make a GET
request to /actuator/health
, as shown in the following curl-based example:
$ curl 'http://localhost:8080/actuator/health' -i -X GET
The resulting response is similar to the following:
HTTP/1.1 200 OK
Content-Type: application/vnd.spring-boot.actuator.v2+json;charset=UTF-8
Content-Length: 670
{
"status" : "UP",
"details" : {
"diskSpace" : {
"status" : "UP",
"details" : {
"total" : 189731442688,
"free" : 40325517312,
"threshold" : 10485760
}
},
"db" : {
"status" : "UP",
"details" : {
"database" : "HSQL Database Engine",
"hello" : 1
}
},
"broker" : {
"status" : "UP",
"details" : {
"us1" : {
"status" : "UP",
"details" : {
"version" : "1.0.2"
}
},
"us2" : {
"status" : "UP",
"details" : {
"version" : "1.0.4"
}
}
}
}
}
}
9.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 |
---|---|---|
|
|
Overall status of the application. |
|
|
Details of the health of the application. Presence is controlled by |
|
|
Status of a specific part of the application. |
|
|
Details of the health of a specific part of the application. |
9.2. Retrieving the Health of a component
To retrieve the health of a particular component of the application, make a GET
request to /actuator/health/{component}
, as shown in the following curl-based example:
$ curl 'http://localhost:8080/actuator/health/db' -i -X GET
The resulting response is similar to the following:
HTTP/1.1 200 OK
Content-Type: application/vnd.spring-boot.actuator.v2+json;charset=UTF-8
Content-Length: 99
{
"status" : "UP",
"details" : {
"database" : "HSQL Database Engine",
"hello" : 1
}
}
9.2.1. Response Structure
The response contains details of the health of a particular component of the application. The following table describes the structure of the response:
Path | Type | Description |
---|---|---|
|
|
Status of a specific part of the application |
|
|
Details of the health of a specific part of the application. |
9.3. Retrieving the Health of a component instance
If a particular component consists of multiple instances (as the broker
indicator in the example above), the health of a particular instance of that component can be retrieved by issuing a GET
request to /actuator/health/{component}/{instance}
, as shown in the following curl-based example:
$ curl 'http://localhost:8080/actuator/health/broker/us1' -i -X GET
The resulting response is similar to the following:
HTTP/1.1 200 OK
Content-Type: application/vnd.spring-boot.actuator.v2+json;charset=UTF-8
Content-Length: 66
{
"status" : "UP",
"details" : {
"version" : "1.0.2"
}
}
9.3.1. Response Structure
The response contains details of the health of an instance of a particular component of the application. The following table describes the structure of the response:
Path | Type | Description |
---|---|---|
|
|
Status of a specific part of the application |
|
|
Details of the health of a specific part of the application. |
10. Heap Dump (heapdump
)
The heapdump
endpoint provides a heap dump from the application’s JVM.
10.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.
11. HTTP Trace (httptrace
)
The httptrace
endpoint provides information about HTTP request-response exchanges.
11.1. Retrieving the Traces
To retrieve the traces, make a GET
request to /actuator/httptrace
, as shown in the following curl-based example:
$ curl 'http://localhost:8080/actuator/httptrace' -i -X GET
The resulting response is similar to the following:
HTTP/1.1 200 OK
Content-Type: application/vnd.spring-boot.actuator.v2+json;charset=UTF-8
Content-Length: 503
{
"traces" : [ {
"timestamp" : "2019-10-02T14:30:33.250Z",
"principal" : {
"name" : "alice"
},
"session" : {
"id" : "f7a53306-5c41-44aa-84fa-fad94b29133d"
},
"request" : {
"method" : "GET",
"uri" : "https://api.example.com",
"headers" : {
"Accept" : [ "application/json" ]
}
},
"response" : {
"status" : 200,
"headers" : {
"Content-Type" : [ "application/json" ]
}
},
"timeTaken" : 1
} ]
}
11.1.1. Response Structure
The response contains details of the traced HTTP request-response exchanges. The following table describes the structure of the response:
Path | Type | Description |
---|---|---|
|
|
An array of traced HTTP request-response exchanges. |
|
|
Timestamp of when the traced exchange occurred. |
|
|
Principal of the exchange, if any. |
|
|
Name of the principal. |
|
|
HTTP method of the request. |
|
|
Remote address from which the request was received, if known. |
|
|
URI of the request. |
|
|
Headers of the request, keyed by header name. |
|
|
Values of the header |
|
|
Status of the response |
|
|
Headers of the response, keyed by header name. |
|
|
Values of the header |
|
|
Session associated with the exchange, if any. |
|
|
ID of the session. |
|
|
Time, in milliseconds, taken to handle the exchange. |
12. Info (info
)
The info
endpoint provides general information about the application.
12.1. Retrieving the Info
To retrieve the information about the application, make a GET
request to /actuator/info
, as shown in the following curl-based example:
$ curl 'http://localhost:8080/actuator/info' -i -X GET
The resulting response is similar to the following:
HTTP/1.1 200 OK
Content-Type: application/vnd.spring-boot.actuator.v2+json;charset=UTF-8
Content-Length: 235
{
"git" : {
"commit" : {
"time" : "+51722-03-01T13:18:48Z",
"id" : "df027cf"
},
"branch" : "master"
},
"build" : {
"version" : "1.0.3",
"artifact" : "application",
"group" : "com.example"
}
}
12.1.1. Response Structure
The response contains general information about the application.
Each section of the response is contributed by an InfoContributor
.
Spring Boot provides build
and git
contributions.
build
Response Structure
The following table describe the structure of the build
section of the response:
Path | Type | Description |
---|---|---|
|
|
Artifact ID of the application, if any. |
|
|
Group ID of the application, if any. |
|
|
Name of the application, if any. |
|
|
Version of the application, if any. |
|
|
Timestamp of when the application was built, if any. |
git
Response Structure
The following table describes the structure of the git
section of the response:
Path | Type | Description |
---|---|---|
|
|
Name of the Git branch, if any. |
|
|
Details of the Git commit, if any. |
|
|
Timestamp of the commit, if any. |
|
|
ID of the commit, if any. |
13. Spring Integration graph (integrationgraph
)
The integrationgraph
endpoint exposes a graph containing all Spring Integration components.
13.1. Retrieving the Spring Integration graph
To retrieve the information about the application, make a GET
request to /actuator/integrationgraph
, as shown in the following curl-based example:
$ curl 'http://localhost:8080/actuator/integrationgraph' -i -X GET
The resulting response is similar to the following:
HTTP/1.1 200 OK
Content-Type: application/vnd.spring-boot.actuator.v2+json;charset=UTF-8
Content-Length: 667
{
"contentDescriptor" : {
"providerVersion" : "5.1.8.RELEASE",
"providerFormatVersion" : 1.0,
"provider" : "spring-integration"
},
"nodes" : [ {
"nodeId" : 1,
"name" : "nullChannel",
"componentType" : "null-channel",
"properties" : { }
}, {
"nodeId" : 2,
"name" : "errorChannel",
"componentType" : "publish-subscribe-channel",
"properties" : { }
}, {
"nodeId" : 3,
"name" : "_org.springframework.integration.errorLogger",
"componentType" : "logging-channel-adapter",
"properties" : { },
"input" : "errorChannel"
} ],
"links" : [ {
"from" : 2,
"to" : 3,
"type" : "input"
} ]
}
13.1.1. Response Structure
The response contains all Spring Integration components used within the application, as well as the links between them. More information about the structure can be found in the reference documentation.
13.2. Rebuilding the Spring Integration graph
To rebuild the exposed graph, make a POST
request to /actuator/integrationgraph
, as shown in the following curl-based example:
$ curl 'http://localhost:8080/actuator/integrationgraph' -i -X POST
This will result in a 204 - No Content
response:
HTTP/1.1 204 No Content
14. Liquibase (liquibase
)
The liquibase
endpoint provides information about database change sets applied by Liquibase.
14.1. Retrieving the Changes
To retrieve the changes, make a GET
request to /actuator/liquibase
, as shown in the following curl-based example:
$ curl 'http://localhost:8080/actuator/liquibase' -i -X GET
The resulting response is similar to the following:
HTTP/1.1 200 OK
Content-Type: application/vnd.spring-boot.actuator.v2+json;charset=UTF-8
Content-Length: 688
{
"contexts" : {
"application" : {
"liquibaseBeans" : {
"liquibase" : {
"changeSets" : [ {
"author" : "marceloverdijk",
"changeLog" : "classpath:/db/changelog/db.changelog-master.yaml",
"comments" : "",
"contexts" : [ ],
"dateExecuted" : "2019-10-02T14:29:47.455Z",
"deploymentId" : "0026587438",
"description" : "createTable tableName=customer",
"execType" : "EXECUTED",
"id" : "1",
"labels" : [ ],
"checksum" : "8:46debf252cce6d7b25e28ddeb9fc4bf6",
"orderExecuted" : 1
} ]
}
}
}
}
}
14.1.1. Response Structure
The response contains details of the application’s Liquibase change sets. The following table describes the structure of the response:
Path | Type | Description |
---|---|---|
|
|
Application contexts keyed by id |
|
|
Change sets made by the Liquibase beans, keyed by bean name. |
|
|
Author of the change set. |
|
|
Change log that contains the change set. |
|
|
Comments on the change set. |
|
|
Contexts of the change set. |
|
|
Timestamp of when the change set was executed. |
|
|
ID of the deployment that ran the change set. |
|
|
Description of the change set. |
|
|
Execution type of the change set ( |
|
|
ID of the change set. |
|
|
Labels associated with the change set. |
|
|
Checksum of the change set. |
|
|
Order of the execution of the change set. |
|
|
Tag associated with the change set, if any. |
|
|
Id of the parent application context, if any. |
15. Log File (logfile
)
The logfile
endpoint provides access to the contents of the application’s log file.
15.1. Retrieving the Log File
To retrieve the log file, make a GET
request to /actuator/logfile
, as shown in the following curl-based example:
$ curl 'http://localhost:8080/actuator/logfile' -i -X GET
The resulting response is similar to the following:
HTTP/1.1 200 OK
Accept-Ranges: bytes
Content-Type: text/plain;charset=UTF-8
Content-Length: 4723
. ____ _ __ _ _
/\\ / ___'_ __ _ _(_)_ __ __ _ \ \ \ \
( ( )\___ | '_ | '_| | '_ \/ _` | \ \ \ \
\\/ ___)| |_)| | | | | || (_| | ) ) ) )
' |____| .__|_| |_|_| |_\__, | / / / /
=========|_|==============|___/=/_/_/_/
:: Spring Boot ::
2017-08-08 17:12:30.910 INFO 19866 --- [ main] s.f.SampleWebFreeMarkerApplication : Starting SampleWebFreeMarkerApplication on host.local with PID 19866
2017-08-08 17:12:30.913 INFO 19866 --- [ main] s.f.SampleWebFreeMarkerApplication : No active profile set, falling back to default profiles: default
2017-08-08 17:12:30.952 INFO 19866 --- [ main] ConfigServletWebServerApplicationContext : Refreshing org.springframework.boot.web.servlet.context.AnnotationConfigServletWebServerApplicationContext@76b10754: startup date [Tue Aug 08 17:12:30 BST 2017]; root of context hierarchy
2017-08-08 17:12:31.878 INFO 19866 --- [ main] o.s.b.w.embedded.tomcat.TomcatWebServer : Tomcat initialized with port(s): 8080 (http)
2017-08-08 17:12:31.889 INFO 19866 --- [ main] o.apache.catalina.core.StandardService : Starting service [Tomcat]
2017-08-08 17:12:31.890 INFO 19866 --- [ main] org.apache.catalina.core.StandardEngine : Starting Servlet Engine: Apache Tomcat/8.5.16
2017-08-08 17:12:31.978 INFO 19866 --- [ost-startStop-1] o.a.c.c.C.[Tomcat].[localhost].[/] : Initializing Spring embedded WebApplicationContext
2017-08-08 17:12:31.978 INFO 19866 --- [ost-startStop-1] o.s.web.context.ContextLoader : Root WebApplicationContext: initialization completed in 1028 ms
2017-08-08 17:12:32.080 INFO 19866 --- [ost-startStop-1] o.s.b.w.servlet.ServletRegistrationBean : Mapping servlet: 'dispatcherServlet' to [/]
2017-08-08 17:12:32.084 INFO 19866 --- [ost-startStop-1] o.s.b.w.servlet.FilterRegistrationBean : Mapping filter: 'characterEncodingFilter' to: [/*]
2017-08-08 17:12:32.084 INFO 19866 --- [ost-startStop-1] o.s.b.w.servlet.FilterRegistrationBean : Mapping filter: 'hiddenHttpMethodFilter' to: [/*]
2017-08-08 17:12:32.084 INFO 19866 --- [ost-startStop-1] o.s.b.w.servlet.FilterRegistrationBean : Mapping filter: 'httpPutFormContentFilter' to: [/*]
2017-08-08 17:12:32.084 INFO 19866 --- [ost-startStop-1] o.s.b.w.servlet.FilterRegistrationBean : Mapping filter: 'requestContextFilter' to: [/*]
2017-08-08 17:12:32.349 INFO 19866 --- [ main] s.w.s.m.m.a.RequestMappingHandlerAdapter : Looking for @ControllerAdvice: org.springframework.boot.web.servlet.context.AnnotationConfigServletWebServerApplicationContext@76b10754: startup date [Tue Aug 08 17:12:30 BST 2017]; root of context hierarchy
2017-08-08 17:12:32.420 INFO 19866 --- [ main] s.w.s.m.m.a.RequestMappingHandlerMapping : Mapped "{[/error]}" onto public org.springframework.http.ResponseEntity<java.util.Map<java.lang.String, java.lang.Object>> org.springframework.boot.autoconfigure.web.servlet.error.BasicErrorController.error(javax.servlet.http.HttpServletRequest)
2017-08-08 17:12:32.421 INFO 19866 --- [ main] s.w.s.m.m.a.RequestMappingHandlerMapping : Mapped "{[/error],produces=[text/html]}" onto public org.springframework.web.servlet.ModelAndView org.springframework.boot.autoconfigure.web.servlet.error.BasicErrorController.errorHtml(javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse)
2017-08-08 17:12:32.444 INFO 19866 --- [ main] o.s.w.s.handler.SimpleUrlHandlerMapping : Mapped URL path [/webjars/**] onto handler of type [class org.springframework.web.servlet.resource.ResourceHttpRequestHandler]
2017-08-08 17:12:32.444 INFO 19866 --- [ main] o.s.w.s.handler.SimpleUrlHandlerMapping : Mapped URL path [/**] onto handler of type [class org.springframework.web.servlet.resource.ResourceHttpRequestHandler]
2017-08-08 17:12:32.471 INFO 19866 --- [ main] o.s.w.s.handler.SimpleUrlHandlerMapping : Mapped URL path [/**/favicon.ico] onto handler of type [class org.springframework.web.servlet.resource.ResourceHttpRequestHandler]
2017-08-08 17:12:32.600 INFO 19866 --- [ main] o.s.w.s.v.f.FreeMarkerConfigurer : ClassTemplateLoader for Spring macros added to FreeMarker configuration
2017-08-08 17:12:32.681 INFO 19866 --- [ main] o.s.j.e.a.AnnotationMBeanExporter : Registering beans for JMX exposure on startup
2017-08-08 17:12:32.744 INFO 19866 --- [ main] o.s.b.w.embedded.tomcat.TomcatWebServer : Tomcat started on port(s): 8080 (http)
2017-08-08 17:12:32.750 INFO 19866 --- [ main] s.f.SampleWebFreeMarkerApplication : Started SampleWebFreeMarkerApplication in 2.172 seconds (JVM running for 2.479)
15.2. Retrieving Part of the Log File
Retrieving part of the log file is not supported when using Jersey. |
To retrieve part of the log file, make a GET
request to /actuator/logfile
by using the Range
header, as shown in the following curl-based example:
$ curl 'http://localhost:8080/actuator/logfile' -i -X GET \
-H 'Range: bytes=0-1023'
The preceding example retrieves the first 1024 bytes of the log file. The resulting response is similar to the following:
HTTP/1.1 206 Partial Content
Accept-Ranges: bytes
Content-Type: text/plain;charset=UTF-8
Content-Range: bytes 0-1023/4723
Content-Length: 1024
. ____ _ __ _ _
/\\ / ___'_ __ _ _(_)_ __ __ _ \ \ \ \
( ( )\___ | '_ | '_| | '_ \/ _` | \ \ \ \
\\/ ___)| |_)| | | | | || (_| | ) ) ) )
' |____| .__|_| |_|_| |_\__, | / / / /
=========|_|==============|___/=/_/_/_/
:: Spring Boot ::
2017-08-08 17:12:30.910 INFO 19866 --- [ main] s.f.SampleWebFreeMarkerApplication : Starting SampleWebFreeMarkerApplication on host.local with PID 19866
2017-08-08 17:12:30.913 INFO 19866 --- [ main] s.f.SampleWebFreeMarkerApplication : No active profile set, falling back to default profiles: default
2017-08-08 17:12:30.952 INFO 19866 --- [ main] ConfigServletWebServerApplicationContext : Refreshing org.springframework.boot.web.servlet.context.AnnotationConfigServletWebServerApplicationContext@76b10754: startup date [Tue Aug 08 17:12:30 BST 2017]; root of context hierarchy
2017-08-08 17:12:31.878 INFO 19866 --- [ main] o.s.b.w.embedded.tomcat.TomcatWebServer : Tomcat initialized with port(
16. Loggers (loggers
)
The loggers
endpoint provides access to the application’s loggers and the configuration of their levels.
16.1. Retrieving All Loggers
To retrieve the application’s loggers, make a GET
request to /actuator/loggers
, as shown in the following curl-based example:
$ curl 'http://localhost:8080/actuator/loggers' -i -X GET
The resulting response is similar to the following:
HTTP/1.1 200 OK
Content-Type: application/vnd.spring-boot.actuator.v2+json;charset=UTF-8
Content-Length: 283
{
"levels" : [ "OFF", "FATAL", "ERROR", "WARN", "INFO", "DEBUG", "TRACE" ],
"loggers" : {
"ROOT" : {
"configuredLevel" : "INFO",
"effectiveLevel" : "INFO"
},
"com.example" : {
"configuredLevel" : "DEBUG",
"effectiveLevel" : "DEBUG"
}
}
}
16.1.1. Response Structure
The response contains details of the application’s loggers. The following table describes the structure of the response:
Path | Type | Description |
---|---|---|
|
|
Levels support by the logging system. |
|
|
Loggers keyed by name. |
|
|
Configured level of the logger, if any. |
|
|
Effective level of the logger. |
16.2. Retrieving a Single Logger
To retrieve a single logger, make a GET
request to /actuator/loggers/{logger.name}
, as shown in the following curl-based example:
$ curl 'http://localhost:8080/actuator/loggers/com.example' -i -X GET
The preceding example retrieves information about the logger named com.example
.
The resulting response is similar to the following:
HTTP/1.1 200 OK
Content-Disposition: inline;filename=f.txt
Content-Type: application/vnd.spring-boot.actuator.v2+json;charset=UTF-8
Content-Length: 61
{
"configuredLevel" : "INFO",
"effectiveLevel" : "INFO"
}
16.2.1. Response Structure
The response contains details of the requested logger. The following table describes the structure of the response:
Path | Type | Description |
---|---|---|
|
|
Configured level of the logger, if any. |
|
|
Effective level of the logger. |
16.3. Setting a Log Level
To set the level of a logger, make a POST
request to /actuator/loggers/{logger.name}
with a JSON body that specifies the configured level for the logger, as shown in the following curl-based example:
$ curl 'http://localhost:8080/actuator/loggers/com.example' -i -X POST \
-H 'Content-Type: application/json' \
-d '{"configuredLevel":"debug"}'
The preceding example sets the configuredLevel
of the com.example
logger to DEBUG
.
16.3.1. Request Structure
The request specifies the desired level of the logger. The following table describes the structure of the request:
Path | Type | Description |
---|---|---|
|
|
Level for the logger. May be omitted to clear the level. |
16.4. Clearing a Log Level
To clear the level of a logger, make a POST
request to /actuator/loggers/{logger.name}
with a JSON body containing an empty object, as shown in the following curl-based example:
$ curl 'http://localhost:8080/actuator/loggers/com.example' -i -X POST \
-H 'Content-Type: application/json' \
-d '{}'
The preceding example clears the configured level of the com.example
logger.
17. Mappings (mappings
)
The mappings
endpoint provides information about the application’s request mappings.
17.1. Retrieving the Mappings
To retrieve the mappings, make a GET
request to /actuator/mappings
, as shown in the following curl-based example:
$ curl 'http://localhost:44633/actuator/mappings' -i -X GET
The resulting response is similar to the following:
HTTP/1.1 200 OK
Content-Type: application/vnd.spring-boot.actuator.v2+json;charset=UTF-8
Transfer-Encoding: chunked
Date: Wed, 02 Oct 2019 14:30:39 GMT
Content-Length: 5676
{
"contexts" : {
"application" : {
"mappings" : {
"dispatcherServlets" : {
"dispatcherServlet" : [ {
"handler" : "ResourceHttpRequestHandler [class path resource [META-INF/resources/], class path resource [resources/], class path resource [static/], class path resource [public/], ServletContext resource [/], class path resource []]",
"predicate" : "/**/favicon.ico"
}, {
"handler" : "Actuator web endpoint 'mappings'",
"predicate" : "{GET /actuator/mappings, produces [application/vnd.spring-boot.actuator.v2+json || application/json]}",
"details" : {
"handlerMethod" : {
"className" : "org.springframework.boot.actuate.endpoint.web.servlet.AbstractWebMvcEndpointHandlerMapping.OperationHandler",
"name" : "handle",
"descriptor" : "(Ljavax/servlet/http/HttpServletRequest;Ljava/util/Map;)Ljava/lang/Object;"
},
"requestMappingConditions" : {
"consumes" : [ ],
"headers" : [ ],
"methods" : [ "GET" ],
"params" : [ ],
"patterns" : [ "/actuator/mappings" ],
"produces" : [ {
"mediaType" : "application/vnd.spring-boot.actuator.v2+json",
"negated" : false
}, {
"mediaType" : "application/json",
"negated" : false
} ]
}
}
}, {
"handler" : "Actuator root web endpoint",
"predicate" : "{GET /actuator, produces [application/vnd.spring-boot.actuator.v2+json || application/json]}",
"details" : {
"handlerMethod" : {
"className" : "org.springframework.boot.actuate.endpoint.web.servlet.WebMvcEndpointHandlerMapping.WebMvcLinksHandler",
"name" : "links",
"descriptor" : "(Ljavax/servlet/http/HttpServletRequest;Ljavax/servlet/http/HttpServletResponse;)Ljava/lang/Object;"
},
"requestMappingConditions" : {
"consumes" : [ ],
"headers" : [ ],
"methods" : [ "GET" ],
"params" : [ ],
"patterns" : [ "/actuator" ],
"produces" : [ {
"mediaType" : "application/vnd.spring-boot.actuator.v2+json",
"negated" : false
}, {
"mediaType" : "application/json",
"negated" : false
} ]
}
}
}, {
"handler" : "public java.lang.String org.springframework.boot.actuate.autoconfigure.endpoint.web.documentation.MappingsEndpointServletDocumentationTests$ExampleController.example()",
"predicate" : "{POST /, params [a!=alpha], headers [X-Custom=Foo], consumes [application/json || !application/xml], produces [text/plain]}",
"details" : {
"handlerMethod" : {
"className" : "org.springframework.boot.actuate.autoconfigure.endpoint.web.documentation.MappingsEndpointServletDocumentationTests.ExampleController",
"name" : "example",
"descriptor" : "()Ljava/lang/String;"
},
"requestMappingConditions" : {
"consumes" : [ {
"mediaType" : "application/json",
"negated" : false
}, {
"mediaType" : "application/xml",
"negated" : true
} ],
"headers" : [ {
"name" : "X-Custom",
"value" : "Foo",
"negated" : false
} ],
"methods" : [ "POST" ],
"params" : [ {
"name" : "a",
"value" : "alpha",
"negated" : true
} ],
"patterns" : [ "/" ],
"produces" : [ {
"mediaType" : "text/plain",
"negated" : false
} ]
}
}
}, {
"handler" : "ResourceHttpRequestHandler [\"classpath:/META-INF/resources/webjars/\"]",
"predicate" : "/webjars/**"
}, {
"handler" : "ResourceHttpRequestHandler [\"classpath:/META-INF/resources/\", \"classpath:/resources/\", \"classpath:/static/\", \"classpath:/public/\", \"/\"]",
"predicate" : "/**"
} ]
},
"servletFilters" : [ {
"servletNameMappings" : [ ],
"urlPatternMappings" : [ "/*" ],
"name" : "requestContextFilter",
"className" : "org.springframework.boot.web.servlet.filter.OrderedRequestContextFilter"
}, {
"servletNameMappings" : [ ],
"urlPatternMappings" : [ "/*" ],
"name" : "hiddenHttpMethodFilter",
"className" : "org.springframework.boot.web.servlet.filter.OrderedHiddenHttpMethodFilter"
}, {
"servletNameMappings" : [ ],
"urlPatternMappings" : [ "/*" ],
"name" : "formContentFilter",
"className" : "org.springframework.boot.web.servlet.filter.OrderedFormContentFilter"
} ],
"servlets" : [ {
"mappings" : [ ],
"name" : "default",
"className" : "org.apache.catalina.servlets.DefaultServlet"
}, {
"mappings" : [ "/" ],
"name" : "dispatcherServlet",
"className" : "org.springframework.web.servlet.DispatcherServlet"
} ]
}
}
}
}
17.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 |
---|---|---|
|
|
Application contexts keyed by id. |
|
|
Mappings in the context, keyed by mapping type. |
|
|
Dispatcher servlet mappings, if any. |
|
|
Servlet filter mappings, if any. |
|
|
Servlet mappings, if any. |
|
|
Dispatcher handler mappings, if any. |
|
|
Id of the parent application context, if any. |
The entries that may be found in contexts.*.mappings
are described in the following sections.
17.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:
Path | Type | Description |
---|---|---|
|
|
Dispatcher servlet mappings, if any, keyed by dispatcher servlet bean name. |
|
|
Additional implementation-specific details about the mapping. Optional. |
|
|
Handler for the mapping. |
|
|
Predicate for the mapping. |
|
|
Details of the method, if any, that will handle requests to this mapping. |
|
|
Fully qualified name of the class of the method. |
|
|
Name of the method. |
|
|
Descriptor of the method as specified in the Java Language Specification. |
|
|
Details of the request mapping conditions. |
|
|
Details of the consumes condition |
|
|
Consumed media type. |
|
|
Whether the media type is negated. |
|
|
Details of the headers condition. |
|
|
Name of the header. |
|
|
Required value of the header, if any. |
|
|
Whether the value is negated. |
|
|
HTTP methods that are handled. |
|
|
Details of the params condition. |
|
|
Name of the parameter. |
|
|
Required value of the parameter, if any. |
|
|
Whether the value is negated. |
|
|
Patterns identifying the paths handled by the mapping. |
|
|
Details of the produces condition. |
|
|
Produced media type. |
|
|
Whether the media type is negated. |
17.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 of the servlet. |
|
|
Name of the servlet. |
|
|
Class name of the servlet |
17.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 |
---|---|---|
|
|
Names of the servlets to which the filter is mapped. |
|
|
URL pattern to which the filter is mapped. |
|
|
Name of the filter. |
|
|
Class name of the filter |
17.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:
Path | Type | Description |
---|---|---|
|
|
Dispatcher handler mappings, if any, keyed by dispatcher handler bean name. |
|
|
Additional implementation-specific details about the mapping. Optional. |
|
|
Handler for the mapping. |
|
|
Predicate for the mapping. |
|
|
Details of the request mapping conditions. |
|
|
Details of the consumes condition |
|
|
Consumed media type. |
|
|
Whether the media type is negated. |
|
|
Details of the headers condition. |
|
|
Name of the header. |
|
|
Required value of the header, if any. |
|
|
Whether the value is negated. |
|
|
HTTP methods that are handled. |
|
|
Details of the params condition. |
|
|
Name of the parameter. |
|
|
Required value of the parameter, if any. |
|
|
Whether the value is negated. |
|
|
Patterns identifying the paths handled by the mapping. |
|
|
Details of the produces condition. |
|
|
Produced media type. |
|
|
Whether the media type is negated. |
|
|
Details of the method, if any, that will handle requests to this mapping. |
|
|
Fully qualified name of the class of the method. |
|
|
Name of the method. |
|
|
Descriptor of the method as specified in the Java Language Specification. |
|
|
Details of the function, if any, that will handle requests to this mapping. |
|
|
Fully qualified name of the class of the function. |
18. Metrics (metrics
)
The metrics
endpoint provides access to application metrics.
18.1. Retrieving Metric Names
To retrieve the names of the available metrics, make a GET
request to /actuator/metrics
, as shown in the following curl-based example:
$ curl 'http://localhost:8080/actuator/metrics' -i -X GET
The resulting response is similar to the following:
HTTP/1.1 200 OK
Content-Type: application/vnd.spring-boot.actuator.v2+json;charset=UTF-8
Content-Length: 154
{
"names" : [ "jvm.memory.max", "jvm.memory.used", "jvm.memory.committed", "jvm.buffer.memory.used", "jvm.buffer.count", "jvm.buffer.total.capacity" ]
}
18.1.1. Response Structure
The response contains details of the metric names. The following table describes the structure of the response:
Path | Type | Description |
---|---|---|
|
|
Names of the known metrics. |
18.2. Retrieving a Metric
To retrieve a metric, make a GET
request to /actuator/metrics/{metric.name}
, as shown in the following curl-based example:
$ curl 'http://localhost:8080/actuator/metrics/jvm.memory.max' -i -X GET
The preceding example retrieves information about the metric named jvm.memory.max
.
The resulting response is similar to the following:
HTTP/1.1 200 OK
Content-Disposition: inline;filename=f.txt
Content-Type: application/vnd.spring-boot.actuator.v2+json;charset=UTF-8
Content-Length: 474
{
"name" : "jvm.memory.max",
"description" : "The maximum amount of memory in bytes that can be used for memory management",
"baseUnit" : "bytes",
"measurements" : [ {
"statistic" : "VALUE",
"value" : 2.384461823E9
} ],
"availableTags" : [ {
"tag" : "area",
"values" : [ "heap", "nonheap" ]
}, {
"tag" : "id",
"values" : [ "Compressed Class Space", "PS Survivor Space", "PS Old Gen", "Metaspace", "PS Eden Space", "Code Cache" ]
} ]
}
18.2.1. Query Parameters
The endpoint uses query parameters to drill down into a metric by using its tags. The following table shows the single supported query parameter:
Parameter | Description |
---|---|
|
A tag to use for drill-down in the form |
18.2.2. Response structure
The response contains details of the metric. The following table describes the structure of the response:
Path | Type | Description |
---|---|---|
|
|
Name of the metric |
|
|
Description of the metric |
|
|
Base unit of the metric |
|
|
Measurements of the metric |
|
|
Statistic of the measurement. ( |
|
|
Value of the measurement. |
|
|
Tags that are available for drill-down. |
|
|
Name of the tag. |
|
|
Possible values of the tag. |
18.3. Drilling Down
To drill down into a metric, make a GET
request to /actuator/metrics/{metric.name}
using the tag
query parameter, as shown in the following curl-based example:
$ curl 'http://localhost:8080/actuator/metrics/jvm.memory.max?tag=area%3Anonheap&tag=id%3ACompressed+Class+Space' -i -X GET
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:
HTTP/1.1 200 OK
Content-Disposition: inline;filename=f.txt
Content-Type: application/vnd.spring-boot.actuator.v2+json;charset=UTF-8
Content-Length: 263
{
"name" : "jvm.memory.max",
"description" : "The maximum amount of memory in bytes that can be used for memory management",
"baseUnit" : "bytes",
"measurements" : [ {
"statistic" : "VALUE",
"value" : 1.073741824E9
} ],
"availableTags" : [ ]
}
19. Prometheus (prometheus
)
The prometheus
endpoint provides Spring Boot application’s metrics in the format required for scraping by a Prometheus server.
19.1. Retrieving the Metrics
To retrieve the metrics, make a GET
request to /actuator/prometheus
, as shown in the following curl-based example:
$ curl 'http://localhost:8080/actuator/prometheus' -i -X GET
The resulting response is similar to the following:
HTTP/1.1 200 OK
Content-Type: text/plain;version=0.0.4;charset=utf-8
Content-Length: 2367
# HELP jvm_buffer_count_buffers An estimate of the number of buffers in the pool
# TYPE jvm_buffer_count_buffers gauge
jvm_buffer_count_buffers{id="direct",} 13.0
jvm_buffer_count_buffers{id="mapped",} 0.0
# HELP jvm_memory_committed_bytes The amount of memory in bytes that is committed for the Java virtual machine to use
# TYPE jvm_memory_committed_bytes gauge
jvm_memory_committed_bytes{area="heap",id="PS Survivor Space",} 1.3631488E7
jvm_memory_committed_bytes{area="heap",id="PS Old Gen",} 2.68959744E8
jvm_memory_committed_bytes{area="heap",id="PS Eden Space",} 3.2768E8
jvm_memory_committed_bytes{area="nonheap",id="Metaspace",} 1.6048128E8
jvm_memory_committed_bytes{area="nonheap",id="Code Cache",} 4.816896E7
jvm_memory_committed_bytes{area="nonheap",id="Compressed Class Space",} 2.2593536E7
# HELP jvm_memory_used_bytes The amount of used memory
# TYPE jvm_memory_used_bytes gauge
jvm_memory_used_bytes{area="heap",id="PS Survivor Space",} 7411568.0
jvm_memory_used_bytes{area="heap",id="PS Old Gen",} 1.57196152E8
jvm_memory_used_bytes{area="heap",id="PS Eden Space",} 1.02864048E8
jvm_memory_used_bytes{area="nonheap",id="Metaspace",} 1.51074592E8
jvm_memory_used_bytes{area="nonheap",id="Code Cache",} 4.6989952E7
jvm_memory_used_bytes{area="nonheap",id="Compressed Class Space",} 2.0699704E7
# HELP jvm_memory_max_bytes The maximum amount of memory in bytes that can be used for memory management
# TYPE jvm_memory_max_bytes gauge
jvm_memory_max_bytes{area="heap",id="PS Survivor Space",} 1.3631488E7
jvm_memory_max_bytes{area="heap",id="PS Old Gen",} 7.16177408E8
jvm_memory_max_bytes{area="heap",id="PS Eden Space",} 3.3030144E8
jvm_memory_max_bytes{area="nonheap",id="Metaspace",} -1.0
jvm_memory_max_bytes{area="nonheap",id="Code Cache",} 2.5165824E8
jvm_memory_max_bytes{area="nonheap",id="Compressed Class Space",} 1.073741824E9
# HELP jvm_buffer_memory_used_bytes An estimate of the memory that the Java virtual machine is using for this buffer pool
# TYPE jvm_buffer_memory_used_bytes gauge
jvm_buffer_memory_used_bytes{id="direct",} 426117.0
jvm_buffer_memory_used_bytes{id="mapped",} 0.0
# HELP jvm_buffer_total_capacity_bytes An estimate of the total capacity of the buffers in this pool
# TYPE jvm_buffer_total_capacity_bytes gauge
jvm_buffer_total_capacity_bytes{id="direct",} 426116.0
jvm_buffer_total_capacity_bytes{id="mapped",} 0.0
20. Scheduled Tasks (scheduledtasks
)
The scheduledtasks
endpoint provides information about the application’s scheduled tasks.
20.1. Retrieving the Scheduled Tasks
To retrieve the scheduled tasks, make a GET
request to /actuator/scheduledtasks
, as shown in the following curl-based example:
$ curl 'http://localhost:8080/actuator/scheduledtasks' -i -X GET
The resulting response is similar to the following:
HTTP/1.1 200 OK
Content-Type: application/vnd.spring-boot.actuator.v2+json;charset=UTF-8
Content-Length: 629
{
"cron" : [ {
"runnable" : {
"target" : "com.example.Processor.processOrders"
},
"expression" : "0 0 0/3 1/1 * ?"
} ],
"fixedDelay" : [ {
"runnable" : {
"target" : "com.example.Processor.purge"
},
"initialDelay" : 5000,
"interval" : 5000
} ],
"fixedRate" : [ {
"runnable" : {
"target" : "com.example.Processor.retrieveIssues"
},
"initialDelay" : 10000,
"interval" : 3000
} ],
"custom" : [ {
"runnable" : {
"target" : "com.example.Processor$CustomTriggeredRunnable"
},
"trigger" : "com.example.Processor$CustomTrigger@3b61ef1c"
} ]
}
20.1.1. Response Structure
The response contains details of the application’s scheduled tasks. The following table describes the structure of the response:
Path | Type | Description |
---|---|---|
|
|
Cron tasks, if any. |
|
|
Target that will be executed. |
|
|
Cron expression. |
|
|
Fixed delay tasks, if any. |
|
|
Target that will be executed. |
|
|
Delay, in milliseconds, before first execution. |
|
|
Interval, in milliseconds, between the end of the last execution and the start of the next. |
|
|
Fixed rate tasks, if any. |
|
|
Target that will be executed. |
|
|
Interval, in milliseconds, between the start of each execution. |
|
|
Delay, in milliseconds, before first execution. |
|
|
Tasks with custom triggers, if any. |
|
|
Target that will be executed. |
|
|
Trigger for the task. |
21. Sessions (sessions
)
The sessions
endpoint provides information about the application’s HTTP sessions that are managed by Spring Session.
21.1. Retrieving Sessions
To retrieve the sessions, make a GET
request to /actuator/sessions
, as shown in the following curl-based example:
$ curl 'http://localhost:8080/actuator/sessions?username=alice' -i -X GET
The preceding examples retrieves all of the sessions for the user whose username is alice
.
The resulting response is similar to the following:
HTTP/1.1 200 OK
Content-Type: application/vnd.spring-boot.actuator.v2+json;charset=UTF-8
Content-Length: 753
{
"sessions" : [ {
"id" : "2cf05948-7dee-4e3e-80b5-a694abb2eda0",
"attributeNames" : [ ],
"creationTime" : "2019-10-02T02:30:42.078Z",
"lastAccessedTime" : "2019-10-02T14:29:57.078Z",
"maxInactiveInterval" : 1800,
"expired" : false
}, {
"id" : "4db5efcc-99cb-4d05-a52c-b49acfbb7ea9",
"attributeNames" : [ ],
"creationTime" : "2019-10-02T09:30:42.079Z",
"lastAccessedTime" : "2019-10-02T14:30:05.079Z",
"maxInactiveInterval" : 1800,
"expired" : false
}, {
"id" : "23e3592f-b0ab-4947-9bff-77dffaa43a19",
"attributeNames" : [ ],
"creationTime" : "2019-10-02T12:30:42.079Z",
"lastAccessedTime" : "2019-10-02T14:30:30.079Z",
"maxInactiveInterval" : 1800,
"expired" : false
} ]
}
21.1.1. Query Parameters
The endpoint uses query parameters to limit the sessions that it returns. The following table shows the single required query parameter:
Parameter | Description |
---|---|
|
Name of the user. |
21.1.2. Response Structure
The response contains details of the matching sessions. The following table describes the structure of the response:
Path | Type | Description |
---|---|---|
|
|
Sessions for the given username. |
|
|
ID of the session. |
|
|
Names of the attributes stored in the session. |
|
|
Timestamp of when the session was created. |
|
|
Timestamp of when the session was last accessed. |
|
|
Maximum permitted period of inactivity, in seconds, before the session will expire. |
|
|
Whether the session has expired. |
21.2. Retrieving a Single Session
To retrieve a single session, make a GET
request to /actuator/sessions/{id}
, as shown in the following curl-based example:
$ curl 'http://localhost:8080/actuator/sessions/4db5efcc-99cb-4d05-a52c-b49acfbb7ea9' -i -X GET
The preceding example retrieves the session with the id
of 4db5efcc-99cb-4d05-a52c-b49acfbb7ea9
.
The resulting response is similar to the following:
HTTP/1.1 200 OK
Content-Type: application/vnd.spring-boot.actuator.v2+json;charset=UTF-8
Content-Length: 228
{
"id" : "4db5efcc-99cb-4d05-a52c-b49acfbb7ea9",
"attributeNames" : [ ],
"creationTime" : "2019-10-02T09:30:42.079Z",
"lastAccessedTime" : "2019-10-02T14:30:05.079Z",
"maxInactiveInterval" : 1800,
"expired" : false
}
21.2.1. Response Structure
The response contains details of the requested session. The following table describes the structure of the response:
Path | Type | Description |
---|---|---|
|
|
ID of the session. |
|
|
Names of the attributes stored in the session. |
|
|
Timestamp of when the session was created. |
|
|
Timestamp of when the session was last accessed. |
|
|
Maximum permitted period of inactivity, in seconds, before the session will expire. |
|
|
Whether the session has expired. |
21.3. Deleting a Session
To delete a session, make a DELETE
request to /actuator/sessions/{id}
, as shown in the following curl-based example:
$ curl 'http://localhost:8080/actuator/sessions/4db5efcc-99cb-4d05-a52c-b49acfbb7ea9' -i -X DELETE
The preceding example deletes the session with the id
of 4db5efcc-99cb-4d05-a52c-b49acfbb7ea9
.
22. Shutdown (shutdown
)
The shutdown
endpoint is used to shut down the application.
22.1. Shutting Down the Application
To shut down the application, make a POST
request to /actuator/shutdown
, as shown in the following curl-based example:
$ curl 'http://localhost:8080/actuator/shutdown' -i -X POST
A response similar to the following is produced:
HTTP/1.1 200 OK
Content-Type: application/vnd.spring-boot.actuator.v2+json;charset=UTF-8
Content-Length: 41
{
"message" : "Shutting down, bye..."
}
22.1.1. Response Structure
The response contains details of the result of the shutdown request. The following table describes the structure of the response:
Path | Type | Description |
---|---|---|
|
|
Message describing the result of the request. |
23. Thread Dump (threaddump
)
The threaddump
endpoint provides a thread dump from the application’s JVM.
23.1. Retrieving the Thread Dump
To retrieve the thread dump, make a GET
request to /actuator/threaddump
, as shown in the following curl-based example:
$ curl 'http://localhost:8080/actuator/threaddump' -i -X GET
The resulting response is similar to the following:
HTTP/1.1 200 OK
Content-Type: application/vnd.spring-boot.actuator.v2+json;charset=UTF-8
Content-Length: 8681
{
"threads" : [ {
"threadName" : "Thread-103",
"threadId" : 556,
"blockedTime" : -1,
"blockedCount" : 0,
"waitedTime" : -1,
"waitedCount" : 1,
"lockName" : "java.util.concurrent.CountDownLatch$Sync@65a00f63",
"lockOwnerId" : -1,
"inNative" : false,
"suspended" : false,
"threadState" : "WAITING",
"stackTrace" : [ {
"methodName" : "park",
"fileName" : "Unsafe.java",
"lineNumber" : -2,
"className" : "sun.misc.Unsafe",
"nativeMethod" : true
}, {
"methodName" : "park",
"fileName" : "LockSupport.java",
"lineNumber" : 175,
"className" : "java.util.concurrent.locks.LockSupport",
"nativeMethod" : false
}, {
"methodName" : "parkAndCheckInterrupt",
"fileName" : "AbstractQueuedSynchronizer.java",
"lineNumber" : 836,
"className" : "java.util.concurrent.locks.AbstractQueuedSynchronizer",
"nativeMethod" : false
}, {
"methodName" : "doAcquireSharedInterruptibly",
"fileName" : "AbstractQueuedSynchronizer.java",
"lineNumber" : 997,
"className" : "java.util.concurrent.locks.AbstractQueuedSynchronizer",
"nativeMethod" : false
}, {
"methodName" : "acquireSharedInterruptibly",
"fileName" : "AbstractQueuedSynchronizer.java",
"lineNumber" : 1304,
"className" : "java.util.concurrent.locks.AbstractQueuedSynchronizer",
"nativeMethod" : false
}, {
"methodName" : "await",
"fileName" : "CountDownLatch.java",
"lineNumber" : 231,
"className" : "java.util.concurrent.CountDownLatch",
"nativeMethod" : false
}, {
"methodName" : "lambda$threadDump$0",
"fileName" : "ThreadDumpEndpointDocumentationTests.java",
"lineNumber" : 53,
"className" : "org.springframework.boot.actuate.autoconfigure.endpoint.web.documentation.ThreadDumpEndpointDocumentationTests",
"nativeMethod" : false
}, {
"methodName" : "run",
"lineNumber" : -1,
"className" : "org.springframework.boot.actuate.autoconfigure.endpoint.web.documentation.ThreadDumpEndpointDocumentationTests$$Lambda$2675/895542617",
"nativeMethod" : false
}, {
"methodName" : "run",
"fileName" : "Thread.java",
"lineNumber" : 748,
"className" : "java.lang.Thread",
"nativeMethod" : false
} ],
"lockedMonitors" : [ ],
"lockedSynchronizers" : [ {
"className" : "java.util.concurrent.locks.ReentrantLock$NonfairSync",
"identityHashCode" : 595562989
} ],
"lockInfo" : {
"className" : "java.util.concurrent.CountDownLatch$Sync",
"identityHashCode" : 1704988515
}
}, {
"threadName" : "Thread-101",
"threadId" : 554,
"blockedTime" : -1,
"blockedCount" : 0,
"waitedTime" : -1,
"waitedCount" : 1,
"lockOwnerId" : -1,
"inNative" : false,
"suspended" : false,
"threadState" : "TIMED_WAITING",
"stackTrace" : [ {
"methodName" : "sleep",
"fileName" : "Thread.java",
"lineNumber" : -2,
"className" : "java.lang.Thread",
"nativeMethod" : true
}, {
"methodName" : "performShutdown",
"fileName" : "ShutdownEndpoint.java",
"lineNumber" : 65,
"className" : "org.springframework.boot.actuate.context.ShutdownEndpoint",
"nativeMethod" : false
}, {
"methodName" : "run",
"lineNumber" : -1,
"className" : "org.springframework.boot.actuate.context.ShutdownEndpoint$$Lambda$2674/2137082192",
"nativeMethod" : false
}, {
"methodName" : "run",
"fileName" : "Thread.java",
"lineNumber" : 748,
"className" : "java.lang.Thread",
"nativeMethod" : false
} ],
"lockedMonitors" : [ ],
"lockedSynchronizers" : [ ]
}, {
"threadName" : "pool-10-thread-1",
"threadId" : 546,
"blockedTime" : -1,
"blockedCount" : 0,
"waitedTime" : -1,
"waitedCount" : 0,
"lockOwnerId" : -1,
"inNative" : false,
"suspended" : false,
"threadState" : "RUNNABLE",
"stackTrace" : [ {
"methodName" : "siftUp",
"fileName" : "ScheduledThreadPoolExecutor.java",
"lineNumber" : 886,
"className" : "java.util.concurrent.ScheduledThreadPoolExecutor$DelayedWorkQueue",
"nativeMethod" : false
}, {
"methodName" : "offer",
"fileName" : "ScheduledThreadPoolExecutor.java",
"lineNumber" : 1020,
"className" : "java.util.concurrent.ScheduledThreadPoolExecutor$DelayedWorkQueue",
"nativeMethod" : false
}, {
"methodName" : "add",
"fileName" : "ScheduledThreadPoolExecutor.java",
"lineNumber" : 1037,
"className" : "java.util.concurrent.ScheduledThreadPoolExecutor$DelayedWorkQueue",
"nativeMethod" : false
}, {
"methodName" : "add",
"fileName" : "ScheduledThreadPoolExecutor.java",
"lineNumber" : 809,
"className" : "java.util.concurrent.ScheduledThreadPoolExecutor$DelayedWorkQueue",
"nativeMethod" : false
}, {
"methodName" : "delayedExecute",
"fileName" : "ScheduledThreadPoolExecutor.java",
"lineNumber" : 328,
"className" : "java.util.concurrent.ScheduledThreadPoolExecutor",
"nativeMethod" : false
}, {
"methodName" : "schedule",
"fileName" : "ScheduledThreadPoolExecutor.java",
"lineNumber" : 533,
"className" : "java.util.concurrent.ScheduledThreadPoolExecutor",
"nativeMethod" : false
}, {
"methodName" : "schedule",
"fileName" : "Executors.java",
"lineNumber" : 729,
"className" : "java.util.concurrent.Executors$DelegatedScheduledExecutorService",
"nativeMethod" : false
}, {
"methodName" : "schedule",
"fileName" : "ReschedulingRunnable.java",
"lineNumber" : 80,
"className" : "org.springframework.scheduling.concurrent.ReschedulingRunnable",
"nativeMethod" : false
}, {
"methodName" : "run",
"fileName" : "ReschedulingRunnable.java",
"lineNumber" : 99,
"className" : "org.springframework.scheduling.concurrent.ReschedulingRunnable",
"nativeMethod" : false
}, {
"methodName" : "call",
"fileName" : "Executors.java",
"lineNumber" : 511,
"className" : "java.util.concurrent.Executors$RunnableAdapter",
"nativeMethod" : false
}, {
"methodName" : "run",
"fileName" : "FutureTask.java",
"lineNumber" : 266,
"className" : "java.util.concurrent.FutureTask",
"nativeMethod" : false
}, {
"methodName" : "access$201",
"fileName" : "ScheduledThreadPoolExecutor.java",
"lineNumber" : 180,
"className" : "java.util.concurrent.ScheduledThreadPoolExecutor$ScheduledFutureTask",
"nativeMethod" : false
}, {
"methodName" : "run",
"fileName" : "ScheduledThreadPoolExecutor.java",
"lineNumber" : 293,
"className" : "java.util.concurrent.ScheduledThreadPoolExecutor$ScheduledFutureTask",
"nativeMethod" : false
}, {
"methodName" : "runWorker",
"fileName" : "ThreadPoolExecutor.java",
"lineNumber" : 1149,
"className" : "java.util.concurrent.ThreadPoolExecutor",
"nativeMethod" : false
}, {
"methodName" : "run",
"fileName" : "ThreadPoolExecutor.java",
"lineNumber" : 624,
"className" : "java.util.concurrent.ThreadPoolExecutor$Worker",
"nativeMethod" : false
}, {
"methodName" : "run",
"fileName" : "Thread.java",
"lineNumber" : 748,
"className" : "java.lang.Thread",
"nativeMethod" : false
} ],
"lockedMonitors" : [ {
"className" : "java.lang.Object",
"identityHashCode" : 514315582,
"lockedStackDepth" : 7,
"lockedStackFrame" : {
"methodName" : "schedule",
"fileName" : "ReschedulingRunnable.java",
"lineNumber" : 80,
"className" : "org.springframework.scheduling.concurrent.ReschedulingRunnable",
"nativeMethod" : false
}
}, {
"className" : "java.lang.Object",
"identityHashCode" : 514315582,
"lockedStackDepth" : 8,
"lockedStackFrame" : {
"methodName" : "run",
"fileName" : "ReschedulingRunnable.java",
"lineNumber" : 99,
"className" : "org.springframework.scheduling.concurrent.ReschedulingRunnable",
"nativeMethod" : false
}
} ],
"lockedSynchronizers" : [ {
"className" : "java.util.concurrent.ThreadPoolExecutor$Worker",
"identityHashCode" : 1954474722
}, {
"className" : "java.util.concurrent.locks.ReentrantLock$NonfairSync",
"identityHashCode" : 752853406
} ]
} ]
}
23.1.1. Response Structure
The response contains details of the JVM’s threads. The following table describes the structure of the response:
Path | Type | Description |
---|---|---|
|
|
JVM’s threads. |
|
|
Total number of times that the thread has been blocked. |
|
|
Time in milliseconds that the thread has spent blocked. -1 if thread contention monitoring is disabled. |
|
|
Whether the thread is a daemon thread. Only available on Java 9 or later. |
|
|
Whether the thread is executing native code. |
|
|
Description of the object on which the thread is blocked, if any. |
|
|
Object for which the thread is blocked waiting. |
|
|
Fully qualified class name of the lock object. |
|
|
Identity hash code of the lock object. |
|
|
Monitors locked by this thread, if any |
|
|
Class name of the lock object. |
|
|
Identity hash code of the lock object. |
|
|
Stack depth where the monitor was locked. |
|
|
Stack frame that locked the monitor. |
|
|
Synchronizers locked by this thread. |
|
|
Class name of the locked synchronizer. |
|
|
Identity hash code of the locked synchronizer. |
|
|
ID of the thread that owns the object on which the thread is blocked. |
|
|
Name of the thread that owns the object on which the thread is blocked, if any. |
|
|
Priority of the thread. Only available on Java 9 or later. |
|
|
Stack trace of the thread. |
|
|
Name of the class loader of the class that contains the execution point identified by this entry, if any. Only available on Java 9 or later. |
|
|
Name of the class that contains the execution point identified by this entry. |
|
|
Name of the source file that contains the execution point identified by this entry, if any. |
|
|
Line number of the execution point identified by this entry. Negative if unknown. |
|
|
Name of the method. |
|
|
Name of the module that contains the execution point identified by this entry, if any. Only available on Java 9 or later. |
|
|
Version of the module that contains the execution point identified by this entry, if any. Only available on Java 9 or later. |
|
|
Whether the execution point is a native method. |
|
|
Whether the thread is suspended. |
|
|
ID of the thread. |
|
|
Name of the thread. |
|
|
State of the thread ( |
|
|
Total number of times that the thread has waited for notification. |
|
|
Time in milliseconds that the thread has spent waiting. -1 if thread contention monitoring is disabled |