Package org.springframework.web.reactive.function.client

Class DefaultClientObservationConvention

java.lang.Object

org.springframework.web.reactive.function.client.DefaultClientObservationConvention

All Implemented Interfaces:

io.micrometer.observation.KeyValuesConvention, io.micrometer.observation.ObservationConvention<ClientObservationContext>, ClientObservationConvention

public class DefaultClientObservationConvention
extends Object
implements ClientObservationConvention

Default implementation for a WebClient ObservationConvention, extracting information from the ClientObservationContext.

Since:

6.0

Author:

Brian Clozel

Field Summary

Fields inherited from interface io.micrometer.observation.ObservationConvention

EMPTY

Constructor Summary

Constructors

Constructor	Description
DefaultClientObservationConvention()	Create a convention with the default name "http.client.requests".
DefaultClientObservationConvention(String name)	Create a convention with a custom name.

Method Summary

Modifier and Type	Method	Description
protected io.micrometer.common.KeyValue	clientName(ClientObservationContext context)
protected io.micrometer.common.KeyValue	exception(ClientObservationContext context)
String	getContextualName(ClientObservationContext context)
io.micrometer.common.KeyValues	getHighCardinalityKeyValues(ClientObservationContext context)
io.micrometer.common.KeyValues	getLowCardinalityKeyValues(ClientObservationContext context)
String	getName()
protected io.micrometer.common.KeyValue	httpUrl(ClientObservationContext context)
protected io.micrometer.common.KeyValue	method(ClientObservationContext context)
protected io.micrometer.common.KeyValue	outcome(ClientObservationContext context)
protected io.micrometer.common.KeyValue	status(ClientObservationContext context)
protected io.micrometer.common.KeyValue	uri(ClientObservationContext context)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.web.reactive.function.client.ClientObservationConvention

supportsContext

Constructor Details

DefaultClientObservationConvention

public DefaultClientObservationConvention()

Create a convention with the default name "http.client.requests".

DefaultClientObservationConvention

public DefaultClientObservationConvention(String name)

Create a convention with a custom name.

Parameters:

name - the observation name

Method Details

getName

public String getName()

Specified by:

getName in interface io.micrometer.observation.ObservationConvention<ClientObservationContext>

getContextualName

public String getContextualName(ClientObservationContext context)

Specified by:

getContextualName in interface io.micrometer.observation.ObservationConvention<ClientObservationContext>

getLowCardinalityKeyValues

public io.micrometer.common.KeyValues getLowCardinalityKeyValues(ClientObservationContext context)

Specified by:

getLowCardinalityKeyValues in interface io.micrometer.observation.ObservationConvention<ClientObservationContext>

uri

protected io.micrometer.common.KeyValue uri(ClientObservationContext context)

method

protected io.micrometer.common.KeyValue method(ClientObservationContext context)

status

protected io.micrometer.common.KeyValue status(ClientObservationContext context)

exception

protected io.micrometer.common.KeyValue exception(ClientObservationContext context)

outcome

protected io.micrometer.common.KeyValue outcome(ClientObservationContext context)

getHighCardinalityKeyValues

public io.micrometer.common.KeyValues getHighCardinalityKeyValues(ClientObservationContext context)

Specified by:

getHighCardinalityKeyValues in interface io.micrometer.observation.ObservationConvention<ClientObservationContext>

httpUrl

protected io.micrometer.common.KeyValue httpUrl(ClientObservationContext context)

clientName

protected io.micrometer.common.KeyValue clientName(ClientObservationContext context)