Class OpenTelemetryServerRequestObservationConvention

java.lang.Object

org.springframework.http.server.observation.OpenTelemetryServerRequestObservationConvention

All Implemented Interfaces:

io.micrometer.observation.KeyValuesConvention, io.micrometer.observation.ObservationConvention<ServerRequestObservationContext>, ServerRequestObservationConvention

public class OpenTelemetryServerRequestObservationConvention
extends Object
implements ServerRequestObservationConvention

A ServerRequestObservationConvention based on the stable OpenTelemetry semantic conventions.

Since:

7.0

Author:

Brian Clozel, Tommy Ludwig

See Also:

• OpenTelemetryServerHttpObservationDocumentation

Field Summary

Fields inherited from interface io.micrometer.observation.ObservationConvention

EMPTY

Constructor Summary

Constructors

Constructor	Description
OpenTelemetryServerRequestObservationConvention()

Method Summary

Modifier and Type	Method	Description
protected io.micrometer.common.KeyValue	exception(ServerRequestObservationContext context)
String	getContextualName(ServerRequestObservationContext context)	HTTP span names SHOULD be {method} {target} if there is a (low-cardinality) target available.
io.micrometer.common.KeyValues	getHighCardinalityKeyValues(ServerRequestObservationContext context)
io.micrometer.common.KeyValues	getLowCardinalityKeyValues(ServerRequestObservationContext context)
protected @Nullable String	getMethodValue(ServerRequestObservationContext context)
String	getName()
protected io.micrometer.common.KeyValue	httpUrl(ServerRequestObservationContext context)
protected io.micrometer.common.KeyValue	method(ServerRequestObservationContext context)
protected io.micrometer.common.KeyValue	methodOriginal(ServerRequestObservationContext context)
protected io.micrometer.common.KeyValue	outcome(ServerRequestObservationContext context)
protected io.micrometer.common.KeyValue	pathTemplate(ServerRequestObservationContext context)
protected io.micrometer.common.KeyValue	scheme(ServerRequestObservationContext context)
protected io.micrometer.common.KeyValue	status(ServerRequestObservationContext context)

Methods inherited from class Object

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

Methods inherited from interface ServerRequestObservationConvention

supportsContext

Constructor Details

OpenTelemetryServerRequestObservationConvention

public OpenTelemetryServerRequestObservationConvention()

Method Details

getName

public String getName()

Specified by:

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

getContextualName

public String getContextualName(ServerRequestObservationContext context)

HTTP span names SHOULD be {method} {target} if there is a (low-cardinality) target available. If there is no (low-cardinality) {target} available, HTTP span names SHOULD be {method}.

The {method} MUST be {http.request.method} if the method represents the original method known to the instrumentation. In other cases (when {http.request.method} is set to _OTHER), {method} MUST be HTTP.

The target SHOULD be the {http.route}.

Specified by:

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

Parameters:

context - context

Returns:

contextual name

See Also:

• OpenTelemetry Semantic Convention HTTP Span Name (v1.36.0)

getLowCardinalityKeyValues

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

Specified by:

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

getHighCardinalityKeyValues

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

Specified by:

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

method

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

getMethodValue

protected @Nullable String getMethodValue(ServerRequestObservationContext context)

scheme

protected io.micrometer.common.KeyValue scheme(ServerRequestObservationContext context)

status

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

pathTemplate

protected io.micrometer.common.KeyValue pathTemplate(ServerRequestObservationContext context)

exception

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

outcome

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

httpUrl

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

methodOriginal

protected io.micrometer.common.KeyValue methodOriginal(ServerRequestObservationContext context)