diff --git a/spring-boot-actuator-docs/src/main/asciidoc/autoconfig.adoc b/spring-boot-actuator-docs/src/main/asciidoc/autoconfig.adoc index be4c278d032..cb8a830ea5d 100644 --- a/spring-boot-actuator-docs/src/main/asciidoc/autoconfig.adoc +++ b/spring-boot-actuator-docs/src/main/asciidoc/autoconfig.adoc @@ -1,4 +1,4 @@ -=== /autoconfig +=== Link: autoconfig This endpoint is a report on the Spring Boot auto-configuration process that happened when your application started up. It lists all the `@Conditional` annotations that were evaluated as the context started and in each case it gives an indication of if (and why) diff --git a/spring-boot-actuator-docs/src/main/asciidoc/beans.adoc b/spring-boot-actuator-docs/src/main/asciidoc/beans.adoc index 306f81dcbc7..b484ca5f0c9 100644 --- a/spring-boot-actuator-docs/src/main/asciidoc/beans.adoc +++ b/spring-boot-actuator-docs/src/main/asciidoc/beans.adoc @@ -1,4 +1,4 @@ -=== /beans +=== Link: beans This endpoint is a report on the Spring Boot `ApplicationContext`. It lists the beans in the context and their dependencies, detailing the names and concrete classes of each bean. diff --git a/spring-boot-actuator-docs/src/main/asciidoc/configprops.adoc b/spring-boot-actuator-docs/src/main/asciidoc/configprops.adoc index 0d0eedd625d..e5cc2714783 100644 --- a/spring-boot-actuator-docs/src/main/asciidoc/configprops.adoc +++ b/spring-boot-actuator-docs/src/main/asciidoc/configprops.adoc @@ -1,4 +1,4 @@ -=== /configprops +=== Link: configprops This endpoint is a report on the Spring Boot `@ConfigurationProperties` beans. Beans with this annotation are bound to the `Environment` on startup, so they reflect the externalised configuration of the application. Beans are listed by name. A bean that is diff --git a/spring-boot-actuator-docs/src/main/asciidoc/dump.adoc b/spring-boot-actuator-docs/src/main/asciidoc/dump.adoc index 0ff6fc7a415..bc3d5043e48 100644 --- a/spring-boot-actuator-docs/src/main/asciidoc/dump.adoc +++ b/spring-boot-actuator-docs/src/main/asciidoc/dump.adoc @@ -1,4 +1,4 @@ -=== /dump +=== Link: dump This endpoint is a thread dump: the result is a list of threads each with their name, monitor state and stack. It is the same information as you would get from `kill -3` of a running Java process. Can be very useful for detecting issues at runtime, especially diff --git a/spring-boot-actuator-docs/src/main/asciidoc/env.adoc b/spring-boot-actuator-docs/src/main/asciidoc/env.adoc index 939d684ea59..57e043925c0 100644 --- a/spring-boot-actuator-docs/src/main/asciidoc/env.adoc +++ b/spring-boot-actuator-docs/src/main/asciidoc/env.adoc @@ -1,4 +1,4 @@ -=== /env +=== Link: env This endpoint is a dump of the Spring `Environment`. It lists the active profiles and all the `PropertySources` in the `Environment` (the ones that are listed first take precedence when binding to `@ConfigurationProperties` or `@Value`). Normally you will see the Java diff --git a/spring-boot-actuator-docs/src/main/asciidoc/health.adoc b/spring-boot-actuator-docs/src/main/asciidoc/health.adoc index 10bde41e794..a08d7ed82c4 100644 --- a/spring-boot-actuator-docs/src/main/asciidoc/health.adoc +++ b/spring-boot-actuator-docs/src/main/asciidoc/health.adoc @@ -1,4 +1,4 @@ -=== /health +=== Link: health This endpoint is an indication of the health of the application. It has an overall status ("UP", "DOWN" etc.), which is the only thing you see unless either you are authenticated or the endpoint is marked as `sensitive=false` (`endpoints.health.sensitive=false`). diff --git a/spring-boot-actuator-docs/src/main/asciidoc/index.adoc b/spring-boot-actuator-docs/src/main/asciidoc/index.adoc index 11111014047..8819fb22d00 100644 --- a/spring-boot-actuator-docs/src/main/asciidoc/index.adoc +++ b/spring-boot-actuator-docs/src/main/asciidoc/index.adoc @@ -17,7 +17,7 @@ include::{generated}/endpoints.adoc[] -=== /logfile +=== Link: logfile This endpoint (if available) contains the plain text logfile configured by the user using `logging.file` or `logging.path` (by default logs are only emitted on stdout so one of these properties has to be set for this endpoint to be active). @@ -33,7 +33,7 @@ include::{generated}/logfile/http-response.adoc[] -=== /docs +=== Link: docs This endpoint (if available) contains HTML documemtation for the other endpoints. Its path can be "/docs" (if there is an existing home page) or "/" (otherwise, including if the HAL browser is not active). diff --git a/spring-boot-actuator-docs/src/main/asciidoc/info.adoc b/spring-boot-actuator-docs/src/main/asciidoc/info.adoc index 981095184ab..9a5a40ca82a 100644 --- a/spring-boot-actuator-docs/src/main/asciidoc/info.adoc +++ b/spring-boot-actuator-docs/src/main/asciidoc/info.adoc @@ -1,4 +1,4 @@ -=== /info +=== Link: info This endpoint is empty and marked as `sensitive=false` by default (so it is unauthenticated by default if Spring Security is in use). It reflects the content of the `info.*` properties in the `Environment`, as well as the properties in `git.properties` diff --git a/spring-boot-actuator-docs/src/main/asciidoc/mappings.adoc b/spring-boot-actuator-docs/src/main/asciidoc/mappings.adoc index 7e47b179839..1d38e0b4368 100644 --- a/spring-boot-actuator-docs/src/main/asciidoc/mappings.adoc +++ b/spring-boot-actuator-docs/src/main/asciidoc/mappings.adoc @@ -1,4 +1,4 @@ -=== /mappings +=== Link: mappings This endpoint lists the Spring MVC request mappings, so users can see the handlers registered for requests by path, method, media type, etc. diff --git a/spring-boot-actuator-docs/src/main/asciidoc/metrics.adoc b/spring-boot-actuator-docs/src/main/asciidoc/metrics.adoc index f67b2d9d4ca..b78b625f6e6 100644 --- a/spring-boot-actuator-docs/src/main/asciidoc/metrics.adoc +++ b/spring-boot-actuator-docs/src/main/asciidoc/metrics.adoc @@ -1,4 +1,4 @@ -=== /metrics +=== Link: metrics This endpoint lists the public metrics exposed by the application. By default this includes all the counters in the `CounterService` and all the gauges in the `GaugeService`, plus a few JVM metrics about memory and uptime. Users can register diff --git a/spring-boot-actuator-docs/src/main/asciidoc/trace.adoc b/spring-boot-actuator-docs/src/main/asciidoc/trace.adoc index 8edc75fb0d7..4fd8c0155a6 100644 --- a/spring-boot-actuator-docs/src/main/asciidoc/trace.adoc +++ b/spring-boot-actuator-docs/src/main/asciidoc/trace.adoc @@ -1,4 +1,4 @@ -=== /trace +=== Link: trace This endpoint lists contents of the `TraceRepository` (which users can override by providing a bean of that type, or by injecting that bean and adding stuff to it). By default it is the last 100 HTTP requests, including all headers in the request and diff --git a/spring-boot-actuator-docs/src/test/resources/templates/endpoints.adoc.tpl b/spring-boot-actuator-docs/src/test/resources/templates/endpoints.adoc.tpl index a7c0617c55b..cd6963a233a 100644 --- a/spring-boot-actuator-docs/src/test/resources/templates/endpoints.adoc.tpl +++ b/spring-boot-actuator-docs/src/test/resources/templates/endpoints.adoc.tpl @@ -2,7 +2,7 @@ if (endpoint.custom) { %> include::{docs}/${endpoint.custom}[] <% } else { %> -=== ${endpoint.title} +=== Link: ${endpoint.title} Example curl request: include::{generated}${endpoint.path}/curl-request.adoc[]