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
default String	peerName(REQUEST request)
default String	peerName(REQUEST request, RESPONSE response)	Deprecated. This method is deprecated and will be removed in the next release.
default Integer	peerPort(REQUEST request)
default Integer	peerPort(REQUEST request, RESPONSE response)	Deprecated. This method is deprecated and will be removed in the next release.
default String	sockFamily(REQUEST request, RESPONSE response)
default String	sockPeerAddr(REQUEST request, RESPONSE response)
default String	sockPeerName(REQUEST request, RESPONSE response)
default Integer	sockPeerPort(REQUEST request, RESPONSE response)
String	transport(REQUEST request, RESPONSE response)

Method Details

transport

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

peerName

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

Deprecated.

This method is deprecated and will be removed in the next release.

Logical remote hostname.

peerName

@Nullable
default String peerName(REQUEST request)

peerPort

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

Deprecated.

This method is deprecated and will be removed in the next release.

Logical remote port number.

peerPort

@Nullable
default Integer peerPort(REQUEST request)

sockFamily

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

sockPeerAddr

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

sockPeerName

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

sockPeerPort

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