Browse Source

Merge branch '3.3.x' into 3.4.x

Closes gh-45364
pull/45650/head
Phillip Webb 8 months ago
parent
commit
3cfeac4cc6
  1. 4
      spring-boot-project/spring-boot-actuator-autoconfigure/build.gradle
  2. 2
      spring-boot-project/spring-boot-actuator-autoconfigure/src/docs/antora/modules/api/pages/rest/actuator/metrics.adoc

4
spring-boot-project/spring-boot-actuator-autoconfigure/build.gradle

@ -217,6 +217,10 @@ def documentationTest = tasks.register("documentationTest", Test) {
} }
} }
tasks.named("generateAntoraPlaybook") {
antoraExtensions.xref.stubs = ["appendix:.*", "api:.*", "reference:.*"]
}
antoraContributions { antoraContributions {
'actuator-rest-api' { 'actuator-rest-api' {
aggregateContent { aggregateContent {

2
spring-boot-project/spring-boot-actuator-autoconfigure/src/docs/antora/modules/api/pages/rest/actuator/metrics.adoc

@ -4,7 +4,7 @@
The `metrics` endpoint provides access to application metrics to diagnose the metrics the application has recorded. The `metrics` endpoint provides access to application metrics to diagnose the metrics the application has recorded.
This endpoint should not be "scraped" or used as a metrics backend in production. This endpoint should not be "scraped" or used as a metrics backend in production.
Its purpose is to show the currently registered metrics so users can see what metrics are available, what their current values are, and if triggering certain operations cause any change in certain values. Its purpose is to show the currently registered metrics so users can see what metrics are available, what their current values are, and if triggering certain operations cause any change in certain values.
If you want to diagnose your applications through the metrics they collect, you should use an external metrics backend. If you want to diagnose your applications through the metrics they collect, you should use an xref:reference:actuator/metrics.adoc[external metrics backend].
In this case, the `metrics` endpoint can still be useful. In this case, the `metrics` endpoint can still be useful.

Loading…
Cancel
Save