Package io.opentelemetry.instrumentation.api.instrumenter.http

Class HttpServerAttributesExtractor<REQUEST,RESPONSE>

java.lang.Object

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

All Implemented Interfaces:

AttributesExtractor<REQUEST,RESPONSE>

public final class HttpServerAttributesExtractor<REQUEST,RESPONSE>
extends Object

Extractor of HTTP server attributes. Instrumentation of HTTP server frameworks should extend this class, defining HttpServerAttributesExtractor and HttpServerAttributesExtractor with the actual request / response types of the instrumented library. If an attribute is not available in this library, it is appropriate to return null from the protected attribute methods, but implement as many as possible for best compliance with the OpenTelemetry specification.

Method Summary

Modifier and Type	Method	Description
static <REQUEST,RESPONSE> HttpServerAttributesExtractor<REQUEST,RESPONSE>	create(HttpServerAttributesGetter<REQUEST,RESPONSE> getter)	Creates the HTTP server attributes extractor with default configuration.
static <REQUEST,RESPONSE> HttpServerAttributesExtractor<REQUEST,RESPONSE>	create(HttpServerAttributesGetter<REQUEST,RESPONSE> getter, CapturedHttpHeaders capturedHttpHeaders)	Creates the HTTP server attributes extractor.
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

Methods inherited from interface io.opentelemetry.instrumentation.api.instrumenter.AttributesExtractor

onEnd, onStart, set

Method Detail

create

public static <REQUEST,RESPONSE> HttpServerAttributesExtractor<REQUEST,RESPONSE> create(HttpServerAttributesGetter<REQUEST,RESPONSE> getter)

Creates the HTTP server attributes extractor with default configuration.

create

public static <REQUEST,RESPONSE> HttpServerAttributesExtractor<REQUEST,RESPONSE> create(HttpServerAttributesGetter<REQUEST,RESPONSE> getter,
                                                                                                    CapturedHttpHeaders capturedHttpHeaders)

Creates the HTTP server attributes extractor.

Parameters:

capturedHttpHeaders - A configuration object specifying which HTTP request and response headers should be captured as span attributes.

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>