Skip to content

Commit 2e08a07

Browse files
committed
Add a list of produced observations
This commit adds a list observations produced by Spring Framework in the reference documentation. Closes gh-30060
1 parent df4e7d1 commit 2e08a07

File tree

1 file changed

+24
-0
lines changed

1 file changed

+24
-0
lines changed

framework-docs/src/docs/asciidoc/integration/observability.adoc

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,30 @@ Traces provide a holistic view of an entire system, crossing application boundar
99
Spring Framework instruments various parts of its own codebase to publish observations if an `ObservationRegistry` is configured.
1010
You can learn more about {docs-spring-boot}/html/actuator.html#actuator.metrics[configuring the observability infrastructure in Spring Boot].
1111

12+
13+
[[integration.observability.list]]
14+
== List of produced Observations
15+
16+
Spring Framework instruments various features for observability.
17+
As outlined <<integration.observability,at the beginning of this section>>, observations can generate timer Metrics and/or Traces depending on the configuration.
18+
19+
.Observations produced by Spring Framework
20+
[%autowidth]
21+
|===
22+
|Observation name |Description
23+
24+
|<<integration.observability.http-client,`"http.client.requests"`>>
25+
|Time spent for HTTP client exchanges
26+
27+
|<<integration.observability.http-server,`"http.server.requests"`>>
28+
|Processing time for HTTP server exchanges at the Framework level
29+
|===
30+
31+
NOTE: Observations are using Micrometer's official naming convention, but Metrics names will be automatically converted
32+
https://micrometer.io/docs/concepts#_naming_meters[to the format preferred by the monitoring system backend]
33+
(Prometheus, Atlas, Graphite, InfluxDB...).
34+
35+
1236
[[integration.observability.concepts]]
1337
== Micrometer Observation concepts
1438

0 commit comments

Comments
 (0)