mirror of
https://github.com/spring-projects/spring-boot.git
synced 2024-09-03 04:26:12 +08:00
Rework title anchors for actuator docs
Closes gh-26615
This commit is contained in:
Phillip Webb
parent
2dbf39c738
commit
f692b0e937
@ -13,8 +13,18 @@ configurations {
|
||||
documentation
|
||||
}
|
||||
|
||||
repositories {
|
||||
maven {
|
||||
url "https://repo.spring.io/release"
|
||||
mavenContent {
|
||||
includeGroup "io.spring.asciidoctor"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
dependencies {
|
||||
asciidoctorExtensions("org.springframework.restdocs:spring-restdocs-asciidoctor")
|
||||
asciidoctorExtensions("io.spring.asciidoctor:spring-asciidoctor-extensions-section-ids")
|
||||
|
||||
api(project(":spring-boot-project:spring-boot-actuator"))
|
||||
|
||||
|
||||
@ -0,0 +1,134 @@
|
||||
overview=overview
|
||||
overview-endpoint-urls=overview.endpoint-urls
|
||||
overview-timestamps=overview.timestamps
|
||||
audit-events=audit-events
|
||||
audit-events-retrieving=audit-events.retrieving
|
||||
audit-events-retrieving-query-parameters=audit-events.retrieving.query-parameters
|
||||
audit-events-retrieving-response-structure=audit-events.retrieving.response-structure
|
||||
beans=beans
|
||||
beans-retrieving=beans.retrieving
|
||||
beans-retrieving-response-structure=beans.retrieving.response-structure
|
||||
caches=caches
|
||||
caches-all=caches.all
|
||||
caches-all-response-structure=caches.all.response-structure
|
||||
caches-named=caches.named
|
||||
caches-named-query-parameters=caches.named.query-parameters
|
||||
caches-named-response-structure=caches.named.response-structure
|
||||
caches-evict-all=caches.evict-all
|
||||
caches-evict-named=caches.evict-named
|
||||
caches-evict-named-request-structure=caches.evict-named.request-structure
|
||||
conditions=conditions
|
||||
conditions-retrieving=conditions.retrieving
|
||||
conditions-retrieving-response-structure=conditions.retrieving.response-structure
|
||||
configprops=configprops
|
||||
configprops-retrieving=configprops.retrieving
|
||||
configprops-retrieving-response-structure=configprops.retrieving.response-structure
|
||||
configprops-retrieving-by-prefix=configprops.retrieving-by-prefix
|
||||
configprops-retrieving-by-prefix-response-structure=configprops.retrieving-by-prefix.response-structure
|
||||
env=env
|
||||
env-entire=env.entire
|
||||
env-entire-response-structure=env.entire.response-structure
|
||||
env-single-property=env.single-property
|
||||
env-single-response-structure=env.single-property.response-structure
|
||||
flyway=flyway
|
||||
flyway-retrieving=flyway.retrieving
|
||||
flyway-retrieving-response-structure=flyway.retrieving.response-structure
|
||||
health=health
|
||||
health-retrieving=health.retrieving
|
||||
health-retrieving-response-structure=health.retrieving.response-structure
|
||||
health-retrieving-component=health.retrieving-component
|
||||
health-retrieving-component-response-structure=health.retrieving-component.response-structure
|
||||
health-retrieving-component-nested=health.retrieving-component-nested
|
||||
health-retrieving-component-instance-response-structure=health.retrieving-component-nested.response-structure
|
||||
heapdump=heapdump
|
||||
heapdump-retrieving=heapdump.retrieving
|
||||
http-trace=http-trace
|
||||
http-trace-retrieving=http-trace.retrieving
|
||||
http-trace-retrieving-response-structure=http-trace.retrieving.response-structure
|
||||
info=info
|
||||
info-retrieving=info.retrieving
|
||||
info-retrieving-response-structure=info.retrieving.response-structure
|
||||
info-retrieving-response-structure-build=info.retrieving.response-structure.build
|
||||
info-retrieving-response-structure-git=info.retrieving.response-structure.git
|
||||
integrationgraph=integrationgraph
|
||||
integrationgraph-retrieving=integrationgraph.retrieving
|
||||
integrationgraph-retrieving-response-structure=integrationgraph.retrieving.response-structure
|
||||
integrationgraph-rebuilding=integrationgraph.rebuilding
|
||||
liquibase=liquibase
|
||||
liquibase-retrieving=liquibase.retrieving
|
||||
liquibase-retrieving-response-structure=liquibase.retrieving.response-structure
|
||||
log-file=logfile
|
||||
logfile-retrieving=logfile.retrieving
|
||||
logfile-retrieving-part=logfile.retrieving-part
|
||||
loggers=loggers
|
||||
loggers-all=loggers.all
|
||||
loggers-all-response-structure=loggers.all.response-structure
|
||||
loggers-single=loggers.single
|
||||
loggers-single-response-structure=loggers.single.response-structure
|
||||
loggers-group=loggers.group
|
||||
loggers-group-response-structure=loggers.group.response-structure
|
||||
loggers-setting-level=loggers.setting-level
|
||||
loggers-setting-level-request-structure=loggers.setting-level.request-structure
|
||||
loggers-group-setting-level=loggers.group-setting-level
|
||||
loggers-group-setting-level-request-structure=loggers.group-setting-level.request-structure
|
||||
loggers-clearing-level=loggers.clearing-level
|
||||
mappings=mappings
|
||||
mappings-retrieving=mappings.retrieving
|
||||
mappings-retrieving-response-structure=mappings.retrieving.response-structure
|
||||
mappings-retrieving-response-structure-dispatcher-servlets=mappings.retrieving.response-structure-dispatcher-servlets
|
||||
mappings-retrieving-response-structure-servlets=mappings.retrieving.response-structure-servlets
|
||||
mappings-retrieving-response-structure-servlet-filters=mappings.retrieving.response-structure-servlet-filters
|
||||
mappings-retrieving-response-structure-dispatcher-handlers=mappings.retrieving.response-structure-dispatcher-handlers
|
||||
metrics=metrics
|
||||
metrics-retrieving-names=metrics.retrieving-names
|
||||
metrics-retrieving-names-response-structure=metrics.retrieving-names.response-structure
|
||||
metrics-retrieving-metric=metrics.retrieving-metric
|
||||
metrics-retrieving-metric-query-parameters=metrics.retrieving-metric.query-parameters
|
||||
metrics-retrieving-metric-response-structure=metrics.retrieving-metric.response-structure
|
||||
metrics-drilling-down=metrics.drilling-down
|
||||
prometheus=prometheus
|
||||
prometheus-retrieving=prometheus.retrieving
|
||||
prometheus-retrieving-query-parameters=prometheus.retrieving.query-parameters
|
||||
prometheus-retrieving-names=prometheus.retrieving-names
|
||||
quartz=quartz
|
||||
quartz-report=quartz.report
|
||||
quartz-report-response-structure=quartz.report.response-structure
|
||||
quartz-job-groups=quartz.job-groups
|
||||
quartz-job-groups-response-structure=quartz.job-groups.response-structure
|
||||
quartz-trigger-groups=quartz.trigger-groups
|
||||
quartz-trigger-groups-response-structure=quartz.trigger-groups.response-structure
|
||||
quartz-job-group=quartz.job-group
|
||||
quartz-job-group-response-structure=quartz.job-group.response-structure
|
||||
quartz-trigger-group=quartz.trigger-group
|
||||
quartz-trigger-group-response-structure=quartz.trigger-group.response-structure
|
||||
quartz-job=quartz.job
|
||||
quartz-job-response-structure=quartz.job.response-structure
|
||||
quartz-trigger=quartz.trigger
|
||||
quartz-trigger-common-response-structure=quartz.trigger.common-response-structure
|
||||
quartz-trigger-cron-response-structure=quartz.trigger.cron-response-structure
|
||||
quartz-trigger-simple-response-structure=quartz.trigger.simple-response-structure
|
||||
quartz-trigger-daily-time-interval-response-structure=quartz.trigger.daily-time-interval-response-structure
|
||||
quartz-trigger-calendar-interval-response-structure=quartz.trigger.calendar-interval-response-structure
|
||||
quartz-trigger-custom-response-structure=quartz.trigger.custom-response-structure
|
||||
scheduled-tasks=scheduled-tasks
|
||||
scheduled-tasks-retrieving=scheduled-tasks.retrieving
|
||||
scheduled-tasks-retrieving-response-structure=scheduled-tasks.retrieving.response-structure
|
||||
sessions=sessions
|
||||
sessions-retrieving=sessions.retrieving
|
||||
sessions-retrieving-query-parameters=sessions.retrieving.query-parameters
|
||||
sessions-retrieving-response-structure=sessions.retrieving.response-structure
|
||||
sessions-retrieving-id=sessions.retrieving-id
|
||||
sessions-retrieving-id-response-structure=sessions.retrieving-id.response-structure
|
||||
sessions-deleting=sessions.deleting
|
||||
shutdown=shutdown
|
||||
shutdown-shutting-down=shutdown.shutting-down
|
||||
shutdown-shutting-down-response-structure=shutdown.shutting-down.response-structure
|
||||
startup=startup
|
||||
startup-retrieving=startup.retrieving
|
||||
startup-retrieving-snapshot=startup.retrieving.snapshot
|
||||
startup-retrieving-drain=startup.retrieving.drain
|
||||
startup-retrieving-response-structure=startup.retrieving.response-structure
|
||||
threaddump=threaddump
|
||||
threaddump-retrieving-json=threaddump.retrieving-json
|
||||
threaddump-retrieving-json-response-structure=threaddump.retrieving-json.response-structure
|
||||
threaddump-retrieving-text=threaddump.retrieving-text
|
||||
@ -4,7 +4,7 @@ The `auditevents` endpoint provides information about the application's audit ev
|
||||
|
||||
|
||||
|
||||
[[audit-events-retrieving]]
|
||||
[[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:
|
||||
|
||||
@ -17,7 +17,7 @@ include::{snippets}/auditevents/filtered/http-response.adoc[]
|
||||
|
||||
|
||||
|
||||
[[audit-events-retrieving-query-parameters]]
|
||||
[[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:
|
||||
@ -27,7 +27,7 @@ include::{snippets}/auditevents/filtered/request-parameters.adoc[]
|
||||
|
||||
|
||||
|
||||
[[audit-events-retrieving-response-structure]]
|
||||
[[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:
|
||||
|
||||
@ -4,7 +4,7 @@ The `beans` endpoint provides information about the application's beans.
|
||||
|
||||
|
||||
|
||||
[[beans-retrieving]]
|
||||
[[beans.retrieving]]
|
||||
== Retrieving the Beans
|
||||
To retrieve the beans, make a `GET` request to `/actuator/beans`, as shown in the following curl-based example:
|
||||
|
||||
@ -16,7 +16,7 @@ include::{snippets}/beans/http-response.adoc[]
|
||||
|
||||
|
||||
|
||||
[[beans-retrieving-response-structure]]
|
||||
[[beans.retrieving.response-structure]]
|
||||
=== Response Structure
|
||||
The response contains details of the application's beans.
|
||||
The following table describes the structure of the response:
|
||||
|
||||
@ -4,7 +4,7 @@ The `caches` endpoint provides access to the application's caches.
|
||||
|
||||
|
||||
|
||||
[[caches-all]]
|
||||
[[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:
|
||||
|
||||
@ -16,7 +16,7 @@ include::{snippets}/caches/all/http-response.adoc[]
|
||||
|
||||
|
||||
|
||||
[[caches-all-response-structure]]
|
||||
[[caches.all.response-structure]]
|
||||
=== Response Structure
|
||||
The response contains details of the application's caches.
|
||||
The following table describes the structure of the response:
|
||||
@ -26,7 +26,7 @@ include::{snippets}/caches/all/response-fields.adoc[]
|
||||
|
||||
|
||||
|
||||
[[caches-named]]
|
||||
[[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:
|
||||
|
||||
@ -39,7 +39,7 @@ include::{snippets}/caches/named/http-response.adoc[]
|
||||
|
||||
|
||||
|
||||
[[caches-named-query-parameters]]
|
||||
[[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.
|
||||
@ -50,7 +50,7 @@ include::{snippets}/caches/named/request-parameters.adoc[]
|
||||
|
||||
|
||||
|
||||
[[caches-named-response-structure]]
|
||||
[[caches.named.response-structure]]
|
||||
=== Response Structure
|
||||
The response contains details of the requested cache.
|
||||
The following table describes the structure of the response:
|
||||
@ -60,7 +60,7 @@ include::{snippets}/caches/named/response-fields.adoc[]
|
||||
|
||||
|
||||
|
||||
[[caches-evict-all]]
|
||||
[[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:
|
||||
|
||||
@ -68,7 +68,7 @@ include::{snippets}/caches/evict-all/curl-request.adoc[]
|
||||
|
||||
|
||||
|
||||
[[caches-evict-named]]
|
||||
[[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:
|
||||
|
||||
@ -78,7 +78,7 @@ NOTE: As there are two caches named `countries`, the `cacheManager` has to be pr
|
||||
|
||||
|
||||
|
||||
[[caches-evict-named-request-structure]]
|
||||
[[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.
|
||||
|
||||
@ -4,7 +4,7 @@ The `conditions` endpoint provides information about the evaluation of condition
|
||||
|
||||
|
||||
|
||||
[[conditions-retrieving]]
|
||||
[[conditions.retrieving]]
|
||||
== Retrieving the Report
|
||||
To retrieve the report, make a `GET` request to `/actuator/conditions`, as shown in the following curl-based example:
|
||||
|
||||
@ -16,7 +16,7 @@ include::{snippets}/conditions/http-response.adoc[]
|
||||
|
||||
|
||||
|
||||
[[conditions-retrieving-response-structure]]
|
||||
[[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:
|
||||
|
||||
@ -4,7 +4,7 @@ The `configprops` endpoint provides information about the application's `@Config
|
||||
|
||||
|
||||
|
||||
[[configprops-retrieving]]
|
||||
[[configprops.retrieving]]
|
||||
== Retrieving All @ConfigurationProperties Beans
|
||||
To retrieve all of the `@ConfigurationProperties` beans, make a `GET` request to `/actuator/configprops`, as shown in the following curl-based example:
|
||||
|
||||
@ -16,7 +16,7 @@ include::{snippets}/configprops/all/http-response.adoc[]
|
||||
|
||||
|
||||
|
||||
[[configprops-retrieving-response-structure]]
|
||||
[[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:
|
||||
@ -26,7 +26,7 @@ include::{snippets}/configprops/all/response-fields.adoc[]
|
||||
|
||||
|
||||
|
||||
[[configprops-retrieving-by-prefix]]
|
||||
[[configprops.retrieving-by-prefix]]
|
||||
== Retrieving @ConfigurationProperties Beans By Prefix
|
||||
To retrieve the `@ConfigurationProperties` beans mapped under a certain prefix, make a `GET` request to `/actuator/configprops/\{prefix}`, as shown in the following curl-based example:
|
||||
|
||||
@ -40,7 +40,7 @@ NOTE: The `\{prefix}` does not need to be exact, a more general prefix will retu
|
||||
|
||||
|
||||
|
||||
[[configprops-retrieving-by-prefix-response-structure]]
|
||||
[[configprops.retrieving-by-prefix.response-structure]]
|
||||
=== Response Structure
|
||||
The response contains details of the application's `@ConfigurationProperties` beans.
|
||||
The following table describes the structure of the response:
|
||||
|
||||
@ -4,7 +4,7 @@ The `env` endpoint provides information about the application's `Environment`.
|
||||
|
||||
|
||||
|
||||
[[env-entire]]
|
||||
[[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:
|
||||
|
||||
@ -16,7 +16,7 @@ include::{snippets}/env/all/http-response.adoc[]
|
||||
|
||||
|
||||
|
||||
[[env-entire-response-structure]]
|
||||
[[env.entire.response-structure]]
|
||||
=== Response Structure
|
||||
The response contains details of the application's `Environment`.
|
||||
The following table describes the structure of the response:
|
||||
@ -26,7 +26,7 @@ include::{snippets}/env/all/response-fields.adoc[]
|
||||
|
||||
|
||||
|
||||
[[env-single-property]]
|
||||
[[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:
|
||||
|
||||
@ -39,7 +39,7 @@ include::{snippets}/env/single/http-response.adoc[]
|
||||
|
||||
|
||||
|
||||
[[env-single-response-structure]]
|
||||
[[env.single-property.response-structure]]
|
||||
=== Response Structure
|
||||
The response contains details of the requested property.
|
||||
The following table describes the structure of the response:
|
||||
|
||||
@ -4,7 +4,7 @@ The `flyway` endpoint provides information about database migrations performed b
|
||||
|
||||
|
||||
|
||||
[[flyway-retrieving]]
|
||||
[[flyway.retrieving]]
|
||||
== Retrieving the Migrations
|
||||
To retrieve the migrations, make a `GET` request to `/actuator/flyway`, as shown in the following curl-based example:
|
||||
|
||||
@ -16,7 +16,7 @@ include::{snippets}/flyway/http-response.adoc[]
|
||||
|
||||
|
||||
|
||||
[[flyway-retrieving-response-structure]]
|
||||
[[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:
|
||||
|
||||
@ -4,8 +4,8 @@ The `health` endpoint provides detailed information about the health of the appl
|
||||
|
||||
|
||||
|
||||
[[health-retrieving]]
|
||||
== Retrieving the Health of the application
|
||||
[[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:
|
||||
|
||||
include::{snippets}/health/curl-request.adoc[]
|
||||
@ -16,7 +16,7 @@ include::{snippets}/health/http-response.adoc[]
|
||||
|
||||
|
||||
|
||||
[[health-retrieving-response-structure]]
|
||||
[[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:
|
||||
@ -29,8 +29,8 @@ If you need to return V2 JSON you should use an accept header or `application/vn
|
||||
|
||||
|
||||
|
||||
[[health-retrieving-component]]
|
||||
== Retrieving the Health of a component
|
||||
[[health.retrieving-component]]
|
||||
== 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[]
|
||||
@ -41,7 +41,7 @@ include::{snippets}/health/component/http-response.adoc[]
|
||||
|
||||
|
||||
|
||||
[[health-retrieving-component-response-structure]]
|
||||
[[health.retrieving-component.response-structure]]
|
||||
=== Response Structure
|
||||
The response contains details of the health of a particular component of the application's health.
|
||||
The following table describes the structure of the response:
|
||||
@ -51,8 +51,8 @@ include::{snippets}/health/component/response-fields.adoc[]
|
||||
|
||||
|
||||
|
||||
[[health-retrieving-component-nested]]
|
||||
== Retrieving the Health of a nested component
|
||||
[[health.retrieving-component-nested]]
|
||||
== 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[]
|
||||
@ -66,7 +66,7 @@ The health endpoint supports any number of `/\{component}` identifiers in the UR
|
||||
|
||||
|
||||
|
||||
[[health-retrieving-component-instance-response-structure]]
|
||||
[[health.retrieving-component-nested.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:
|
||||
|
||||
@ -4,7 +4,7 @@ The `heapdump` endpoint provides a heap dump from the application's JVM.
|
||||
|
||||
|
||||
|
||||
[[heapdump-retrieving]]
|
||||
[[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.
|
||||
|
||||
@ -4,7 +4,7 @@ The `httptrace` endpoint provides information about HTTP request-response exchan
|
||||
|
||||
|
||||
|
||||
[[http-trace-retrieving]]
|
||||
[[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:
|
||||
|
||||
@ -16,7 +16,7 @@ include::{snippets}/httptrace/http-response.adoc[]
|
||||
|
||||
|
||||
|
||||
[[http-trace-retrieving-response-structure]]
|
||||
[[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:
|
||||
|
||||
@ -4,7 +4,7 @@ The `info` endpoint provides general information about the application.
|
||||
|
||||
|
||||
|
||||
[[info-retrieving]]
|
||||
[[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:
|
||||
|
||||
@ -16,7 +16,7 @@ include::{snippets}/info/http-response.adoc[]
|
||||
|
||||
|
||||
|
||||
[[info-retrieving-response-structure]]
|
||||
[[info.retrieving.response-structure]]
|
||||
=== Response Structure
|
||||
The response contains general information about the application.
|
||||
Each section of the response is contributed by an `InfoContributor`.
|
||||
@ -24,7 +24,7 @@ Spring Boot provides `build` and `git` contributions.
|
||||
|
||||
|
||||
|
||||
[[info-retrieving-response-structure-build]]
|
||||
[[info.retrieving.response-structure.build]]
|
||||
==== Build Response Structure
|
||||
The following table describe the structure of the `build` section of the response:
|
||||
|
||||
@ -33,7 +33,7 @@ include::{snippets}/info/response-fields-beneath-build.adoc[]
|
||||
|
||||
|
||||
|
||||
[[info-retrieving-response-structure-git]]
|
||||
[[info.retrieving.response-structure.git]]
|
||||
==== Git Response Structure
|
||||
The following table describes the structure of the `git` section of the response:
|
||||
|
||||
|
||||
@ -4,8 +4,8 @@ The `integrationgraph` endpoint exposes a graph containing all Spring Integratio
|
||||
|
||||
|
||||
|
||||
[[integrationgraph-retrieving]]
|
||||
== Retrieving the Spring Integration graph
|
||||
[[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:
|
||||
|
||||
include::{snippets}/integrationgraph/graph/curl-request.adoc[]
|
||||
@ -16,15 +16,15 @@ include::{snippets}/integrationgraph/graph/http-response.adoc[]
|
||||
|
||||
|
||||
|
||||
[[integrationgraph-retrieving-response-structure]]
|
||||
[[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 {spring-integration-docs}index-single.html#integration-graph[reference documentation].
|
||||
|
||||
|
||||
|
||||
[[integrationgraph-rebuilding]]
|
||||
== Rebuilding the Spring Integration graph
|
||||
[[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:
|
||||
|
||||
include::{snippets}/integrationgraph/rebuild/curl-request.adoc[]
|
||||
|
||||
@ -4,7 +4,7 @@ The `liquibase` endpoint provides information about database change sets applied
|
||||
|
||||
|
||||
|
||||
[[liquibase-retrieving]]
|
||||
[[liquibase.retrieving]]
|
||||
== Retrieving the Changes
|
||||
To retrieve the changes, make a `GET` request to `/actuator/liquibase`, as shown in the following curl-based example:
|
||||
|
||||
@ -16,7 +16,7 @@ include::{snippets}/liquibase/http-response.adoc[]
|
||||
|
||||
|
||||
|
||||
[[liquibase-retrieving-response-structure]]
|
||||
[[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:
|
||||
|
||||
@ -1,10 +1,10 @@
|
||||
[[log-file]]
|
||||
[[logfile]]
|
||||
= Log File (`logfile`)
|
||||
The `logfile` endpoint provides access to the contents of the application's log file.
|
||||
|
||||
|
||||
|
||||
[[logfile-retrieving]]
|
||||
[[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:
|
||||
|
||||
@ -16,7 +16,7 @@ include::{snippets}/logfile/entire/http-response.adoc[]
|
||||
|
||||
|
||||
|
||||
[[logfile-retrieving-part]]
|
||||
[[logfile.retrieving-part]]
|
||||
== Retrieving Part of the Log File
|
||||
NOTE: Retrieving part of the log file is not supported when using Jersey.
|
||||
|
||||
|
||||
@ -4,7 +4,7 @@ The `loggers` endpoint provides access to the application's loggers and the conf
|
||||
|
||||
|
||||
|
||||
[[loggers-all]]
|
||||
[[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:
|
||||
|
||||
@ -16,7 +16,7 @@ include::{snippets}/loggers/all/http-response.adoc[]
|
||||
|
||||
|
||||
|
||||
[[loggers-all-response-structure]]
|
||||
[[loggers.all.response-structure]]
|
||||
=== Response Structure
|
||||
The response contains details of the application's loggers.
|
||||
The following table describes the structure of the response:
|
||||
@ -26,7 +26,7 @@ include::{snippets}/loggers/all/response-fields.adoc[]
|
||||
|
||||
|
||||
|
||||
[[loggers-single]]
|
||||
[[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:
|
||||
|
||||
@ -39,7 +39,7 @@ include::{snippets}/loggers/single/http-response.adoc[]
|
||||
|
||||
|
||||
|
||||
[[loggers-single-response-structure]]
|
||||
[[loggers.single.response-structure]]
|
||||
=== Response Structure
|
||||
The response contains details of the requested logger.
|
||||
The following table describes the structure of the response:
|
||||
@ -49,7 +49,7 @@ include::{snippets}/loggers/single/response-fields.adoc[]
|
||||
|
||||
|
||||
|
||||
[[loggers-group]]
|
||||
[[loggers.group]]
|
||||
== Retrieving a Single Group
|
||||
To retrieve a single group, make a `GET` request to `/actuator/loggers/{group.name}`,
|
||||
as shown in the following curl-based example:
|
||||
@ -63,7 +63,7 @@ include::{snippets}/loggers/group/http-response.adoc[]
|
||||
|
||||
|
||||
|
||||
[[loggers-group-response-structure]]
|
||||
[[loggers.group.response-structure]]
|
||||
=== Response Structure
|
||||
The response contains details of the requested group.
|
||||
The following table describes the structure of the response:
|
||||
@ -73,7 +73,7 @@ include::{snippets}/loggers/group/response-fields.adoc[]
|
||||
|
||||
|
||||
|
||||
[[loggers-setting-level]]
|
||||
[[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:
|
||||
|
||||
@ -83,7 +83,7 @@ The preceding example sets the `configuredLevel` of the `com.example` logger to
|
||||
|
||||
|
||||
|
||||
[[loggers-setting-level-request-structure]]
|
||||
[[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:
|
||||
@ -93,7 +93,7 @@ include::{snippets}/loggers/set/request-fields.adoc[]
|
||||
|
||||
|
||||
|
||||
[[loggers-group-setting-level]]
|
||||
[[loggers.group-setting-level]]
|
||||
== Setting a Log Level for a Group
|
||||
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:
|
||||
|
||||
@ -103,7 +103,7 @@ The preceding example sets the `configuredLevel` of the `test` logger group to `
|
||||
|
||||
|
||||
|
||||
[[loggers-group-setting-level-request-structure]]
|
||||
[[loggers.group-setting-level.request-structure]]
|
||||
=== Request Structure
|
||||
The request specifies the desired level of the logger group.
|
||||
The following table describes the structure of the request:
|
||||
@ -113,7 +113,7 @@ include::{snippets}/loggers/set/request-fields.adoc[]
|
||||
|
||||
|
||||
|
||||
[[loggers-clearing-level]]
|
||||
[[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:
|
||||
|
||||
|
||||
@ -4,7 +4,7 @@ The `mappings` endpoint provides information about the application's request map
|
||||
|
||||
|
||||
|
||||
[[mappings-retrieving]]
|
||||
[[mappings.retrieving]]
|
||||
== Retrieving the Mappings
|
||||
To retrieve the mappings, make a `GET` request to `/actuator/mappings`, as shown in the following curl-based example:
|
||||
|
||||
@ -16,7 +16,7 @@ include::{snippets}/mappings/http-response.adoc[]
|
||||
|
||||
|
||||
|
||||
[[mappings-retrieving-response-structure]]
|
||||
[[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).
|
||||
@ -29,7 +29,7 @@ The entries that may be found in `contexts.*.mappings` are described in the foll
|
||||
|
||||
|
||||
|
||||
[[mappings-retrieving-response-structure-dispatcher-servlets]]
|
||||
[[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:
|
||||
@ -39,7 +39,7 @@ include::{snippets}/mappings/response-fields-dispatcher-servlets.adoc[]
|
||||
|
||||
|
||||
|
||||
[[mappings-retrieving-response-structure-servlets]]
|
||||
[[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:
|
||||
@ -49,7 +49,7 @@ include::{snippets}/mappings/response-fields-servlets.adoc[]
|
||||
|
||||
|
||||
|
||||
[[mappings-retrieving-response-structure-servlet-filters]]
|
||||
[[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:
|
||||
@ -59,7 +59,7 @@ include::{snippets}/mappings/response-fields-servlet-filters.adoc[]
|
||||
|
||||
|
||||
|
||||
[[mappings-retrieving-response-structure-dispatcher-handlers]]
|
||||
[[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:
|
||||
|
||||
@ -4,7 +4,7 @@ The `metrics` endpoint provides access to application metrics.
|
||||
|
||||
|
||||
|
||||
[[metrics-retrieving-names]]
|
||||
[[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:
|
||||
|
||||
@ -16,7 +16,7 @@ include::{snippets}/metrics/names/http-response.adoc[]
|
||||
|
||||
|
||||
|
||||
[[metrics-retrieving-names-response-structure]]
|
||||
[[metrics.retrieving-names.response-structure]]
|
||||
=== Response Structure
|
||||
The response contains details of the metric names.
|
||||
The following table describes the structure of the response:
|
||||
@ -26,7 +26,7 @@ include::{snippets}/metrics/names/response-fields.adoc[]
|
||||
|
||||
|
||||
|
||||
[[metrics-retrieving-metric]]
|
||||
[[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:
|
||||
|
||||
@ -39,9 +39,9 @@ include::{snippets}/metrics/metric/http-response.adoc[]
|
||||
|
||||
|
||||
|
||||
[[metrics-retrieving-metric-query-parameters]]
|
||||
[[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 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"]
|
||||
@ -49,7 +49,7 @@ include::{snippets}/metrics/metric-with-tags/request-parameters.adoc[]
|
||||
|
||||
|
||||
|
||||
[[metrics-retrieving-metric-response-structure]]
|
||||
[[metrics.retrieving-metric.response-structure]]
|
||||
=== Response structure
|
||||
The response contains details of the metric.
|
||||
The following table describes the structure of the response:
|
||||
@ -58,7 +58,7 @@ include::{snippets}/metrics/metric/response-fields.adoc[]
|
||||
|
||||
|
||||
|
||||
[[metrics-drilling-down]]
|
||||
[[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:
|
||||
|
||||
|
||||
@ -4,7 +4,7 @@ The `prometheus` endpoint provides Spring Boot application's metrics in the form
|
||||
|
||||
|
||||
|
||||
[[prometheus-retrieving]]
|
||||
[[prometheus.retrieving]]
|
||||
== Retrieving All Metrics
|
||||
To retrieve all metrics, make a `GET` request to `/actuator/prometheus`, as shown in the following curl-based example:
|
||||
|
||||
@ -25,7 +25,7 @@ include::{snippets}/prometheus/openmetrics/http-response.adoc[]
|
||||
|
||||
|
||||
|
||||
[[prometheus-retrieving-query-parameters]]
|
||||
[[prometheus.retrieving.query-parameters]]
|
||||
=== Query Parameters
|
||||
The endpoint uses query parameters to limit the samples that it returns.
|
||||
The following table shows the supported query parameters:
|
||||
@ -35,7 +35,7 @@ include::{snippets}/prometheus/names/request-parameters.adoc[]
|
||||
|
||||
|
||||
|
||||
[[prometheus-retrieving-names]]
|
||||
[[prometheus.retrieving-names]]
|
||||
== Retrieving Filtered Metrics
|
||||
To retrieve metrics matching specific names, make a `GET` request to `/actuator/prometheus` with the `includedNames` query parameter, as shown in the following curl-based example:
|
||||
|
||||
|
||||
@ -4,7 +4,7 @@ The `quartz` endpoint provides information about jobs and triggers that are mana
|
||||
|
||||
|
||||
|
||||
[[quartz-report]]
|
||||
[[quartz.report]]
|
||||
== Retrieving Registered Groups
|
||||
Jobs and triggers are managed in groups.
|
||||
To retrieve the list of registered job and trigger groups, make a `GET` request to `/actuator/quartz`, as shown in the following curl-based example:
|
||||
@ -17,7 +17,7 @@ include::{snippets}/quartz/report/http-response.adoc[]
|
||||
|
||||
|
||||
|
||||
[[quartz-report-response-structure]]
|
||||
[[quartz.report.response-structure]]
|
||||
=== Response Structure
|
||||
The response contains the groups names for registered jobs and triggers.
|
||||
The following table describes the structure of the response:
|
||||
@ -27,7 +27,7 @@ include::{snippets}/quartz/report/response-fields.adoc[]
|
||||
|
||||
|
||||
|
||||
[[quartz-job-groups]]
|
||||
[[quartz.job-groups]]
|
||||
== Retrieving Registered Job Names
|
||||
To retrieve the list of registered job names, make a `GET` request to `/actuator/quartz/jobs`, as shown in the following curl-based example:
|
||||
|
||||
@ -39,7 +39,7 @@ include::{snippets}/quartz/jobs/http-response.adoc[]
|
||||
|
||||
|
||||
|
||||
[[quartz-job-groups-response-structure]]
|
||||
[[quartz.job-groups.response-structure]]
|
||||
=== Response Structure
|
||||
The response contains the registered job names for each group.
|
||||
The following table describes the structure of the response:
|
||||
@ -49,7 +49,7 @@ include::{snippets}/quartz/jobs/response-fields.adoc[]
|
||||
|
||||
|
||||
|
||||
[[quartz-trigger-groups]]
|
||||
[[quartz.trigger-groups]]
|
||||
== Retrieving Registered Trigger Names
|
||||
To retrieve the list of registered trigger names, make a `GET` request to `/actuator/quartz/triggers`, as shown in the following curl-based example:
|
||||
|
||||
@ -61,7 +61,7 @@ include::{snippets}/quartz/triggers/http-response.adoc[]
|
||||
|
||||
|
||||
|
||||
[[quartz-trigger-groups-response-structure]]
|
||||
[[quartz.trigger-groups.response-structure]]
|
||||
=== Response Structure
|
||||
The response contains the registered trigger names for each group.
|
||||
The following table describes the structure of the response:
|
||||
@ -71,7 +71,7 @@ include::{snippets}/quartz/triggers/response-fields.adoc[]
|
||||
|
||||
|
||||
|
||||
[[quartz-job-group]]
|
||||
[[quartz.job-group]]
|
||||
== Retrieving Overview of a Job Group
|
||||
To retrieve an overview of the jobs in a particular group, make a `GET` request to `/actuator/quartz/jobs/\{groupName}`, as shown in the following curl-based example:
|
||||
|
||||
@ -84,7 +84,7 @@ include::{snippets}/quartz/job-group/http-response.adoc[]
|
||||
|
||||
|
||||
|
||||
[[quartz-job-group-response-structure]]
|
||||
[[quartz.job-group.response-structure]]
|
||||
=== Response Structure
|
||||
The response contains an overview of jobs in a particular group.
|
||||
The following table describes the structure of the response:
|
||||
@ -94,7 +94,7 @@ include::{snippets}/quartz/job-group/response-fields.adoc[]
|
||||
|
||||
|
||||
|
||||
[[quartz-trigger-group]]
|
||||
[[quartz.trigger-group]]
|
||||
== Retrieving Overview of a Trigger Group
|
||||
|
||||
To retrieve an overview of the triggers in a particular group, make a `GET` request to `/actuator/quartz/triggers/\{groupName}`, as shown in the following curl-based example:
|
||||
@ -108,7 +108,7 @@ include::{snippets}/quartz/trigger-group/http-response.adoc[]
|
||||
|
||||
|
||||
|
||||
[[quartz-trigger-group-response-structure]]
|
||||
[[quartz.trigger-group.response-structure]]
|
||||
=== Response Structure
|
||||
The response contains an overview of triggers in a particular group.
|
||||
Trigger implementation specific details are available.
|
||||
@ -119,7 +119,7 @@ include::{snippets}/quartz/trigger-group/response-fields.adoc[]
|
||||
|
||||
|
||||
|
||||
[[quartz-job]]
|
||||
[[quartz.job]]
|
||||
== Retrieving Details of a Job
|
||||
To retrieve the details about a particular job, make a `GET` request to `/actuator/quartz/jobs/\{groupName}/\{jobName}`, as shown in the following curl-based example:
|
||||
|
||||
@ -134,7 +134,7 @@ If a key in the data map is identified as sensitive, its value is sanitized.
|
||||
|
||||
|
||||
|
||||
[[quartz-job-response-structure]]
|
||||
[[quartz.job.response-structure]]
|
||||
=== Response Structure
|
||||
The response contains the full details of a job including a summary of the triggers associated with it, if any.
|
||||
The triggers are sorted by next fire time and priority.
|
||||
@ -145,7 +145,7 @@ include::{snippets}/quartz/job-details/response-fields.adoc[]
|
||||
|
||||
|
||||
|
||||
[[quartz-trigger]]
|
||||
[[quartz.trigger]]
|
||||
== Retrieving Details of a Trigger
|
||||
To retrieve the details about a particular trigger, make a `GET` request to `/actuator/quartz/triggers/\{groupName}/\{triggerName}`, as shown in the following curl-based example:
|
||||
|
||||
@ -155,7 +155,7 @@ The preceding example retrieves the details of trigger identified by the `sample
|
||||
|
||||
|
||||
|
||||
[[quartz-trigger-common-response-structure]]
|
||||
[[quartz.trigger.common-response-structure]]
|
||||
=== Common Response Structure
|
||||
The response has a common structure and an additional object that is specific to the trigger's type.
|
||||
There are five supported types:
|
||||
@ -173,7 +173,7 @@ include::{snippets}/quartz/trigger-details-common/response-fields.adoc[]
|
||||
|
||||
|
||||
|
||||
[[quartz-trigger-cron-response-structure]]
|
||||
[[quartz.trigger.cron-response-structure]]
|
||||
=== Cron Trigger Response Structure
|
||||
A cron trigger defines the cron expression that is used to determine when it has to fire.
|
||||
The resulting response for such a trigger implementation is similar to the following:
|
||||
@ -182,7 +182,7 @@ include::{snippets}/quartz/trigger-details-cron/http-response.adoc[]
|
||||
|
||||
|
||||
Much of the response is common to all trigger types.
|
||||
The structure of the common elements of the response was <<quartz-trigger-common-response-structure,described previously>>.
|
||||
The structure of the common elements of the response was <<quartz.trigger.common-response-structure,described previously>>.
|
||||
The following table describes the structure of the parts of the response that are specific to cron triggers:
|
||||
|
||||
[cols="2,1,3"]
|
||||
@ -190,7 +190,7 @@ include::{snippets}/quartz/trigger-details-cron/response-fields.adoc[]
|
||||
|
||||
|
||||
|
||||
[[quartz-trigger-simple-response-structure]]
|
||||
[[quartz.trigger.simple-response-structure]]
|
||||
=== Simple Trigger Response Structure
|
||||
A simple trigger is used to fire a Job at a given moment in time, and optionally repeated at a specified interval.
|
||||
The resulting response for such a trigger implementation is similar to the following:
|
||||
@ -199,7 +199,7 @@ include::{snippets}/quartz/trigger-details-simple/http-response.adoc[]
|
||||
|
||||
|
||||
Much of the response is common to all trigger types.
|
||||
The structure of the common elements of the response was <<quartz-trigger-common-response-structure,described previously>>.
|
||||
The structure of the common elements of the response was <<quartz.trigger.common-response-structure,described previously>>.
|
||||
The following table describes the structure of the parts of the response that are specific to simple triggers:
|
||||
|
||||
[cols="2,1,3"]
|
||||
@ -207,7 +207,7 @@ include::{snippets}/quartz/trigger-details-simple/response-fields.adoc[]
|
||||
|
||||
|
||||
|
||||
[[quartz-trigger-daily-time-interval-response-structure]]
|
||||
[[quartz.trigger.daily-time-interval-response-structure]]
|
||||
=== Daily Time Interval Trigger Response Structure
|
||||
A daily time interval trigger is used to fire a Job based upon daily repeating time intervals.
|
||||
The resulting response for such a trigger implementation is similar to the following:
|
||||
@ -216,7 +216,7 @@ include::{snippets}/quartz/trigger-details-daily-time-interval/http-response.ado
|
||||
|
||||
|
||||
Much of the response is common to all trigger types.
|
||||
The structure of the common elements of the response was <<quartz-trigger-common-response-structure,described previously>>.
|
||||
The structure of the common elements of the response was <<quartz.trigger.common-response-structure,described previously>>.
|
||||
The following table describes the structure of the parts of the response that are specific to daily time interval triggers:
|
||||
|
||||
[cols="2,1,3"]
|
||||
@ -224,7 +224,7 @@ include::{snippets}/quartz/trigger-details-daily-time-interval/response-fields.a
|
||||
|
||||
|
||||
|
||||
[[quartz-trigger-calendar-interval-response-structure]]
|
||||
[[quartz.trigger.calendar-interval-response-structure]]
|
||||
=== Calendar Interval Trigger Response Structure
|
||||
A calendar interval trigger is used to fire a Job based upon repeating calendar time intervals.
|
||||
The resulting response for such a trigger implementation is similar to the following:
|
||||
@ -233,7 +233,7 @@ include::{snippets}/quartz/trigger-details-calendar-interval/http-response.adoc[
|
||||
|
||||
|
||||
Much of the response is common to all trigger types.
|
||||
The structure of the common elements of the response was <<quartz-trigger-common-response-structure,described previously>>.
|
||||
The structure of the common elements of the response was <<quartz.trigger.common-response-structure,described previously>>.
|
||||
The following table describes the structure of the parts of the response that are specific to calendar interval triggers:
|
||||
|
||||
[cols="2,1,3"]
|
||||
@ -241,7 +241,7 @@ include::{snippets}/quartz/trigger-details-calendar-interval/response-fields.ado
|
||||
|
||||
|
||||
|
||||
[[quartz-trigger-custom-response-structure]]
|
||||
[[quartz.trigger.custom-response-structure]]
|
||||
=== Custom Trigger Response Structure
|
||||
A custom trigger is any other implementation.
|
||||
The resulting response for such a trigger implementation is similar to the following:
|
||||
@ -250,7 +250,7 @@ include::{snippets}/quartz/trigger-details-custom/http-response.adoc[]
|
||||
|
||||
|
||||
Much of the response is common to all trigger types.
|
||||
The structure of the common elements of the response was <<quartz-trigger-common-response-structure,described previously>>.
|
||||
The structure of the common elements of the response was <<quartz.trigger.common-response-structure,described previously>>.
|
||||
The following table describes the structure of the parts of the response that are specific to custom triggers:
|
||||
|
||||
[cols="2,1,3"]
|
||||
|
||||
@ -4,7 +4,7 @@ The `scheduledtasks` endpoint provides information about the application's sched
|
||||
|
||||
|
||||
|
||||
[[scheduled-tasks-retrieving]]
|
||||
[[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:
|
||||
|
||||
@ -16,7 +16,7 @@ include::{snippets}/scheduled-tasks/http-response.adoc[]
|
||||
|
||||
|
||||
|
||||
[[scheduled-tasks-retrieving-response-structure]]
|
||||
[[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:
|
||||
|
||||
@ -4,7 +4,7 @@ The `sessions` endpoint provides information about the application's HTTP sessio
|
||||
|
||||
|
||||
|
||||
[[sessions-retrieving]]
|
||||
[[sessions.retrieving]]
|
||||
== Retrieving Sessions
|
||||
To retrieve the sessions, make a `GET` request to `/actuator/sessions`, as shown in the following curl-based example:
|
||||
|
||||
@ -17,7 +17,7 @@ include::{snippets}/sessions/username/http-response.adoc[]
|
||||
|
||||
|
||||
|
||||
[[sessions-retrieving-query-parameters]]
|
||||
[[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:
|
||||
@ -27,7 +27,7 @@ include::{snippets}/sessions/username/request-parameters.adoc[]
|
||||
|
||||
|
||||
|
||||
[[sessions-retrieving-response-structure]]
|
||||
[[sessions.retrieving.response-structure]]
|
||||
=== Response Structure
|
||||
The response contains details of the matching sessions.
|
||||
The following table describes the structure of the response:
|
||||
@ -37,7 +37,7 @@ include::{snippets}/sessions/username/response-fields.adoc[]
|
||||
|
||||
|
||||
|
||||
[[sessions-retrieving-id]]
|
||||
[[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:
|
||||
|
||||
@ -50,7 +50,7 @@ include::{snippets}/sessions/id/http-response.adoc[]
|
||||
|
||||
|
||||
|
||||
[[sessions-retrieving-id-response-structure]]
|
||||
[[sessions.retrieving-id.response-structure]]
|
||||
=== Response Structure
|
||||
The response contains details of the requested session.
|
||||
The following table describes the structure of the response:
|
||||
@ -60,7 +60,7 @@ include::{snippets}/sessions/id/response-fields.adoc[]
|
||||
|
||||
|
||||
|
||||
[[sessions-deleting]]
|
||||
[[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:
|
||||
|
||||
|
||||
@ -4,7 +4,7 @@ The `shutdown` endpoint is used to shut down the application.
|
||||
|
||||
|
||||
|
||||
[[shutdown-shutting-down]]
|
||||
[[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:
|
||||
|
||||
@ -16,7 +16,7 @@ include::{snippets}/shutdown/http-response.adoc[]
|
||||
|
||||
|
||||
|
||||
[[shutdown-shutting-down-response-structure]]
|
||||
[[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:
|
||||
|
||||
@ -4,14 +4,14 @@ The `startup` endpoint provides information about the application's startup sequ
|
||||
|
||||
|
||||
|
||||
[[startup-retrieving]]
|
||||
== Retrieving the Application Startup steps
|
||||
[[startup.retrieving]]
|
||||
== Retrieving the Application Startup Steps
|
||||
The application startup steps can either be retrieved as a snapshot (`GET`) or drained from the buffer (`POST`).
|
||||
|
||||
|
||||
|
||||
[[startup-retrieving-snapshot]]
|
||||
=== Retrieving a snapshot of the Application Startup steps
|
||||
[[startup.retrieving.snapshot]]
|
||||
=== Retrieving a snapshot of the Application Startup Steps
|
||||
To retrieve the steps recorded so far during the application startup phase, make a `GET` request to `/actuator/startup`, as shown in the following curl-based example:
|
||||
|
||||
include::{snippets}/startup-snapshot/curl-request.adoc[]
|
||||
@ -22,8 +22,8 @@ include::{snippets}/startup-snapshot/http-response.adoc[]
|
||||
|
||||
|
||||
|
||||
[[startup-retrieving-drain]]
|
||||
== Draining the Application Startup steps
|
||||
[[startup.retrieving.drain]]
|
||||
=== Draining the Application Startup Steps
|
||||
To drain and return the steps recorded so far during the application startup phase, make a `POST` request to `/actuator/startup`, as shown in the following curl-based example:
|
||||
|
||||
include::{snippets}/startup/curl-request.adoc[]
|
||||
@ -34,7 +34,7 @@ include::{snippets}/startup/http-response.adoc[]
|
||||
|
||||
|
||||
|
||||
[[startup-retrieving-response-structure]]
|
||||
[[startup.retrieving.response-structure]]
|
||||
=== Response Structure
|
||||
The response contains details of the application startup steps.
|
||||
The following table describes the structure of the response:
|
||||
|
||||
@ -4,7 +4,7 @@ The `threaddump` endpoint provides a thread dump from the application's JVM.
|
||||
|
||||
|
||||
|
||||
[[threaddump-retrieving-json]]
|
||||
[[threaddump.retrieving-json]]
|
||||
== Retrieving the Thread Dump as JSON
|
||||
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:
|
||||
|
||||
@ -16,7 +16,7 @@ include::{snippets}/threaddump/json/http-response.adoc[]
|
||||
|
||||
|
||||
|
||||
[[threaddump-retrieving-json-response-structure]]
|
||||
[[threaddump.retrieving-json.response-structure]]
|
||||
=== Response Structure
|
||||
The response contains details of the JVM's threads.
|
||||
The following table describes the structure of the response:
|
||||
@ -26,7 +26,7 @@ include::{snippets}/threaddump/json/response-fields.adoc[]
|
||||
|
||||
|
||||
|
||||
[[threaddump-retrieving-text]]
|
||||
[[threaddump.retrieving-text]]
|
||||
== Retrieving the Thread Dump as Text
|
||||
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:
|
||||
|
||||
@ -20,14 +20,14 @@ This API documentation describes Spring Boot Actuators web endpoints.
|
||||
== Overview
|
||||
Before you proceed, you should read the following topics:
|
||||
|
||||
* <<overview-endpoint-urls>>
|
||||
* <<overview-timestamps>>
|
||||
* <<overview.endpoint-urls>>
|
||||
* <<overview.timestamps>>
|
||||
|
||||
NOTE: In order to get the correct JSON responses documented below, Jackson must be available.
|
||||
|
||||
|
||||
|
||||
[[overview-endpoint-urls]]
|
||||
[[overview.endpoint-urls]]
|
||||
=== URLs
|
||||
By default, all web endpoints are available beneath the path `/actuator` with URLs of
|
||||
the form `/actuator/\{id}`. The `/actuator` base path can be configured by using the
|
||||
@ -44,7 +44,7 @@ The preceding `application.properties` example changes the form of the endpoint
|
||||
|
||||
|
||||
|
||||
[[overview-timestamps]]
|
||||
[[overview.timestamps]]
|
||||
=== Timestamps
|
||||
All timestamps that are consumed by the endpoints, either as query parameters or in the
|
||||
request body, must be formatted as an offset date and time as specified in
|
||||
|
||||
Loading…
Reference in New Issue
Block a user