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

Interface NetServerAttributesGetter<REQUEST>

All Known Implementing Classes:

InetSocketAddressNetServerAttributesGetter

public interface NetServerAttributesGetter<REQUEST>

An interface for getting server-based network attributes. It adapts an instrumentation-specific request type into the 3 common attributes (transport, sockPeerPort, sockPeerAddr).

Instrumentation authors will create implementations of this interface for their specific server library/framework. It will be used by the NetServerAttributesExtractor to obtain the various network attributes in a type-generic way.

Method Summary

Modifier and Type	Method	Description
String	getHostName(REQUEST request)
Integer	getHostPort(REQUEST request)
default String	getProtocolName(REQUEST request)	Returns the application protocol used.
default String	getProtocolVersion(REQUEST request)	Returns the version of the application protocol used.
default String	getSockFamily(REQUEST request)
default String	getSockHostAddr(REQUEST request)
default Integer	getSockHostPort(REQUEST request)
default String	getSockPeerAddr(REQUEST request)
default Integer	getSockPeerPort(REQUEST request)
String	getTransport(REQUEST request)

Method Details

getTransport

@Nullable
String getTransport(REQUEST request)

getProtocolName

@Nullable
default String getProtocolName(REQUEST request)

Returns the application protocol used.

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

getProtocolVersion

@Nullable
default String getProtocolVersion(REQUEST request)

Returns the version of the application protocol used.

Examples: `3.1.1`.

getHostName

@Nullable
String getHostName(REQUEST request)

getHostPort

@Nullable
Integer getHostPort(REQUEST request)

getSockFamily

@Nullable
default String getSockFamily(REQUEST request)

getSockPeerAddr

@Nullable
default String getSockPeerAddr(REQUEST request)

getSockPeerPort

@Nullable
default Integer getSockPeerPort(REQUEST request)

getSockHostAddr

@Nullable
default String getSockHostAddr(REQUEST request)

getSockHostPort

@Nullable
default Integer getSockHostPort(REQUEST request)