Polish Actuator Web API documentation

See gh-8042

spring-boot-project/spring-boot-actuator-autoconfigure/src/main/asciidoc/endpoints/auditevents.adoc

@@ -8,14 +8,14 @@ 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 `/application/auditevents` as shown
+To retrieve the audit events, make a `GET` request to `/application/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
+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 following:
 
 include::{snippets}auditevents/filtered/http-response.adoc[]
 
@@ -24,14 +24,14 @@ 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 supported
-query parameters are shown in the following table:
+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[]
 
-The `after` parameter is required. One or both of the `principal` and `type` parameters
-can also be used to further limit the results.
+The `after` parameter is required. You can also use one or both of the `principal` and
+`type` parameters to further limit the results.
 
 
 
@@ -39,7 +39,7 @@ can also be used to further limit the results.
 === Response Structure
 
 The response contains details of all of the audit events that matched the query. The
-structure of the response is described in the following table:
+following table describes the structure of the response:
 
 [cols="2,1,3"]
 include::{snippets}auditevents/after/response-fields.adoc[]

spring-boot-project/spring-boot-actuator-autoconfigure/src/main/asciidoc/endpoints/beans.adoc

@@ -8,7 +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 `/application/beans` as shown in the
+To retrieve the beans, make a `GET` request to `/application/beans`, as shown in the
 following curl-based example:
 
 include::{snippets}beans/curl-request.adoc[]
@@ -22,8 +22,8 @@ include::{snippets}beans/http-response.adoc[]
 [[beans-retrieving-response-structure]]
 === Response Structure
 
-The response contains details of the application's beans. The structure of the response is
-described in the following table:
+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[]

spring-boot-project/spring-boot-actuator-autoconfigure/src/main/asciidoc/endpoints/configprops.adoc

@@ -10,7 +10,7 @@ The `configprops` endpoint provides information about the application's
 == Retrieving the `@ConfigurationProperties` Bean
 
 To retrieve the `@ConfigurationProperties` beans, make a `GET` request to
-`/application/configprops` as shown in the following curl-based example:
+`/application/configprops`, as shown in the following curl-based example:
 
 include::{snippets}configprops/curl-request.adoc[]
 
@@ -24,7 +24,7 @@ include::{snippets}configprops/http-response.adoc[]
 === Response Structure
 
 The response contains details of the application's `@ConfigurationProperties` beans. The
-structure of the response is described in the following table:
+following table describes the structure of the response:
 
 [cols="2,1,3"]
 include::{snippets}configprops/response-fields.adoc[]

spring-boot-project/spring-boot-actuator-autoconfigure/src/main/asciidoc/endpoints/env.adoc

@@ -8,7 +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 `/application/env` as shown in
+To retrieve the entire environment, make a `GET` request to `/application/env`, as shown in
 the following curl-based example:
 
 include::{snippets}env/all/curl-request.adoc[]
@@ -22,8 +22,8 @@ include::{snippets}env/all/http-response.adoc[]
 [[env-entire-response-structure]]
 === Response Structure
 
-The response contains details of the application's `Environment`. The structure of the
-response is described in the following table:
+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,7 +33,7 @@ include::{snippets}env/all/response-fields.adoc[]
 [[env-single-property]]
 == Retrieving a Single Property
 
-To retrieve a single property, make a `GET` request to `/application/env/{property.name}`
+To retrieve a single property, make a `GET` request to `/application/env/{property.name}`,
 as shown in the following curl-based example:
 
 include::{snippets}env/single/curl-request.adoc[]
@@ -48,8 +48,8 @@ include::{snippets}env/single/http-response.adoc[]
 [[env-single-response-structure]]
 === Response Structure
 
-The response contains details of the requested property. The structure of the response is
-described in the following table:
+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[]

spring-boot-project/spring-boot-actuator-autoconfigure/src/main/asciidoc/endpoints/flyway.adoc

@@ -8,7 +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 `/application/flyway` as shown in the
+To retrieve the migrations, make a `GET` request to `/application/flyway`, as shown in the
 following curl-based example:
 
 include::{snippets}flyway/curl-request.adoc[]
@@ -22,8 +22,8 @@ include::{snippets}flyway/http-response.adoc[]
 [[flyway-retrieving-response-structure]]
 === Response Structure
 
-The response contains details of the application's Flyway migrations. The structure of the
-response is described in the following table:
+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[]

spring-boot-project/spring-boot-actuator-autoconfigure/src/main/asciidoc/endpoints/health.adoc

@@ -8,7 +8,7 @@ The `health` endpoint provides detailed information about the health of the appl
 [[health-retrieving]]
 == Retrieving the Health
 
-To retrieve the health of the application, make a `GET` request to `/application/health`
+To retrieve the health of the application, make a `GET` request to `/application/health`,
 as shown in the following curl-based example:
 
 include::{snippets}health/curl-request.adoc[]
@@ -22,8 +22,8 @@ include::{snippets}health/http-response.adoc[]
 [[health-retrieving-response-structure]]
 === Response Structure
 
-The response contains details of the health of the application. The structure of the
-response is described in the following table:
+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[]

spring-boot-project/spring-boot-actuator-autoconfigure/src/main/asciidoc/endpoints/heapdump.adoc

@@ -6,13 +6,13 @@ The `heapdump` endpoint provides a heap dump from the application's JVM.
 
 
 [[heapdump-retrieving]]
-== Retrieving the Heap dump
+== Retrieving the Heap Dump
 
 To retrieve the heap dump, make a `GET` request to `/application/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 using the `-O` option as shown
