Package org.springframework.boot.actuate.metrics.web.reactive.server

Class WebFluxTags

java.lang.Object
org.springframework.boot.actuate.metrics.web.reactive.server.WebFluxTags
public final class WebFluxTags extends Object
Factory methods for Tags associated with a request-response exchange that is handled by WebFlux.
Since:
2.0.0
Author:
Jon Schneider, Andy Wilkinson, Michael McFadyen, Brian Clozel

  • Method Details

    • method

      public static io.micrometer.core.instrument.Tag method(ServerWebExchange exchange)
      Creates a method tag based on the method of the ServerWebExchange.getRequest() request of the given exchange.
      Parameters:
      exchange - the exchange
      Returns:
      the method tag whose value is a capitalized method (e.g. GET).

    • status

      public static io.micrometer.core.instrument.Tag status(ServerWebExchange exchange)
      Creates a status tag based on the response status of the given exchange.
      Parameters:
      exchange - the exchange
      Returns:
      the status tag derived from the response status

    • uri

      public static io.micrometer.core.instrument.Tag uri(ServerWebExchange exchange)
      Creates a uri tag based on the URI of the given exchange. 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:
      exchange - the exchange
      Returns:
      the uri tag derived from the exchange

    • uri

      public static io.micrometer.core.instrument.Tag uri(ServerWebExchange exchange, boolean ignoreTrailingSlash)
      Creates a uri tag based on the URI of the given exchange. 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:
      exchange - the exchange
      ignoreTrailingSlash - whether to ignore the trailing slash
      Returns:
      the uri tag derived from the exchange

    • exception

      public static io.micrometer.core.instrument.Tag exception(Throwable exception)
      Creates an 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(ServerWebExchange exchange, Throwable exception)
      Creates an outcome tag based on the response status of the given exchange and the exception thrown during request processing.
      Parameters:
      exchange - the exchange
      exception - the termination signal sent by the publisher
      Returns:
      the outcome tag derived from the response status
      Since:
      2.5.0