Skip to content

Commit 7730937

Browse files
committed
Polish "Add details of the purpose of the metrics endpoint"
See gh-44767
1 parent 09fd202 commit 7730937

File tree

1 file changed

+5
-1
lines changed
  • spring-boot-project/spring-boot-actuator-autoconfigure/src/docs/antora/modules/api/pages/rest/actuator

1 file changed

+5
-1
lines changed

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

+5-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,11 @@
11
[[metrics]]
22
= Metrics (`metrics`)
33

4-
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. It's 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. In this case, the `metrics` endpoint can still be useful.
4+
The `metrics` endpoint provides access to application metrics to diagnose the metrics the application has recorded.
5+
This endpoint should not be "scraped" or used as a metrics backend in production.
6+
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.
7+
If you want to diagnose your applications through the metrics they collect, you should use an xref:reference:actuator/metrics.adoc[external metrics backend].
8+
In this case, the `metrics` endpoint can still be useful.
59

610

711

0 commit comments

Comments
 (0)