Package io.opentelemetry.instrumentation.api.instrumenter

Class AttributesExtractor<REQUEST,RESPONSE>

java.lang.Object

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

Direct Known Subclasses:

CodeAttributesExtractor, DbAttributesExtractor, HttpAttributesExtractor, MessagingAttributesExtractor, NetAttributesExtractor, RpcAttributesExtractor

public abstract class AttributesExtractor<REQUEST,RESPONSE>
extends Object

Extractor of Attributes for a given request and response. Will be called on start with just the AttributesExtractor and again on end with both AttributesExtractor and AttributesExtractor to allow populating attributes at each stage of a request's lifecycle. It is best to populate as much as possible in onStart(AttributesBuilder, Object) to have it available during sampling.

See Also:

DbAttributesExtractor, HttpAttributesExtractor, NetAttributesExtractor

Constructor Summary

Constructors

Constructor	Description
AttributesExtractor()

Method Summary

Modifier and Type	Method	Description
protected abstract 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 abstract void	onStart(io.opentelemetry.api.common.AttributesBuilder attributes, REQUEST request)	Extracts attributes from the AttributesExtractor into the AttributesBuilder at the beginning of a request.
protected static <T> void	set(io.opentelemetry.api.common.AttributesBuilder attributes, io.opentelemetry.api.common.AttributeKey<T> key, T value)	Sets the value with the given key to the AttributesBuilder if value is not null.

Methods inherited from class java.lang.Object

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

Constructor Detail

AttributesExtractor

public AttributesExtractor()

Method Detail

onStart

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

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

onEnd

protected abstract 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.

set

protected static <T> void set(io.opentelemetry.api.common.AttributesBuilder attributes,
                              io.opentelemetry.api.common.AttributeKey<T> key,
                              T value)

Sets the value with the given key to the AttributesBuilder if value is not null.