Port the build to Gradle
Closes gh-19609 Closes gh-19608
This commit is contained in:
@@ -10,12 +10,12 @@ The `auditevents` endpoint provides information about the application's audit ev
|
||||
|
||||
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[]
|
||||
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:
|
||||
|
||||
include::{snippets}auditevents/filtered/http-response.adoc[]
|
||||
include::{snippets}/auditevents/filtered/http-response.adoc[]
|
||||
|
||||
|
||||
|
||||
@@ -26,7 +26,7 @@ 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[]
|
||||
include::{snippets}/auditevents/filtered/request-parameters.adoc[]
|
||||
|
||||
|
||||
|
||||
@@ -37,4 +37,4 @@ 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[]
|
||||
include::{snippets}/auditevents/all/response-fields.adoc[]
|
||||
@@ -10,11 +10,11 @@ The `beans` endpoint provides information about the application's beans.
|
||||
|
||||
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[]
|
||||
include::{snippets}/beans/curl-request.adoc[]
|
||||
|
||||
The resulting response is similar to the following:
|
||||
|
||||
include::{snippets}beans/http-response.adoc[]
|
||||
include::{snippets}/beans/http-response.adoc[]
|
||||
|
||||
|
||||
|
||||
@@ -25,4 +25,4 @@ 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[]
|
||||
include::{snippets}/beans/response-fields.adoc[]
|
||||
@@ -9,11 +9,11 @@ The `caches` endpoint provides access to the application's caches.
|
||||
== Retrieving All Caches
|
||||
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[]
|
||||
include::{snippets}/caches/all/curl-request.adoc[]
|
||||
|
||||
The resulting response is similar to the following:
|
||||
|
||||
include::{snippets}caches/all/http-response.adoc[]
|
||||
include::{snippets}/caches/all/http-response.adoc[]
|
||||
|
||||
|
||||
|
||||
@@ -23,7 +23,7 @@ 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[]
|
||||
include::{snippets}/caches/all/response-fields.adoc[]
|
||||
|
||||
|
||||
|
||||
@@ -31,12 +31,12 @@ include::{snippets}caches/all/response-fields.adoc[]
|
||||
== 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:
|
||||
|
||||
include::{snippets}caches/named/curl-request.adoc[]
|
||||
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:
|
||||
|
||||
include::{snippets}caches/named/http-response.adoc[]
|
||||
include::{snippets}/caches/named/http-response.adoc[]
|
||||
|
||||
|
||||
|
||||
@@ -47,7 +47,7 @@ Otherwise, the `cacheManager` must be specified.
|
||||
The following table shows the supported query parameters:
|
||||
|
||||
[cols="2,4"]
|
||||
include::{snippets}caches/named/request-parameters.adoc[]
|
||||
include::{snippets}/caches/named/request-parameters.adoc[]
|
||||
|
||||
|
||||
|
||||
@@ -57,7 +57,7 @@ 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[]
|
||||
include::{snippets}/caches/named/response-fields.adoc[]
|
||||
|
||||
|
||||
|
||||
@@ -65,7 +65,7 @@ include::{snippets}caches/named/response-fields.adoc[]
|
||||
== Evict All Caches
|
||||
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[]
|
||||
include::{snippets}/caches/evict-all/curl-request.adoc[]
|
||||
|
||||
|
||||
|
||||
@@ -73,7 +73,7 @@ include::{snippets}caches/evict-all/curl-request.adoc[]
|
||||
== 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:
|
||||
|
||||
include::{snippets}caches/evict-named/curl-request.adoc[]
|
||||
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.
|
||||
|
||||
@@ -86,4 +86,4 @@ 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[]
|
||||
include::{snippets}/caches/evict-named/request-parameters.adoc[]
|
||||
@@ -10,11 +10,11 @@ The `conditions` endpoint provides information about the evaluation of condition
|
||||
|
||||
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[]
|
||||
include::{snippets}/conditions/curl-request.adoc[]
|
||||
|
||||
The resulting response is similar to the following:
|
||||
|
||||
include::{snippets}conditions/http-response.adoc[]
|
||||
include::{snippets}/conditions/http-response.adoc[]
|
||||
|
||||
|
||||
|
||||
@@ -25,4 +25,4 @@ 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[]
|
||||
include::{snippets}/conditions/response-fields.adoc[]
|
||||
@@ -10,11 +10,11 @@ The `configprops` endpoint provides information about the application's `@Config
|
||||
|
||||
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[]
|
||||
include::{snippets}/configprops/curl-request.adoc[]
|
||||
|
||||
The resulting response is similar to the following:
|
||||
|
||||
include::{snippets}configprops/http-response.adoc[]
|
||||
include::{snippets}/configprops/http-response.adoc[]
|
||||
|
||||
|
||||
|
||||
@@ -25,4 +25,4 @@ The response contains details of the application's `@ConfigurationProperties` be
|
||||
The following table describes the structure of the response:
|
||||
|
||||
[cols="2,1,3"]
|
||||
include::{snippets}configprops/response-fields.adoc[]
|
||||
include::{snippets}/configprops/response-fields.adoc[]
|
||||
@@ -10,11 +10,11 @@ The `env` endpoint provides information about the application's `Environment`.
|
||||
|
||||
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[]
|
||||
include::{snippets}/env/all/curl-request.adoc[]
|
||||
|
||||
The resulting response is similar to the following:
|
||||
|
||||
include::{snippets}env/all/http-response.adoc[]
|
||||
include::{snippets}/env/all/http-response.adoc[]
|
||||
|
||||
|
||||
|
||||
@@ -25,7 +25,7 @@ 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[]
|
||||
include::{snippets}/env/all/response-fields.adoc[]
|
||||
|
||||
|
||||
|
||||
@@ -34,12 +34,12 @@ include::{snippets}env/all/response-fields.adoc[]
|
||||
|
||||
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[]
|
||||
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:
|
||||
|
||||
include::{snippets}env/single/http-response.adoc[]
|
||||
include::{snippets}/env/single/http-response.adoc[]
|
||||
|
||||
|
||||
|
||||
@@ -50,4 +50,4 @@ 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[]
|
||||
include::{snippets}/env/single/response-fields.adoc[]
|
||||
@@ -10,11 +10,11 @@ The `flyway` endpoint provides information about database migrations performed b
|
||||
|
||||
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[]
|
||||
include::{snippets}/flyway/curl-request.adoc[]
|
||||
|
||||
The resulting response is similar to the following:
|
||||
|
||||
include::{snippets}flyway/http-response.adoc[]
|
||||
include::{snippets}/flyway/http-response.adoc[]
|
||||
|
||||
|
||||
|
||||
@@ -25,4 +25,4 @@ 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[]
|
||||
include::{snippets}/flyway/response-fields.adoc[]
|
||||
@@ -8,11 +8,11 @@ The `health` endpoint provides detailed information about the health of the appl
|
||||
== 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:
|
||||
|
||||
include::{snippets}health/curl-request.adoc[]
|
||||
include::{snippets}/health/curl-request.adoc[]
|
||||
|
||||
The resulting response is similar to the following:
|
||||
|
||||
include::{snippets}health/http-response.adoc[]
|
||||
include::{snippets}/health/http-response.adoc[]
|
||||
|
||||
|
||||
|
||||
@@ -22,7 +22,7 @@ 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[]
|
||||
include::{snippets}/health/response-fields.adoc[]
|
||||
|
||||
NOTE: The response fields above are for the V3 API.
|
||||
If you need to return V2 JSON you should use an accept header or `application/vnd.spring-boot.actuator.v2+json`
|
||||
@@ -33,11 +33,11 @@ If you need to return V2 JSON you should use an accept header or `application/vn
|
||||
== Retrieving the Health of a component
|
||||
To retrieve the health of a particular component of the application's health, make a `GET` request to `/actuator/health/\{component}`, as shown in the following curl-based example:
|
||||
|
||||
include::{snippets}health/component/curl-request.adoc[]
|
||||
include::{snippets}/health/component/curl-request.adoc[]
|
||||
|
||||
The resulting response is similar to the following:
|
||||
|
||||
include::{snippets}health/component/http-response.adoc[]
|
||||
include::{snippets}/health/component/http-response.adoc[]
|
||||
|
||||
|
||||
|
||||
@@ -47,7 +47,7 @@ The response contains details of the health of a particular component of the app
|
||||
The following table describes the structure of the response:
|
||||
|
||||
[cols="2,1,3"]
|
||||
include::{snippets}health/component/response-fields.adoc[]
|
||||
include::{snippets}/health/component/response-fields.adoc[]
|
||||
|
||||
|
||||
|
||||
@@ -55,11 +55,11 @@ include::{snippets}health/component/response-fields.adoc[]
|
||||
== Retrieving the Health of a nested component
|
||||
If a particular component contains other nested components (as the `broker` indicator in the example above), the health of such a nested component can be retrieved by issuing a `GET` request to `/actuator/health/\{component}/\{subcomponent}`, as shown in the following curl-based example:
|
||||
|
||||
include::{snippets}health/instance/curl-request.adoc[]
|
||||
include::{snippets}/health/instance/curl-request.adoc[]
|
||||
|
||||
The resulting response is similar to the following:
|
||||
|
||||
include::{snippets}health/instance/http-response.adoc[]
|
||||
include::{snippets}/health/instance/http-response.adoc[]
|
||||
|
||||
Components of an application's health may be nested arbitrarily deep depending on the application's health indicators and how they have been grouped.
|
||||
The health endpoint supports any number of `/\{component}` identifiers in the URL to allow the health of a component at any depth to be retrieved.
|
||||
@@ -72,4 +72,4 @@ The response contains details of the health of an instance of a particular compo
|
||||
The following table describes the structure of the response:
|
||||
|
||||
[cols="2,1,3"]
|
||||
include::{snippets}health/instance/response-fields.adoc[]
|
||||
include::{snippets}/health/instance/response-fields.adoc[]
|
||||
@@ -13,6 +13,6 @@ The response is binary data in https://docs.oracle.com/javase/8/docs/technotes/s
|
||||
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[]
|
||||
include::{snippets}/heapdump/curl-request.adoc[]
|
||||
|
||||
The preceding example results in a file named `heapdump` being written to the current working directory.
|
||||
@@ -10,11 +10,11 @@ The `httptrace` endpoint provides information about HTTP request-response exchan
|
||||
|
||||
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[]
|
||||
include::{snippets}/httptrace/curl-request.adoc[]
|
||||
|
||||
The resulting response is similar to the following:
|
||||
|
||||
include::{snippets}httptrace/http-response.adoc[]
|
||||
include::{snippets}/httptrace/http-response.adoc[]
|
||||
|
||||
|
||||
|
||||
@@ -25,4 +25,4 @@ 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[]
|
||||
include::{snippets}/httptrace/response-fields.adoc[]
|
||||
@@ -10,11 +10,11 @@ The `info` endpoint provides general information about the application.
|
||||
|
||||
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[]
|
||||
include::{snippets}/info/curl-request.adoc[]
|
||||
|
||||
The resulting response is similar to the following:
|
||||
|
||||
include::{snippets}info/http-response.adoc[]
|
||||
include::{snippets}/info/http-response.adoc[]
|
||||
|
||||
|
||||
|
||||
@@ -33,7 +33,7 @@ Spring Boot provides `build` and `git` contributions.
|
||||
The following table describe the structure of the `build` section of the response:
|
||||
|
||||
[cols="2,1,3"]
|
||||
include::{snippets}info/response-fields-beneath-build.adoc[]
|
||||
include::{snippets}/info/response-fields-beneath-build.adoc[]
|
||||
|
||||
|
||||
|
||||
@@ -43,4 +43,4 @@ include::{snippets}info/response-fields-beneath-build.adoc[]
|
||||
The following table describes the structure of the `git` section of the response:
|
||||
|
||||
[cols="2,1,3"]
|
||||
include::{snippets}info/response-fields-beneath-git.adoc[]
|
||||
include::{snippets}/info/response-fields-beneath-git.adoc[]
|
||||
@@ -9,11 +9,11 @@ The `integrationgraph` endpoint exposes a graph containing all Spring Integratio
|
||||
== 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:
|
||||
|
||||
include::{snippets}integrationgraph/graph/curl-request.adoc[]
|
||||
include::{snippets}/integrationgraph/graph/curl-request.adoc[]
|
||||
|
||||
The resulting response is similar to the following:
|
||||
|
||||
include::{snippets}integrationgraph/graph/http-response.adoc[]
|
||||
include::{snippets}/integrationgraph/graph/http-response.adoc[]
|
||||
|
||||
|
||||
|
||||
@@ -28,8 +28,8 @@ More information about the structure can be found in the https://docs.spring.io/
|
||||
== 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:
|
||||
|
||||
include::{snippets}integrationgraph/rebuild/curl-request.adoc[]
|
||||
include::{snippets}/integrationgraph/rebuild/curl-request.adoc[]
|
||||
|
||||
This will result in a `204 - No Content` response:
|
||||
|
||||
include::{snippets}integrationgraph/rebuild/http-response.adoc[]
|
||||
include::{snippets}/integrationgraph/rebuild/http-response.adoc[]
|
||||
@@ -10,11 +10,11 @@ The `liquibase` endpoint provides information about database change sets applied
|
||||
|
||||
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[]
|
||||
include::{snippets}/liquibase/curl-request.adoc[]
|
||||
|
||||
The resulting response is similar to the following:
|
||||
|
||||
include::{snippets}liquibase/http-response.adoc[]
|
||||
include::{snippets}/liquibase/http-response.adoc[]
|
||||
|
||||
|
||||
|
||||
@@ -25,4 +25,4 @@ 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[]
|
||||
include::{snippets}/liquibase/response-fields.adoc[]
|
||||
@@ -10,11 +10,11 @@ The `logfile` endpoint provides access to the contents of the application's log
|
||||
|
||||
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[]
|
||||
include::{snippets}/logfile/entire/curl-request.adoc[]
|
||||
|
||||
The resulting response is similar to the following:
|
||||
|
||||
include::{snippets}logfile/entire/http-response.adoc[]
|
||||
include::{snippets}/logfile/entire/http-response.adoc[]
|
||||
|
||||
|
||||
|
||||
@@ -25,9 +25,9 @@ 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:
|
||||
|
||||
include::{snippets}logfile/range/curl-request.adoc[]
|
||||
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:
|
||||
|
||||
include::{snippets}logfile/range/http-response.adoc[]
|
||||
include::{snippets}/logfile/range/http-response.adoc[]
|
||||
@@ -10,11 +10,11 @@ The `loggers` endpoint provides access to the application's loggers and the conf
|
||||
|
||||
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[]
|
||||
include::{snippets}/loggers/all/curl-request.adoc[]
|
||||
|
||||
The resulting response is similar to the following:
|
||||
|
||||
include::{snippets}loggers/all/http-response.adoc[]
|
||||
include::{snippets}/loggers/all/http-response.adoc[]
|
||||
|
||||
|
||||
|
||||
@@ -25,7 +25,7 @@ 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[]
|
||||
include::{snippets}/loggers/all/response-fields.adoc[]
|
||||
|
||||
|
||||
|
||||
@@ -34,12 +34,12 @@ include::{snippets}loggers/all/response-fields.adoc[]
|
||||
|
||||
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[]
|
||||
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:
|
||||
|
||||
include::{snippets}loggers/single/http-response.adoc[]
|
||||
include::{snippets}/loggers/single/http-response.adoc[]
|
||||
|
||||
|
||||
|
||||
@@ -50,7 +50,7 @@ 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[]
|
||||
include::{snippets}/loggers/single/response-fields.adoc[]
|
||||
|
||||
|
||||
|
||||
@@ -60,12 +60,12 @@ include::{snippets}loggers/single/response-fields.adoc[]
|
||||
To retrieve a single group, make a `GET` request to `/actuator/loggers/{group.name}`,
|
||||
as shown in the following curl-based example:
|
||||
|
||||
include::{snippets}loggers/group/curl-request.adoc[]
|
||||
include::{snippets}/loggers/group/curl-request.adoc[]
|
||||
|
||||
The preceding example retrieves information about the logger group named `test`.
|
||||
The resulting response is similar to the following:
|
||||
|
||||
include::{snippets}loggers/group/http-response.adoc[]
|
||||
include::{snippets}/loggers/group/http-response.adoc[]
|
||||
|
||||
|
||||
|
||||
@@ -76,7 +76,7 @@ The response contains details of the requested group.
|
||||
The following table describes the structure of the response:
|
||||
|
||||
[cols="3,1,3"]
|
||||
include::{snippets}loggers/group/response-fields.adoc[]
|
||||
include::{snippets}/loggers/group/response-fields.adoc[]
|
||||
|
||||
|
||||
|
||||
@@ -85,7 +85,7 @@ include::{snippets}loggers/group/response-fields.adoc[]
|
||||
|
||||
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[]
|
||||
include::{snippets}/loggers/set/curl-request.adoc[]
|
||||
|
||||
The preceding example sets the `configuredLevel` of the `com.example` logger to `DEBUG`.
|
||||
|
||||
@@ -98,7 +98,7 @@ 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[]
|
||||
include::{snippets}/loggers/set/request-fields.adoc[]
|
||||
|
||||
|
||||
|
||||
@@ -107,7 +107,7 @@ include::{snippets}loggers/set/request-fields.adoc[]
|
||||
|
||||
To set the level of a logger, make a `POST` request to `/actuator/loggers/{group.name}` with a JSON body that specifies the configured level for the logger group, as shown in the following curl-based example:
|
||||
|
||||
include::{snippets}loggers/setGroup/curl-request.adoc[]
|
||||
include::{snippets}/loggers/setGroup/curl-request.adoc[]
|
||||
|
||||
The preceding example sets the `configuredLevel` of the `test` logger group to `DEBUG`.
|
||||
|
||||
@@ -120,7 +120,7 @@ The request specifies the desired level of the logger group.
|
||||
The following table describes the structure of the request:
|
||||
|
||||
[cols="3,1,3"]
|
||||
include::{snippets}loggers/set/request-fields.adoc[]
|
||||
include::{snippets}/loggers/set/request-fields.adoc[]
|
||||
|
||||
|
||||
|
||||
@@ -129,6 +129,6 @@ include::{snippets}loggers/set/request-fields.adoc[]
|
||||
|
||||
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[]
|
||||
include::{snippets}/loggers/clear/curl-request.adoc[]
|
||||
|
||||
The preceding example clears the configured level of the `com.example` logger.
|
||||
@@ -10,11 +10,11 @@ The `mappings` endpoint provides information about the application's request map
|
||||
|
||||
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[]
|
||||
include::{snippets}/mappings/curl-request.adoc[]
|
||||
|
||||
The resulting response is similar to the following:
|
||||
|
||||
include::{snippets}mappings/http-response.adoc[]
|
||||
include::{snippets}/mappings/http-response.adoc[]
|
||||
|
||||
|
||||
|
||||
@@ -26,7 +26,7 @@ The items found in the response depend on the type of web application (reactive
|
||||
The following table describes the structure of the common elements of the response:
|
||||
|
||||
[cols="2,1,3"]
|
||||
include::{snippets}mappings/response-fields.adoc[]
|
||||
include::{snippets}/mappings/response-fields.adoc[]
|
||||
|
||||
The entries that may be found in `contexts.*.mappings` are described in the following sections.
|
||||
|
||||
@@ -38,7 +38,7 @@ When using Spring MVC, the response contains details of any `DispatcherServlet`
|
||||
The following table describes the structure of this section of the response:
|
||||
|
||||
[cols="4,1,2"]
|
||||
include::{snippets}mappings/response-fields-dispatcher-servlets.adoc[]
|
||||
include::{snippets}/mappings/response-fields-dispatcher-servlets.adoc[]
|
||||
|
||||
|
||||
|
||||
@@ -49,7 +49,7 @@ When using the Servlet stack, the response contains details of any `Servlet` map
|
||||
The following table describes the structure of this section of the response:
|
||||
|
||||
[cols="2,1,3"]
|
||||
include::{snippets}mappings/response-fields-servlets.adoc[]
|
||||
include::{snippets}/mappings/response-fields-servlets.adoc[]
|
||||
|
||||
|
||||
|
||||
@@ -60,7 +60,7 @@ When using the Servlet stack, the response contains details of any `Filter` mapp
|
||||
The following table describes the structure of this section of the response:
|
||||
|
||||
[cols="2,1,3"]
|
||||
include::{snippets}mappings/response-fields-servlet-filters.adoc[]
|
||||
include::{snippets}/mappings/response-fields-servlet-filters.adoc[]
|
||||
|
||||
|
||||
|
||||
@@ -71,4 +71,4 @@ When using Spring WebFlux, the response contains details of any `DispatcherHandl
|
||||
The following table describes the structure of this section of the response:
|
||||
|
||||
[cols="4,1,2"]
|
||||
include::{snippets}mappings/response-fields-dispatcher-handlers.adoc[]
|
||||
include::{snippets}/mappings/response-fields-dispatcher-handlers.adoc[]
|
||||
@@ -10,11 +10,11 @@ The `metrics` endpoint provides access to application metrics.
|
||||
|
||||
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[]
|
||||
include::{snippets}/metrics/names/curl-request.adoc[]
|
||||
|
||||
The resulting response is similar to the following:
|
||||
|
||||
include::{snippets}metrics/names/http-response.adoc[]
|
||||
include::{snippets}/metrics/names/http-response.adoc[]
|
||||
|
||||
|
||||
|
||||
@@ -25,7 +25,7 @@ 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[]
|
||||
include::{snippets}/metrics/names/response-fields.adoc[]
|
||||
|
||||
|
||||
|
||||
@@ -34,12 +34,12 @@ include::{snippets}metrics/names/response-fields.adoc[]
|
||||
|
||||
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[]
|
||||
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:
|
||||
|
||||
include::{snippets}metrics/metric/http-response.adoc[]
|
||||
include::{snippets}/metrics/metric/http-response.adoc[]
|
||||
|
||||
|
||||
|
||||
@@ -50,7 +50,7 @@ The endpoint uses query parameters to <<metrics-drilling-down,drill down>> into
|
||||
The following table shows the single supported query parameter:
|
||||
|
||||
[cols="2,4"]
|
||||
include::{snippets}metrics/metric-with-tags/request-parameters.adoc[]
|
||||
include::{snippets}/metrics/metric-with-tags/request-parameters.adoc[]
|
||||
|
||||
|
||||
|
||||
@@ -60,7 +60,7 @@ include::{snippets}metrics/metric-with-tags/request-parameters.adoc[]
|
||||
The response contains details of the metric.
|
||||
The following table describes the structure of the response:
|
||||
|
||||
include::{snippets}metrics/metric/response-fields.adoc[]
|
||||
include::{snippets}/metrics/metric/response-fields.adoc[]
|
||||
|
||||
|
||||
[[metrics-drilling-down]]
|
||||
@@ -68,9 +68,9 @@ include::{snippets}metrics/metric/response-fields.adoc[]
|
||||
|
||||
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[]
|
||||
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:
|
||||
|
||||
include::{snippets}metrics/metric-with-tags/http-response.adoc[]
|
||||
include::{snippets}/metrics/metric-with-tags/http-response.adoc[]
|
||||
@@ -10,8 +10,8 @@ The `prometheus` endpoint provides Spring Boot application's metrics in the form
|
||||
|
||||
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[]
|
||||
include::{snippets}/prometheus/curl-request.adoc[]
|
||||
|
||||
The resulting response is similar to the following:
|
||||
|
||||
include::{snippets}prometheus/http-response.adoc[]
|
||||
include::{snippets}/prometheus/http-response.adoc[]
|
||||
@@ -10,11 +10,11 @@ The `scheduledtasks` endpoint provides information about the application's sched
|
||||
|
||||
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[]
|
||||
include::{snippets}/scheduled-tasks/curl-request.adoc[]
|
||||
|
||||
The resulting response is similar to the following:
|
||||
|
||||
include::{snippets}scheduled-tasks/http-response.adoc[]
|
||||
include::{snippets}/scheduled-tasks/http-response.adoc[]
|
||||
|
||||
|
||||
|
||||
@@ -25,4 +25,4 @@ 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[]
|
||||
include::{snippets}/scheduled-tasks/response-fields.adoc[]
|
||||
@@ -10,12 +10,12 @@ The `sessions` endpoint provides information about the application's HTTP sessio
|
||||
|
||||
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[]
|
||||
include::{snippets}/sessions/username/curl-request.adoc[]
|
||||
|
||||
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[]
|
||||
include::{snippets}/sessions/username/http-response.adoc[]
|
||||
|
||||
|
||||
|
||||
@@ -26,7 +26,7 @@ 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[]
|
||||
include::{snippets}/sessions/username/request-parameters.adoc[]
|
||||
|
||||
|
||||
|
||||
@@ -37,7 +37,7 @@ 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[]
|
||||
include::{snippets}/sessions/username/response-fields.adoc[]
|
||||
|
||||
|
||||
|
||||
@@ -46,12 +46,12 @@ include::{snippets}sessions/username/response-fields.adoc[]
|
||||
|
||||
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[]
|
||||
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:
|
||||
|
||||
include::{snippets}sessions/id/http-response.adoc[]
|
||||
include::{snippets}/sessions/id/http-response.adoc[]
|
||||
|
||||
|
||||
|
||||
@@ -62,7 +62,7 @@ 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[]
|
||||
include::{snippets}/sessions/id/response-fields.adoc[]
|
||||
|
||||
|
||||
|
||||
@@ -71,6 +71,6 @@ include::{snippets}sessions/id/response-fields.adoc[]
|
||||
|
||||
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[]
|
||||
include::{snippets}/sessions/delete/curl-request.adoc[]
|
||||
|
||||
The preceding example deletes the session with the `id` of `4db5efcc-99cb-4d05-a52c-b49acfbb7ea9`.
|
||||
@@ -10,11 +10,11 @@ The `shutdown` endpoint is used to shut down the application.
|
||||
|
||||
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[]
|
||||
include::{snippets}/shutdown/curl-request.adoc[]
|
||||
|
||||
A response similar to the following is produced:
|
||||
|
||||
include::{snippets}shutdown/http-response.adoc[]
|
||||
include::{snippets}/shutdown/http-response.adoc[]
|
||||
|
||||
|
||||
|
||||
@@ -25,4 +25,4 @@ 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[]
|
||||
include::{snippets}/shutdown/response-fields.adoc[]
|
||||
@@ -10,11 +10,11 @@ The `threaddump` endpoint provides a thread dump from the application's JVM.
|
||||
|
||||
To retrieve the thread dump as JSON, make a `GET` request to `/actuator/threaddump` with an appropriate `Accept` header, as shown in the following curl-based example:
|
||||
|
||||
include::{snippets}threaddump/json/curl-request.adoc[]
|
||||
include::{snippets}/threaddump/json/curl-request.adoc[]
|
||||
|
||||
The resulting response is similar to the following:
|
||||
|
||||
include::{snippets}threaddump/json/http-response.adoc[]
|
||||
include::{snippets}/threaddump/json/http-response.adoc[]
|
||||
|
||||
|
||||
|
||||
@@ -25,7 +25,7 @@ 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/json/response-fields.adoc[]
|
||||
include::{snippets}/threaddump/json/response-fields.adoc[]
|
||||
|
||||
|
||||
|
||||
@@ -35,8 +35,8 @@ include::{snippets}threaddump/json/response-fields.adoc[]
|
||||
To retrieve the thread dump as text, make a `GET` request to `/actuator/threaddump` that
|
||||
accepts `text/plain`, as shown in the following curl-based example:
|
||||
|
||||
include::{snippets}threaddump/text/curl-request.adoc[]
|
||||
include::{snippets}/threaddump/text/curl-request.adoc[]
|
||||
|
||||
The resulting response is similar to the following:
|
||||
|
||||
include::{snippets}threaddump/text/http-response.adoc[]
|
||||
include::{snippets}/threaddump/text/http-response.adoc[]
|
||||
Reference in New Issue
Block a user