Top Description Inners Fields Constructors Methods
org.springframework.http.client.observation

public Class DefaultClientRequestObservationConvention

extends Object
implements ClientRequestObservationConvention
Class Inheritance
All Implemented Interfaces
org.springframework.http.client.observation.ClientRequestObservationConvention, io.micrometer.observation.ObservationConvention, io.micrometer.observation.KeyValuesConvention
Imports
java.io.IOException, java.util.regex.Pattern, io.micrometer.common.KeyValue, .KeyValues, org.springframework.http.HttpStatus, .HttpStatusCode, org.springframework.http.client.ClientHttpResponse, org.springframework.http.client.observation.ClientHttpObservationDocumentation.HighCardinalityKeyNames, .ClientHttpObservationDocumentation.LowCardinalityKeyNames, org.springframework.util.StringUtils
Default implementation for a ClientRequestObservationConvention, extracting information from the ClientRequestObservationContext.
Author
Brian Clozel
Since
6.0

Nested and Inner Type Summary

Modifier and TypeClass and Description
pack-priv static class
DefaultClientRequestObservationConvention.HttpOutcome

Field Summary

Modifier and TypeField and Description
private static final KeyValue
CLIENT_NAME_NONE

private static final String
DEFAULT_NAME

private static final KeyValue
EXCEPTION_NONE

private static final KeyValue
HTTP_OUTCOME_SUCCESS

private static final KeyValue
HTTP_OUTCOME_UNKNOWN

private static final KeyValue
HTTP_URL_NONE

private static final KeyValue
METHOD_NONE

private final String
name

private static final Pattern
PATTERN_BEFORE_PATH

private static final KeyValue
STATUS_CLIENT_ERROR

private static final KeyValue
STATUS_IO_ERROR

private static final KeyValue
URI_NONE

Constructor Summary

AccessConstructor and Description
public
DefaultClientRequestObservationConvention()

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

public
DefaultClientRequestObservationConvention(String
the observation name
name)

Create a convention with a custom name.

Method Summary

Modifier and TypeMethod and Description
protected KeyValue
clientName(ClientRequestObservationContext context)

protected KeyValue
exception(ClientRequestObservationContext context)

private static String
extractPath(String uriTemplate)

public String
getContextualName(ClientRequestObservationContext
context
context)

Overrides default io.micrometer.observation.ObservationConvention.getContextualName.

Allows to override the contextual name for an Observation.

public KeyValues
getHighCardinalityKeyValues(ClientRequestObservationContext context)

Overrides default io.micrometer.observation.ObservationConvention.getHighCardinalityKeyValues.

High cardinality key values.

public KeyValues
getLowCardinalityKeyValues(ClientRequestObservationContext context)

Overrides default io.micrometer.observation.ObservationConvention.getLowCardinalityKeyValues.

Low cardinality key values.

public String
getName()

Overrides default io.micrometer.observation.ObservationConvention.getName.

Allows to override the name for an observation.

protected KeyValue
method(ClientRequestObservationContext context)

protected KeyValue
outcome(ClientRequestObservationContext context)

protected KeyValue
requestUri(ClientRequestObservationContext context)

protected KeyValue
status(ClientRequestObservationContext context)

protected KeyValue
uri(ClientRequestObservationContext context)

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

CLIENT_NAME_NONEback to summary
private static final KeyValue CLIENT_NAME_NONE
DEFAULT_NAMEback to summary
private static final String DEFAULT_NAME
EXCEPTION_NONEback to summary
private static final KeyValue EXCEPTION_NONE
HTTP_OUTCOME_SUCCESSback to summary
private static final KeyValue HTTP_OUTCOME_SUCCESS
HTTP_OUTCOME_UNKNOWNback to summary
private static final KeyValue HTTP_OUTCOME_UNKNOWN
HTTP_URL_NONEback to summary
private static final KeyValue HTTP_URL_NONE
METHOD_NONEback to summary
private static final KeyValue METHOD_NONE
nameback to summary
private final String name
PATTERN_BEFORE_PATHback to summary
private static final Pattern PATTERN_BEFORE_PATH
STATUS_CLIENT_ERRORback to summary
private static final KeyValue STATUS_CLIENT_ERROR
STATUS_IO_ERRORback to summary
private static final KeyValue STATUS_IO_ERROR
URI_NONEback to summary
private static final KeyValue URI_NONE

Constructor Detail

DefaultClientRequestObservationConventionback to summary
public DefaultClientRequestObservationConvention()

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

DefaultClientRequestObservationConventionback to summary
public DefaultClientRequestObservationConvention(String name)

Create a convention with a custom name.

Parameters
name:String

the observation name

Method Detail

clientNameback to summary
protected KeyValue clientName(ClientRequestObservationContext context)
exceptionback to summary
protected KeyValue exception(ClientRequestObservationContext context)
extractPathback to summary
private static String extractPath(String uriTemplate)
getContextualNameback to summary
public String getContextualName(ClientRequestObservationContext context)

Overrides default io.micrometer.observation.ObservationConvention.getContextualName.

Doc from io.micrometer.observation.ObservationConvention.getContextualName.

Allows to override the contextual name for an Observation. The Observation will be renamed only when an explicit context was passed - if an implicit context is used this method won't be called.

Parameters
context:ClientRequestObservationContext

context

Returns:String

the new, contextual name for the observation

Annotations
@Override
getHighCardinalityKeyValuesback to summary
public KeyValues getHighCardinalityKeyValues(ClientRequestObservationContext context)

Overrides default io.micrometer.observation.ObservationConvention.getHighCardinalityKeyValues.

Doc from io.micrometer.observation.ObservationConvention.getHighCardinalityKeyValues.

High cardinality key values.

Returns:KeyValues

key values

Annotations
@Override
getLowCardinalityKeyValuesback to summary
public KeyValues getLowCardinalityKeyValues(ClientRequestObservationContext context)

Overrides default io.micrometer.observation.ObservationConvention.getLowCardinalityKeyValues.

Doc from io.micrometer.observation.ObservationConvention.getLowCardinalityKeyValues.

Low cardinality key values.

Returns:KeyValues

key values

Annotations
@Override
getNameback to summary
public String getName()

Overrides default io.micrometer.observation.ObservationConvention.getName.

Doc from io.micrometer.observation.ObservationConvention.getName.

Allows to override the name for an observation.

Returns:String

the new name for the observation

Annotations
@Override
methodback to summary
protected KeyValue method(ClientRequestObservationContext context)
outcomeback to summary
protected KeyValue outcome(ClientRequestObservationContext context)
requestUriback to summary
protected KeyValue requestUri(ClientRequestObservationContext context)
statusback to summary
protected KeyValue status(ClientRequestObservationContext context)
uriback to summary
protected KeyValue uri(ClientRequestObservationContext context)
org.springframework.http.client.observation back to summary

pack-priv Class DefaultClientRequestObservationConvention.HttpOutcome

extends Object
Class Inheritance
  • java.lang.Object
  • org.springframework.http.client.observation.DefaultClientRequestObservationConvention.HttpOutcome

Constructor Summary

AccessConstructor and Description
pack-priv
HttpOutcome()

Method Summary

Modifier and TypeMethod and Description
pack-priv static KeyValue
forStatus(HttpStatusCode statusCode)

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Constructor Detail

HttpOutcomeback to summary
pack-priv HttpOutcome()

Method Detail

forStatusback to summary
pack-priv static KeyValue forStatus(HttpStatusCode statusCode)