Package io.opentelemetry.instrumentation.api.semconv.network

Interface NetworkAttributesGetter<REQUEST,RESPONSE>

All Known Subinterfaces:

HttpClientAttributesGetter<REQUEST,RESPONSE>, HttpServerAttributesGetter<REQUEST,RESPONSE>

public interface NetworkAttributesGetter<REQUEST,RESPONSE>

An interface for getting network attributes.

Instrumentation authors will create implementations of this interface for their specific library/framework. It will be used by the NetworkAttributesExtractor (or other convention specific extractors) to obtain the various network attributes in a type-generic way.

Since:

2.0.0

Method Summary

Modifier and Type	Method	Description
default String	getNetworkLocalAddress(REQUEST request, RESPONSE response)	Returns the local address of the network connection - IP address or Unix domain socket name.
default InetSocketAddress	getNetworkLocalInetSocketAddress(REQUEST request, RESPONSE response)	Returns an InetSocketAddress object representing the local socket address.
default Integer	getNetworkLocalPort(REQUEST request, RESPONSE response)	Returns the local port number of the network connection.
default String	getNetworkPeerAddress(REQUEST request, RESPONSE response)	Returns the peer address of the network connection - IP address or Unix domain socket name.
default InetSocketAddress	getNetworkPeerInetSocketAddress(REQUEST request, RESPONSE response)	Returns an InetSocketAddress object representing the peer socket address.
default Integer	getNetworkPeerPort(REQUEST request, RESPONSE response)	Returns the peer port number of the network connection.
default String	getNetworkProtocolName(REQUEST request, RESPONSE response)	Returns the OSI application layer or non-OSI equivalent.
default String	getNetworkProtocolVersion(REQUEST request, RESPONSE response)	Returns the version of the protocol returned by getNetworkProtocolName(Object, Object).
default String	getNetworkTransport(REQUEST request, RESPONSE response)	Returns the OSI transport layer or inter-process communication method.
default String	getNetworkType(REQUEST request, RESPONSE response)	Returns the OSI network layer or non-OSI equivalent.

Method Details

getNetworkType

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

Returns the OSI network layer or non-OSI equivalent.

Examples: ipv4, ipv6

getNetworkTransport

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

Returns the OSI transport layer or inter-process communication method.

Examples: tcp, udp

getNetworkProtocolName

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

Returns the OSI application layer or non-OSI equivalent.

Examples: ampq, http, mqtt

getNetworkProtocolVersion

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

Returns the version of the protocol returned by getNetworkProtocolName(Object, Object).

Examples: 3.1.1

getNetworkLocalInetSocketAddress

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

Returns an InetSocketAddress object representing the local socket address.

Implementing this method is equivalent to implementing both getNetworkLocalAddress(Object, Object) and getNetworkLocalPort(Object, Object).

getNetworkLocalAddress

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

Returns the local address of the network connection - IP address or Unix domain socket name.

Examples: 10.1.2.80, /tmp/my.sock

By default, this method attempts to retrieve the local address using the getNetworkLocalInetSocketAddress(Object, Object) method. If that 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 getNetworkLocalInetSocketAddress(Object, Object).

getNetworkLocalPort

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

Returns the local port number of the network connection.

Examples: 65123

By default, this method attempts to retrieve the local port using the getNetworkLocalInetSocketAddress(Object, Object) method. If that 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 getNetworkLocalInetSocketAddress(Object, Object).

getNetworkPeerInetSocketAddress

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

Returns an InetSocketAddress object representing the peer socket address.

Implementing this method is equivalent to implementing both getNetworkPeerAddress(Object, Object) and getNetworkPeerPort(Object, Object).

getNetworkPeerAddress

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

Returns the peer address of the network connection - IP address or Unix domain socket name.

Examples: 10.1.2.80, /tmp/my.sock

By default, this method attempts to retrieve the peer address using the getNetworkPeerInetSocketAddress(Object, Object) method. If that 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 getNetworkPeerInetSocketAddress(Object, Object).

getNetworkPeerPort

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

Returns the peer port number of the network connection.

Examples: 65123

By default, this method attempts to retrieve the peer port using the getNetworkPeerInetSocketAddress(Object, Object) method. If that 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 getNetworkPeerInetSocketAddress(Object, Object).