-in the following example:
+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[]
 

spring-boot-project/spring-boot-actuator-autoconfigure/src/main/asciidoc/endpoints/info.adoc

@@ -9,7 +9,7 @@ The `info` endpoint provides general information about the application.
 == Retrieving the Info
 
 To retrieve the information about the application, make a `GET` request to
-`/application/info` as shown in the following curl-based example:
+`/application/info`, as shown in the following curl-based example:
 
 include::{snippets}info/curl-request.adoc[]
 
@@ -31,7 +31,7 @@ contributions.
 [[info-retrieving-response-structure-build]]
 ==== `build` Response Structure
 
-The structure of the `build` section of the response is described in the following table:
+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[]
@@ -41,7 +41,7 @@ include::{snippets}info/response-fields-beneath-build.adoc[]
 [[info-retrieving-response-structure-git]]
 ==== `git` Response Structure
 
-The structure of the `git` section of the response is described in the following table:
+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[]

spring-boot-project/spring-boot-actuator-autoconfigure/src/main/asciidoc/endpoints/liquibase.adoc

@@ -9,7 +9,7 @@ Liquibase.
 [[liquibase-retrieving]]
 == Retrieving the Changes
 
-To retrieve the changes, make a `GET` request to `/application/liquibase` as shown in the
+To retrieve the changes, make a `GET` request to `/application/liquibase`, as shown in the
 following curl-based example:
 
 include::{snippets}liquibase/curl-request.adoc[]
@@ -23,8 +23,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 structure of
-the response is described in the following table:
+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[]

spring-boot-project/spring-boot-actuator-autoconfigure/src/main/asciidoc/endpoints/logfile.adoc

@@ -8,7 +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 `/application/logfile` as shown in the
+To retrieve the log file, make a `GET` request to `/application/logfile`, as shown in the
 following curl-based example:
 
 include::{snippets}logfile/entire/curl-request.adoc[]
@@ -24,8 +24,8 @@ 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 `/application/logfile` using
-the `Range` header as shown in the following curl-based example:
+To retrieve part of the log file, make a `GET` request to `/application/logfile` by using
+the `Range` header, as shown in the following curl-based example:
 
 include::{snippets}logfile/range/curl-request.adoc[]
 

spring-boot-project/spring-boot-actuator-autoconfigure/src/main/asciidoc/endpoints/loggers.adoc

@@ -1,15 +1,15 @@
 [[loggers]]
 = Loggers (`loggers`)
 
-The `loggers` endpoint provides access to the application's loggers and 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
+== Retrieving All Loggers
 
-To retrieve the application's loggers, make a `GET` request to `/application/loggers` as
+To retrieve the application's loggers, make a `GET` request to `/application/loggers`, as
 shown in the following curl-based example:
 
 include::{snippets}loggers/all/curl-request.adoc[]
@@ -23,8 +23,8 @@ include::{snippets}loggers/all/http-response.adoc[]
 [[loggers-all-response-structure]]
 === Response Structure
 
-The response contains details of the application's loggers. The structure of the response
-is described in the following table:
+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,7 +34,7 @@ include::{snippets}loggers/all/response-fields.adoc[]
 [[loggers-single]]
 == Retrieving a Single Logger
 
