From 3580f1aa3699c6b9be32746f25ddd0a74fcb2f37 Mon Sep 17 00:00:00 2001 From: Andy Wilkinson Date: Wed, 19 Mar 2025 19:44:52 +0000 Subject: [PATCH] Polish "Add details of the purpose of the metrics endpoint" See gh-44767 --- .../antora/modules/api/pages/rest/actuator/metrics.adoc | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) 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 b7c53c3bba..9c5fcc8922 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,11 @@ [[metrics]] = Metrics (`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. +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 xref:reference:actuator/metrics.adoc[external metrics backend]. +In this case, the `metrics` endpoint can still be useful.