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

Class HttpClientAttributesExtractor<REQUEST,RESPONSE>

java.lang.Object

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

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

All Implemented Interfaces:

AttributesExtractor<REQUEST,RESPONSE>

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

Extractor of HTTP client attributes. Instrumentation of HTTP client frameworks should extend this class, defining HttpClientAttributesExtractor and HttpClientAttributesExtractor 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	HttpClientAttributesExtractor()	Creates the HTTP client attributes extractor with default configuration.
protected	HttpClientAttributesExtractor(CapturedHttpHeaders capturedHttpHeaders)	Creates the HTTP client attributes extractor.

Method Summary

Modifier and Type	Method	Description
protected abstract String	flavor(REQUEST request, RESPONSE response)	Extracts the http.flavor span attribute.
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	url(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

HttpClientAttributesExtractor

protected HttpClientAttributesExtractor(CapturedHttpHeaders capturedHttpHeaders)

Creates the HTTP client attributes extractor.

Parameters:

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

HttpClientAttributesExtractor

protected HttpClientAttributesExtractor()

Creates the HTTP client 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>

url

@Nullable
protected abstract String url(REQUEST request)

flavor

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

Extracts the http.flavor span attribute.

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