From 23c3c2753af6bade831aa396197d2a04143e77a8 Mon Sep 17 00:00:00 2001 From: Jonatan Ivanov Date: Tue, 18 Mar 2025 17:37:23 -0700 Subject: [PATCH] Add details of the purpose of the metrics endpoint See gh-44767 --- .../docs/antora/modules/api/pages/rest/actuator/metrics.adoc | 2 +- .../docs/antora/modules/reference/pages/actuator/endpoints.adoc | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/spring-boot-project/spring-boot-actuator-autoconfigure/src/docs/antora/modules/api/pages/rest/actuator/metrics.adoc b/spring-boot-project/spring-boot-actuator-autoconfigure/src/docs/antora/modules/api/pages/rest/actuator/metrics.adoc index fe153d63efd..b7c53c3bba7 100644 --- a/spring-boot-project/spring-boot-actuator-autoconfigure/src/docs/antora/modules/api/pages/rest/actuator/metrics.adoc +++ b/spring-boot-project/spring-boot-actuator-autoconfigure/src/docs/antora/modules/api/pages/rest/actuator/metrics.adoc @@ -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. diff --git a/spring-boot-project/spring-boot-docs/src/docs/antora/modules/reference/pages/actuator/endpoints.adoc b/spring-boot-project/spring-boot-docs/src/docs/antora/modules/reference/pages/actuator/endpoints.adoc index 24b35b99ac7..3ec551d1a9f 100644 --- a/spring-boot-project/spring-boot-docs/src/docs/antora/modules/reference/pages/actuator/endpoints.adoc +++ b/spring-boot-project/spring-boot-docs/src/docs/antora/modules/reference/pages/actuator/endpoints.adoc @@ -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.