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

Class HttpCommonAttributesExtractor<REQUEST,RESPONSE>

java.lang.Object

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

All Implemented Interfaces:

AttributesExtractor<REQUEST,RESPONSE>

Direct Known Subclasses:

HttpClientAttributesExtractor, HttpServerAttributesExtractor

public abstract class HttpCommonAttributesExtractor<REQUEST,RESPONSE>
extends Object
implements AttributesExtractor<REQUEST,RESPONSE>

Extractor of HTTP attributes that are common to client and server instrumentations.

Method Summary

Modifier and Type	Method	Description
protected abstract String	method(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 Long	requestContentLength(REQUEST request, RESPONSE response)	Extracts the http.request_content_length span attribute.
protected abstract Long	requestContentLengthUncompressed(REQUEST request, RESPONSE response)	Extracts the http.request_content_length_uncompressed span attribute.
protected abstract List<String>	requestHeader(REQUEST request, String name)	Extracts all values of header named name from the request, or an empty list if there were none.
protected abstract Long	responseContentLength(REQUEST request, RESPONSE response)	Extracts the http.response_content_length span attribute.
protected abstract Long	responseContentLengthUncompressed(REQUEST request, RESPONSE response)	Extracts the http.response_content_length_uncompressed span attribute.
protected abstract List<String>	responseHeader(REQUEST request, RESPONSE response, String name)	Extracts all values of header named name from the response, or an empty list if there were none.
protected abstract Integer	statusCode(REQUEST request, RESPONSE response)	Extracts the http.status_code span attribute.

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

Method Detail

onStart

public 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>

onEnd

public 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>

method

@Nullable
protected abstract String method(REQUEST request)

requestHeader

protected abstract List<String> requestHeader(REQUEST request,
                                              String name)

Extracts all values of header named name from the request, or an empty list if there were none.

Implementations of this method must not return a null value; an empty list should be returned instead.

requestContentLength

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

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

statusCode

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

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

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

responseHeader

protected abstract List<String> responseHeader(REQUEST request,
                                               RESPONSE response,
                                               String name)

Extracts all values of header named name from the response, or an empty list if there were none.

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

Implementations of this method must not return a null value; an empty list should be returned instead.