-To retrieve a single logger, make a `GET` request to `/application/loggers/{logger.name}`
+To retrieve a single logger, make a `GET` request to `/application/loggers/{logger.name}`,
 as shown in the following curl-based example:
 
 include::{snippets}loggers/single/curl-request.adoc[]
@@ -49,21 +49,20 @@ include::{snippets}loggers/single/http-response.adoc[]
 [[loggerse-single-response-structure]]
 === Response Structure
 
-The response contains details of the requested logger. The structure of the response is
-described in the following table:
+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[]
 
 
 
-
 [[loggers-setting-level]]
 == Setting a Log Level
 
 To set the level of a logger, make a `POST` request to
 `/application/loggers/{logger.name}` with a JSON body that specifies the configured level
-for the logger as shown in the following curl-based example:
+for the logger, as shown in the following curl-based example:
 
 include::{snippets}loggers/set/curl-request.adoc[]
 
@@ -74,8 +73,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 structure of the request is
-described in the following table:
+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[]
@@ -86,7 +85,7 @@ include::{snippets}loggers/set/request-fields.adoc[]
 == Clearing a Log Level
 
 To clear the level of a logger, make a `POST` request to
-`/application/loggers/{logger.name}` with a JSON body containing an empty object as shown
+`/application/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[]

spring-boot-project/spring-boot-actuator-autoconfigure/src/main/asciidoc/endpoints/metrics.adoc

@@ -9,7 +9,7 @@ The `metrics` endpoint provides access to application metrics.
 == Retrieving Metric Names
 
 To retrieve the names of the available metrics, make a `GET` request to
-`/application/metrics` as shown in the following curl-based example:
+`/application/metrics`, as shown in the following curl-based example:
 
 include::{snippets}metrics/names/curl-request.adoc[]
 
@@ -22,8 +22,8 @@ include::{snippets}metrics/names/http-response.adoc[]
 [[metrics-retrieving-names-response-structure]]
 === Response Structure
 
-The response contains details of the metric names. The structure of the response is
-described in the following table:
+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,7 +33,7 @@ include::{snippets}metrics/names/response-fields.adoc[]
 [[metrics-retrieving-metric]]
 == Retrieving a Metric
 
-To retrieve a metric, make a `GET` request to `/application/metrics/{metric.name}` as
+To retrieve a metric, make a `GET` request to `/application/metrics/{metric.name}`, as
 shown in the following curl-based example:
 
 include::{snippets}metrics/metric/curl-request.adoc[]
@@ -49,7 +49,7 @@ include::{snippets}metrics/metric/http-response.adoc[]
 === Query Parameters
 
 The endpoint uses query parameters to <<metrics-drilling-down,drill down>> into a metric
-using its tags. The single supported query parameter is shown in the following table:
+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 +59,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 structure of the response is described in
-the following table:
+The response contains details of the metric. The following table describes the structure
+of the response:
 
 include::{snippets}metrics/metric/response-fields.adoc[]
 
@@ -69,11 +69,11 @@ include::{snippets}metrics/metric/response-fields.adoc[]
 == Drilling Down
 
 To drill down into a metric, make a `GET` request to `/application/metrics/{metric.name}`
-using the `tag` query parameter as shown in the following curl-based example:
+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
+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 `Code Cache`. The resulting
 response is similar to the following:
 

spring-boot-project/spring-boot-actuator-autoconfigure/src/main/asciidoc/endpoints/prometheus.adoc

@@ -9,8 +9,8 @@ required for scraping by a Prometheus server.
 [[prometheus-retrieving]]
 == Retrieving the Metrics
 
-To retrieve the metrics, make a `GET` request to `/application/prometheus` as shown in the
-following curl-based example:
+To retrieve the metrics, make a `GET` request to `/application/prometheus`, as shown in
+the following curl-based example:
 
 include::{snippets}prometheus/curl-request.adoc[]
 

spring-boot-project/spring-boot-actuator-autoconfigure/src/main/asciidoc/endpoints/sessions.adoc

@@ -9,12 +9,12 @@ are managed by Spring Session.
 [[sessions-retrieving]]
 == Retrieving Sessions
 
-To retrieve the sessions, make a `GET` request to `/application/sessions` as shown in the
+To retrieve the sessions, make a `GET` request to `/application/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 with the username
+The preceding examples retrieves all of the sessions for the user whose username is
 `alice`.
 
 The resulting response is similar to the following:
