root
/
spring-boot
mirror of https://github.com/spring-projects/spring-boot.git
1
0
Fork 0
Code Issues Actions 12 Packages Projects Releases Wiki Activity

Add details of the purpose of the metrics endpoint 

See gh-44767
This commit is contained in:
Jonatan Ivanov 2025-03-18 17:37:23 -07:00 committed by Stéphane Nicoll
parent c6e74955a7
commit 23c3c2753a
2 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -1,7 +1,7 @@
[[metrics]]
= Metrics (`metrics`)
The `metrics` endpoint provides access to application metrics.
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.

2
spring-boot-project/spring-boot-docs/src/docs/antora/modules/reference/pages/actuator/endpoints.adoc
View File

@ -66,7 +66,7 @@ Subject to xref:actuator/endpoints.adoc#actuator.endpoints.sanitization[sanitiza
Requires one or more javadoc:{url-liquibase-javadoc}/liquibase.Liquibase[] beans.
| `metrics`
| Shows "`metrics`" information for the current application.
| Shows "`metrics`" information for the current application to diagnose the metrics the application has recorded.
| `mappings`
| Displays a collated list of all javadoc:org.springframework.web.bind.annotation.RequestMapping[format=annotation] paths.