Skip to content

Commit

Permalink
Document limitations of Servlet Filter observations
Browse files Browse the repository at this point in the history
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
  • Loading branch information
bclozel committed Jul 6, 2023
1 parent ad05b02 commit 64e04b7
Showing 1 changed file with 4 additions and 0 deletions.
Expand Up @@ -97,6 +97,10 @@ You can, at any point during request processing, set the error field on the `Obs

include-code::./UserController[]

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.
Typically, the Servlet container error handling is done at a lower level and won't have any active observation nor span.
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.

By default, the following `KeyValues` are created:

.Low cardinality Keys
Expand Down

0 comments on commit 64e04b7

Please sign in to comment.