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

Interface NetClientAttributesGetter<REQUEST,RESPONSE>

All Known Implementing Classes:

InetSocketAddressNetClientAttributesGetter

public interface NetClientAttributesGetter<REQUEST,RESPONSE>

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
String	getPeerName(REQUEST request)
Integer	getPeerPort(REQUEST request)
default String	getProtocolName(REQUEST request, RESPONSE response)	Returns the application protocol used.
default String	getProtocolVersion(REQUEST request, RESPONSE response)	Returns the version of the application protocol used.
default String	getSockFamily(REQUEST request, RESPONSE response)
default String	getSockPeerAddr(REQUEST request, RESPONSE response)
default String	getSockPeerName(REQUEST request, RESPONSE response)
default Integer	getSockPeerPort(REQUEST request, RESPONSE response)
String	getTransport(REQUEST request, RESPONSE response)

Method Details

getTransport

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

getProtocolName

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

Returns the application protocol used.

Examples: `amqp`, `http`, `mqtt`.

getProtocolVersion

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

Returns the version of the application protocol used.

Examples: `3.1.1`.

getPeerName

@Nullable
String getPeerName(REQUEST request)

getPeerPort

@Nullable
Integer getPeerPort(REQUEST request)

getSockFamily

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

getSockPeerAddr

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

getSockPeerName

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

getSockPeerPort

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