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

Interface ServerAttributesGetter<REQUEST,RESPONSE>

All Known Subinterfaces:

HttpClientAttributesGetter<REQUEST,RESPONSE>, HttpServerAttributesGetter<REQUEST,RESPONSE>, NetClientAttributesGetter<REQUEST,RESPONSE>, NetServerAttributesGetter<REQUEST,RESPONSE>

public interface ServerAttributesGetter<REQUEST,RESPONSE>

An interface for getting attributes describing a network server.

Instrumentation authors will create implementations of this interface for their specific library/framework. It will be used by the ServerAttributesExtractor (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	getServerAddress(REQUEST request)	Returns the server domain name if available without reverse DNS lookup; otherwise, IP address or Unix domain socket name.
default InetSocketAddress	getServerInetSocketAddress(REQUEST request, RESPONSE response)	Deprecated. Implement NetworkAttributesGetter.getNetworkPeerInetSocketAddress(Object, Object) or NetworkAttributesGetter.getNetworkLocalInetSocketAddress(Object, Object) instead.
default Integer	getServerPort(REQUEST request)	Return the server port number.
default String	getServerSocketAddress(REQUEST request, RESPONSE response)	Deprecated. Implement NetworkAttributesGetter.getNetworkPeerAddress(Object, Object) or NetworkAttributesGetter.getNetworkLocalAddress(Object, Object) instead.
default String	getServerSocketDomain(REQUEST request, RESPONSE response)	Deprecated. This method is deprecated and will be removed without replacement.
default Integer	getServerSocketPort(REQUEST request, RESPONSE response)	Deprecated. Implement NetworkAttributesGetter.getNetworkPeerPort(Object, Object) or NetworkAttributesGetter.getNetworkLocalPort(Object, Object) instead.

Method Details

getServerAddress

@Nullable
default String getServerAddress(REQUEST request)

Returns the server 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

getServerPort

@Nullable
default Integer getServerPort(REQUEST request)

Return the server port number.

Examples: 80, 8080, 443

getServerInetSocketAddress

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

Deprecated.

Implement NetworkAttributesGetter.getNetworkPeerInetSocketAddress(Object, Object) or NetworkAttributesGetter.getNetworkLocalInetSocketAddress(Object, Object) instead.

Returns an InetSocketAddress object representing the server socket address.

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

getServerSocketDomain

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

Deprecated.

This method is deprecated and will be removed without replacement.

Return the domain name of an immediate peer.

Examples: proxy.example.com

By default, this method attempts to retrieve the server domain name using the 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 getServerInetSocketAddress(Object, Object).

getServerSocketAddress

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

Deprecated.

Implement NetworkAttributesGetter.getNetworkPeerAddress(Object, Object) or NetworkAttributesGetter.getNetworkLocalAddress(Object, Object) instead.

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 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 getServerInetSocketAddress(Object, Object).

getServerSocketPort

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

Deprecated.

Implement NetworkAttributesGetter.getNetworkPeerPort(Object, Object) or NetworkAttributesGetter.getNetworkLocalPort(Object, Object) instead.

Return the physical server port.

Examples: 16456

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