Package io.opentelemetry.instrumentation.api.instrumenter

Class PeerServiceAttributesExtractor<REQUEST,RESPONSE>

java.lang.Object

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

All Implemented Interfaces:

AttributesExtractor<REQUEST,RESPONSE>

public final class PeerServiceAttributesExtractor<REQUEST,RESPONSE>
extends Object
implements AttributesExtractor<REQUEST,RESPONSE>

Extractor of the peer.service span attribute, described in the specification.

Peer service name mappings can be configured using the otel.instrumentation.common.peer-service-mapping configuration property. The format used is a comma-separated list of host=name pairs.

Method Summary

Modifier and Type	Method	Description
static <REQUEST,RESPONSE> PeerServiceAttributesExtractor<REQUEST,RESPONSE>	create(NetClientAttributesGetter<REQUEST,RESPONSE> attributesGetter)	Returns a new PeerServiceAttributesExtractor that will use the passed netAttributesExtractor instance to determine the value of the peer.service attribute.
void	onEnd(io.opentelemetry.api.common.AttributesBuilder attributes, io.opentelemetry.context.Context context, REQUEST request, RESPONSE response, Throwable error)	Extracts attributes from the Context, the AttributesExtractor and either AttributesExtractor or error into the AttributesBuilder at the end of a request.
void	onStart(io.opentelemetry.api.common.AttributesBuilder attributes, io.opentelemetry.context.Context parentContext, REQUEST request)	Extracts attributes from the Context and the AttributesExtractor into the AttributesBuilder at the beginning of a request.

Methods inherited from class java.lang.Object

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

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

onEnd, onStart, set

Method Detail

create

public static <REQUEST,RESPONSE> PeerServiceAttributesExtractor<REQUEST,RESPONSE> create(NetClientAttributesGetter<REQUEST,RESPONSE> attributesGetter)

Returns a new PeerServiceAttributesExtractor that will use the passed netAttributesExtractor instance to determine the value of the peer.service attribute.

onStart

public void onStart(io.opentelemetry.api.common.AttributesBuilder attributes,
                    io.opentelemetry.context.Context parentContext,
                    REQUEST request)

Description copied from interface: AttributesExtractor

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

Specified by:

onStart in interface AttributesExtractor<REQUEST,RESPONSE>

onEnd

public void onEnd(io.opentelemetry.api.common.AttributesBuilder attributes,
                  io.opentelemetry.context.Context context,
                  REQUEST request,
                  @Nullable
                  RESPONSE response,
                  @Nullable
                  Throwable error)

Description copied from interface: AttributesExtractor

Extracts attributes from the Context, the AttributesExtractor and either AttributesExtractor or error into the AttributesBuilder at the end of a request.

Specified by:

onEnd in interface AttributesExtractor<REQUEST,RESPONSE>