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

Class HttpServerAttributesExtractor<REQUEST,RESPONSE>

java.lang.Object

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

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

All Implemented Interfaces:

AttributesExtractor<REQUEST,RESPONSE>

public abstract class HttpServerAttributesExtractor<REQUEST,RESPONSE>
extends HttpCommonAttributesExtractor<REQUEST,RESPONSE>

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.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	HttpServerAttributesExtractor()	Creates the HTTP server attributes extractor with default configuration.
protected	HttpServerAttributesExtractor(CapturedHttpHeaders capturedHttpHeaders)	Creates the HTTP server attributes extractor.

Method Summary

Modifier and Type	Method	Description
protected abstract String	flavor(REQUEST request)
void	onEnd(io.opentelemetry.api.common.AttributesBuilder attributes, REQUEST request, RESPONSE response, Throwable error)	Extracts attributes from the AttributesExtractor and either AttributesExtractor or error into the AttributesBuilder at the end of a request.
void	onStart(io.opentelemetry.api.common.AttributesBuilder attributes, REQUEST request)	Extracts attributes from the AttributesExtractor into the AttributesBuilder at the beginning of a request.
protected abstract String	route(REQUEST request)
protected abstract String	scheme(REQUEST request)
protected abstract String	serverName(REQUEST request, RESPONSE response)	Extracts the http.server_name span attribute.
protected abstract String	target(REQUEST request)

Methods inherited from class io.opentelemetry.instrumentation.api.instrumenter.http.HttpCommonAttributesExtractor

method, requestContentLength, requestContentLengthUncompressed, requestHeader, responseContentLength, responseContentLengthUncompressed, responseHeader, statusCode

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

set

Constructor Detail

HttpServerAttributesExtractor

protected HttpServerAttributesExtractor(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.

HttpServerAttributesExtractor

protected HttpServerAttributesExtractor()

Creates the HTTP server attributes extractor with default configuration.

Method Detail

onStart

public final void onStart(io.opentelemetry.api.common.AttributesBuilder attributes,
                          REQUEST request)

Description copied from interface: AttributesExtractor

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

Specified by:

onStart in interface AttributesExtractor<REQUEST,RESPONSE>

Overrides:

onStart in class HttpCommonAttributesExtractor<REQUEST,RESPONSE>

onEnd

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

Description copied from interface: AttributesExtractor

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

Specified by:

onEnd in interface AttributesExtractor<REQUEST,RESPONSE>

Overrides:

onEnd in class HttpCommonAttributesExtractor<REQUEST,RESPONSE>

flavor

@Nullable
protected abstract String flavor(REQUEST request)

target

@Nullable
protected abstract String target(REQUEST request)

route

@Nullable
protected abstract String route(REQUEST request)

scheme

@Nullable
protected abstract String scheme(REQUEST request)

serverName

@Nullable
protected abstract String serverName(REQUEST request,
                                     @Nullable
                                     RESPONSE response)

Extracts the http.server_name span attribute.

This is called from Instrumenter.end(Context, Object, Object, Throwable), whether response is null or not.