org.springframework.boot.actuate.metrics.web.reactive.client

Class WebClientExchangeTags

java.lang.Object

org.springframework.boot.actuate.metrics.web.reactive.client.WebClientExchangeTags

public final class WebClientExchangeTags
extends Object

Factory methods for creating Tags related to a request-response exchange performed by a WebClient.

Since:

2.1.0

Author:

Brian Clozel, Nishant Raut

Method Summary

Modifier and Type	Method and Description
static io.micrometer.core.instrument.Tag	clientName(ClientRequest request) Create a clientName Tag derived from the host of the URL of the given request.
static io.micrometer.core.instrument.Tag	method(ClientRequest request) Creates a method Tag for the method of the given request.
static io.micrometer.core.instrument.Tag	outcome(ClientResponse response) Creates an outcome Tag derived from the status of the given response.
static io.micrometer.core.instrument.Tag	status(ClientResponse response) Deprecated. since 2.3.0 for removal in 2.5.0 in favor of status(ClientResponse, Throwable)
static io.micrometer.core.instrument.Tag	status(ClientResponse response, Throwable throwable) Creates a status Tag derived from the ClientResponse.statusCode() of the given response if available, the thrown exception otherwise, or considers the request as Cancelled as a last resort.
static io.micrometer.core.instrument.Tag	status(Throwable throwable) Deprecated. since 2.3.0 for removal in 2.5.0 in favor of status(ClientResponse, Throwable)
static io.micrometer.core.instrument.Tag	uri(ClientRequest request) Creates a uri Tag for the URI path 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(ClientRequest request)

Creates a method Tag for the method of the given request.

Parameters:

request - the request

Returns:

the method tag

uri

public static io.micrometer.core.instrument.Tag uri(ClientRequest request)

Creates a uri Tag for the URI path of the given request.

Parameters:

request - the request

Returns:

the uri tag

status

public static io.micrometer.core.instrument.Tag status(ClientResponse response,
                                                       Throwable throwable)

Creates a status Tag derived from the ClientResponse.statusCode() of the given response if available, the thrown exception otherwise, or considers the request as Cancelled as a last resort.

Parameters:

response - the response

throwable - the exception

Returns:

the status tag

Since:

2.3.0

status

@Deprecated
public static io.micrometer.core.instrument.Tag status(ClientResponse response)

Deprecated. since 2.3.0 for removal in 2.5.0 in favor of status(ClientResponse, Throwable)

Creates a status Tag derived from the ClientResponse.statusCode() of the given response.

Parameters:

response - the response

Returns:

the status tag

status

@Deprecated
public static io.micrometer.core.instrument.Tag status(Throwable throwable)

Deprecated. since 2.3.0 for removal in 2.5.0 in favor of status(ClientResponse, Throwable)

Creates a status Tag derived from the exception thrown by the client.

Parameters:

throwable - the exception

Returns:

the status tag

clientName

public static io.micrometer.core.instrument.Tag clientName(ClientRequest request)

Create a clientName Tag derived from the host of the URL of the given request.

Parameters:

request - the request

Returns:

the clientName tag

outcome

public static io.micrometer.core.instrument.Tag outcome(ClientResponse response)

Creates an outcome Tag derived from the status of the given response.

Parameters:

response - the response

Returns:

the outcome tag

Since:

2.2.0