root
/
spring-boot
mirror of https://github.com/spring-projects/spring-boot.git
1
0
Fork 0
Code Issues Actions 9 Packages Projects Releases Wiki Activity

Clarify what an endpoint needs to be auto-configured 

Previously, the endpoint tables in the documentation include an
"Enabled by default" column that listed whether or not an endpoint
was enabled by default. This resulted in some confusion as an endpoint
could be listed as being enabled by default but not actually be
enabled as the requirements for it being auto-configured has not been
met.

This commit removes the "Enabled by default" column and replaces it,
where needed, with some extra information in the "Description"
column that describes what is needed for the endpoint to be
auto-configured.

Closes gh-18633
This commit is contained in:
Andy Wilkinson 2019-11-04 14:39:45 +00:00
parent e26d5d95a8
commit 07ca7747fa
1 changed files with 13 additions and 28 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

41
spring-boot-project/spring-boot-docs/src/main/asciidoc/production-ready-features.adoc
View File

@ -56,110 +56,95 @@ For example, by default, the `health` endpoint is mapped to `/actuator/health`.
The following technology-agnostic endpoints are available:
[cols="2,5,2"]
[cols="2,5"]
|===
| ID | Description | Enabled by default
| ID | Description
| `auditevents`
| Exposes audit events information for the current application.
| Yes. Requires an `AuditEventRepository` bean
Requires an `AuditEventRepository` bean.
| `beans`
| Displays a complete list of all the Spring beans in your application.
| Yes
| `caches`
| Exposes available caches.
| Yes
| `conditions`
| Shows the conditions that were evaluated on configuration and auto-configuration classes and the reasons why they did or did not match.
| Yes
| `configprops`
| Displays a collated list of all `@ConfigurationProperties`.
| Yes
| `env`
| Exposes properties from Spring's `ConfigurableEnvironment`.
| Yes
| `flyway`
| Shows any Flyway database migrations that have been applied.
| Yes
Requires one or more `Flyway` beans.
| `health`
| Shows application health information.
| Yes
| `httptrace`
| Displays HTTP trace information (by default, the last 100 HTTP request-response exchanges).
| Yes. Requires an `HttpTraceRepository` bean
Requires an `HttpTraceRepository` bean.
| `info`
| Displays arbitrary application info.
| Yes
| `integrationgraph`
| Shows the Spring Integration graph.
| Yes
Requires a dependency on `spring-integration-core`.
| `loggers`
| Shows and modifies the configuration of loggers in the application.
| Yes
| `liquibase`
| Shows any Liquibase database migrations that have been applied.
| Yes
Requires one or more `Liquibase` beans.
| `metrics`
| Shows '`metrics`' information for the current application.
| Yes
| `mappings`
| Displays a collated list of all `@RequestMapping` paths.
| Yes
| `scheduledtasks`
| Displays the scheduled tasks in your application.
| Yes
| `sessions`
| Allows retrieval and deletion of user sessions from a Spring Session-backed session store.
Not available when using Spring Session's support for reactive web applications.
| Yes
Requires a Servlet-based web application using Spring Session.
| `shutdown`
| Lets the application be gracefully shutdown.
| No
Disabled by default.
| `threaddump`
| Performs a thread dump.
| Yes
|===
If your application is a web application (Spring MVC, Spring WebFlux, or Jersey), you can use the following additional endpoints:
[cols="2,5,2"]
[cols="2,5"]
|===
| ID | Description | Enabled by default
| ID | Description
| `heapdump`
| Returns an `hprof` heap dump file.
| Yes
| `jolokia`
| Exposes JMX beans over HTTP (when Jolokia is on the classpath, not available for WebFlux).
| Yes
Requires a dependency on `jolokia-core`.
| `logfile`
| Returns the contents of the logfile (if `logging.file.name` or `logging.file.path` properties have been set).
Supports the use of the HTTP `Range` header to retrieve part of the log file's content.
| Yes
| `prometheus`
| Exposes metrics in a format that can be scraped by a Prometheus server.
| Yes
Requires a dependency on `micrometer-registry-prometheus`.
|===
To learn more about the Actuator's endpoints and their request and response formats, please refer to the separate API documentation ({spring-boot-actuator-restapi}/html/[HTML] or {spring-boot-actuator-restapi}/pdf/spring-boot-actuator-web-api.pdf[PDF]).