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

Interface HttpClientAttributesGetter<REQUEST,RESPONSE>

All Superinterfaces:

HttpCommonAttributesGetter<REQUEST,RESPONSE>

public interface HttpClientAttributesGetter<REQUEST,RESPONSE>
extends HttpCommonAttributesGetter<REQUEST,RESPONSE>

An interface for getting HTTP client attributes.

Instrumentation authors will create implementations of this interface for their specific library/framework. It will be used by the HttpClientAttributesExtractor to obtain the various HTTP client attributes in a type-generic way.

Method Summary

Modifier and Type	Method	Description
default String	flavor(REQUEST request, RESPONSE response)	Deprecated. Use getFlavor(Object, Object).
default String	getFlavor(REQUEST request, RESPONSE response)	Extracts the http.flavor span attribute.
default String	getUrl(REQUEST request)
default String	url(REQUEST request)	Deprecated. Use getUrl(Object) instead.

Methods inherited from interface io.opentelemetry.instrumentation.api.instrumenter.http.HttpCommonAttributesGetter

getMethod, getRequestHeader, getResponseHeader, getStatusCode, method, requestHeader, responseHeader, statusCode

Method Details

getUrl

@Nullable
default String getUrl(REQUEST request)

url

@Deprecated
@Nullable
default String url(REQUEST request)

Deprecated.

Use getUrl(Object) instead.

This method is deprecated and will be removed in the subsequent release.

getFlavor

@Nullable
default String getFlavor(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.

flavor

@Deprecated
@Nullable
default String flavor(REQUEST request,
 @Nullable
 RESPONSE response)

Deprecated.

Use getFlavor(Object, Object).

Extracts the http.flavor span attribute.

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

This method is deprecated and will be removed in the subsequent release.