mirror of
https://github.com/spring-projects/spring-boot.git
synced 2024-09-03 04:26:12 +08:00
Polish documentation for actuator-docs
Closes gh-3564
This commit is contained in:
parent
bf0b857357
commit
e0ee7c7ffb
@ -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
|
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)
|
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,
|
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
|
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
|
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).
|
same format (and recursively up to the top of the hierarchy).
|
||||||
|
|
||||||
NOTE: the report is actually about `@Conditional` evaluation not auto-configuration
|
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
|
per se, but most auto-configuration features use `@Conditional` heavily, so there is a lot
|
||||||
of overlap.
|
of overlap.
|
||||||
|
|
||||||
Example curl request:
|
Example curl request:
|
||||||
|
@ -2,7 +2,7 @@
|
|||||||
This endpoint is a report on the Spring Boot `ApplicationContext`. It lists the beans in
|
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.
|
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:
|
Example curl request:
|
||||||
include::{generated}/beans/curl-request.adoc[]
|
include::{generated}/beans/curl-request.adoc[]
|
||||||
|
@ -1,11 +1,11 @@
|
|||||||
=== Link: dump
|
=== Link: dump
|
||||||
This endpoint is a thread dump: the result is a list of threads each with their name,
|
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
|
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
|
sluggish behaviour caused by threads blocked by slow or unavailable I/O (e.g. if a
|
||||||
connection pool is exhausted).
|
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:
|
Example curl request:
|
||||||
include::{generated}/dump/curl-request.adoc[]
|
include::{generated}/dump/curl-request.adoc[]
|
||||||
|
@ -100,7 +100,7 @@ For example in Maven:
|
|||||||
----
|
----
|
||||||
|
|
||||||
|
|
||||||
or in Gradle
|
or in Gradle:
|
||||||
|
|
||||||
[source,groovy,indent=0]
|
[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.
|
`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
|
If you do that then a new endpoint will appear at `/` or `/hal` (relative to the
|
||||||
@ -139,17 +139,17 @@ For example in Maven:
|
|||||||
----
|
----
|
||||||
<dependency>
|
<dependency>
|
||||||
<groupId>org.springframework.boot</groupId>
|
<groupId>org.springframework.boot</groupId>
|
||||||
<artifactId>spring-boot-hypermedia-docs</artifactId>
|
<artifactId>spring-boot-actuator-docs</artifactId>
|
||||||
</dependency>
|
</dependency>
|
||||||
----
|
----
|
||||||
|
|
||||||
or in Gradle
|
or in Gradle:
|
||||||
|
|
||||||
[source,groovy,indent=0]
|
[source,groovy,indent=0]
|
||||||
----
|
----
|
||||||
dependencies {
|
dependencies {
|
||||||
...
|
...
|
||||||
compile('org.springframework.boot:spring-boot-hypermedia-docs')
|
compile('org.springframework.boot:spring-boot-actuator-docs')
|
||||||
...
|
...
|
||||||
}
|
}
|
||||||
----
|
----
|
||||||
|
@ -1,7 +1,7 @@
|
|||||||
=== Link: trace
|
=== Link: trace
|
||||||
This endpoint lists contents of the `TraceRepository` (which users can override by
|
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
|
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.
|
response, and the path and HTTP status.
|
||||||
|
|
||||||
Example curl request:
|
Example curl request:
|
||||||
|
@ -692,19 +692,19 @@ content into your application; rather pick only the properties that you need.
|
|||||||
endpoints.docs.curies.enabled=false
|
endpoints.docs.curies.enabled=false
|
||||||
endpoints.docs.enabled=true
|
endpoints.docs.enabled=true
|
||||||
endpoints.docs.path=/docs
|
endpoints.docs.path=/docs
|
||||||
endpoints.docs.sensitive=false
|
endpoints.docs.sensitive=false
|
||||||
endpoints.flyway.enabled=true
|
endpoints.flyway.enabled=true
|
||||||
endpoints.flyway.id=flyway
|
endpoints.flyway.id=flyway
|
||||||
endpoints.flyway.sensitive=true
|
endpoints.flyway.sensitive=true
|
||||||
endpoints.hal.enabled=true
|
endpoints.hal.enabled=true
|
||||||
endpoints.hal.path= # Redirects root HTML traffic to the HAL browser
|
endpoints.hal.path= # Redirects root HTML traffic to the HAL browser
|
||||||
endpoints.hal.sensitive=false
|
endpoints.hal.sensitive=false
|
||||||
endpoints.links.enabled=true
|
endpoints.links.enabled=true
|
||||||
endpoints.links.path= # / if not already used, /links instead
|
endpoints.links.path= # / if not already used, /links instead
|
||||||
endpoints.links.sensitive=false
|
endpoints.links.sensitive=false
|
||||||
endpoints.liquibase.enabled=true
|
endpoints.liquibase.enabled=true
|
||||||
endpoints.liquibase.id=liquibase
|
endpoints.liquibase.id=liquibase
|
||||||
endpoints.liquibase.sensitive=false
|
endpoints.liquibase.sensitive=false
|
||||||
|
|
||||||
# ENDPOINTS CORS CONFIGURATION ({sc-spring-boot-actuator}/autoconfigure/MvcEndpointCorsProperties.{sc-ext}[MvcEndpointCorsProperties])
|
# 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.
|
endpoints.cors.allow-credentials= # set whether user credentials are support. When not set, credentials are not supported.
|
||||||
|
Loading…
Reference in New Issue
Block a user