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

Class NetAttributesExtractor<REQUEST,RESPONSE>

java.lang.Object

io.opentelemetry.instrumentation.api.instrumenter.AttributesExtractor<REQUEST,RESPONSE>

io.opentelemetry.instrumentation.api.instrumenter.net.NetAttributesExtractor<REQUEST,RESPONSE>

Direct Known Subclasses:

InetSocketAddressNetAttributesExtractor

public abstract class NetAttributesExtractor<REQUEST,RESPONSE>
extends AttributesExtractor<REQUEST,RESPONSE>

Extractor of Network attributes. It is common to have access to InetSocketAddress, in which case it is more convenient to use InetSocketAddressNetAttributesExtractor.

Constructor Summary

Constructors

Constructor	Description
NetAttributesExtractor()

Method Summary

Modifier and Type	Method	Description
protected void	onEnd(io.opentelemetry.api.common.AttributesBuilder attributes, REQUEST request, @Nullable RESPONSE response)	Extracts attributes from the AttributesExtractor and AttributesExtractor into the AttributesBuilder at the end of a request.
protected void	onStart(io.opentelemetry.api.common.AttributesBuilder attributes, REQUEST request)	Extracts attributes from the AttributesExtractor into the AttributesBuilder at the beginning of a request.
abstract @Nullable String	peerIp(REQUEST request, @Nullable RESPONSE response)	This method will be called twice: both when the request starts (response is always null then) and when the response ends.
abstract @Nullable String	peerName(REQUEST request, @Nullable RESPONSE response)	This method will be called twice: both when the request starts (response is always null then) and when the response ends.
abstract @Nullable Integer	peerPort(REQUEST request, @Nullable RESPONSE response)	This method will be called twice: both when the request starts (response is always null then) and when the response ends.
abstract @Nullable String	transport(REQUEST request)

Methods inherited from class io.opentelemetry.instrumentation.api.instrumenter.AttributesExtractor

set

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

NetAttributesExtractor

public NetAttributesExtractor()

Method Detail

onStart

protected final void onStart(io.opentelemetry.api.common.AttributesBuilder attributes,
                             REQUEST request)

Description copied from class: AttributesExtractor

Extracts attributes from the AttributesExtractor into the AttributesBuilder at the beginning of a request.

Specified by:

onStart in class AttributesExtractor<REQUEST,RESPONSE>

onEnd

protected final void onEnd(io.opentelemetry.api.common.AttributesBuilder attributes,
                           REQUEST request,
                           @Nullable RESPONSE response)

Description copied from class: AttributesExtractor

Extracts attributes from the AttributesExtractor and AttributesExtractor into the AttributesBuilder at the end of a request.

Specified by:

onEnd in class AttributesExtractor<REQUEST,RESPONSE>

transport

public abstract @Nullable String transport(REQUEST request)

peerName

public abstract @Nullable String peerName(REQUEST request,
                                          @Nullable RESPONSE response)

This method will be called twice: both when the request starts (response is always null then) and when the response ends. This way it is possible to capture net attributes in both phases of processing.

peerPort

public abstract @Nullable Integer peerPort(REQUEST request,
                                           @Nullable RESPONSE response)

This method will be called twice: both when the request starts (response is always null then) and when the response ends. This way it is possible to capture net attributes in both phases of processing.

peerIp

public abstract @Nullable String peerIp(REQUEST request,
                                        @Nullable RESPONSE response)

This method will be called twice: both when the request starts (response is always null then) and when the response ends. This way it is possible to capture net attributes in both phases of processing.