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

Interface HttpServerAttributesGetter<REQUEST,RESPONSE>

All Superinterfaces:

ClientAttributesGetter<REQUEST,RESPONSE>, HttpCommonAttributesGetter<REQUEST,RESPONSE>, NetServerAttributesGetter<REQUEST,RESPONSE>, NetworkAttributesGetter<REQUEST,RESPONSE>, ServerAttributesGetter<REQUEST,RESPONSE>, UrlAttributesGetter<REQUEST>

public interface HttpServerAttributesGetter<REQUEST,RESPONSE>
extends HttpCommonAttributesGetter<REQUEST,RESPONSE>, UrlAttributesGetter<REQUEST>, NetServerAttributesGetter<REQUEST,RESPONSE>, NetworkAttributesGetter<REQUEST,RESPONSE>, ServerAttributesGetter<REQUEST,RESPONSE>, ClientAttributesGetter<REQUEST,RESPONSE>

An interface for getting HTTP server attributes.

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

Method Summary

Modifier and Type	Method	Description
default String	getHttpRoute(REQUEST request)	Returns the matched route (path template in the format used by the respective server framework).
String	getUrlPath(REQUEST request)	Returns the URI path component.
String	getUrlQuery(REQUEST request)	Returns the URI query component.
String	getUrlScheme(REQUEST request)	Returns the URI scheme component identifying the used protocol.

Methods inherited from interface io.opentelemetry.instrumentation.api.instrumenter.network.ClientAttributesGetter

getClientAddress, getClientInetSocketAddress, getClientPort, getClientSocketAddress, getClientSocketPort

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

getErrorType, getHttpRequestHeader, getHttpRequestMethod, getHttpResponseHeader, getHttpResponseStatusCode

Methods inherited from interface io.opentelemetry.instrumentation.api.instrumenter.net.NetServerAttributesGetter

getNetworkType, getSockFamily, getTransport

Methods inherited from interface io.opentelemetry.instrumentation.api.instrumenter.network.NetworkAttributesGetter

getNetworkProtocolName, getNetworkProtocolVersion, getNetworkTransport

Methods inherited from interface io.opentelemetry.instrumentation.api.instrumenter.network.ServerAttributesGetter

getServerAddress, getServerInetSocketAddress, getServerPort, getServerSocketAddress, getServerSocketDomain, getServerSocketPort

Method Details

getUrlScheme

@Nullable
String getUrlScheme(REQUEST request)

Returns the URI scheme component identifying the used protocol.

Examples: https, ftp, telnet

Specified by:

getUrlScheme in interface UrlAttributesGetter<REQUEST>

getUrlPath

@Nullable
String getUrlPath(REQUEST request)

Returns the URI path component.

Examples: /search

Specified by:

getUrlPath in interface UrlAttributesGetter<REQUEST>

getUrlQuery

@Nullable
String getUrlQuery(REQUEST request)

Returns the URI query component.

Examples: q=OpenTelemetry

Specified by:

getUrlQuery in interface UrlAttributesGetter<REQUEST>

getHttpRoute

@Nullable
default String getHttpRoute(REQUEST request)

Returns the matched route (path template in the format used by the respective server framework).

Examples: /users/:userID?, {controller}/{action}/{id?}