Skip to content

Commit b281868

Browse files
committed
Polish "Clarify usage of BufferingApplicationStartup"
See gh-25075
1 parent 853dbc3 commit b281868

File tree

3 files changed

+5
-8
lines changed

3 files changed

+5
-8
lines changed

spring-boot-project/spring-boot-actuator-autoconfigure/src/docs/asciidoc/endpoints/startup.adoc

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,24 +4,23 @@
44
The `startup` endpoint provides information about the application's startup sequence.
55

66

7-
87
[[startup-retrieving]]
98
== Retrieving the Application Startup steps
109

11-
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:
10+
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:
1211

1312
include::{snippets}/startup/curl-request.adoc[]
1413

1514
The resulting response is similar to the following:
1615

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

19-
18+
NOTE: Each such call removes the returned steps from the buffer.
2019

2120
[[startup-retrieving-response-structure]]
2221
=== Response Structure
2322

24-
The response contains details of the application startup steps recorded so far by the application.
23+
The response contains details of the application startup steps.
2524
The following table describes the structure of the response:
2625

2726
[cols="2,1,3"]

spring-boot-project/spring-boot-docs/src/docs/asciidoc/production-ready-features.adoc

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -122,9 +122,8 @@ The following technology-agnostic endpoints are available:
122122
Disabled by default.
123123

124124
| `startup`
125-
| Shows the startup steps data collected by the `ApplicationStartup`.
125+
| Shows the <<spring-boot-features.adoc#boot-features-application-startup-tracking,startup steps data>> collected by the `ApplicationStartup`.
126126
Requires the `SpringApplication` to be configured with a `BufferingApplicationStartup`.
127-
More details about the implementations can be found at <<boot-features.adoc#boot-features-application-startup-tracking, application startup tracking>> page.
128127

129128
| `threaddump`
130129
| Performs a thread dump.

spring-boot-project/spring-boot-docs/src/docs/asciidoc/spring-boot-features.adoc

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -485,8 +485,7 @@ Once configured, you can record data by running the application with the Flight
485485

486486
Spring Boot ships with the `BufferingApplicationStartup` variant; this implementation is meant for buffering the startup steps and draining them into an external metrics system.
487487
Applications can ask for the bean of type `BufferingApplicationStartup` in any component.
488-
Additionally, Spring Boot Actuator will <<production-ready-features.adoc#production-ready-endpoints, expose a `startup` endpoint to expose this information as a JSON document>>.
489-
Be aware, that during startup endpoint processing, all the collected steps will be pulled from the buffer, and sent in the response - so the further requests won't get the startup steps again.
488+
Additionally, Spring Boot Actuator will {spring-boot-actuator-restapi-docs}/#startup[expose a `startup` endpoint to expose this information as a JSON document].
490489

491490
[[boot-features-external-config]]
492491
== Externalized Configuration

0 commit comments

Comments
 (0)