Class ServerHttpObservationFilter

All Implemented Interfaces:
Filter, Aware, BeanNameAware, DisposableBean, InitializingBean, EnvironmentAware, EnvironmentCapable, ServletContextAware

public class ServerHttpObservationFilter extends OncePerRequestFilter
Filter that creates observations for HTTP exchanges. This collects information about the execution time and information gathered from the ServerRequestObservationContext.

Web Frameworks can fetch the current context as a request attribute and contribute additional information to it. The configured ServerRequestObservationConvention will use this context to collect metadata and attach it to the observation.

Brian Clozel
  • Field Details


      public static final String CURRENT_OBSERVATION_CONTEXT_ATTRIBUTE
      Name of the request attribute holding the context for the current observation.
  • Constructor Details

    • ServerHttpObservationFilter

      public ServerHttpObservationFilter(io.micrometer.observation.ObservationRegistry observationRegistry)
      Create an HttpRequestsObservationFilter that records observations against the given ObservationRegistry. The default convention will be used.
      observationRegistry - the registry to use for recording observations
    • ServerHttpObservationFilter

      public ServerHttpObservationFilter(io.micrometer.observation.ObservationRegistry observationRegistry, ServerRequestObservationConvention observationConvention)
      Create an HttpRequestsObservationFilter that records observations against the given ObservationRegistry with a custom convention.
      observationRegistry - the registry to use for recording observations
      observationConvention - the convention to use for all recorded observations
  • Method Details

    • findObservationContext

      public static Optional<ServerRequestObservationContext> findObservationContext(HttpServletRequest request)
      Get the current observation context from the given request, if available.
      request - the current request
      the current observation context
    • shouldNotFilterAsyncDispatch

      protected boolean shouldNotFilterAsyncDispatch()
      Description copied from class: OncePerRequestFilter
      The dispatcher type jakarta.servlet.DispatcherType.ASYNC means a filter can be invoked in more than one thread over the course of a single request. Some filters only need to filter the initial thread (e.g. request wrapping) while others may need to be invoked at least once in each additional thread for example for setting up thread locals or to perform final processing at the very end.

      Note that although a filter can be mapped to handle specific dispatcher types via web.xml or in Java through the ServletContext, servlet containers may enforce different defaults with respect to dispatcher types. This flag enforces the design intent of the filter.

      The default return value is "true", which means the filter will not be invoked during subsequent async dispatches. If "false", the filter will be invoked during async dispatches with the same guarantees of being invoked only once during a request within a single thread.

      shouldNotFilterAsyncDispatch in class OncePerRequestFilter
    • doFilterInternal

      protected void doFilterInternal(HttpServletRequest request, HttpServletResponse response, FilterChain filterChain) throws ServletException, IOException
      Description copied from class: OncePerRequestFilter
      Same contract as for doFilter, but guaranteed to be just invoked once per request within a single request thread. See OncePerRequestFilter.shouldNotFilterAsyncDispatch() for details.

      Provides HttpServletRequest and HttpServletResponse arguments instead of the default ServletRequest and ServletResponse ones.

      Specified by:
      doFilterInternal in class OncePerRequestFilter