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

Class MessagingAttributesExtractor<REQUEST,RESPONSE>

java.lang.Object

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

All Implemented Interfaces:

AttributesExtractor<REQUEST,RESPONSE>

public abstract class MessagingAttributesExtractor<REQUEST,RESPONSE>
extends Object
implements 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 String	conversationId(REQUEST request)
protected abstract String	destination(REQUEST request)
protected abstract String	destinationKind(REQUEST request)
protected abstract String	messageId(REQUEST request, RESPONSE response)
protected abstract Long	messagePayloadCompressedSize(REQUEST request)
protected abstract Long	messagePayloadSize(REQUEST request)
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.
abstract MessageOperation	operation()
protected abstract String	protocol(REQUEST request)
protected abstract String	protocolVersion(REQUEST request)
protected abstract String	system(REQUEST request)
protected abstract boolean	temporaryDestination(REQUEST request)
protected abstract String	url(REQUEST 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

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

public final 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 final 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>

operation

public abstract MessageOperation operation()

system

@Nullable
protected abstract String system(REQUEST request)

destinationKind

@Nullable
protected abstract String destinationKind(REQUEST request)

destination

@Nullable
protected abstract String destination(REQUEST request)

temporaryDestination

protected abstract boolean temporaryDestination(REQUEST request)

protocol

@Nullable
protected abstract String protocol(REQUEST request)

protocolVersion

@Nullable
protected abstract String protocolVersion(REQUEST request)

url

@Nullable
protected abstract String url(REQUEST request)

conversationId

@Nullable
protected abstract String conversationId(REQUEST request)

messagePayloadSize

@Nullable
protected abstract Long messagePayloadSize(REQUEST request)

messagePayloadCompressedSize

@Nullable
protected abstract Long messagePayloadCompressedSize(REQUEST request)

messageId

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