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

Class InetSocketAddressNetAttributesExtractor<REQUEST,RESPONSE>

java.lang.Object

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

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

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

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

Extractor of Network attributes from a InetSocketAddress. Most network libraries will provide access to a InetSocketAddress so this is a convenient alternative to NetAttributesExtractor. There is no meaning to implement both in the same instrumentation.

Constructor Summary

Constructors

Constructor	Description
InetSocketAddressNetAttributesExtractor()

Method Summary

Modifier and Type	Method	Description
abstract @Nullable InetSocketAddress	getAddress(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.
@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.
@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.
@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.

Methods inherited from class io.opentelemetry.instrumentation.api.instrumenter.net.NetAttributesExtractor

onEnd, onStart, transport

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

InetSocketAddressNetAttributesExtractor

public InetSocketAddressNetAttributesExtractor()

Method Detail

getAddress

public abstract @Nullable InetSocketAddress getAddress(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.

peerName

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

Description copied from class: NetAttributesExtractor

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.

Specified by:

peerName in class NetAttributesExtractor<REQUEST,RESPONSE>

peerPort

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

Description copied from class: NetAttributesExtractor

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.

Specified by:

peerPort in class NetAttributesExtractor<REQUEST,RESPONSE>

peerIp

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

Description copied from class: NetAttributesExtractor

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.

Specified by:

peerIp in class NetAttributesExtractor<REQUEST,RESPONSE>