Package io.opentelemetry.instrumentation.api.instrumenter.messaging

Class MessagingAttributesExtractor<REQUEST,RESPONSE>

java.lang.Object

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

io.opentelemetry.instrumentation.api.instrumenter.messaging.MessagingAttributesExtractor<REQUEST,RESPONSE>

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

Extractor of messaging attributes. Instrumentation of messaging frameworks/libraries should extend this class, defining MessagingAttributesExtractor and MessagingAttributesExtractor with the actual request / response types of the instrumented library. If an attribute is not available in this library, it is appropriate to return null from the protected attribute methods, but implement as many as possible for best compliance with the OpenTelemetry specification.

Field Summary

Fields

Modifier and Type	Field	Description
static String	TEMP_DESTINATION_NAME

Constructor Summary

Constructors

Constructor	Description
MessagingAttributesExtractor()

Method Summary

Modifier and Type	Method	Description
protected abstract @Nullable String	conversationId(REQUEST request)
protected abstract @Nullable String	destination(REQUEST request)
protected abstract @Nullable String	destinationKind(REQUEST request)
protected abstract @Nullable String	messageId(REQUEST request, @Nullable RESPONSE response)
protected abstract @Nullable Long	messagePayloadCompressedSize(REQUEST request)
protected abstract @Nullable Long	messagePayloadSize(REQUEST request)
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.
protected abstract @Nullable MessageOperation	operation(REQUEST request)
protected abstract @Nullable String	protocol(REQUEST request)
protected abstract @Nullable String	protocolVersion(REQUEST request)
protected abstract @Nullable String	system(REQUEST request)
protected abstract boolean	temporaryDestination(REQUEST request)
protected abstract @Nullable String	url(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

Field Detail

TEMP_DESTINATION_NAME

public static final String TEMP_DESTINATION_NAME

See Also:

Constant Field Values

Constructor Detail

MessagingAttributesExtractor

public MessagingAttributesExtractor()

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>

system

protected abstract @Nullable String system(REQUEST request)

destinationKind

protected abstract @Nullable String destinationKind(REQUEST request)

destination

protected abstract @Nullable String destination(REQUEST request)

temporaryDestination

protected abstract boolean temporaryDestination(REQUEST request)

protocol

protected abstract @Nullable String protocol(REQUEST request)

protocolVersion

protected abstract @Nullable String protocolVersion(REQUEST request)

url

protected abstract @Nullable String url(REQUEST request)

conversationId

protected abstract @Nullable String conversationId(REQUEST request)

messagePayloadSize

protected abstract @Nullable Long messagePayloadSize(REQUEST request)

messagePayloadCompressedSize

protected abstract @Nullable Long messagePayloadCompressedSize(REQUEST request)

operation

protected abstract @Nullable MessageOperation operation(REQUEST request)

messageId

protected abstract @Nullable String messageId(REQUEST request,
                                              @Nullable RESPONSE response)