From 2e08a07d7c02fe2994486f668398995288d6a489 Mon Sep 17 00:00:00 2001 From: Brian Clozel Date: Fri, 17 Mar 2023 17:27:11 +0100 Subject: [PATCH] Add a list of produced observations This commit adds a list observations produced by Spring Framework in the reference documentation. Closes gh-30060 --- .../asciidoc/integration/observability.adoc | 24 +++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/framework-docs/src/docs/asciidoc/integration/observability.adoc b/framework-docs/src/docs/asciidoc/integration/observability.adoc index 028bc1ee4e..735d6aeb3b 100644 --- a/framework-docs/src/docs/asciidoc/integration/observability.adoc +++ b/framework-docs/src/docs/asciidoc/integration/observability.adoc @@ -9,6 +9,30 @@ Traces provide a holistic view of an entire system, crossing application boundar Spring Framework instruments various parts of its own codebase to publish observations if an `ObservationRegistry` is configured. You can learn more about {docs-spring-boot}/html/actuator.html#actuator.metrics[configuring the observability infrastructure in Spring Boot]. + +[[integration.observability.list]] +== List of produced Observations + +Spring Framework instruments various features for observability. +As outlined <>, observations can generate timer Metrics and/or Traces depending on the configuration. + +.Observations produced by Spring Framework +[%autowidth] +|=== +|Observation name |Description + +|<> +|Time spent for HTTP client exchanges + +|<> +|Processing time for HTTP server exchanges at the Framework level +|=== + +NOTE: Observations are using Micrometer's official naming convention, but Metrics names will be automatically converted +https://micrometer.io/docs/concepts#_naming_meters[to the format preferred by the monitoring system backend] +(Prometheus, Atlas, Graphite, InfluxDB...). + + [[integration.observability.concepts]] == Micrometer Observation concepts