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

Class HttpAttributesExtractor<REQUEST,RESPONSE>

java.lang.Object

io.opentelemetry.instrumentation.api.instrumenter.AttributesExtractor<REQUEST,RESPONSE>

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

public abstract class HttpAttributesExtractor<REQUEST,RESPONSE>
extends AttributesExtractor<REQUEST,RESPONSE>

Extractor of HTTP attributes. Instrumentation of HTTP server or client frameworks should extend this class, defining HttpAttributesExtractor and HttpAttributesExtractor 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

Constructor	Description
HttpAttributesExtractor()

Method Summary

Modifier and Type	Method	Description
protected abstract @Nullable String	clientIp(REQUEST request, @Nullable RESPONSE response)	Extracts the http.client_ip span attribute.
protected abstract @Nullable String	flavor(REQUEST request, @Nullable RESPONSE response)	Extracts the http.flavor span attribute.
protected abstract @Nullable String	host(REQUEST request)
protected abstract @Nullable String	method(REQUEST request)
protected void	onEnd(io.opentelemetry.api.common.AttributesBuilder attributes, REQUEST request, @Nullable RESPONSE response)	Extracts attributes from the AttributesExtractor and AttributesExtractor into the AttributesBuilder at the end of a request.
protected 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 @Nullable Long	requestContentLength(REQUEST request, @Nullable RESPONSE response)	Extracts the http.request_content_length span attribute.
protected abstract @Nullable Long	requestContentLengthUncompressed(REQUEST request, @Nullable RESPONSE response)	Extracts the http.request_content_length_uncompressed span attribute.
protected abstract @Nullable Long	responseContentLength(REQUEST request, RESPONSE response)	Extracts the http.response_content_length span attribute.
protected abstract @Nullable Long	responseContentLengthUncompressed(REQUEST request, RESPONSE response)	Extracts the http.response_content_length_uncompressed span attribute.
protected abstract @Nullable String	route(REQUEST request)
protected abstract @Nullable String	scheme(REQUEST request)
protected abstract @Nullable String	serverName(REQUEST request, @Nullable RESPONSE response)	Extracts the http.server_name span attribute.
protected abstract @Nullable Integer	statusCode(REQUEST request, RESPONSE response)	Extracts the http.status_code span attribute.
protected abstract @Nullable String	target(REQUEST request)
protected abstract @Nullable String	url(REQUEST request)
protected abstract @Nullable String	userAgent(REQUEST request)

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

set

Methods inherited from class java.lang.Object

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

Constructor Detail

HttpAttributesExtractor

public HttpAttributesExtractor()

Method Detail

onStart

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

Description copied from class: AttributesExtractor

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

Specified by:

onStart in class AttributesExtractor<REQUEST,RESPONSE>

onEnd

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

Description copied from class: AttributesExtractor

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

Specified by:

onEnd in class AttributesExtractor<REQUEST,RESPONSE>

method

protected abstract @Nullable String method(REQUEST request)

url

protected abstract @Nullable String url(REQUEST request)

target

protected abstract @Nullable String target(REQUEST request)

host

protected abstract @Nullable String host(REQUEST request)

route

protected abstract @Nullable String route(REQUEST request)

scheme

protected abstract @Nullable String scheme(REQUEST request)

userAgent

protected abstract @Nullable String userAgent(REQUEST request)

requestContentLength

protected abstract @Nullable Long requestContentLength(REQUEST request,
                                                       @Nullable RESPONSE response)

Extracts the http.request_content_length span attribute.

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

requestContentLengthUncompressed

protected abstract @Nullable Long requestContentLengthUncompressed(REQUEST request,
                                                                   @Nullable RESPONSE response)

Extracts the http.request_content_length_uncompressed span attribute.

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

flavor

protected abstract @Nullable 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.

serverName

protected abstract @Nullable 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.

clientIp

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

Extracts the http.client_ip span attribute.

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

statusCode

protected abstract @Nullable Integer statusCode(REQUEST request,
                                                RESPONSE response)

Extracts the http.status_code span attribute.

This is called from Instrumenter.end(Context, Object, Object, Throwable), only when response is non-null.

responseContentLength

protected abstract @Nullable Long responseContentLength(REQUEST request,
                                                        RESPONSE response)

Extracts the http.response_content_length span attribute.

This is called from Instrumenter.end(Context, Object, Object, Throwable), only when response is non-null.

responseContentLengthUncompressed

protected abstract @Nullable Long responseContentLengthUncompressed(REQUEST request,
                                                                    RESPONSE response)

Extracts the http.response_content_length_uncompressed span attribute.

This is called from Instrumenter.end(Context, Object, Object, Throwable), only when response is non-null.