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, that is, the path template in the format used by the respective server framework.
default String	getServerAddress(REQUEST request)	Deprecated. This method is deprecated and will be removed without replacement.
default Integer	getServerPort(REQUEST request)	Deprecated. This method is deprecated and will be removed without replacement.
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, getClientPort

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

getClientInetSocketAddress, getClientSocketAddress, getClientSocketPort, getNetworkType, getServerInetSocketAddress, getServerSocketAddress, getServerSocketPort, getSockFamily, getTransport

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

getNetworkLocalAddress, getNetworkLocalInetSocketAddress, getNetworkLocalPort, getNetworkPeerAddress, getNetworkPeerInetSocketAddress, getNetworkPeerPort, getNetworkProtocolName, getNetworkProtocolVersion, getNetworkTransport

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

getServerSocketDomain

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, that is, the path template in the format used by the respective server framework.

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

getServerAddress

@Deprecated
@Nullable
default String getServerAddress(REQUEST request)

Deprecated.

This method is deprecated and will be removed without replacement. The HttpServerAttributesExtractor now extracts the server address and port from the received HTTP request's headers.

Returns the name of the local HTTP server that received the request.

Specified by:

getServerAddress in interface ServerAttributesGetter<REQUEST,RESPONSE>

getServerPort

@Deprecated
@Nullable
default Integer getServerPort(REQUEST request)

Deprecated.

This method is deprecated and will be removed without replacement. The HttpServerAttributesExtractor now extracts the server address and port from the received HTTP request's headers.

Returns the port of the local HTTP server that received the request.

Specified by:

getServerPort in interface ServerAttributesGetter<REQUEST,RESPONSE>