Use one sentence per line in Actuator and Gradle plugin doc source
Closes gh-18185
This commit is contained in:
Andy Wilkinson
@@ -8,14 +8,12 @@ The `auditevents` endpoint provides information about the application's audit ev
|
||||
[[audit-events-retrieving]]
|
||||
== Retrieving Audit Events
|
||||
|
||||
To retrieve the audit events, make a `GET` request to `/actuator/auditevents`, as shown
|
||||
in the following curl-based example:
|
||||
To retrieve the audit events, make a `GET` request to `/actuator/auditevents`, as shown in the following curl-based example:
|
||||
|
||||
include::{snippets}auditevents/filtered/curl-request.adoc[]
|
||||
|
||||
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:
|
||||
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:
|
||||
|
||||
include::{snippets}auditevents/filtered/http-response.adoc[]
|
||||
|
||||
@@ -24,8 +22,8 @@ include::{snippets}auditevents/filtered/http-response.adoc[]
|
||||
[[audit-events-retrieving-query-parameters]]
|
||||
=== Query Parameters
|
||||
|
||||
The endpoint uses query parameters to limit the events that it returns. The following
|
||||
table shows the supported query parameters:
|
||||
The endpoint uses query parameters to limit the events that it returns.
|
||||
The following table shows the supported query parameters:
|
||||
|
||||
[cols="2,4"]
|
||||
include::{snippets}auditevents/filtered/request-parameters.adoc[]
|
||||
@@ -35,8 +33,8 @@ include::{snippets}auditevents/filtered/request-parameters.adoc[]
|
||||
[[audit-events-retrieving-response-structure]]
|
||||
=== 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:
|
||||
The response contains details of all of the audit events that matched the query.
|
||||
The following table describes the structure of the response:
|
||||
|
||||
[cols="2,1,3"]
|
||||
include::{snippets}auditevents/all/response-fields.adoc[]
|
||||
|
||||
@@ -8,8 +8,7 @@ The `beans` endpoint provides information about the application's beans.
|
||||
[[beans-retrieving]]
|
||||
== Retrieving the Beans
|
||||
|
||||
To retrieve the beans, make a `GET` request to `/actuator/beans`, as shown in the
|
||||
following curl-based example:
|
||||
To retrieve the beans, make a `GET` request to `/actuator/beans`, as shown in the following curl-based example:
|
||||
|
||||
include::{snippets}beans/curl-request.adoc[]
|
||||
|
||||
@@ -22,8 +21,8 @@ include::{snippets}beans/http-response.adoc[]
|
||||
[[beans-retrieving-response-structure]]
|
||||
=== Response Structure
|
||||
|
||||
The response contains details of the application's beans. The following table describes
|
||||
the structure of the response:
|
||||
The response contains details of the application's beans.
|
||||
The following table describes the structure of the response:
|
||||
|
||||
[cols="2,1,3"]
|
||||
include::{snippets}beans/response-fields.adoc[]
|
||||
|
||||
@@ -7,8 +7,7 @@ The `caches` endpoint provides access to the application's caches.
|
||||
|
||||
[[caches-all]]
|
||||
== Retrieving All Caches
|
||||
To retrieve the application's caches, make a `GET` request to `/actuator/caches`, as
|
||||
shown in the following curl-based example:
|
||||
To retrieve the application's caches, make a `GET` request to `/actuator/caches`, as shown in the following curl-based example:
|
||||
|
||||
include::{snippets}caches/all/curl-request.adoc[]
|
||||
|
||||
@@ -20,8 +19,8 @@ include::{snippets}caches/all/http-response.adoc[]
|
||||
|
||||
[[caches-all-response-structure]]
|
||||
=== Response Structure
|
||||
The response contains details of the application's caches. The following table describes
|
||||
the structure of the response:
|
||||
The response contains details of the application's caches.
|
||||
The following table describes the structure of the response:
|
||||
|
||||
[cols="3,1,3"]
|
||||
include::{snippets}caches/all/response-fields.adoc[]
|
||||
@@ -30,13 +29,12 @@ include::{snippets}caches/all/response-fields.adoc[]
|
||||
|
||||
[[caches-named]]
|
||||
== 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:
|
||||
To retrieve a cache by name, make a `GET` request to `/actuator/caches/\{name}`, as shown in the following curl-based example:
|
||||
|
||||
include::{snippets}caches/named/curl-request.adoc[]
|
||||
|
||||
The preceding example retrieves information about the cache named `cities`. The
|
||||
resulting response is similar to the following:
|
||||
The preceding example retrieves information about the cache named `cities`.
|
||||
The resulting response is similar to the following:
|
||||
|
||||
include::{snippets}caches/named/http-response.adoc[]
|
||||
|
||||
@@ -44,9 +42,9 @@ include::{snippets}caches/named/http-response.adoc[]
|
||||
|
||||
[[caches-named-query-parameters]]
|
||||
=== 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:
|
||||
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:
|
||||
|
||||
[cols="2,4"]
|
||||
include::{snippets}caches/named/request-parameters.adoc[]
|
||||
@@ -55,8 +53,8 @@ include::{snippets}caches/named/request-parameters.adoc[]
|
||||
|
||||
[[caches-named-response-structure]]
|
||||
=== Response Structure
|
||||
The response contains details of the requested cache. The following table describes the
|
||||
structure of the response:
|
||||
The response contains details of the requested cache.
|
||||
The following table describes the structure of the response:
|
||||
|
||||
[cols="3,1,3"]
|
||||
include::{snippets}caches/named/response-fields.adoc[]
|
||||
@@ -65,8 +63,7 @@ include::{snippets}caches/named/response-fields.adoc[]
|
||||
|
||||
[[caches-evict-all]]
|
||||
== Evict All Caches
|
||||
To clear all available caches, make a `DELETE` request to `/actuator/caches` as shown in
|
||||
the following curl-based example:
|
||||
To clear all available caches, make a `DELETE` request to `/actuator/caches` as shown in the following curl-based example:
|
||||
|
||||
include::{snippets}caches/evict-all/curl-request.adoc[]
|
||||
|
||||
@@ -74,21 +71,19 @@ include::{snippets}caches/evict-all/curl-request.adoc[]
|
||||
|
||||
[[caches-evict-named]]
|
||||
== 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:
|
||||
To evict a particular cache, make a `DELETE` request to `/actuator/caches/\{name}` as shown in the following curl-based example:
|
||||
|
||||
include::{snippets}caches/evict-named/curl-request.adoc[]
|
||||
|
||||
NOTE: As there are two caches named `countries`, the `cacheManager` has to be provided to
|
||||
specify which `Cache` should be cleared.
|
||||
NOTE: As there are two caches named `countries`, the `cacheManager` has to be provided to specify which `Cache` should be cleared.
|
||||
|
||||
|
||||
|
||||
[[caches-evict-named-request-structure]]
|
||||
=== 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:
|
||||
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:
|
||||
|
||||
[cols="2,4"]
|
||||
include::{snippets}caches/evict-named/request-parameters.adoc[]
|
||||
|
||||
@@ -1,16 +1,14 @@
|
||||
[[conditions]]
|
||||
= Conditions Evaluation Report (`conditions`)
|
||||
|
||||
The `conditions` endpoint provides information about the evaluation of conditions on
|
||||
configuration and auto-configuration classes.
|
||||
The `conditions` endpoint provides information about the evaluation of conditions on configuration and auto-configuration classes.
|
||||
|
||||
|
||||
|
||||
[[conditions-retrieving]]
|
||||
== Retrieving the Report
|
||||
|
||||
To retrieve the report, make a `GET` request to `/actuator/conditions`, as shown in
|
||||
the following curl-based example:
|
||||
To retrieve the report, make a `GET` request to `/actuator/conditions`, as shown in the following curl-based example:
|
||||
|
||||
include::{snippets}conditions/curl-request.adoc[]
|
||||
|
||||
@@ -23,8 +21,8 @@ include::{snippets}conditions/http-response.adoc[]
|
||||
[[conditions-retrieving-response-structure]]
|
||||
=== Response Structure
|
||||
|
||||
The response contains details of the application's condition evaluation. The following
|
||||
table describes the structure of the response:
|
||||
The response contains details of the application's condition evaluation.
|
||||
The following table describes the structure of the response:
|
||||
|
||||
[cols="3,1,3"]
|
||||
include::{snippets}conditions/response-fields.adoc[]
|
||||
|
||||
@@ -1,16 +1,14 @@
|
||||
[[configprops]]
|
||||
= Configuration Properties (`configprops`)
|
||||
|
||||
The `configprops` endpoint provides information about the application's
|
||||
`@ConfigurationProperties` beans.
|
||||
The `configprops` endpoint provides information about the application's `@ConfigurationProperties` beans.
|
||||
|
||||
|
||||
|
||||
[[configprops-retrieving]]
|
||||
== Retrieving the `@ConfigurationProperties` Bean
|
||||
|
||||
To retrieve the `@ConfigurationProperties` beans, make a `GET` request to
|
||||
`/actuator/configprops`, as shown in the following curl-based example:
|
||||
To retrieve the `@ConfigurationProperties` beans, make a `GET` request to `/actuator/configprops`, as shown in the following curl-based example:
|
||||
|
||||
include::{snippets}configprops/curl-request.adoc[]
|
||||
|
||||
@@ -23,8 +21,8 @@ include::{snippets}configprops/http-response.adoc[]
|
||||
[[configprops-retrieving-response-structure]]
|
||||
=== Response Structure
|
||||
|
||||
The response contains details of the application's `@ConfigurationProperties` beans. The
|
||||
following table describes the structure of the response:
|
||||
The response contains details of the application's `@ConfigurationProperties` beans.
|
||||
The following table describes the structure of the response:
|
||||
|
||||
[cols="2,1,3"]
|
||||
include::{snippets}configprops/response-fields.adoc[]
|
||||
|
||||
@@ -8,8 +8,7 @@ The `env` endpoint provides information about the application's `Environment`.
|
||||
[[env-entire]]
|
||||
== Retrieving the Entire Environment
|
||||
|
||||
To retrieve the entire environment, make a `GET` request to `/actuator/env`, as shown in
|
||||
the following curl-based example:
|
||||
To retrieve the entire environment, make a `GET` request to `/actuator/env`, as shown in the following curl-based example:
|
||||
|
||||
include::{snippets}env/all/curl-request.adoc[]
|
||||
|
||||
@@ -22,8 +21,8 @@ include::{snippets}env/all/http-response.adoc[]
|
||||
[[env-entire-response-structure]]
|
||||
=== Response Structure
|
||||
|
||||
The response contains details of the application's `Environment`. The following table
|
||||
describes the structure of the response:
|
||||
The response contains details of the application's `Environment`.
|
||||
The following table describes the structure of the response:
|
||||
|
||||
[cols="3,1,3"]
|
||||
include::{snippets}env/all/response-fields.adoc[]
|
||||
@@ -33,13 +32,12 @@ include::{snippets}env/all/response-fields.adoc[]
|
||||
[[env-single-property]]
|
||||
== 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:
|
||||
To retrieve a single property, make a `GET` request to `/actuator/env/{property.name}`, as shown in the following curl-based example:
|
||||
|
||||
include::{snippets}env/single/curl-request.adoc[]
|
||||
|
||||
The preceding example retrieves information about the property named
|
||||
`com.example.cache.max-size`. The resulting response is similar to the following:
|
||||
The preceding example retrieves information about the property named `com.example.cache.max-size`.
|
||||
The resulting response is similar to the following:
|
||||
|
||||
include::{snippets}env/single/http-response.adoc[]
|
||||
|
||||
@@ -48,8 +46,8 @@ include::{snippets}env/single/http-response.adoc[]
|
||||
[[env-single-response-structure]]
|
||||
=== Response Structure
|
||||
|
||||
The response contains details of the requested property. The following table describes the
|
||||
structure of the response:
|
||||
The response contains details of the requested property.
|
||||
The following table describes the structure of the response:
|
||||
|
||||
[cols="3,1,3"]
|
||||
include::{snippets}env/single/response-fields.adoc[]
|
||||
|
||||
@@ -8,8 +8,7 @@ The `flyway` endpoint provides information about database migrations performed b
|
||||
[[flyway-retrieving]]
|
||||
== Retrieving the Migrations
|
||||
|
||||
To retrieve the migrations, make a `GET` request to `/actuator/flyway`, as shown in the
|
||||
following curl-based example:
|
||||
To retrieve the migrations, make a `GET` request to `/actuator/flyway`, as shown in the following curl-based example:
|
||||
|
||||
include::{snippets}flyway/curl-request.adoc[]
|
||||
|
||||
@@ -22,8 +21,8 @@ include::{snippets}flyway/http-response.adoc[]
|
||||
[[flyway-retrieving-response-structure]]
|
||||
=== Response Structure
|
||||
|
||||
The response contains details of the application's Flyway migrations. The following table
|
||||
describes the structure of the response:
|
||||
The response contains details of the application's Flyway migrations.
|
||||
The following table describes the structure of the response:
|
||||
|
||||
[cols="2,1,3"]
|
||||
include::{snippets}flyway/response-fields.adoc[]
|
||||
|
||||
@@ -6,8 +6,7 @@ The `health` endpoint provides detailed information about the health of the appl
|
||||
|
||||
[[health-retrieving]]
|
||||
== 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:
|
||||
To retrieve the health of the application, make a `GET` request to `/actuator/health`, as shown in the following curl-based example:
|
||||
|
||||
include::{snippets}health/curl-request.adoc[]
|
||||
|
||||
@@ -19,8 +18,8 @@ include::{snippets}health/http-response.adoc[]
|
||||
|
||||
[[health-retrieving-response-structure]]
|
||||
=== Response Structure
|
||||
The response contains details of the health of the application. The following table
|
||||
describes the structure of the response:
|
||||
The response contains details of the health of the application.
|
||||
The following table describes the structure of the response:
|
||||
|
||||
[cols="2,1,3"]
|
||||
include::{snippets}health/response-fields.adoc[]
|
||||
@@ -29,8 +28,7 @@ include::{snippets}health/response-fields.adoc[]
|
||||
|
||||
[[health-retrieving-component]]
|
||||
== 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:
|
||||
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:
|
||||
|
||||
include::{snippets}health/component/curl-request.adoc[]
|
||||
|
||||
@@ -52,10 +50,7 @@ include::{snippets}health/component/response-fields.adoc[]
|
||||
|
||||
[[health-retrieving-component-instance]]
|
||||
== 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:
|
||||
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:
|
||||
|
||||
include::{snippets}health/instance/curl-request.adoc[]
|
||||
|
||||
@@ -67,8 +62,8 @@ include::{snippets}health/instance/http-response.adoc[]
|
||||
|
||||
[[health-retrieving-component-instance-response-structure]]
|
||||
=== 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:
|
||||
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:
|
||||
|
||||
[cols="2,1,3"]
|
||||
include::{snippets}health/instance/response-fields.adoc[]
|
||||
|
||||
@@ -8,13 +8,11 @@ The `heapdump` endpoint provides a heap dump from the application's JVM.
|
||||
[[heapdump-retrieving]]
|
||||
== Retrieving the Heap Dump
|
||||
|
||||
To retrieve the heap dump, make a `GET` request to `/actuator/heapdump`. The response
|
||||
is binary data in https://docs.oracle.com/javase/8/docs/technotes/samples/hprof.html[
|
||||
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:
|
||||
To retrieve the heap dump, make a `GET` request to `/actuator/heapdump`.
|
||||
The response is binary data in https://docs.oracle.com/javase/8/docs/technotes/samples/hprof.html[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:
|
||||
|
||||
include::{snippets}heapdump/curl-request.adoc[]
|
||||
|
||||
The preceding example results in a file named `heapdump` being written to the current
|
||||
working directory.
|
||||
The preceding example results in a file named `heapdump` being written to the current working directory.
|
||||
|
||||
@@ -8,8 +8,7 @@ The `httptrace` endpoint provides information about HTTP request-response exchan
|
||||
[[http-trace-retrieving]]
|
||||
== Retrieving the Traces
|
||||
|
||||
To retrieve the traces, make a `GET` request to `/actuator/httptrace`, as shown in the
|
||||
following curl-based example:
|
||||
To retrieve the traces, make a `GET` request to `/actuator/httptrace`, as shown in the following curl-based example:
|
||||
|
||||
include::{snippets}httptrace/curl-request.adoc[]
|
||||
|
||||
@@ -22,8 +21,8 @@ include::{snippets}httptrace/http-response.adoc[]
|
||||
[[http-trace-retrieving-response-structure]]
|
||||
=== Response Structure
|
||||
|
||||
The response contains details of the traced HTTP request-response exchanges. The
|
||||
following table describes the structure of the response:
|
||||
The response contains details of the traced HTTP request-response exchanges.
|
||||
The following table describes the structure of the response:
|
||||
|
||||
[cols="2,1,3"]
|
||||
include::{snippets}httptrace/response-fields.adoc[]
|
||||
|
||||
@@ -8,8 +8,7 @@ The `info` endpoint provides general information about the application.
|
||||
[[info-retrieving]]
|
||||
== 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:
|
||||
To retrieve the information about the application, make a `GET` request to `/actuator/info`, as shown in the following curl-based example:
|
||||
|
||||
include::{snippets}info/curl-request.adoc[]
|
||||
|
||||
@@ -22,9 +21,9 @@ include::{snippets}info/http-response.adoc[]
|
||||
[[info-retrieving-response-structure]]
|
||||
=== 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.
|
||||
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.
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -1,15 +1,13 @@
|
||||
[[integrationgraph]]
|
||||
= Spring Integration graph (`integrationgraph`)
|
||||
|
||||
The `integrationgraph` endpoint exposes a graph containing all Spring Integration
|
||||
components.
|
||||
The `integrationgraph` endpoint exposes a graph containing all Spring Integration components.
|
||||
|
||||
|
||||
|
||||
[[integrationgraph-retrieving]]
|
||||
== 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:
|
||||
To retrieve the information about the application, make a `GET` request to `/actuator/integrationgraph`, as shown in the following curl-based example:
|
||||
|
||||
include::{snippets}integrationgraph/graph/curl-request.adoc[]
|
||||
|
||||
@@ -21,17 +19,14 @@ include::{snippets}integrationgraph/graph/http-response.adoc[]
|
||||
|
||||
[[integrationgraph-retrieving-response-structure]]
|
||||
=== 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
|
||||
https://docs.spring.io/spring-integration/reference/html/#integration-graph[reference
|
||||
documentation].
|
||||
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 https://docs.spring.io/spring-integration/reference/html/#integration-graph[reference documentation].
|
||||
|
||||
|
||||
|
||||
[[integrationgraph-rebuilding]]
|
||||
== 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:
|
||||
To rebuild the exposed graph, make a `POST` request to `/actuator/integrationgraph`, as shown in the following curl-based example:
|
||||
|
||||
include::{snippets}integrationgraph/rebuild/curl-request.adoc[]
|
||||
|
||||
|
||||
@@ -1,16 +1,14 @@
|
||||
[[liquibase]]
|
||||
= Liquibase (`liquibase`)
|
||||
|
||||
The `liquibase` endpoint provides information about database change sets applied by
|
||||
Liquibase.
|
||||
The `liquibase` endpoint provides information about database change sets applied by Liquibase.
|
||||
|
||||
|
||||
|
||||
[[liquibase-retrieving]]
|
||||
== Retrieving the Changes
|
||||
|
||||
To retrieve the changes, make a `GET` request to `/actuator/liquibase`, as shown in the
|
||||
following curl-based example:
|
||||
To retrieve the changes, make a `GET` request to `/actuator/liquibase`, as shown in the following curl-based example:
|
||||
|
||||
include::{snippets}liquibase/curl-request.adoc[]
|
||||
|
||||
@@ -23,8 +21,8 @@ include::{snippets}liquibase/http-response.adoc[]
|
||||
[[liquibase-retrieving-response-structure]]
|
||||
=== Response Structure
|
||||
|
||||
The response contains details of the application's Liquibase change sets. The following
|
||||
table describes the structure of the response:
|
||||
The response contains details of the application's Liquibase change sets.
|
||||
The following table describes the structure of the response:
|
||||
|
||||
[cols="2,1,3"]
|
||||
include::{snippets}liquibase/response-fields.adoc[]
|
||||
|
||||
@@ -8,8 +8,7 @@ The `logfile` endpoint provides access to the contents of the application's log
|
||||
[[logfile-retrieving]]
|
||||
== Retrieving the Log File
|
||||
|
||||
To retrieve the log file, make a `GET` request to `/actuator/logfile`, as shown in the
|
||||
following curl-based example:
|
||||
To retrieve the log file, make a `GET` request to `/actuator/logfile`, as shown in the following curl-based example:
|
||||
|
||||
include::{snippets}logfile/entire/curl-request.adoc[]
|
||||
|
||||
@@ -24,12 +23,11 @@ include::{snippets}logfile/entire/http-response.adoc[]
|
||||
|
||||
NOTE: 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:
|
||||
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:
|
||||
|
||||
include::{snippets}logfile/range/curl-request.adoc[]
|
||||
|
||||
The preceding example retrieves the first 1024 bytes of the log file. The resulting
|
||||
response is similar to the following:
|
||||
The preceding example retrieves the first 1024 bytes of the log file.
|
||||
The resulting response is similar to the following:
|
||||
|
||||
include::{snippets}logfile/range/http-response.adoc[]
|
||||
|
||||
@@ -1,16 +1,14 @@
|
||||
[[loggers]]
|
||||
= Loggers (`loggers`)
|
||||
|
||||
The `loggers` endpoint provides access to the application's loggers and the configuration
|
||||
of their levels.
|
||||
The `loggers` endpoint provides access to the application's loggers and the configuration of their levels.
|
||||
|
||||
|
||||
|
||||
[[loggers-all]]
|
||||
== Retrieving All Loggers
|
||||
|
||||
To retrieve the application's loggers, make a `GET` request to `/actuator/loggers`, as
|
||||
shown in the following curl-based example:
|
||||
To retrieve the application's loggers, make a `GET` request to `/actuator/loggers`, as shown in the following curl-based example:
|
||||
|
||||
include::{snippets}loggers/all/curl-request.adoc[]
|
||||
|
||||
@@ -23,8 +21,8 @@ include::{snippets}loggers/all/http-response.adoc[]
|
||||
[[loggers-all-response-structure]]
|
||||
=== Response Structure
|
||||
|
||||
The response contains details of the application's loggers. The following table describes
|
||||
the structure of the response:
|
||||
The response contains details of the application's loggers.
|
||||
The following table describes the structure of the response:
|
||||
|
||||
[cols="3,1,3"]
|
||||
include::{snippets}loggers/all/response-fields.adoc[]
|
||||
@@ -34,13 +32,12 @@ include::{snippets}loggers/all/response-fields.adoc[]
|
||||
[[loggers-single]]
|
||||
== 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:
|
||||
To retrieve a single logger, make a `GET` request to `/actuator/loggers/{logger.name}`, as shown in the following curl-based example:
|
||||
|
||||
include::{snippets}loggers/single/curl-request.adoc[]
|
||||
|
||||
The preceding example retrieves information about the logger named `com.example`. The
|
||||
resulting response is similar to the following:
|
||||
The preceding example retrieves information about the logger named `com.example`.
|
||||
The resulting response is similar to the following:
|
||||
|
||||
include::{snippets}loggers/single/http-response.adoc[]
|
||||
|
||||
@@ -49,8 +46,8 @@ include::{snippets}loggers/single/http-response.adoc[]
|
||||
[[loggers-single-response-structure]]
|
||||
=== Response Structure
|
||||
|
||||
The response contains details of the requested logger. The following table describes the
|
||||
structure of the response:
|
||||
The response contains details of the requested logger.
|
||||
The following table describes the structure of the response:
|
||||
|
||||
[cols="3,1,3"]
|
||||
include::{snippets}loggers/single/response-fields.adoc[]
|
||||
@@ -60,9 +57,7 @@ include::{snippets}loggers/single/response-fields.adoc[]
|
||||
[[loggers-setting-level]]
|
||||
== 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:
|
||||
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:
|
||||
|
||||
include::{snippets}loggers/set/curl-request.adoc[]
|
||||
|
||||
@@ -73,8 +68,8 @@ The preceding example sets the `configuredLevel` of the `com.example` logger to
|
||||
[[loggers-setting-level-request-structure]]
|
||||
=== Request Structure
|
||||
|
||||
The request specifies the desired level of the logger. The following table describes the
|
||||
structure of the request:
|
||||
The request specifies the desired level of the logger.
|
||||
The following table describes the structure of the request:
|
||||
|
||||
[cols="3,1,3"]
|
||||
include::{snippets}loggers/set/request-fields.adoc[]
|
||||
@@ -84,9 +79,7 @@ include::{snippets}loggers/set/request-fields.adoc[]
|
||||
[[loggers-clearing-level]]
|
||||
== 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:
|
||||
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:
|
||||
|
||||
include::{snippets}loggers/clear/curl-request.adoc[]
|
||||
|
||||
|
||||
@@ -8,8 +8,7 @@ The `mappings` endpoint provides information about the application's request map
|
||||
[[mappings-retrieving]]
|
||||
== Retrieving the Mappings
|
||||
|
||||
To retrieve the mappings, make a `GET` request to `/actuator/mappings`, as shown in the
|
||||
following curl-based example:
|
||||
To retrieve the mappings, make a `GET` request to `/actuator/mappings`, as shown in the following curl-based example:
|
||||
|
||||
include::{snippets}mappings/curl-request.adoc[]
|
||||
|
||||
@@ -22,23 +21,21 @@ include::{snippets}mappings/http-response.adoc[]
|
||||
[[mappings-retrieving-response-structure]]
|
||||
=== 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:
|
||||
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:
|
||||
|
||||
[cols="2,1,3"]
|
||||
include::{snippets}mappings/response-fields.adoc[]
|
||||
|
||||
The entries that may be found in `contexts.*.mappings` are described in the
|
||||
following sections.
|
||||
The entries that may be found in `contexts.*.mappings` are described in the following sections.
|
||||
|
||||
|
||||
[[mappings-retrieving-response-structure-dispatcher-servlets]]
|
||||
=== 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:
|
||||
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:
|
||||
|
||||
[cols="4,1,2"]
|
||||
include::{snippets}mappings/response-fields-dispatcher-servlets.adoc[]
|
||||
@@ -48,9 +45,8 @@ include::{snippets}mappings/response-fields-dispatcher-servlets.adoc[]
|
||||
[[mappings-retrieving-response-structure-servlets]]
|
||||
=== 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:
|
||||
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:
|
||||
|
||||
[cols="2,1,3"]
|
||||
include::{snippets}mappings/response-fields-servlets.adoc[]
|
||||
@@ -60,9 +56,8 @@ include::{snippets}mappings/response-fields-servlets.adoc[]
|
||||
[[mappings-retrieving-response-structure-servlet-filters]]
|
||||
=== 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:
|
||||
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:
|
||||
|
||||
[cols="2,1,3"]
|
||||
include::{snippets}mappings/response-fields-servlet-filters.adoc[]
|
||||
@@ -72,9 +67,8 @@ include::{snippets}mappings/response-fields-servlet-filters.adoc[]
|
||||
[[mappings-retrieving-response-structure-dispatcher-handlers]]
|
||||
=== 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:
|
||||
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:
|
||||
|
||||
[cols="4,1,2"]
|
||||
include::{snippets}mappings/response-fields-dispatcher-handlers.adoc[]
|
||||
|
||||
@@ -8,8 +8,7 @@ The `metrics` endpoint provides access to application metrics.
|
||||
[[metrics-retrieving-names]]
|
||||
== 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:
|
||||
To retrieve the names of the available metrics, make a `GET` request to `/actuator/metrics`, as shown in the following curl-based example:
|
||||
|
||||
include::{snippets}metrics/names/curl-request.adoc[]
|
||||
|
||||
@@ -22,8 +21,8 @@ include::{snippets}metrics/names/http-response.adoc[]
|
||||
[[metrics-retrieving-names-response-structure]]
|
||||
=== Response Structure
|
||||
|
||||
The response contains details of the metric names. The following table describes the
|
||||
structure of the response:
|
||||
The response contains details of the metric names.
|
||||
The following table describes the structure of the response:
|
||||
|
||||
[cols="3,1,2"]
|
||||
include::{snippets}metrics/names/response-fields.adoc[]
|
||||
@@ -33,13 +32,12 @@ include::{snippets}metrics/names/response-fields.adoc[]
|
||||
[[metrics-retrieving-metric]]
|
||||
== Retrieving a Metric
|
||||
|
||||
To retrieve a metric, make a `GET` request to `/actuator/metrics/{metric.name}`, as
|
||||
shown in the following curl-based example:
|
||||
To retrieve a metric, make a `GET` request to `/actuator/metrics/{metric.name}`, as shown in the following curl-based example:
|
||||
|
||||
include::{snippets}metrics/metric/curl-request.adoc[]
|
||||
|
||||
The preceding example retrieves information about the metric named `jvm.memory.max`. The
|
||||
resulting response is similar to the following:
|
||||
The preceding example retrieves information about the metric named `jvm.memory.max`.
|
||||
The resulting response is similar to the following:
|
||||
|
||||
include::{snippets}metrics/metric/http-response.adoc[]
|
||||
|
||||
@@ -48,8 +46,8 @@ include::{snippets}metrics/metric/http-response.adoc[]
|
||||
[[metrics-retrieving-metric-query-parameters]]
|
||||
=== Query Parameters
|
||||
|
||||
The endpoint uses query parameters to <<metrics-drilling-down,drill down>> into a metric
|
||||
by using its tags. The following table shows the single supported query parameter:
|
||||
The endpoint uses query parameters to <<metrics-drilling-down,drill down>> into a metric by using its tags.
|
||||
The following table shows the single supported query parameter:
|
||||
|
||||
[cols="2,4"]
|
||||
include::{snippets}metrics/metric-with-tags/request-parameters.adoc[]
|
||||
@@ -59,8 +57,8 @@ include::{snippets}metrics/metric-with-tags/request-parameters.adoc[]
|
||||
[[metrics-retrieving-metric-response-structure]]
|
||||
=== Response structure
|
||||
|
||||
The response contains details of the metric. The following table describes the structure
|
||||
of the response:
|
||||
The response contains details of the metric.
|
||||
The following table describes the structure of the response:
|
||||
|
||||
include::{snippets}metrics/metric/response-fields.adoc[]
|
||||
|
||||
@@ -68,13 +66,11 @@ include::{snippets}metrics/metric/response-fields.adoc[]
|
||||
[[metrics-drilling-down]]
|
||||
== 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:
|
||||
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:
|
||||
|
||||
include::{snippets}metrics/metric-with-tags/curl-request.adoc[]
|
||||
|
||||
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:
|
||||
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:
|
||||
|
||||
include::{snippets}metrics/metric-with-tags/http-response.adoc[]
|
||||
|
||||
@@ -1,16 +1,14 @@
|
||||
[[prometheus]]
|
||||
= Prometheus (`prometheus`)
|
||||
|
||||
The `prometheus` endpoint provides Spring Boot application's metrics in the format
|
||||
required for scraping by a Prometheus server.
|
||||
The `prometheus` endpoint provides Spring Boot application's metrics in the format required for scraping by a Prometheus server.
|
||||
|
||||
|
||||
|
||||
[[prometheus-retrieving]]
|
||||
== Retrieving the Metrics
|
||||
|
||||
To retrieve the metrics, make a `GET` request to `/actuator/prometheus`, as shown in
|
||||
the following curl-based example:
|
||||
To retrieve the metrics, make a `GET` request to `/actuator/prometheus`, as shown in the following curl-based example:
|
||||
|
||||
include::{snippets}prometheus/curl-request.adoc[]
|
||||
|
||||
|
||||
@@ -1,16 +1,14 @@
|
||||
[[scheduled-tasks]]
|
||||
= Scheduled Tasks (`scheduledtasks`)
|
||||
|
||||
The `scheduledtasks` endpoint provides information about the application's scheduled
|
||||
tasks.
|
||||
The `scheduledtasks` endpoint provides information about the application's scheduled tasks.
|
||||
|
||||
|
||||
|
||||
[[scheduled-tasks-retrieving]]
|
||||
== Retrieving the Scheduled Tasks
|
||||
|
||||
To retrieve the scheduled tasks, make a `GET` request to `/actuator/scheduledtasks`,
|
||||
as shown in the following curl-based example:
|
||||
To retrieve the scheduled tasks, make a `GET` request to `/actuator/scheduledtasks`, as shown in the following curl-based example:
|
||||
|
||||
include::{snippets}scheduled-tasks/curl-request.adoc[]
|
||||
|
||||
@@ -23,8 +21,8 @@ include::{snippets}scheduled-tasks/http-response.adoc[]
|
||||
[[scheduled-tasks-retrieving-response-structure]]
|
||||
=== Response Structure
|
||||
|
||||
The response contains details of the application's scheduled tasks. The following table
|
||||
describes the structure of the response:
|
||||
The response contains details of the application's scheduled tasks.
|
||||
The following table describes the structure of the response:
|
||||
|
||||
[cols="2,1,3"]
|
||||
include::{snippets}scheduled-tasks/response-fields.adoc[]
|
||||
|
||||
@@ -1,22 +1,18 @@
|
||||
[[sessions]]
|
||||
= Sessions (`sessions`)
|
||||
|
||||
The `sessions` endpoint provides information about the application's HTTP sessions that
|
||||
are managed by Spring Session.
|
||||
The `sessions` endpoint provides information about the application's HTTP sessions that are managed by Spring Session.
|
||||
|
||||
|
||||
|
||||
[[sessions-retrieving]]
|
||||
== Retrieving Sessions
|
||||
|
||||
To retrieve the sessions, make a `GET` request to `/actuator/sessions`, as shown in the
|
||||
following curl-based example:
|
||||
To retrieve the sessions, make a `GET` request to `/actuator/sessions`, as shown in the following curl-based example:
|
||||
|
||||
include::{snippets}sessions/username/curl-request.adoc[]
|
||||
|
||||
The preceding examples retrieves all of the sessions for the user whose username is
|
||||
`alice`.
|
||||
|
||||
The preceding examples retrieves all of the sessions for the user whose username is `alice`.
|
||||
The resulting response is similar to the following:
|
||||
|
||||
include::{snippets}sessions/username/http-response.adoc[]
|
||||
@@ -26,8 +22,8 @@ include::{snippets}sessions/username/http-response.adoc[]
|
||||
[[sessions-retrieving-query-parameters]]
|
||||
=== Query Parameters
|
||||
|
||||
The endpoint uses query parameters to limit the sessions that it returns. The following
|
||||
table shows the single required query parameter:
|
||||
The endpoint uses query parameters to limit the sessions that it returns.
|
||||
The following table shows the single required query parameter:
|
||||
|
||||
[cols="2,4"]
|
||||
include::{snippets}sessions/username/request-parameters.adoc[]
|
||||
@@ -37,8 +33,8 @@ include::{snippets}sessions/username/request-parameters.adoc[]
|
||||
[[sessions-retrieving-response-structure]]
|
||||
=== Response Structure
|
||||
|
||||
The response contains details of the matching sessions. The following table describes the
|
||||
structure of the response:
|
||||
The response contains details of the matching sessions.
|
||||
The following table describes the structure of the response:
|
||||
|
||||
[cols="3,1,3"]
|
||||
include::{snippets}sessions/username/response-fields.adoc[]
|
||||
@@ -48,14 +44,12 @@ include::{snippets}sessions/username/response-fields.adoc[]
|
||||
[[sessions-retrieving-id]]
|
||||
== 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:
|
||||
To retrieve a single session, make a `GET` request to `/actuator/sessions/\{id}`, as shown in the following curl-based example:
|
||||
|
||||
include::{snippets}sessions/id/curl-request.adoc[]
|
||||
|
||||
The preceding example retrieves the session with the `id` of
|
||||
`4db5efcc-99cb-4d05-a52c-b49acfbb7ea9`. The resulting response is similar to the
|
||||
following:
|
||||
The preceding example retrieves the session with the `id` of `4db5efcc-99cb-4d05-a52c-b49acfbb7ea9`.
|
||||
The resulting response is similar to the following:
|
||||
|
||||
include::{snippets}sessions/id/http-response.adoc[]
|
||||
|
||||
@@ -64,8 +58,8 @@ include::{snippets}sessions/id/http-response.adoc[]
|
||||
[[sessions-retrieving-id-response-structure]]
|
||||
=== Response Structure
|
||||
|
||||
The response contains details of the requested session. The following table describes the
|
||||
structure of the response:
|
||||
The response contains details of the requested session.
|
||||
The following table describes the structure of the response:
|
||||
|
||||
[cols="3,1,3"]
|
||||
include::{snippets}sessions/id/response-fields.adoc[]
|
||||
@@ -75,10 +69,8 @@ include::{snippets}sessions/id/response-fields.adoc[]
|
||||
[[sessions-deleting]]
|
||||
== Deleting a Session
|
||||
|
||||
To delete a session, make a `DELETE` request to `/actuator/sessions/\{id}`, as shown in
|
||||
the following curl-based example:
|
||||
To delete a session, make a `DELETE` request to `/actuator/sessions/\{id}`, as shown in the following curl-based example:
|
||||
|
||||
include::{snippets}sessions/delete/curl-request.adoc[]
|
||||
|
||||
The preceding example deletes the session with the `id` of
|
||||
`4db5efcc-99cb-4d05-a52c-b49acfbb7ea9`.
|
||||
The preceding example deletes the session with the `id` of `4db5efcc-99cb-4d05-a52c-b49acfbb7ea9`.
|
||||
|
||||
@@ -8,8 +8,7 @@ The `shutdown` endpoint is used to shut down the application.
|
||||
[[shutdown-shutting-down]]
|
||||
== Shutting Down the Application
|
||||
|
||||
To shut down the application, make a `POST` request to `/actuator/shutdown`, as shown
|
||||
in the following curl-based example:
|
||||
To shut down the application, make a `POST` request to `/actuator/shutdown`, as shown in the following curl-based example:
|
||||
|
||||
include::{snippets}shutdown/curl-request.adoc[]
|
||||
|
||||
@@ -22,8 +21,8 @@ include::{snippets}shutdown/http-response.adoc[]
|
||||
[[shutdown-shutting-down-response-structure]]
|
||||
=== Response Structure
|
||||
|
||||
The response contains details of the result of the shutdown request. The following table
|
||||
describes the structure of the response:
|
||||
The response contains details of the result of the shutdown request.
|
||||
The following table describes the structure of the response:
|
||||
|
||||
[cols="3,1,3"]
|
||||
include::{snippets}shutdown/response-fields.adoc[]
|
||||
|
||||
@@ -8,8 +8,7 @@ The `threaddump` endpoint provides a thread dump from the application's JVM.
|
||||
[[threaddump-retrieving]]
|
||||
== Retrieving the Thread Dump
|
||||
|
||||
To retrieve the thread dump, make a `GET` request to `/actuator/threaddump`, as shown
|
||||
in the following curl-based example:
|
||||
To retrieve the thread dump, make a `GET` request to `/actuator/threaddump`, as shown in the following curl-based example:
|
||||
|
||||
include::{snippets}threaddump/curl-request.adoc[]
|
||||
|
||||
@@ -22,8 +21,8 @@ include::{snippets}threaddump/http-response.adoc[]
|
||||
[[threaddump-retrieving-response-structure]]
|
||||
=== Response Structure
|
||||
|
||||
The response contains details of the JVM's threads. The following table describes the
|
||||
structure of the response:
|
||||
The response contains details of the JVM's threads.
|
||||
The following table describes the structure of the response:
|
||||
|
||||
[cols="3,1,2"]
|
||||
include::{snippets}threaddump/response-fields.adoc[]
|
||||
|
||||
Reference in New Issue
Block a user