Skip to content

Commit

Permalink
Merge pull request #25075 from oleg-sukhov
Browse files Browse the repository at this point in the history
* pr/25075:
  Polish "Clarify usage of BufferingApplicationStartup"
  Clarify usage of BufferingApplicationStartup

Closes gh-25075
  • Loading branch information
snicoll committed Feb 9, 2021
2 parents 88bea82 + b281868 commit 1c5b802
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 6 deletions.
Expand Up @@ -4,24 +4,23 @@
The `startup` endpoint provides information about the application's startup sequence.



[[startup-retrieving]]
== Retrieving the Application Startup steps

To retrieve 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:
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[]

The resulting response is similar to the following:

include::{snippets}/startup/http-response.adoc[]


NOTE: Each such call removes the returned steps from the buffer.

[[startup-retrieving-response-structure]]
=== Response Structure

The response contains details of the application startup steps recorded so far by the application.
The response contains details of the application startup steps.
The following table describes the structure of the response:

[cols="2,1,3"]
Expand Down
Expand Up @@ -122,7 +122,7 @@ The following technology-agnostic endpoints are available:
Disabled by default.

| `startup`
| Shows the startup steps data collected by the `ApplicationStartup`.
| Shows the <<spring-boot-features.adoc#boot-features-application-startup-tracking,startup steps data>> collected by the `ApplicationStartup`.
Requires the `SpringApplication` to be configured with a `BufferingApplicationStartup`.

| `threaddump`
Expand Down
Expand Up @@ -485,7 +485,7 @@ Once configured, you can record data by running the application with the Flight

Spring Boot ships with the `BufferingApplicationStartup` variant; this implementation is meant for buffering the startup steps and draining them into an external metrics system.
Applications can ask for the bean of type `BufferingApplicationStartup` in any component.
Additionally, Spring Boot Actuator will <<production-ready-features.adoc#production-ready-endpoints, expose a `startup` endpoint to expose this information as a JSON document>>.
Additionally, Spring Boot Actuator will {spring-boot-actuator-restapi-docs}/#startup[expose a `startup` endpoint to expose this information as a JSON document].

[[boot-features-external-config]]
== Externalized Configuration
Expand Down

0 comments on commit 1c5b802

Please sign in to comment.