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

public sealed Enum ClientHttpObservationDocumentation

extends Enum<ClientHttpObservationDocumentation>
implements ObservationDocumentation
Class Inheritance
All Implemented Interfaces
io.micrometer.observation.docs.ObservationDocumentation
Imports
io.micrometer.common.KeyValue, io.micrometer.common.docs.KeyName, io.micrometer.observation.Observation, .ObservationConvention, io.micrometer.observation.docs.ObservationDocumentation, org.springframework.http.client.ClientHttpRequestFactory
Documented KeyValues for HTTP client observations.

This class is used by automated tools to document KeyValues attached to the HTTP client observations.

Author
Brian Clozel
Since
6.0

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static enum
ClientHttpObservationDocumentation.HighCardinalityKeyNames

public static enum
ClientHttpObservationDocumentation.LowCardinalityKeyNames

Field Summary

Modifier and TypeField and Description
public static final ClientHttpObservationDocumentation
HTTP_CLIENT_EXCHANGES

HTTP exchanges observations for clients.

Constructor Summary

AccessConstructor and Description
private
ClientHttpObservationDocumentation()

Method Summary

Modifier and TypeMethod and Description
public static ClientHttpObservationDocumentation
valueOf(String name)

public static ClientHttpObservationDocumentation[]
values()

Inherited from java.lang.Enum:
clonecompareTodescribeConstableequalsfinalizegetDeclaringClasshashCodenameordinaltoStringvalueOf

Field Detail

HTTP_CLIENT_EXCHANGESback to summary
public static final ClientHttpObservationDocumentation HTTP_CLIENT_EXCHANGES

HTTP exchanges observations for clients.

Constructor Detail

ClientHttpObservationDocumentationback to summary
private ClientHttpObservationDocumentation()

Method Detail

valueOfback to summary
public static ClientHttpObservationDocumentation valueOf(String name)
valuesback to summary
public static ClientHttpObservationDocumentation[] values()
org.springframework.http.client.observation back to summary

public sealed Enum ClientHttpObservationDocumentation.HighCardinalityKeyNames

extends Enum<ClientHttpObservationDocumentation.HighCardinalityKeyNames>
implements KeyName
Class Inheritance
All Implemented Interfaces
io.micrometer.common.docs.KeyName

Field Summary

Modifier and TypeField and Description
public static final ClientHttpObservationDocumentation.HighCardinalityKeyNames
CLIENT_NAME

Client name derived from the request URI host.

public static final ClientHttpObservationDocumentation.HighCardinalityKeyNames
HTTP_URL

HTTP request URI.

Constructor Summary

AccessConstructor and Description
private
HighCardinalityKeyNames()

Method Summary

Modifier and TypeMethod and Description
public static ClientHttpObservationDocumentation.HighCardinalityKeyNames
valueOf(String name)

public static ClientHttpObservationDocumentation.HighCardinalityKeyNames[]
values()

Inherited from java.lang.Enum:
clonecompareTodescribeConstableequalsfinalizegetDeclaringClasshashCodenameordinaltoStringvalueOf

Field Detail

CLIENT_NAMEback to summary
public static final ClientHttpObservationDocumentation.HighCardinalityKeyNames CLIENT_NAME

Deprecated

for removal since 6.0.5.

in favor of LowCardinalityKeyNames#CLIENT_NAME; scheduled for removal in 6.2. This will be available both as a low and high cardinality key value.

Client name derived from the request URI host.

Annotations
@Deprecated
since:6.0.5
forRemoval:true
HTTP_URLback to summary
public static final ClientHttpObservationDocumentation.HighCardinalityKeyNames HTTP_URL

HTTP request URI.

Constructor Detail

HighCardinalityKeyNamesback to summary
private HighCardinalityKeyNames()

Method Detail

valueOfback to summary
public static ClientHttpObservationDocumentation.HighCardinalityKeyNames valueOf(String name)
valuesback to summary
public static ClientHttpObservationDocumentation.HighCardinalityKeyNames[] values()
org.springframework.http.client.observation back to summary

public sealed Enum ClientHttpObservationDocumentation.LowCardinalityKeyNames

extends Enum<ClientHttpObservationDocumentation.LowCardinalityKeyNames>
implements KeyName
Class Inheritance
All Implemented Interfaces
io.micrometer.common.docs.KeyName

Field Summary

Modifier and TypeField and Description
public static final ClientHttpObservationDocumentation.LowCardinalityKeyNames
CLIENT_NAME

Client name derived from the request URI host.

public static final ClientHttpObservationDocumentation.LowCardinalityKeyNames
EXCEPTION

Name of the exception thrown during the exchange, or none if no exception happened.

public static final ClientHttpObservationDocumentation.LowCardinalityKeyNames
METHOD

Name of HTTP request method or none if the request could not be created.

public static final ClientHttpObservationDocumentation.LowCardinalityKeyNames
OUTCOME

Outcome of the HTTP client exchange.

public static final ClientHttpObservationDocumentation.LowCardinalityKeyNames
STATUS

HTTP response raw status code, or "IO_ERROR" in case of IOException, or "CLIENT_ERROR" if no response was received.

public static final ClientHttpObservationDocumentation.LowCardinalityKeyNames
URI

URI template used for HTTP request, or none if none was provided.

Constructor Summary

AccessConstructor and Description
private
LowCardinalityKeyNames()

Method Summary

Modifier and TypeMethod and Description
public static ClientHttpObservationDocumentation.LowCardinalityKeyNames
valueOf(String name)

public static ClientHttpObservationDocumentation.LowCardinalityKeyNames[]
values()

Inherited from java.lang.Enum:
clonecompareTodescribeConstableequalsfinalizegetDeclaringClasshashCodenameordinaltoStringvalueOf

Field Detail

CLIENT_NAMEback to summary
public static final ClientHttpObservationDocumentation.LowCardinalityKeyNames CLIENT_NAME

Client name derived from the request URI host.

Since
6.0.5
EXCEPTIONback to summary
public static final ClientHttpObservationDocumentation.LowCardinalityKeyNames EXCEPTION

Name of the exception thrown during the exchange, or none if no exception happened.

METHODback to summary
public static final ClientHttpObservationDocumentation.LowCardinalityKeyNames METHOD

Name of HTTP request method or none if the request could not be created.

OUTCOMEback to summary
public static final ClientHttpObservationDocumentation.LowCardinalityKeyNames OUTCOME

Outcome of the HTTP client exchange.

See Also
org.springframework.http.HttpStatus.Series
STATUSback to summary
public static final ClientHttpObservationDocumentation.LowCardinalityKeyNames STATUS

HTTP response raw status code, or "IO_ERROR" in case of IOException, or "CLIENT_ERROR" if no response was received.

URIback to summary
public static final ClientHttpObservationDocumentation.LowCardinalityKeyNames URI

URI template used for HTTP request, or none if none was provided. Only the path part of the URI is considered.

Constructor Detail

LowCardinalityKeyNamesback to summary
private LowCardinalityKeyNames()

Method Detail

valueOfback to summary
public static ClientHttpObservationDocumentation.LowCardinalityKeyNames valueOf(String name)
valuesback to summary
public static ClientHttpObservationDocumentation.LowCardinalityKeyNames[] values()