Package org.springframework.boot.actuate.metrics.web.servlet

Class DefaultWebMvcTagsProvider

java.lang.Object
org.springframework.boot.actuate.metrics.web.servlet.DefaultWebMvcTagsProvider
All Implemented Interfaces:
WebMvcTagsProvider
@Deprecated(since="3.0.0", forRemoval=true) public class DefaultWebMvcTagsProvider extends Object implements WebMvcTagsProvider
Deprecated, for removal: This API element is subject to removal in a future version.
since 3.0.0 for removal in 3.2.0 in favor of ServerRequestObservationConvention
Default implementation of WebMvcTagsProvider.
Since:
2.0.0

  • Constructor Summary

    Constructors
    Constructor
    Description
    DefaultWebMvcTagsProvider()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    DefaultWebMvcTagsProvider(boolean ignoreTrailingSlash)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    DefaultWebMvcTagsProvider(boolean ignoreTrailingSlash, List<WebMvcTagsContributor> contributors)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Creates a new DefaultWebMvcTagsProvider that will provide tags from the given contributors in addition to its own.
    DefaultWebMvcTagsProvider(List<WebMvcTagsContributor> contributors)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Creates a new DefaultWebMvcTagsProvider that will provide tags from the given contributors in addition to its own.

  • Method Summary

    Modifier and Type
    Method
    Description
    Iterable<io.micrometer.core.instrument.Tag>
    getLongRequestTags(jakarta.servlet.http.HttpServletRequest request, Object handler)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Provides tags to be used by long task timers.
    Iterable<io.micrometer.core.instrument.Tag>
    getTags(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, Object handler, Throwable exception)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Provides tags to be associated with metrics for the given request and response exchange.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • DefaultWebMvcTagsProvider

      public DefaultWebMvcTagsProvider()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • DefaultWebMvcTagsProvider

      public DefaultWebMvcTagsProvider(List<WebMvcTagsContributor> contributors)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Creates a new DefaultWebMvcTagsProvider that will provide tags from the given contributors in addition to its own.
      Parameters:
      contributors - the contributors that will provide additional tags
      Since:
      2.3.0

    • DefaultWebMvcTagsProvider

      public DefaultWebMvcTagsProvider(boolean ignoreTrailingSlash)
      Deprecated, for removal: This API element is subject to removal in a future version.

    • DefaultWebMvcTagsProvider

      public DefaultWebMvcTagsProvider(boolean ignoreTrailingSlash, List<WebMvcTagsContributor> contributors)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Creates a new DefaultWebMvcTagsProvider that will provide tags from the given contributors in addition to its own.
      Parameters:
      ignoreTrailingSlash - whether trailing slashes should be ignored when determining the uri tag.
      contributors - the contributors that will provide additional tags
      Since:
      2.3.0

  • Method Details

    • getTags

      public Iterable<io.micrometer.core.instrument.Tag> getTags(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, Object handler, Throwable exception)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Description copied from interface: WebMvcTagsProvider
      Provides tags to be associated with metrics for the given request and response exchange.
      Specified by:
      getTags in interface WebMvcTagsProvider
      Parameters:
      request - the request
      response - the response
      handler - the handler for the request or null if the handler is unknown
      exception - the current exception, if any
      Returns:
      tags to associate with metrics for the request and response exchange

    • getLongRequestTags

      public Iterable<io.micrometer.core.instrument.Tag> getLongRequestTags(jakarta.servlet.http.HttpServletRequest request, Object handler)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Description copied from interface: WebMvcTagsProvider
      Provides tags to be used by long task timers.
      Specified by:
      getLongRequestTags in interface WebMvcTagsProvider
      Parameters:
      request - the HTTP request
      handler - the handler for the request or null if the handler is unknown
      Returns:
      tags to associate with metrics recorded for the request