Package io.opentelemetry.instrumentation.api.instrumenter.network

Interface ClientAttributesGetter<REQUEST,RESPONSE>

All Known Subinterfaces:

HttpServerAttributesGetter<REQUEST,RESPONSE>, NetServerAttributesGetter<REQUEST,RESPONSE>

public interface ClientAttributesGetter<REQUEST,RESPONSE>

An interface for getting attributes describing a network client.

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

Method Summary

Modifier and Type	Method	Description
default String	getClientAddress(REQUEST request)	Returns the client address - domain name if available without reverse DNS lookup; otherwise, IP address or Unix domain socket name.
default InetSocketAddress	getClientInetSocketAddress(REQUEST request, RESPONSE response)	Deprecated. Implement NetworkAttributesGetter.getNetworkPeerInetSocketAddress(Object, Object) instead.
default Integer	getClientPort(REQUEST request)	Returns the client port number.
default String	getClientSocketAddress(REQUEST request, RESPONSE response)	Deprecated. Implement NetworkAttributesGetter.getNetworkPeerAddress(Object, Object) instead.
default Integer	getClientSocketPort(REQUEST request, RESPONSE response)	Deprecated. Implement NetworkAttributesGetter.getNetworkPeerPort(Object, Object) instead.

Method Details

getClientAddress

@Nullable
default String getClientAddress(REQUEST request)

Returns the client address - domain name if available without reverse DNS lookup; otherwise, IP address or Unix domain socket name.

Examples: client.example.com, 10.1.2.80, /tmp/my.sock

getClientPort

@Nullable
default Integer getClientPort(REQUEST request)

Returns the client port number.

Examples: 65123

getClientInetSocketAddress

@Deprecated
@Nullable
default InetSocketAddress getClientInetSocketAddress(REQUEST request,
 @Nullable
 RESPONSE response)

Deprecated.

Implement NetworkAttributesGetter.getNetworkPeerInetSocketAddress(Object, Object) instead.

Returns an InetSocketAddress object representing the immediate client socket address.

Implementing this method is equivalent to implementing all of getClientSocketAddress(Object, Object) and getClientSocketPort(Object, Object).

getClientSocketAddress

@Deprecated
@Nullable
default String getClientSocketAddress(REQUEST request,
 @Nullable
 RESPONSE response)

Deprecated.

Implement NetworkAttributesGetter.getNetworkPeerAddress(Object, Object) instead.

Returns the immediate client peer address - unix domain socket name, IPv4 or IPv6 address.

Examples: /tmp/my.sock, 127.0.0.1

By default, this method attempts to retrieve the immediate client address using the getClientInetSocketAddress(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 getClientInetSocketAddress(Object, Object).

getClientSocketPort

@Deprecated
@Nullable
default Integer getClientSocketPort(REQUEST request,
 @Nullable
 RESPONSE response)

Deprecated.

Implement NetworkAttributesGetter.getNetworkPeerPort(Object, Object) instead.

Returns the immediate client peer port number.

Examples: 35555

By default, this method attempts to retrieve the immediate client port using the getClientInetSocketAddress(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 getClientInetSocketAddress(Object, Object).