Skip to content

Add details of the purpose of the metrics endpoint #44767

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -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 xref:reference:actuator/metrics.adoc[external metrics backend].
In this case, the `metrics` endpoint can still be useful.



Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
Loading