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	getPeerName(REQUEST request)
default Integer	getPeerPort(REQUEST request)
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)
default String	getTransport(REQUEST request, RESPONSE response)
default String	peerName(REQUEST request)	Deprecated. Use getPeerName(Object) instead.
default Integer	peerPort(REQUEST request)	Deprecated. Use getPeerPort(Object) instead.
default String	sockFamily(REQUEST request, RESPONSE response)	Deprecated. Use getSockFamily(Object, Object) instead.
default String	sockPeerAddr(REQUEST request, RESPONSE response)	Deprecated. Use getSockPeerAddr(Object, Object) instead.
default String	sockPeerName(REQUEST request, RESPONSE response)	Deprecated. Use getSockPeerName(Object, Object) instead.
default Integer	sockPeerPort(REQUEST request, RESPONSE response)	Deprecated. Use getSockPeerName(Object, Object) instead.
default String	transport(REQUEST request, RESPONSE response)	Deprecated. Use getTransport(Object, Object) instead.

Method Details

getTransport

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

transport

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

Deprecated.

Use getTransport(Object, Object) instead.

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

getPeerName

@Nullable
default String getPeerName(REQUEST request)

peerName

@Deprecated
@Nullable
default String peerName(REQUEST request)

Deprecated.

Use getPeerName(Object) instead.

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

getPeerPort

@Nullable
default Integer getPeerPort(REQUEST request)

peerPort

@Deprecated
@Nullable
default Integer peerPort(REQUEST request)

Deprecated.

Use getPeerPort(Object) instead.

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

getSockFamily

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

sockFamily

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

Deprecated.

Use getSockFamily(Object, Object) instead.

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

getSockPeerAddr

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

sockPeerAddr

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

Deprecated.

Use getSockPeerAddr(Object, Object) instead.

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

getSockPeerName

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

sockPeerName

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

Deprecated.

Use getSockPeerName(Object, Object) instead.

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

getSockPeerPort

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

sockPeerPort

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

Deprecated.

Use getSockPeerName(Object, Object) instead.

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