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

Interface NetworkAttributesGetter<REQUEST,RESPONSE>

All Known Subinterfaces:

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

public interface NetworkAttributesGetter<REQUEST,RESPONSE>

An interface for getting network attributes.

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

Method Summary

Modifier and Type	Method	Description
default String	getNetworkProtocolName(REQUEST request, RESPONSE response)	Returns the OSI Application Layer or non-OSI equivalent.
default String	getNetworkProtocolVersion(REQUEST request, RESPONSE response)	Returns the version of the application layer protocol used.
default String	getNetworkTransport(REQUEST request, RESPONSE response)	Returns the OSI Transport Layer or Inter-process Communication method.
default String	getNetworkType(REQUEST request, RESPONSE response)	Returns the OSI Network Layer or non-OSI equivalent.

Method Details

getNetworkTransport

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

Returns the OSI Transport Layer or Inter-process Communication method.

Examples: tcp, udp

getNetworkType

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

Returns the OSI Network Layer or non-OSI equivalent.

Examples: ipv4, ipv6

getNetworkProtocolName

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

Returns the OSI Application Layer or non-OSI equivalent.

Examples: ampq, http, mqtt

getNetworkProtocolVersion

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

Returns the version of the application layer protocol used.

Examples: 3.1.1