diff --git a/spring-boot-actuator-docs/src/main/asciidoc/autoconfig.adoc b/spring-boot-actuator-docs/src/main/asciidoc/autoconfig.adoc index cb8a830ea5..50e424ddd2 100644 --- a/spring-boot-actuator-docs/src/main/asciidoc/autoconfig.adoc +++ b/spring-boot-actuator-docs/src/main/asciidoc/autoconfig.adoc @@ -3,14 +3,14 @@ This endpoint is a report on the Spring Boot auto-configuration process that hap 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) the condition matched. A positive match results in a bean being included in the context, -and a negative result means the opposite (the beans's class may not even be loaded). +and a negative result means the opposite (the bean's class may not even be loaded). The report is split into 2 parts, positive matches first, and then negative. If the context is a hierarchy, there is also a separate report on the parent context with the same format (and recursively up to the top of the hierarchy). -NOTE: the report is actually about `@Conditional` evaluation not auto-configuration -per se, but most autoconfiguration features use `@Conditional` heavily, so there is a lot +NOTE: The report is actually about `@Conditional` evaluation not auto-configuration +per se, but most auto-configuration features use `@Conditional` heavily, so there is a lot of overlap. Example curl request: diff --git a/spring-boot-actuator-docs/src/main/asciidoc/beans.adoc b/spring-boot-actuator-docs/src/main/asciidoc/beans.adoc index b484ca5f0c..ff1cfa88f0 100644 --- a/spring-boot-actuator-docs/src/main/asciidoc/beans.adoc +++ b/spring-boot-actuator-docs/src/main/asciidoc/beans.adoc @@ -2,7 +2,7 @@ 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. -NOTE: some beans are pure configuration (any class that is annotated `@Configuration`). +NOTE: Some beans are pure configuration (any class that is annotated `@Configuration`). Example curl request: include::{generated}/beans/curl-request.adoc[] diff --git a/spring-boot-actuator-docs/src/main/asciidoc/dump.adoc b/spring-boot-actuator-docs/src/main/asciidoc/dump.adoc index bc3d5043e4..ae02b771d7 100644 --- a/spring-boot-actuator-docs/src/main/asciidoc/dump.adoc +++ b/spring-boot-actuator-docs/src/main/asciidoc/dump.adoc @@ -1,11 +1,11 @@ === 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 +running Java process. It can be very useful for detecting issues at runtime, especially sluggish behaviour caused by threads blocked by slow or unavailable I/O (e.g. if a connection pool is exhausted). -NOTE: some `SecurityManager` implementations might prevent this endpoint from working. +NOTE: Some `SecurityManager` implementations might prevent this endpoint from working. Example curl request: include::{generated}/dump/curl-request.adoc[] diff --git a/spring-boot-actuator-docs/src/main/asciidoc/index.adoc b/spring-boot-actuator-docs/src/main/asciidoc/index.adoc index 8819fb22d0..33a75bd7a8 100644 --- a/spring-boot-actuator-docs/src/main/asciidoc/index.adoc +++ b/spring-boot-actuator-docs/src/main/asciidoc/index.adoc @@ -100,7 +100,7 @@ For example in Maven: ---- -or in Gradle +or in Gradle: [source,groovy,indent=0] ---- @@ -111,7 +111,7 @@ or in Gradle } ---- -NOTE: if you are using Spring Data REST, then a dependency on the +NOTE: If you are using Spring Data REST, then a dependency on the `spring-data-rest-hal-browser` will have an equivalent effect. If you do that then a new endpoint will appear at `/` or `/hal` (relative to the @@ -139,17 +139,17 @@ For example in Maven: ---- org.springframework.boot - spring-boot-hypermedia-docs + spring-boot-actuator-docs ---- -or in Gradle +or in Gradle: [source,groovy,indent=0] ---- dependencies { ... - compile('org.springframework.boot:spring-boot-hypermedia-docs') + compile('org.springframework.boot:spring-boot-actuator-docs') ... } ---- diff --git a/spring-boot-actuator-docs/src/main/asciidoc/trace.adoc b/spring-boot-actuator-docs/src/main/asciidoc/trace.adoc index 4fd8c0155a..6e7da07c23 100644 --- a/spring-boot-actuator-docs/src/main/asciidoc/trace.adoc +++ b/spring-boot-actuator-docs/src/main/asciidoc/trace.adoc @@ -1,7 +1,7 @@ === 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 +default it stores the last 100 HTTP requests, including all headers in the request and response, and the path and HTTP status. Example curl request: diff --git a/spring-boot-docs/src/main/asciidoc/appendix-application-properties.adoc b/spring-boot-docs/src/main/asciidoc/appendix-application-properties.adoc index 4a37ac3cc8..f7c65dfc30 100644 --- a/spring-boot-docs/src/main/asciidoc/appendix-application-properties.adoc +++ b/spring-boot-docs/src/main/asciidoc/appendix-application-properties.adoc @@ -692,19 +692,19 @@ content into your application; rather pick only the properties that you need. endpoints.docs.curies.enabled=false endpoints.docs.enabled=true endpoints.docs.path=/docs - endpoints.docs.sensitive=false - endpoints.flyway.enabled=true - endpoints.flyway.id=flyway - endpoints.flyway.sensitive=true - endpoints.hal.enabled=true - endpoints.hal.path= # Redirects root HTML traffic to the HAL browser - endpoints.hal.sensitive=false - endpoints.links.enabled=true - endpoints.links.path= # / if not already used, /links instead - endpoints.links.sensitive=false - endpoints.liquibase.enabled=true - endpoints.liquibase.id=liquibase - endpoints.liquibase.sensitive=false + endpoints.docs.sensitive=false + endpoints.flyway.enabled=true + endpoints.flyway.id=flyway + endpoints.flyway.sensitive=true + endpoints.hal.enabled=true + endpoints.hal.path= # Redirects root HTML traffic to the HAL browser + endpoints.hal.sensitive=false + endpoints.links.enabled=true + endpoints.links.path= # / if not already used, /links instead + endpoints.links.sensitive=false + endpoints.liquibase.enabled=true + endpoints.liquibase.id=liquibase + endpoints.liquibase.sensitive=false # ENDPOINTS CORS CONFIGURATION ({sc-spring-boot-actuator}/autoconfigure/MvcEndpointCorsProperties.{sc-ext}[MvcEndpointCorsProperties]) endpoints.cors.allow-credentials= # set whether user credentials are support. When not set, credentials are not supported.