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

public Class DefaultServerRequestObservationConvention

extends Object
implements ServerRequestObservationConvention
Class Inheritance
All Implemented Interfaces
org.springframework.http.server.observation.ServerRequestObservationConvention, io.micrometer.observation.ObservationConvention, io.micrometer.observation.KeyValuesConvention
Imports
java.util.Set, java.util.stream.Collectors, .Stream, io.micrometer.common.KeyValue, .KeyValues, org.springframework.http.HttpMethod, .HttpStatus, .HttpStatusCode, org.springframework.http.server.observation.ServerHttpObservationDocumentation.HighCardinalityKeyNames, .ServerHttpObservationDocumentation.LowCardinalityKeyNames, org.springframework.util.StringUtils
Default ServerRequestObservationConvention.
Author
Brian Clozel
Since
6.0

Nested and Inner Type Summary

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

Field Summary

Modifier and TypeField and Description
private static final String
DEFAULT_NAME

private static final KeyValue
EXCEPTION_NONE

private static final Set<String>
HTTP_METHODS

private static final KeyValue
HTTP_OUTCOME_SUCCESS

private static final KeyValue
HTTP_OUTCOME_UNKNOWN

private static final KeyValue
HTTP_URL_UNKNOWN

private static final KeyValue
METHOD_UNKNOWN

private final String
name

private static final KeyValue
STATUS_UNKNOWN

private static final KeyValue
URI_NOT_FOUND

private static final KeyValue
URI_REDIRECTION

private static final KeyValue
URI_ROOT

private static final KeyValue
URI_UNKNOWN

Constructor Summary

AccessConstructor and Description
public
DefaultServerRequestObservationConvention()

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

public
DefaultServerRequestObservationConvention(String
the observation name
name)

Create a convention with a custom name.

Method Summary

Modifier and TypeMethod and Description
protected KeyValue
exception(ServerRequestObservationContext context)

public String
getContextualName(ServerRequestObservationContext
context
context)

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

Allows to override the contextual name for an Observation.
public KeyValues
getHighCardinalityKeyValues(ServerRequestObservationContext context)

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

High cardinality key values.
public KeyValues
getLowCardinalityKeyValues(ServerRequestObservationContext 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
httpUrl(ServerRequestObservationContext context)

protected KeyValue
method(ServerRequestObservationContext context)

protected KeyValue
outcome(ServerRequestObservationContext context)

protected KeyValue
status(ServerRequestObservationContext context)

protected KeyValue
uri(ServerRequestObservationContext context)

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

DEFAULT_NAMEback to summary
private static final String DEFAULT_NAME
EXCEPTION_NONEback to summary
private static final KeyValue EXCEPTION_NONE
HTTP_METHODSback to summary
private static final Set<String> HTTP_METHODS
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_UNKNOWNback to summary
private static final KeyValue HTTP_URL_UNKNOWN
METHOD_UNKNOWNback to summary
private static final KeyValue METHOD_UNKNOWN
nameback to summary
private final String name
STATUS_UNKNOWNback to summary
private static final KeyValue STATUS_UNKNOWN
URI_NOT_FOUNDback to summary
private static final KeyValue URI_NOT_FOUND
URI_REDIRECTIONback to summary
private static final KeyValue URI_REDIRECTION
URI_ROOTback to summary
private static final KeyValue URI_ROOT
URI_UNKNOWNback to summary
private static final KeyValue URI_UNKNOWN

Constructor Detail

DefaultServerRequestObservationConventionback to summary
public DefaultServerRequestObservationConvention()

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

DefaultServerRequestObservationConventionback to summary
public DefaultServerRequestObservationConvention(String name)

Create a convention with a custom name.

Parameters
name:String

the observation name

Method Detail

exceptionback to summary
protected KeyValue exception(ServerRequestObservationContext context)
getContextualNameback to summary
public String getContextualName(ServerRequestObservationContext 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:ServerRequestObservationContext

context

Returns:String

the new, contextual name for the observation

Annotations
@Override
getHighCardinalityKeyValuesback to summary
public KeyValues getHighCardinalityKeyValues(ServerRequestObservationContext 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(ServerRequestObservationContext 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
httpUrlback to summary
protected KeyValue httpUrl(ServerRequestObservationContext context)
methodback to summary
protected KeyValue method(ServerRequestObservationContext context)
outcomeback to summary
protected KeyValue outcome(ServerRequestObservationContext context)
statusback to summary
protected KeyValue status(ServerRequestObservationContext context)
uriback to summary
protected KeyValue uri(ServerRequestObservationContext context)
org.springframework.http.server.observation back to summary

pack-priv Class DefaultServerRequestObservationConvention.HttpOutcome

extends Object
Class Inheritance
  • java.lang.Object
  • org.springframework.http.server.observation.DefaultServerRequestObservationConvention.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)