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

Interface NetClientAttributesGetter<REQUEST,RESPONSE>

All Superinterfaces:

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

All Known Subinterfaces:

HttpClientAttributesGetter<REQUEST,RESPONSE>

@Deprecated
public interface NetClientAttributesGetter<REQUEST,RESPONSE>
extends NetworkAttributesGetter<REQUEST,RESPONSE>, ServerAttributesGetter<REQUEST,RESPONSE>

Deprecated.

Make sure that your instrumentation implements the getters from the ...network package instead. This class will be removed in the 2.0 release.

An interface for getting client-based network attributes. It adapts from a type-specific request and response into the 4 common network attribute values.

Instrumentation authors will create implementations of this interface for their specific library/framework. It will be used by the NetClientAttributesExtractor 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)	Deprecated. Returns the OSI network layer or non-OSI equivalent.
default InetSocketAddress	getServerInetSocketAddress(REQUEST request, RESPONSE response)	Deprecated. Returns an InetSocketAddress object representing the server socket address.
default String	getServerSocketAddress(REQUEST request, RESPONSE response)	Deprecated. Return the physical server IP address or Unix socket address.
default Integer	getServerSocketPort(REQUEST request, RESPONSE response)	Deprecated. Return the physical server port.
default String	getSockFamily(REQUEST request, RESPONSE response)	Deprecated. Returns the protocol address family which is used for communication.
default String	getTransport(REQUEST request, RESPONSE response)	Deprecated.

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

getServerAddress, getServerPort, getServerSocketDomain

Method Details

getTransport

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

Deprecated.

getSockFamily

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

Deprecated.

Returns the protocol address family which is used for communication.

Examples: inet, inet6

By default, this method attempts to retrieve the address family using the getServerInetSocketAddress(Object, Object) method. If it is not 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 getServerSocketAddress(Object, Object).

getNetworkType

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

Deprecated.

Returns the OSI network layer or non-OSI equivalent.

Examples: ipv4, ipv6

Specified by:

getNetworkType in interface NetworkAttributesGetter<REQUEST,RESPONSE>

getServerInetSocketAddress

@Nullable
default InetSocketAddress getServerInetSocketAddress(REQUEST request,
 @Nullable
 RESPONSE response)

Deprecated.

Description copied from interface: ServerAttributesGetter

Returns an InetSocketAddress object representing the server socket address.

Implementing this method is equivalent to implementing all of ServerAttributesGetter.getServerSocketDomain(Object, Object), ServerAttributesGetter.getServerSocketAddress(Object, Object) and ServerAttributesGetter.getServerSocketPort(Object, Object).

Specified by:

getServerInetSocketAddress in interface ServerAttributesGetter<REQUEST,RESPONSE>

getServerSocketAddress

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

Deprecated.

Description copied from interface: ServerAttributesGetter

Return the physical server IP address or Unix socket address.

Examples: 10.5.3.2

By default, this method attempts to retrieve the server address using the ServerAttributesGetter.getServerInetSocketAddress(Object, Object) method. If this method is not 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 ServerAttributesGetter.getServerInetSocketAddress(Object, Object).

Specified by:

getServerSocketAddress in interface ServerAttributesGetter<REQUEST,RESPONSE>

getServerSocketPort

@Nullable
default Integer getServerSocketPort(REQUEST request,
 @Nullable
 RESPONSE response)

Deprecated.

Description copied from interface: ServerAttributesGetter

Return the physical server port.

Examples: 16456

By default, this method attempts to retrieve the server port using the ServerAttributesGetter.getServerInetSocketAddress(Object, Object) method. If this method is not 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 ServerAttributesGetter.getServerInetSocketAddress(Object, Object).

Specified by:

getServerSocketPort in interface ServerAttributesGetter<REQUEST,RESPONSE>