Package io.opentelemetry.instrumentation.api.instrumenter.net

Interface NetServerAttributesGetter<REQUEST,RESPONSE>

All Superinterfaces:

ClientAttributesGetter<REQUEST,RESPONSE>, NetworkAttributesGetter<REQUEST,RESPONSE>, ServerAttributesGetter<REQUEST,RESPONSE>

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

An interface for getting server-based network attributes. It adapts an instrumentation-specific request type into the 3 common attributes (transport, sockPeerPort, sockPeerAddr).

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

Method Summary

Modifier and Type	Method	Description
default String	getNetworkType(REQUEST request, RESPONSE response)	Returns the OSI Network Layer or non-OSI equivalent.
default String	getSockFamily(REQUEST request)	Returns the protocol address family which is used for communication.
default String	getTransport(REQUEST request)

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.network.NetworkAttributesGetter

getNetworkProtocolName, getNetworkProtocolVersion, getNetworkTransport

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

getServerAddress, getServerInetSocketAddress, getServerPort, getServerSocketAddress, getServerSocketDomain, getServerSocketPort

Method Details

getTransport

@Nullable
default String getTransport(REQUEST request)

getSockFamily

@Nullable
default String getSockFamily(REQUEST request)

Returns the protocol address family which is used for communication.

Examples: `inet`, `inet6`.

By default, this method attempts to retrieve the address family using one of the ClientAttributesGetter.getClientInetSocketAddress(Object, Object) and ServerAttributesGetter.getServerInetSocketAddress(Object, Object) methods. If neither of these methods is implemented, it will simply return null. If the instrumented library does not expose InetSocketAddress in its API, you might want to implement this method instead of ClientAttributesGetter.getClientInetSocketAddress(Object, Object) and ServerAttributesGetter.getServerInetSocketAddress(Object, Object).

getNetworkType

@Nullable
default String getNetworkType(REQUEST request,
 @Nullable
 RESPONSE response)

Returns the OSI Network Layer or non-OSI equivalent.

Examples: ipv4, ipv6

Specified by:

getNetworkType in interface NetworkAttributesGetter<REQUEST,RESPONSE>