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

Class WebMvcTags

java.lang.Object

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

public final class WebMvcTags
extends Object

Factory methods for Tags associated with a request-response exchange that is handled by Spring MVC.

Since:

2.0.0

Author:

Jon Schneider, Andy Wilkinson, Brian Clozel

Method Summary

Modifier and Type	Method and Description
static io.micrometer.core.instrument.Tag	exception(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	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(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(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(javax.servlet.http.HttpServletRequest request,
                                                    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(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