Package io.micrometer.spring.web.servlet

Class WebMvcTags

  • @NonNullApi
public final class WebMvcTags
extends java.lang.Object
    Factory methods for Tags associated with a request-response exchange that is instrumented by WebMvcMetricsFilter.

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static io.micrometer.core.instrument.Tag exception​(java.lang.Throwable exception)
      Creates a exception tag based on the simple name of the class of the given exception.
      static io.micrometer.core.instrument.Tag method​(javax.servlet.http.HttpServletRequest request)
      Creates a method tag based on the method of the given request.
      static io.micrometer.core.instrument.Tag outcome​(javax.servlet.http.HttpServletResponse response)
      Creates an outcome tag based on the status of the given response.
      static io.micrometer.core.instrument.Tag status​(javax.servlet.http.HttpServletResponse response)
      Creates a method tag based on the status of the given response.
      static io.micrometer.core.instrument.Tag uri​(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
      Creates a uri tag based on the URI of the given request.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Method Detail

      • method

        public static io.micrometer.core.instrument.Tag method​(@Nullable
                                                       javax.servlet.http.HttpServletRequest request)
        Creates a method tag based on the method of the given request.
        Parameters:
        request - the request
        Returns:
        the method tag whose value is a capitalized method (e.g. GET).

      • status

        public static io.micrometer.core.instrument.Tag status​(@Nullable
                                                       javax.servlet.http.HttpServletResponse response)
        Creates a method tag based on the status of the given response.
        Parameters:
        response - the HTTP response
        Returns:
        the status tag derived from the status of the response

      • uri

        public static io.micrometer.core.instrument.Tag uri​(@Nullable
                                                    javax.servlet.http.HttpServletRequest request,
                                                    @Nullable
                                                    javax.servlet.http.HttpServletResponse response)
        Creates a uri tag based on the URI of the given request. Uses the HandlerMapping.BEST_MATCHING_PATTERN_ATTRIBUTE best matching pattern if available. Falling back to REDIRECTION for 3xx responses, NOT_FOUND for 404 responses, root for requests with no path info, and UNKNOWN for all other requests.
        Parameters:
        request - the request
        response - the response
        Returns:
        the uri tag derived from the request

      • exception

        public static io.micrometer.core.instrument.Tag exception​(@Nullable
                                                          java.lang.Throwable exception)
        Creates a exception tag based on the simple name of the class of the given exception.
        Parameters:
        exception - the exception, may be null
        Returns:
        the exception tag derived from the exception

      • outcome

        public static io.micrometer.core.instrument.Tag outcome​(@Nullable
                                                        javax.servlet.http.HttpServletResponse response)
        Creates an outcome tag based on the status of the given response.
        Parameters:
        response - the HTTP response
        Returns:
        the outcome tag derived from the status of the response
        Since:
        1.1.0