Package io.opentelemetry.instrumentation.api.incubator.semconv.messaging

Class MessagingAttributesExtractor<REQUEST,RESPONSE>

java.lang.Object

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

All Implemented Interfaces:

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

public final class MessagingAttributesExtractor<REQUEST,RESPONSE>
extends Object
implements io.opentelemetry.instrumentation.api.instrumenter.AttributesExtractor<REQUEST,RESPONSE>, io.opentelemetry.instrumentation.api.internal.SpanKeyProvider

Extractor of messaging attributes.

This class delegates to a type-specific MessagingAttributesGetter for individual attribute extraction from request/response objects.

Method Summary

Modifier and Type	Method	Description
static <REQUEST, RESPONSE> MessagingAttributesExtractorBuilder<REQUEST,RESPONSE>	builder(MessagingAttributesGetter<REQUEST,RESPONSE> getter, MessageOperation operation)	Deprecated. Use builder(MessagingAttributesGetter, MessagingOperationType, String).
static <REQUEST, RESPONSE> MessagingAttributesExtractorBuilder<REQUEST,RESPONSE>	builder(MessagingAttributesGetter<REQUEST,RESPONSE> getter, MessagingOperationType operationType, String operationName)	Returns a new MessagingAttributesExtractorBuilder configured for the given operation type.
static <REQUEST, RESPONSE> io.opentelemetry.instrumentation.api.instrumenter.AttributesExtractor<REQUEST,RESPONSE>	create(MessagingAttributesGetter<REQUEST,RESPONSE> getter, MessageOperation operation)	Deprecated. Use create(MessagingAttributesGetter, MessagingOperationType, String).
static <REQUEST, RESPONSE> io.opentelemetry.instrumentation.api.instrumenter.AttributesExtractor<REQUEST,RESPONSE>	create(MessagingAttributesGetter<REQUEST,RESPONSE> getter, MessagingOperationType operationType, String operationName)	Creates the messaging attributes extractor for the given operation type.
io.opentelemetry.instrumentation.api.internal.SpanKey	internalGetSpanKey()	This method is internal and is hence not for public use.
void	onEnd(io.opentelemetry.api.common.AttributesBuilder attributes, io.opentelemetry.context.Context context, REQUEST request, RESPONSE response, Throwable error)
void	onStart(io.opentelemetry.api.common.AttributesBuilder attributes, io.opentelemetry.context.Context parentContext, REQUEST request)

Methods inherited from class java.lang.Object

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

Method Details

create

public static <REQUEST,
RESPONSE>
io.opentelemetry.instrumentation.api.instrumenter.AttributesExtractor<REQUEST,RESPONSE> create(MessagingAttributesGetter<REQUEST,RESPONSE> getter,
 MessagingOperationType operationType,
 String operationName)

Creates the messaging attributes extractor for the given operation type.

Parameters:

operationName - the system-specific name of the operation, emitted as messaging.operation.name, e.g. send, poll or ack.

create

@Deprecated
public static <REQUEST,
RESPONSE>
io.opentelemetry.instrumentation.api.instrumenter.AttributesExtractor<REQUEST,RESPONSE> create(MessagingAttributesGetter<REQUEST,RESPONSE> getter,
 @Nullable
 MessageOperation operation)

Deprecated.

Use create(MessagingAttributesGetter, MessagingOperationType, String). May be removed in the next minor release.

builder

public static <REQUEST,
RESPONSE>
MessagingAttributesExtractorBuilder<REQUEST,RESPONSE> builder(MessagingAttributesGetter<REQUEST,RESPONSE> getter,
 MessagingOperationType operationType,
 String operationName)

Returns a new MessagingAttributesExtractorBuilder configured for the given operation type.

Parameters:

operationName - the system-specific name of the operation, emitted as messaging.operation.name, e.g. send, poll or ack.

builder

@Deprecated
public static <REQUEST,
RESPONSE>
MessagingAttributesExtractorBuilder<REQUEST,RESPONSE> builder(MessagingAttributesGetter<REQUEST,RESPONSE> getter,
 @Nullable
 MessageOperation operation)

Deprecated.

Use builder(MessagingAttributesGetter, MessagingOperationType, String). May be removed in the next minor release.

onStart

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

Specified by:

onStart in interface io.opentelemetry.instrumentation.api.instrumenter.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)

Specified by:

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

internalGetSpanKey

@Nullable
public io.opentelemetry.instrumentation.api.internal.SpanKey internalGetSpanKey()

This method is internal and is hence not for public use. Its API is unstable and can change at any time.

Specified by:

internalGetSpanKey in interface io.opentelemetry.instrumentation.api.internal.SpanKeyProvider