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
default String	getHostName(REQUEST request)
default Integer	getHostPort(REQUEST request)
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)
default String	getTransport(REQUEST request)
default String	hostName(REQUEST request)	Deprecated. Use getHostName(Object) instead.
default Integer	hostPort(REQUEST request)	Deprecated. Use getHostPort(Object) instead.
default String	sockFamily(REQUEST request)	Deprecated. Use getSockFamily(Object) instead.
default String	sockHostAddr(REQUEST request)	Deprecated. Use getSockHostAddr(Object) instead.
default Integer	sockHostPort(REQUEST request)	Deprecated. Use getSockHostPort(Object) instead.
default String	sockPeerAddr(REQUEST request)	Deprecated. Use getSockPeerAddr(Object) instead.
default Integer	sockPeerPort(REQUEST request)	Deprecated. Use getSockPeerPort(Object) instead.
default String	transport(REQUEST request)	Deprecated. Use getTransport(Object) instead.

Method Details

getTransport

@Nullable
default String getTransport(REQUEST request)

transport

@Deprecated
@Nullable
default String transport(REQUEST request)

Deprecated.

Use getTransport(Object) instead.

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

getHostName

@Nullable
default String getHostName(REQUEST request)

hostName

@Deprecated
@Nullable
default String hostName(REQUEST request)

Deprecated.

Use getHostName(Object) instead.

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

getHostPort

@Nullable
default Integer getHostPort(REQUEST request)

hostPort

@Deprecated
@Nullable
default Integer hostPort(REQUEST request)

Deprecated.

Use getHostPort(Object) instead.

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

getSockFamily

@Nullable
default String getSockFamily(REQUEST request)

sockFamily

@Deprecated
@Nullable
default String sockFamily(REQUEST request)

Deprecated.

Use getSockFamily(Object) instead.

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

getSockPeerAddr

@Nullable
default String getSockPeerAddr(REQUEST request)

sockPeerAddr

@Deprecated
@Nullable
default String sockPeerAddr(REQUEST request)

Deprecated.

Use getSockPeerAddr(Object) instead.

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

getSockPeerPort

@Nullable
default Integer getSockPeerPort(REQUEST request)

sockPeerPort

@Deprecated
@Nullable
default Integer sockPeerPort(REQUEST request)

Deprecated.

Use getSockPeerPort(Object) instead.

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

getSockHostAddr

@Nullable
default String getSockHostAddr(REQUEST request)

sockHostAddr

@Deprecated
@Nullable
default String sockHostAddr(REQUEST request)

Deprecated.

Use getSockHostAddr(Object) instead.

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

getSockHostPort

@Nullable
default Integer getSockHostPort(REQUEST request)

sockHostPort

@Deprecated
@Nullable
default Integer sockHostPort(REQUEST request)

Deprecated.

Use getSockHostPort(Object) instead.

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