@@ -26,8 +26,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 single
-required query parameter is shown in the following table:
+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 +37,8 @@ include::{snippets}sessions/username/request-parameters.adoc[]
 [[sessions-retrieving-response-structure]]
 === Response Structure
 
-The response contains details of the matching sessions. The structure of the response is
-described in the following table:
+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,12 +48,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 `/application/sessions/{id}` as
+To retrieve a single session, make a `GET` request to `/application/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
+The preceding example retrieves the session with the `id` of
 `4db5efcc-99cb-4d05-a52c-b49acfbb7ea9`. The resulting response is similar to the
 following:
 
@@ -64,8 +64,8 @@ include::{snippets}sessions/id/http-response.adoc[]
 [[sessions-retrieving-id-response-structure]]
 === Response Structure
 
-The response contains details of the requested session. The structure of the response is
-described in the following table:
+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 +75,10 @@ include::{snippets}sessions/id/response-fields.adoc[]
 [[sessions-deleting]]
 == Deleting a Session
 
-To delete a session, make a `DELETE` request to `/application/sessions/{id}` as shown in
+To delete a session, make a `DELETE` request to `/application/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
+The preceding example deletes the session with the `id` of
 `4db5efcc-99cb-4d05-a52c-b49acfbb7ea9`.

spring-boot-project/spring-boot-actuator-autoconfigure/src/main/asciidoc/endpoints/shutdown.adoc

@@ -8,8 +8,8 @@ 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 `/application/shutdown` as shown in
-the following curl-based example:
+To shut down the application, make a `POST` request to `/application/shutdown`, as shown
+in the following curl-based example:
 
 include::{snippets}shutdown/curl-request.adoc[]
 
@@ -22,8 +22,8 @@ include::{snippets}shutdown/http-response.adoc[]
 [[shutdowm-shutting-down-response-structure]]
 === Response Structure
 
-The response contains details of the result of the shutdown request. The structure of the
-response is described in the following table:
+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[]

spring-boot-project/spring-boot-actuator-autoconfigure/src/main/asciidoc/endpoints/status.adoc

@@ -8,7 +8,7 @@ The `status` endpoint provides an overview of the status of the application.
 [[status-retrieving]]
 == Retrieving the Status
 
-To retrieve the status of the application, make a `GET` request to `/application/status`
+To retrieve the status of the application, make a `GET` request to `/application/status`,
 as shown in the following curl-based example:
 
 include::{snippets}status/curl-request.adoc[]
@@ -22,8 +22,8 @@ include::{snippets}status/http-response.adoc[]
 [[status-retrieving-response-structure]]
 === Response Structure
 
-The response contains the status of the application. The structure of the response is
-described in the following table:
+The response contains the status of the application. The following table describes the
+structure of the response:
 
 [cols="2,1,3"]
 include::{snippets}status/response-fields.adoc[]

spring-boot-project/spring-boot-actuator-autoconfigure/src/main/asciidoc/endpoints/threaddump.adoc

@@ -8,7 +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 `/application/threaddump` as shown
+To retrieve the thread dump, make a `GET` request to `/application/threaddump`, as shown
 in the following curl-based example:
 
 include::{snippets}threaddump/curl-request.adoc[]
@@ -22,8 +22,8 @@ include::{snippets}threaddump/http-response.adoc[]
 [[threaddump-retrieving-response-structure]]
 === Response Structure
 
-The response contains details of the JVM's threads. The structure of the response is
-described in the following table:
+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[]

spring-boot-project/spring-boot-actuator-autoconfigure/src/main/asciidoc/index.adoc

@@ -15,13 +15,18 @@ This API documentation describes Spring Boot Actuators web endpoints.
 [[overview]]
 == Overview
 
+Before you proceed, you should read the following topics:
+
+* <<overview-endpoint-urls>>
+* <<overview-timestamps>>
+
 
 
 [[overview-endpoint-urls]]
 === URLs
 
 By default, all web endpoints are available beneath the path `/application` with URLs of
-the form `/application/{id}`. The `/application` base path can be configured using the
+the form `/application/{id}`. The `/application` base path can be configured by using the
 `management.endpoints.web.base-path` property, as shown in the following example:
 
 [source,properties,indent=0]