Spring/spring-boot
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #44767 from jonatan-ivanov

Browse Source 
* pr/44767:
  Remove link
  Polish "Add details of the purpose of the metrics endpoint"
  Add details of the purpose of the metrics endpoint

Closes gh-44767
This commit is contained in:
Stéphane Nicoll
2025-04-10 10:14:06 +02:00
parent c6e74955a7 cfd5e45d57
commit 19d74cfb7f
2 changed files with 6 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -1,7 +1,11 @@
[[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.
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.
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.