Skip to content

Commit 64e04b7

Browse files
committed
Document limitations of Servlet Filter observations
This commit documents the fact that the Servlet Filter based observations for MVC applications is limited by the Servlet Filter contract in the first place. All processing and logging that happens outside of the scope of the filter is not observed. Log statements from the catalina engine (in the case of Tomcat), or any container-specific infrastructure, is not covered by the instrumentation. Closes gh-29398
1 parent ad05b02 commit 64e04b7

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

framework-docs/modules/ROOT/pages/integration/observability.adoc

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -97,6 +97,10 @@ You can, at any point during request processing, set the error field on the `Obs
9797

9898
include-code::./UserController[]
9999

100+
NOTE: Because the instrumentation is done at the Servlet Filter level, the observation scope only covers the filters ordered after this one as well as the handling of the request.
101+
Typically, the Servlet container error handling is done at a lower level and won't have any active observation nor span.
102+
For this use case, a container-specific implementation is required, such as a `org.apache.catalina.Valve` for Tomcat; this is outside of the scope of this project.
103+
100104
By default, the following `KeyValues` are created:
101105

102106
.Low cardinality Keys

0 commit comments

Comments
 (0)