Skip to content

Commit 23c3c27

Browse files
jonatan-ivanovsnicoll
authored andcommitted
Add details of the purpose of the metrics endpoint
See gh-44767
1 parent c6e7495 commit 23c3c27

File tree

2 files changed

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

2 files changed

+2
-2
lines changed

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

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

4-
The `metrics` endpoint provides access to application metrics.
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.
55

66

77

Diff for: spring-boot-project/spring-boot-docs/src/docs/antora/modules/reference/pages/actuator/endpoints.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ Subject to xref:actuator/endpoints.adoc#actuator.endpoints.sanitization[sanitiza
6666
Requires one or more javadoc:{url-liquibase-javadoc}/liquibase.Liquibase[] beans.
6767

6868
| `metrics`
69-
| Shows "`metrics`" information for the current application.
69+
| Shows "`metrics`" information for the current application to diagnose the metrics the application has recorded.
7070

7171
| `mappings`
7272
| Displays a collated list of all javadoc:org.springframework.web.bind.annotation.RequestMapping[format=annotation] paths.

0 commit comments

Comments
 (0)