Package io.opentelemetry.instrumentation.api.semconv.http

Class HttpServerAttributesExtractor<REQUEST,RESPONSE>

java.lang.Object

io.opentelemetry.instrumentation.api.semconv.http.HttpServerAttributesExtractor<REQUEST,RESPONSE>

All Implemented Interfaces:

AttributesExtractor<REQUEST,RESPONSE>, SpanKeyProvider

public final class HttpServerAttributesExtractor<REQUEST,RESPONSE>
extends Object
implements SpanKeyProvider

Extractor of HTTP server attributes.

Since:

2.0.0

Method Summary

Modifier and Type	Method	Description
static <REQUEST, RESPONSE> HttpServerAttributesExtractorBuilder<REQUEST,RESPONSE>	builder(HttpServerAttributesGetter<REQUEST,RESPONSE> httpAttributesGetter)	Returns a new HttpServerAttributesExtractorBuilder that can be used to configure the HTTP client attributes extractor.
static <REQUEST, RESPONSE> AttributesExtractor<REQUEST,RESPONSE>	create(HttpServerAttributesGetter<REQUEST,RESPONSE> httpAttributesGetter)	Creates the HTTP server attributes extractor with default configuration.
SpanKey	internalGetSpanKey()	This method is internal and is hence not for public use.
void	onEnd(io.opentelemetry.api.common.AttributesBuilder attributes, io.opentelemetry.context.Context context, REQUEST request, RESPONSE response, Throwable error)	Extracts attributes from the Context, the AttributesExtractor and either AttributesExtractor or error into the AttributesBuilder at the end of a request.
void	onStart(io.opentelemetry.api.common.AttributesBuilder attributes, io.opentelemetry.context.Context parentContext, REQUEST request)	Extracts attributes from the Context and the AttributesExtractor into the AttributesBuilder at the beginning of a request.

Methods inherited from class java.lang.Object

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

Method Details

create

public static <REQUEST,
RESPONSE>
AttributesExtractor<REQUEST,RESPONSE> create(HttpServerAttributesGetter<REQUEST,RESPONSE> httpAttributesGetter)

Creates the HTTP server attributes extractor with default configuration.

See Also:

• InstrumenterBuilder.addAttributesExtractor(AttributesExtractor)

builder

public static <REQUEST,
RESPONSE>
HttpServerAttributesExtractorBuilder<REQUEST,RESPONSE> builder(HttpServerAttributesGetter<REQUEST,RESPONSE> httpAttributesGetter)

Returns a new HttpServerAttributesExtractorBuilder that can be used to configure the HTTP client attributes extractor.

onStart

public void onStart(io.opentelemetry.api.common.AttributesBuilder attributes,
 io.opentelemetry.context.Context parentContext,
 REQUEST request)

Description copied from interface: AttributesExtractor

Extracts attributes from the Context and the AttributesExtractor into the AttributesBuilder at the beginning of a request.

Specified by:

onStart in interface AttributesExtractor<REQUEST,RESPONSE>

onEnd

public void onEnd(io.opentelemetry.api.common.AttributesBuilder attributes,
 io.opentelemetry.context.Context context,
 REQUEST request,
 @Nullable
 RESPONSE response,
 @Nullable
 Throwable error)

Description copied from interface: AttributesExtractor

Extracts attributes from the Context, the AttributesExtractor and either AttributesExtractor or error into the AttributesBuilder at the end of a request.

Specified by:

onEnd in interface AttributesExtractor<REQUEST,RESPONSE>

internalGetSpanKey

public SpanKey internalGetSpanKey()

This method is internal and is hence not for public use. Its API is unstable and can change at any time.

Specified by:

internalGetSpanKey in interface SpanKeyProvider