spring-framework/framework-docs/src/docs/asciidoc
Brian Clozel 708f600afe Document how to mark an observation as an error
The `ServerHttpObservationFilter` implementations record observations
for processed HTTP exchanges. The `Observation.Context` contains various
metadata contributed by the observation convention. The instrumentation
can also mark the observation as an error by setting any `Throwable` on
the context.

Because the instrumentation is done as filters, only exceptions reaching
the filter can be considered. Any error handled at a lower level by the
Framework can, or cannot be considered as an error for an observation.

This commit documents how a web application should opt-in for
considering a handled exception as an error for the current observation.

Closes gh-29848
2023-02-02 18:19:17 +01:00
..
core Stop referring to "Spring 3.x" features in documentation and code 2023-01-20 14:13:18 +01:00
data-access Polishing 2022-11-29 13:51:34 +01:00
images Create framework-docs module 2022-11-02 10:59:12 +01:00
integration Document how to mark an observation as an error 2023-02-02 18:19:17 +01:00
languages Additional documentation notes on Java/Kotlin parameter name retention 2022-11-24 14:08:53 +01:00
testing Polishing 2023-01-06 16:50:19 +00:00
web Document how to enable HTTP client Observation instrumentation 2023-02-02 16:03:11 +01:00
appendix.adoc Refactor Asciidoctor attributes in reference docs 2022-11-17 15:35:28 +01:00
attributes.adoc Document how to mark an observation as an error 2023-02-02 18:19:17 +01:00
core.adoc Refactor Asciidoctor attributes in reference docs 2022-11-17 15:35:28 +01:00
data-access.adoc Polishing 2022-12-18 12:05:24 +01:00
index-docinfo-header.html Create framework-docs module 2022-11-02 10:59:12 +01:00
index.adoc Update copyright year in reference manual 2023-01-11 17:32:31 +01:00
integration.adoc Document Observability support in reference docs 2022-11-25 17:33:11 +01:00
languages.adoc Refactor Asciidoctor attributes in reference docs 2022-11-17 15:35:28 +01:00
overview.adoc Update documentation to mention Java 17+ baseline 2022-11-18 09:43:41 +01:00
page-layout.adoc Refactor Asciidoctor attributes in reference docs 2022-11-17 15:35:28 +01:00
rsocket.adoc Refactor Asciidoctor attributes in reference docs 2022-11-17 15:35:28 +01:00
spring-framework.adocbook Increase number of TOC levels to 4 in generated PDF documentation 2023-01-24 15:31:14 +01:00
testing.adoc Introduce appendix in Testing chapter in the reference manual 2022-11-19 14:59:34 +01:00
web-reactive.adoc Fix link to WebFlux section in reference manual 2022-11-19 14:42:55 +01:00
web.adoc Refactor Asciidoctor attributes in reference docs 2022-11-17 15:35:28 +01:00