diff --git a/instrumentation-api-incubator/build.gradle.kts b/instrumentation-api-incubator/build.gradle.kts index 1a59ad1364a8..5d87535b7a2b 100644 --- a/instrumentation-api-incubator/build.gradle.kts +++ b/instrumentation-api-incubator/build.gradle.kts @@ -92,6 +92,7 @@ tasks { testClassesDirs = sourceSets.test.get().output.classesDirs classpath = sourceSets.test.get().runtimeClasspath jvmArgs("-Dotel.semconv-stability.opt-in=database,code,service.peer,rpc") + jvmArgs("-Dotel.semconv-stability.preview=messaging") inputs.dir(jflexOutputDir) } @@ -99,6 +100,7 @@ tasks { testClassesDirs = sourceSets.test.get().output.classesDirs classpath = sourceSets.test.get().runtimeClasspath jvmArgs("-Dotel.semconv-stability.opt-in=database/dup,code/dup,service.peer/dup,rpc/dup") + jvmArgs("-Dotel.semconv-stability.preview=messaging/dup") inputs.dir(jflexOutputDir) } @@ -117,6 +119,11 @@ tasks { } check { - dependsOn(testStableSemconv, testBothSemconv, testExceptionSignalLogs, testExceptionSignalLogsDup) + dependsOn( + testStableSemconv, + testBothSemconv, + testExceptionSignalLogs, + testExceptionSignalLogsDup, + ) } } diff --git a/instrumentation-api-incubator/src/main/java/io/opentelemetry/instrumentation/api/incubator/semconv/messaging/MessageOperation.java b/instrumentation-api-incubator/src/main/java/io/opentelemetry/instrumentation/api/incubator/semconv/messaging/MessageOperation.java index e7ef5c479ed0..c1062bd0d056 100644 --- a/instrumentation-api-incubator/src/main/java/io/opentelemetry/instrumentation/api/incubator/semconv/messaging/MessageOperation.java +++ b/instrumentation-api-incubator/src/main/java/io/opentelemetry/instrumentation/api/incubator/semconv/messaging/MessageOperation.java @@ -5,24 +5,19 @@ package io.opentelemetry.instrumentation.api.incubator.semconv.messaging; -import java.util.Locale; - -/** - * Represents type of operations - * that may be used in a messaging system. - */ +/** Represents an operation that may be used in a messaging system. */ public enum MessageOperation { - PUBLISH, - RECEIVE, - PROCESS; + PUBLISH(MessagingOperationType.SEND), + RECEIVE(MessagingOperationType.RECEIVE), + PROCESS(MessagingOperationType.PROCESS); + + private final MessagingOperationType operationType; + + MessageOperation(MessagingOperationType operationType) { + this.operationType = operationType; + } - /** - * Returns the operation name as defined in the - * specification. - */ - String operationName() { - return name().toLowerCase(Locale.ROOT); + MessagingOperationType type() { + return operationType; } } diff --git a/instrumentation-api-incubator/src/main/java/io/opentelemetry/instrumentation/api/incubator/semconv/messaging/MessagingAttributesExtractor.java b/instrumentation-api-incubator/src/main/java/io/opentelemetry/instrumentation/api/incubator/semconv/messaging/MessagingAttributesExtractor.java index 3ad89017a047..3a680fa8f625 100644 --- a/instrumentation-api-incubator/src/main/java/io/opentelemetry/instrumentation/api/incubator/semconv/messaging/MessagingAttributesExtractor.java +++ b/instrumentation-api-incubator/src/main/java/io/opentelemetry/instrumentation/api/incubator/semconv/messaging/MessagingAttributesExtractor.java @@ -5,6 +5,10 @@ package io.opentelemetry.instrumentation.api.incubator.semconv.messaging; +import static io.opentelemetry.instrumentation.api.internal.SemconvStability.emitOldMessagingSemconv; +import static io.opentelemetry.instrumentation.api.internal.SemconvStability.emitStableMessagingSemconv; +import static io.opentelemetry.semconv.ErrorAttributes.ERROR_TYPE; + import io.opentelemetry.api.common.AttributeKey; import io.opentelemetry.api.common.AttributesBuilder; import io.opentelemetry.context.Context; @@ -17,7 +21,7 @@ /** * Extractor of messaging + * href="https://github.com/open-telemetry/semantic-conventions/blob/v1.43.0/docs/messaging/messaging-spans.md">messaging * attributes. * *

This class delegates to a type-specific {@link MessagingAttributesGetter} for individual @@ -29,8 +33,10 @@ public final class MessagingAttributesExtractor // copied from MessagingIncubatingAttributes private static final AttributeKey MESSAGING_BATCH_MESSAGE_COUNT = AttributeKey.longKey("messaging.batch.message_count"); - private static final AttributeKey MESSAGING_CLIENT_ID = + private static final AttributeKey MESSAGING_CLIENT_ID_OLD = AttributeKey.stringKey("messaging.client_id"); + private static final AttributeKey MESSAGING_CLIENT_ID = + AttributeKey.stringKey("messaging.client.id"); private static final AttributeKey MESSAGING_DESTINATION_ANONYMOUS = AttributeKey.booleanKey("messaging.destination.anonymous"); private static final AttributeKey MESSAGING_DESTINATION_NAME = @@ -51,49 +57,78 @@ public final class MessagingAttributesExtractor AttributeKey.stringKey("messaging.message.id"); private static final AttributeKey MESSAGING_OPERATION = AttributeKey.stringKey("messaging.operation"); + private static final AttributeKey MESSAGING_OPERATION_NAME = + AttributeKey.stringKey("messaging.operation.name"); + private static final AttributeKey MESSAGING_OPERATION_TYPE = + AttributeKey.stringKey("messaging.operation.type"); private static final AttributeKey MESSAGING_SYSTEM = AttributeKey.stringKey("messaging.system"); static final String TEMP_DESTINATION_NAME = "(temporary)"; - /** - * Creates the messaging attributes extractor for the given {@link MessageOperation operation} - * with default configuration. - */ + /** Creates the messaging attributes extractor for the given operation type. */ + public static AttributesExtractor createForOperationType( + MessagingAttributesGetter getter, MessagingOperationType operationType) { + return builderForOperationType(getter, operationType).build(); + } + + /** Creates the messaging attributes extractor for the given operation. */ public static AttributesExtractor create( - MessagingAttributesGetter getter, MessageOperation operation) { + MessagingAttributesGetter getter, @Nullable MessageOperation operation) { return builder(getter, operation).build(); } /** - * Returns a new {@link MessagingAttributesExtractorBuilder} for the given {@link MessageOperation - * operation} that can be used to configure the messaging attributes extractor. + * Returns a new {@link MessagingAttributesExtractorBuilder} configured for the given operation + * type. */ + public static + MessagingAttributesExtractorBuilder builderForOperationType( + MessagingAttributesGetter getter, + @Nullable MessagingOperationType operationType) { + return new MessagingAttributesExtractorBuilder<>(getter, operationType, true); + } + + /** Returns a new messaging attributes extractor builder for the given operation. */ public static MessagingAttributesExtractorBuilder builder( - MessagingAttributesGetter getter, MessageOperation operation) { - return new MessagingAttributesExtractorBuilder<>(getter, operation); + MessagingAttributesGetter getter, @Nullable MessageOperation operation) { + return new MessagingAttributesExtractorBuilder<>( + getter, operation == null ? null : operation.type(), false); } private final MessagingAttributesGetter getter; - private final MessageOperation operation; + @Nullable private final MessagingOperationType operationType; + @Nullable private final String operationName; + private final boolean supportsStableSemconv; private final List capturedHeaders; MessagingAttributesExtractor( MessagingAttributesGetter getter, - MessageOperation operation, + @Nullable MessagingOperationType operationType, + @Nullable String operationName, + boolean supportsStableSemconv, List capturedHeaders) { this.getter = getter; - this.operation = operation; + this.operationType = operationType; + this.operationName = operationName; + this.supportsStableSemconv = supportsStableSemconv; this.capturedHeaders = new ArrayList<>(capturedHeaders); } @Override public void onStart(AttributesBuilder attributes, Context parentContext, REQUEST request) { + boolean emitOldSemconv = !supportsStableSemconv || emitOldMessagingSemconv(); + boolean emitStableSemconv = supportsStableSemconv && emitStableMessagingSemconv(); attributes.put(MESSAGING_SYSTEM, getter.getSystem(request)); boolean isTemporaryDestination = getter.isTemporaryDestination(request); if (isTemporaryDestination) { attributes.put(MESSAGING_DESTINATION_TEMPORARY, true); - attributes.put(MESSAGING_DESTINATION_NAME, TEMP_DESTINATION_NAME); + if (emitStableSemconv) { + attributes.put(MESSAGING_DESTINATION_NAME, getter.getDestination(request)); + attributes.put(MESSAGING_DESTINATION_TEMPLATE, getter.getDestinationTemplate(request)); + } else { + attributes.put(MESSAGING_DESTINATION_NAME, TEMP_DESTINATION_NAME); + } } else { attributes.put(MESSAGING_DESTINATION_NAME, getter.getDestination(request)); attributes.put(MESSAGING_DESTINATION_TEMPLATE, getter.getDestinationTemplate(request)); @@ -106,9 +141,20 @@ public void onStart(AttributesBuilder attributes, Context parentContext, REQUEST attributes.put(MESSAGING_MESSAGE_CONVERSATION_ID, getter.getConversationId(request)); attributes.put(MESSAGING_MESSAGE_BODY_SIZE, getter.getMessageBodySize(request)); attributes.put(MESSAGING_MESSAGE_ENVELOPE_SIZE, getter.getMessageEnvelopeSize(request)); - attributes.put(MESSAGING_CLIENT_ID, getter.getClientId(request)); - if (operation != null) { - attributes.put(MESSAGING_OPERATION, operation.operationName()); + if (emitOldSemconv) { + attributes.put(MESSAGING_CLIENT_ID_OLD, getter.getClientId(request)); + } + if (emitStableSemconv) { + attributes.put(MESSAGING_CLIENT_ID, getter.getClientId(request)); + } + if (emitOldSemconv && operationType != null) { + attributes.put(MESSAGING_OPERATION, operationType.defaultOperationName()); + } + if (emitStableSemconv) { + attributes.put(MESSAGING_OPERATION_NAME, operationName); + if (operationType != null) { + attributes.put(MESSAGING_OPERATION_TYPE, operationType.value()); + } } } @@ -121,6 +167,13 @@ public void onEnd( @Nullable Throwable error) { attributes.put(MESSAGING_MESSAGE_ID, getter.getMessageId(request, response)); attributes.put(MESSAGING_BATCH_MESSAGE_COUNT, getter.getBatchMessageCount(request, response)); + if (supportsStableSemconv && emitStableMessagingSemconv()) { + String errorType = getter.getErrorType(request, response, error); + if (errorType == null && error != null) { + errorType = error.getClass().getName(); + } + attributes.put(ERROR_TYPE, errorType); + } for (String name : capturedHeaders) { List values = getter.getMessageHeader(request, name); @@ -137,17 +190,21 @@ public void onEnd( @Override @Nullable public SpanKey internalGetSpanKey() { - if (operation == null) { + if (operationType == null) { return null; } - switch (operation) { - case PUBLISH: + switch (operationType) { + case CREATE: + return SpanKey.PRODUCER_CREATE; + case SEND: return SpanKey.PRODUCER; case RECEIVE: return SpanKey.CONSUMER_RECEIVE; case PROCESS: return SpanKey.CONSUMER_PROCESS; + case SETTLE: + return SpanKey.CONSUMER_SETTLE; } throw new IllegalStateException("Can't possibly happen"); } diff --git a/instrumentation-api-incubator/src/main/java/io/opentelemetry/instrumentation/api/incubator/semconv/messaging/MessagingAttributesExtractorBuilder.java b/instrumentation-api-incubator/src/main/java/io/opentelemetry/instrumentation/api/incubator/semconv/messaging/MessagingAttributesExtractorBuilder.java index 61f6c6916549..925047dabecf 100644 --- a/instrumentation-api-incubator/src/main/java/io/opentelemetry/instrumentation/api/incubator/semconv/messaging/MessagingAttributesExtractorBuilder.java +++ b/instrumentation-api-incubator/src/main/java/io/opentelemetry/instrumentation/api/incubator/semconv/messaging/MessagingAttributesExtractorBuilder.java @@ -6,24 +6,43 @@ package io.opentelemetry.instrumentation.api.incubator.semconv.messaging; import static java.util.Collections.emptyList; +import static java.util.Objects.requireNonNull; import com.google.errorprone.annotations.CanIgnoreReturnValue; import io.opentelemetry.instrumentation.api.instrumenter.AttributesExtractor; import java.util.ArrayList; import java.util.Collection; import java.util.List; +import javax.annotation.Nullable; /** A builder of {@link MessagingAttributesExtractor}. */ public final class MessagingAttributesExtractorBuilder { final MessagingAttributesGetter getter; - final MessageOperation operation; + @Nullable private final MessagingOperationType operationType; + @Nullable private String operationName; + private final boolean supportsStableSemconv; List capturedHeaders = emptyList(); MessagingAttributesExtractorBuilder( - MessagingAttributesGetter getter, MessageOperation operation) { + MessagingAttributesGetter getter, + @Nullable MessagingOperationType operationType, + boolean supportsStableSemconv) { this.getter = getter; - this.operation = operation; + this.operationType = operationType; + this.operationName = operationType == null ? null : operationType.defaultOperationName(); + this.supportsStableSemconv = supportsStableSemconv; + } + + /** Configures the system-specific operation name emitted as {@code messaging.operation.name}. */ + @CanIgnoreReturnValue + public MessagingAttributesExtractorBuilder setOperationName( + String operationName) { + if (!supportsStableSemconv) { + throw new IllegalStateException("Operation name is not configurable for legacy builders"); + } + this.operationName = requireNonNull(operationName, "operationName"); + return this; } /** @@ -47,6 +66,10 @@ public MessagingAttributesExtractorBuilder setCapturedHeaders * MessagingAttributesExtractorBuilder}. */ public AttributesExtractor build() { - return new MessagingAttributesExtractor<>(getter, operation, capturedHeaders); + if (supportsStableSemconv) { + requireNonNull(operationName, "operationName"); + } + return new MessagingAttributesExtractor<>( + getter, operationType, operationName, supportsStableSemconv, capturedHeaders); } } diff --git a/instrumentation-api-incubator/src/main/java/io/opentelemetry/instrumentation/api/incubator/semconv/messaging/MessagingAttributesGetter.java b/instrumentation-api-incubator/src/main/java/io/opentelemetry/instrumentation/api/incubator/semconv/messaging/MessagingAttributesGetter.java index ae0b29471cf0..eaea16aaf74f 100644 --- a/instrumentation-api-incubator/src/main/java/io/opentelemetry/instrumentation/api/incubator/semconv/messaging/MessagingAttributesGetter.java +++ b/instrumentation-api-incubator/src/main/java/io/opentelemetry/instrumentation/api/incubator/semconv/messaging/MessagingAttributesGetter.java @@ -55,6 +55,21 @@ default String getDestinationPartitionId(REQUEST request) { return null; } + /** + * Returns a description of a class of error the operation ended with. + * + *

If this method returns {@code null}, the exception class name (if any) will be used as error + * type. + * + *

The cardinality of the error type should be low. The instrumentations implementing this + * method are recommended to document the custom values they support. + */ + @Nullable + default String getErrorType( + REQUEST request, @Nullable RESPONSE response, @Nullable Throwable error) { + return null; + } + /** * Extracts all values of header named {@code name} from the request, or an empty list if there * were none. diff --git a/instrumentation-api-incubator/src/main/java/io/opentelemetry/instrumentation/api/incubator/semconv/messaging/MessagingConsumerMetrics.java b/instrumentation-api-incubator/src/main/java/io/opentelemetry/instrumentation/api/incubator/semconv/messaging/MessagingConsumerMetrics.java index 87a98b106d74..76a62a828e84 100644 --- a/instrumentation-api-incubator/src/main/java/io/opentelemetry/instrumentation/api/incubator/semconv/messaging/MessagingConsumerMetrics.java +++ b/instrumentation-api-incubator/src/main/java/io/opentelemetry/instrumentation/api/incubator/semconv/messaging/MessagingConsumerMetrics.java @@ -5,6 +5,9 @@ package io.opentelemetry.instrumentation.api.incubator.semconv.messaging; +import static io.opentelemetry.instrumentation.api.internal.SemconvStability.emitOldMessagingSemconv; +import static io.opentelemetry.instrumentation.api.internal.SemconvStability.emitStableMessagingSemconv; +import static io.opentelemetry.semconv.ErrorAttributes.ERROR_TYPE; import static java.util.concurrent.TimeUnit.SECONDS; import static java.util.logging.Level.FINE; @@ -23,10 +26,11 @@ import io.opentelemetry.instrumentation.api.instrumenter.OperationMetrics; import io.opentelemetry.instrumentation.api.internal.OperationMetricsUtil; import java.util.logging.Logger; +import javax.annotation.Nullable; /** * {@link OperationListener} which keeps track of Consumer + * href="https://github.com/open-telemetry/semantic-conventions/blob/v1.43.0/docs/messaging/messaging-metrics.md#consumer-metrics">consumer * metrics. */ public final class MessagingConsumerMetrics implements OperationListener { @@ -35,39 +39,70 @@ public final class MessagingConsumerMetrics implements OperationListener { // copied from MessagingIncubatingAttributes private static final AttributeKey MESSAGING_BATCH_MESSAGE_COUNT = AttributeKey.longKey("messaging.batch.message_count"); + private static final AttributeKey MESSAGING_OPERATION = + AttributeKey.stringKey("messaging.operation"); + private static final AttributeKey MESSAGING_OPERATION_TYPE = + AttributeKey.stringKey("messaging.operation.type"); private static final ContextKey MESSAGING_CONSUMER_METRICS_STATE = ContextKey.named("messaging-consumer-metrics-state"); private static final Logger logger = Logger.getLogger(MessagingConsumerMetrics.class.getName()); - private final DoubleHistogram receiveDurationHistogram; - private final LongCounter receiveMessageCount; + private final boolean supportsStableSemconv; + private final boolean consumedMessagesOnly; + private final boolean enabled; + @Nullable private final DoubleHistogram receiveDurationHistogram; + @Nullable private final LongCounter receiveMessageCount; + @Nullable private final DoubleHistogram clientOperationDurationHistogram; + @Nullable private final LongCounter consumedMessagesCounter; - private MessagingConsumerMetrics(Meter meter) { - DoubleHistogramBuilder durationBuilder = - meter - .histogramBuilder("messaging.receive.duration") - .setDescription("Measures the duration of receive operation.") - .setExplicitBucketBoundariesAdvice(MessagingMetricsAdvice.DURATION_SECONDS_BUCKETS) - .setUnit("s"); - MessagingMetricsAdvice.applyReceiveDurationAdvice(durationBuilder); - receiveDurationHistogram = durationBuilder.build(); + private MessagingConsumerMetrics(Meter meter, boolean supportsStableSemconv) { + this(meter, supportsStableSemconv, false); + } - LongCounterBuilder longCounterBuilder = - meter - .counterBuilder("messaging.receive.messages") - .setDescription("Measures the number of received messages.") - .setUnit("{message}"); - MessagingMetricsAdvice.applyReceiveMessagesAdvice(longCounterBuilder); - receiveMessageCount = longCounterBuilder.build(); + private MessagingConsumerMetrics( + Meter meter, boolean supportsStableSemconv, boolean consumedMessagesOnly) { + this.supportsStableSemconv = supportsStableSemconv; + this.consumedMessagesOnly = consumedMessagesOnly; + boolean emitOldSemconv = !supportsStableSemconv || emitOldMessagingSemconv(); + boolean emitStableSemconv = supportsStableSemconv && emitStableMessagingSemconv(); + receiveDurationHistogram = + !consumedMessagesOnly && emitOldSemconv ? buildReceiveDuration(meter) : null; + receiveMessageCount = + !consumedMessagesOnly && emitOldSemconv ? buildReceiveMessages(meter) : null; + clientOperationDurationHistogram = + !consumedMessagesOnly && emitStableSemconv ? buildClientOperationDuration(meter) : null; + consumedMessagesCounter = emitStableSemconv ? buildConsumedMessages(meter) : null; + enabled = + receiveDurationHistogram != null + || receiveMessageCount != null + || clientOperationDurationHistogram != null + || consumedMessagesCounter != null; } + /** Returns metrics for extractors configured with {@link MessageOperation}. */ public static OperationMetrics get() { - return OperationMetricsUtil.create("messaging consumer", MessagingConsumerMetrics::new); + return OperationMetricsUtil.create( + "messaging consumer", meter -> new MessagingConsumerMetrics(meter, false)); + } + + /** Returns metrics for extractors configured with {@link MessagingOperationType}. */ + public static OperationMetrics getForOperationType() { + return OperationMetricsUtil.create( + "messaging consumer", meter -> new MessagingConsumerMetrics(meter, true)); + } + + /** Returns only the stable consumed-messages metric for a delivered message. */ + public static OperationMetrics getConsumedMessages() { + return OperationMetricsUtil.create( + "messaging consumed messages", meter -> new MessagingConsumerMetrics(meter, true, true)); } @Override @CanIgnoreReturnValue public Context onStart(Context context, Attributes startAttributes, long startNanos) { + if (!enabled) { + return context; + } return context.with( MESSAGING_CONSUMER_METRICS_STATE, new AutoValue_MessagingConsumerMetrics_State(startAttributes, startNanos)); @@ -75,6 +110,9 @@ public Context onStart(Context context, Attributes startAttributes, long startNa @Override public void onEnd(Context context, Attributes endAttributes, long endNanos) { + if (!enabled) { + return; + } MessagingConsumerMetrics.State state = context.get(MESSAGING_CONSUMER_METRICS_STATE); if (state == null) { logger.log( @@ -85,21 +123,104 @@ public void onEnd(Context context, Attributes endAttributes, long endNanos) { } Attributes attributes = state.startAttributes().toBuilder().putAll(endAttributes).build(); - receiveDurationHistogram.record( - (endNanos - state.startTimeNanos()) / NANOS_PER_S, attributes, context); + double duration = (endNanos - state.startTimeNanos()) / NANOS_PER_S; + String operationType = attributes.get(MESSAGING_OPERATION_TYPE); + boolean recordsLegacyReceive = + !supportsStableSemconv + || "receive".equals(attributes.get(MESSAGING_OPERATION)) + || MessagingOperationType.RECEIVE.value().equals(operationType); + if (receiveDurationHistogram != null && recordsLegacyReceive) { + receiveDurationHistogram.record(duration, attributes, context); + } + // Metric view attribute advice can only select keys statically. The concrete destination name + // must be omitted when a template is available or the destination is temporary or anonymous, + // so this conditional requirement must be enforced before recording. + Attributes filteredAttributes = + clientOperationDurationHistogram != null || consumedMessagesCounter != null + ? MessagingMetricsAdvice.filterAttributes(attributes) + : attributes; + if (clientOperationDurationHistogram != null + && !MessagingOperationType.PROCESS.value().equals(operationType)) { + clientOperationDurationHistogram.record(duration, filteredAttributes, context); + } - long receiveMessagesCount = getReceiveMessagesCount(state.startAttributes(), endAttributes); - receiveMessageCount.add(receiveMessagesCount, attributes, context); + Long batchMessageCount = getBatchMessageCount(state.startAttributes(), endAttributes); + if (receiveMessageCount != null && recordsLegacyReceive) { + long receiveMessagesCount = batchMessageCount == null ? 1 : batchMessageCount; + if (!supportsStableSemconv || receiveMessagesCount > 0) { + receiveMessageCount.add(receiveMessagesCount, attributes, context); + } + } + if (consumedMessagesCounter != null + && (consumedMessagesOnly || MessagingOperationType.RECEIVE.value().equals(operationType))) { + long consumedMessagesCount = + getConsumedMessagesCount(attributes, batchMessageCount, consumedMessagesOnly); + if (consumedMessagesCount > 0) { + consumedMessagesCounter.add(consumedMessagesCount, filteredAttributes, context); + } + } } - private static long getReceiveMessagesCount(Attributes... attributesList) { + @Nullable + private static Long getBatchMessageCount(Attributes... attributesList) { for (Attributes attributes : attributesList) { Long value = attributes.get(MESSAGING_BATCH_MESSAGE_COUNT); if (value != null) { return value; } } - return 1; + return null; + } + + private static long getConsumedMessagesCount( + Attributes attributes, @Nullable Long batchMessageCount, boolean consumedMessagesOnly) { + if (batchMessageCount != null) { + return batchMessageCount; + } + return consumedMessagesOnly || attributes.get(ERROR_TYPE) == null ? 1 : 0; + } + + private static DoubleHistogram buildReceiveDuration(Meter meter) { + DoubleHistogramBuilder builder = + meter + .histogramBuilder("messaging.receive.duration") + .setDescription("Measures the duration of receive operation.") + .setExplicitBucketBoundariesAdvice(MessagingMetricsAdvice.DURATION_SECONDS_BUCKETS) + .setUnit("s"); + MessagingMetricsAdvice.applyOldDurationAdvice(builder); + return builder.build(); + } + + private static LongCounter buildReceiveMessages(Meter meter) { + LongCounterBuilder builder = + meter + .counterBuilder("messaging.receive.messages") + .setDescription("Measures the number of received messages.") + .setUnit("{message}"); + MessagingMetricsAdvice.applyOldMessagesAdvice(builder); + return builder.build(); + } + + private static DoubleHistogram buildClientOperationDuration(Meter meter) { + DoubleHistogramBuilder builder = + meter + .histogramBuilder("messaging.client.operation.duration") + .setDescription( + "Duration of messaging operation initiated by a producer or consumer client.") + .setExplicitBucketBoundariesAdvice(MessagingMetricsAdvice.DURATION_SECONDS_BUCKETS) + .setUnit("s"); + MessagingMetricsAdvice.applyClientOperationDurationAdvice(builder); + return builder.build(); + } + + private static LongCounter buildConsumedMessages(Meter meter) { + LongCounterBuilder builder = + meter + .counterBuilder("messaging.client.consumed.messages") + .setDescription("Number of messages that were delivered to the application.") + .setUnit("{message}"); + MessagingMetricsAdvice.applyConsumedMessagesAdvice(builder); + return builder.build(); } @AutoValue diff --git a/instrumentation-api-incubator/src/main/java/io/opentelemetry/instrumentation/api/incubator/semconv/messaging/MessagingMetricsAdvice.java b/instrumentation-api-incubator/src/main/java/io/opentelemetry/instrumentation/api/incubator/semconv/messaging/MessagingMetricsAdvice.java index ddc4115ea7f4..defc418fc406 100644 --- a/instrumentation-api-incubator/src/main/java/io/opentelemetry/instrumentation/api/incubator/semconv/messaging/MessagingMetricsAdvice.java +++ b/instrumentation-api-incubator/src/main/java/io/opentelemetry/instrumentation/api/incubator/semconv/messaging/MessagingMetricsAdvice.java @@ -12,10 +12,12 @@ import static java.util.Collections.unmodifiableList; import io.opentelemetry.api.common.AttributeKey; +import io.opentelemetry.api.common.Attributes; import io.opentelemetry.api.incubator.metrics.ExtendedDoubleHistogramBuilder; import io.opentelemetry.api.incubator.metrics.ExtendedLongCounterBuilder; import io.opentelemetry.api.metrics.DoubleHistogramBuilder; import io.opentelemetry.api.metrics.LongCounterBuilder; +import java.util.ArrayList; import java.util.List; final class MessagingMetricsAdvice { @@ -28,14 +30,26 @@ final class MessagingMetricsAdvice { AttributeKey.stringKey("messaging.system"); private static final AttributeKey MESSAGING_DESTINATION_NAME = AttributeKey.stringKey("messaging.destination.name"); + private static final AttributeKey MESSAGING_DESTINATION_ANONYMOUS = + AttributeKey.booleanKey("messaging.destination.anonymous"); + private static final AttributeKey MESSAGING_DESTINATION_TEMPORARY = + AttributeKey.booleanKey("messaging.destination.temporary"); private static final AttributeKey MESSAGING_OPERATION = AttributeKey.stringKey("messaging.operation"); + private static final AttributeKey MESSAGING_OPERATION_NAME = + AttributeKey.stringKey("messaging.operation.name"); + private static final AttributeKey MESSAGING_OPERATION_TYPE = + AttributeKey.stringKey("messaging.operation.type"); + private static final AttributeKey MESSAGING_CONSUMER_GROUP_NAME = + AttributeKey.stringKey("messaging.consumer.group.name"); + private static final AttributeKey MESSAGING_DESTINATION_SUBSCRIPTION_NAME = + AttributeKey.stringKey("messaging.destination.subscription.name"); private static final AttributeKey MESSAGING_DESTINATION_PARTITION_ID = AttributeKey.stringKey("messaging.destination.partition.id"); private static final AttributeKey MESSAGING_DESTINATION_TEMPLATE = AttributeKey.stringKey("messaging.destination.template"); - private static final List> MESSAGING_ATTRIBUTES = + private static final List> OLD_ATTRIBUTES = asList( MESSAGING_SYSTEM, MESSAGING_DESTINATION_NAME, @@ -46,25 +60,88 @@ final class MessagingMetricsAdvice { SERVER_PORT, SERVER_ADDRESS); - static void applyPublishDurationAdvice(DoubleHistogramBuilder builder) { + private static final List> CLIENT_OPERATION_DURATION_ATTRIBUTES = + buildAttributes(true, true, true); + private static final List> SENT_MESSAGES_ATTRIBUTES = + buildAttributes(false, false, true); + private static final List> CONSUMED_MESSAGES_ATTRIBUTES = + buildAttributes(true, false, true); + private static final List> PROCESS_DURATION_ATTRIBUTES = + buildAttributes(true, false, true); + + private static List> buildAttributes( + boolean includeConsumerAttributes, boolean includeOperationType, boolean includeErrorType) { + List> attributes = new ArrayList<>(); + attributes.add(MESSAGING_OPERATION_NAME); + attributes.add(MESSAGING_SYSTEM); + if (includeErrorType) { + attributes.add(ERROR_TYPE); + } + if (includeConsumerAttributes) { + attributes.add(MESSAGING_CONSUMER_GROUP_NAME); + } + attributes.add(MESSAGING_DESTINATION_NAME); + if (includeConsumerAttributes) { + attributes.add(MESSAGING_DESTINATION_SUBSCRIPTION_NAME); + } + attributes.add(MESSAGING_DESTINATION_TEMPLATE); + if (includeOperationType) { + attributes.add(MESSAGING_OPERATION_TYPE); + } + attributes.add(MESSAGING_DESTINATION_PARTITION_ID); + return unmodifiableList(attributes); + } + + static Attributes filterAttributes(Attributes attributes) { + if (attributes.get(MESSAGING_DESTINATION_TEMPLATE) == null + && !Boolean.TRUE.equals(attributes.get(MESSAGING_DESTINATION_ANONYMOUS)) + && !Boolean.TRUE.equals(attributes.get(MESSAGING_DESTINATION_TEMPORARY))) { + return attributes; + } + return attributes.toBuilder().remove(MESSAGING_DESTINATION_NAME).build(); + } + + static void applyOldDurationAdvice(DoubleHistogramBuilder builder) { if (!(builder instanceof ExtendedDoubleHistogramBuilder)) { return; } - ((ExtendedDoubleHistogramBuilder) builder).setAttributesAdvice(MESSAGING_ATTRIBUTES); + ((ExtendedDoubleHistogramBuilder) builder).setAttributesAdvice(OLD_ATTRIBUTES); } - static void applyReceiveDurationAdvice(DoubleHistogramBuilder builder) { + static void applyClientOperationDurationAdvice(DoubleHistogramBuilder builder) { if (!(builder instanceof ExtendedDoubleHistogramBuilder)) { return; } - ((ExtendedDoubleHistogramBuilder) builder).setAttributesAdvice(MESSAGING_ATTRIBUTES); + ((ExtendedDoubleHistogramBuilder) builder) + .setAttributesAdvice(CLIENT_OPERATION_DURATION_ATTRIBUTES); + } + + static void applyProcessDurationAdvice(DoubleHistogramBuilder builder) { + if (!(builder instanceof ExtendedDoubleHistogramBuilder)) { + return; + } + ((ExtendedDoubleHistogramBuilder) builder).setAttributesAdvice(PROCESS_DURATION_ATTRIBUTES); + } + + static void applyOldMessagesAdvice(LongCounterBuilder builder) { + if (!(builder instanceof ExtendedLongCounterBuilder)) { + return; + } + ((ExtendedLongCounterBuilder) builder).setAttributesAdvice(OLD_ATTRIBUTES); + } + + static void applySentMessagesAdvice(LongCounterBuilder builder) { + if (!(builder instanceof ExtendedLongCounterBuilder)) { + return; + } + ((ExtendedLongCounterBuilder) builder).setAttributesAdvice(SENT_MESSAGES_ATTRIBUTES); } - static void applyReceiveMessagesAdvice(LongCounterBuilder builder) { + static void applyConsumedMessagesAdvice(LongCounterBuilder builder) { if (!(builder instanceof ExtendedLongCounterBuilder)) { return; } - ((ExtendedLongCounterBuilder) builder).setAttributesAdvice(MESSAGING_ATTRIBUTES); + ((ExtendedLongCounterBuilder) builder).setAttributesAdvice(CONSUMED_MESSAGES_ATTRIBUTES); } private MessagingMetricsAdvice() {} diff --git a/instrumentation-api-incubator/src/main/java/io/opentelemetry/instrumentation/api/incubator/semconv/messaging/MessagingOperationType.java b/instrumentation-api-incubator/src/main/java/io/opentelemetry/instrumentation/api/incubator/semconv/messaging/MessagingOperationType.java new file mode 100644 index 000000000000..53b90807068b --- /dev/null +++ b/instrumentation-api-incubator/src/main/java/io/opentelemetry/instrumentation/api/incubator/semconv/messaging/MessagingOperationType.java @@ -0,0 +1,35 @@ +/* + * Copyright The OpenTelemetry Authors + * SPDX-License-Identifier: Apache-2.0 + */ + +package io.opentelemetry.instrumentation.api.incubator.semconv.messaging; + +/** + * Represents a messaging + * operation type. + */ +public enum MessagingOperationType { + CREATE("create", "create"), + SEND("send", "publish"), + RECEIVE("receive", "receive"), + PROCESS("process", "process"), + SETTLE("settle", "settle"); + + private final String value; + private final String defaultOperationName; + + MessagingOperationType(String value, String defaultOperationName) { + this.value = value; + this.defaultOperationName = defaultOperationName; + } + + String value() { + return value; + } + + String defaultOperationName() { + return defaultOperationName; + } +} diff --git a/instrumentation-api-incubator/src/main/java/io/opentelemetry/instrumentation/api/incubator/semconv/messaging/MessagingProcessMetrics.java b/instrumentation-api-incubator/src/main/java/io/opentelemetry/instrumentation/api/incubator/semconv/messaging/MessagingProcessMetrics.java new file mode 100644 index 000000000000..287741bea625 --- /dev/null +++ b/instrumentation-api-incubator/src/main/java/io/opentelemetry/instrumentation/api/incubator/semconv/messaging/MessagingProcessMetrics.java @@ -0,0 +1,97 @@ +/* + * Copyright The OpenTelemetry Authors + * SPDX-License-Identifier: Apache-2.0 + */ + +package io.opentelemetry.instrumentation.api.incubator.semconv.messaging; + +import static io.opentelemetry.instrumentation.api.internal.SemconvStability.emitStableMessagingSemconv; +import static java.util.concurrent.TimeUnit.SECONDS; +import static java.util.logging.Level.FINE; + +import com.google.auto.value.AutoValue; +import com.google.errorprone.annotations.CanIgnoreReturnValue; +import io.opentelemetry.api.common.Attributes; +import io.opentelemetry.api.metrics.DoubleHistogram; +import io.opentelemetry.api.metrics.DoubleHistogramBuilder; +import io.opentelemetry.api.metrics.Meter; +import io.opentelemetry.context.Context; +import io.opentelemetry.context.ContextKey; +import io.opentelemetry.instrumentation.api.instrumenter.OperationListener; +import io.opentelemetry.instrumentation.api.instrumenter.OperationMetrics; +import io.opentelemetry.instrumentation.api.internal.OperationMetricsUtil; +import java.util.logging.Logger; +import javax.annotation.Nullable; + +/** + * {@link OperationListener} which keeps track of message + * processing metrics. + */ +public final class MessagingProcessMetrics implements OperationListener { + private static final double NANOS_PER_S = SECONDS.toNanos(1); + + private static final ContextKey MESSAGING_PROCESS_METRICS_STATE = + ContextKey.named("messaging-process-metrics-state"); + private static final Logger logger = Logger.getLogger(MessagingProcessMetrics.class.getName()); + + @Nullable private final DoubleHistogram processDurationHistogram; + + private MessagingProcessMetrics(Meter meter) { + processDurationHistogram = emitStableMessagingSemconv() ? buildProcessDuration(meter) : null; + } + + public static OperationMetrics get() { + return OperationMetricsUtil.create("messaging process", MessagingProcessMetrics::new); + } + + @Override + @CanIgnoreReturnValue + public Context onStart(Context context, Attributes startAttributes, long startNanos) { + if (processDurationHistogram == null) { + return context; + } + return context.with( + MESSAGING_PROCESS_METRICS_STATE, + new AutoValue_MessagingProcessMetrics_State(startAttributes, startNanos)); + } + + @Override + public void onEnd(Context context, Attributes endAttributes, long endNanos) { + if (processDurationHistogram == null) { + return; + } + State state = context.get(MESSAGING_PROCESS_METRICS_STATE); + if (state == null) { + logger.log( + FINE, + "No state present when ending context {0}. Cannot record messaging process metrics.", + context); + return; + } + + Attributes attributes = state.startAttributes().toBuilder().putAll(endAttributes).build(); + processDurationHistogram.record( + (endNanos - state.startTimeNanos()) / NANOS_PER_S, + MessagingMetricsAdvice.filterAttributes(attributes), + context); + } + + private static DoubleHistogram buildProcessDuration(Meter meter) { + DoubleHistogramBuilder builder = + meter + .histogramBuilder("messaging.process.duration") + .setDescription("Duration of processing operation.") + .setExplicitBucketBoundariesAdvice(MessagingMetricsAdvice.DURATION_SECONDS_BUCKETS) + .setUnit("s"); + MessagingMetricsAdvice.applyProcessDurationAdvice(builder); + return builder.build(); + } + + @AutoValue + abstract static class State { + abstract Attributes startAttributes(); + + abstract long startTimeNanos(); + } +} diff --git a/instrumentation-api-incubator/src/main/java/io/opentelemetry/instrumentation/api/incubator/semconv/messaging/MessagingProducerMetrics.java b/instrumentation-api-incubator/src/main/java/io/opentelemetry/instrumentation/api/incubator/semconv/messaging/MessagingProducerMetrics.java index ee79fd0c224e..cd022e15a96a 100644 --- a/instrumentation-api-incubator/src/main/java/io/opentelemetry/instrumentation/api/incubator/semconv/messaging/MessagingProducerMetrics.java +++ b/instrumentation-api-incubator/src/main/java/io/opentelemetry/instrumentation/api/incubator/semconv/messaging/MessagingProducerMetrics.java @@ -5,14 +5,19 @@ package io.opentelemetry.instrumentation.api.incubator.semconv.messaging; +import static io.opentelemetry.instrumentation.api.internal.SemconvStability.emitOldMessagingSemconv; +import static io.opentelemetry.instrumentation.api.internal.SemconvStability.emitStableMessagingSemconv; import static java.util.concurrent.TimeUnit.SECONDS; import static java.util.logging.Level.FINE; import com.google.auto.value.AutoValue; import com.google.errorprone.annotations.CanIgnoreReturnValue; +import io.opentelemetry.api.common.AttributeKey; import io.opentelemetry.api.common.Attributes; import io.opentelemetry.api.metrics.DoubleHistogram; import io.opentelemetry.api.metrics.DoubleHistogramBuilder; +import io.opentelemetry.api.metrics.LongCounter; +import io.opentelemetry.api.metrics.LongCounterBuilder; import io.opentelemetry.api.metrics.Meter; import io.opentelemetry.context.Context; import io.opentelemetry.context.ContextKey; @@ -20,34 +25,52 @@ import io.opentelemetry.instrumentation.api.instrumenter.OperationMetrics; import io.opentelemetry.instrumentation.api.internal.OperationMetricsUtil; import java.util.logging.Logger; +import javax.annotation.Nullable; /** * {@link OperationListener} which keeps track of Producer + * href="https://github.com/open-telemetry/semantic-conventions/blob/v1.43.0/docs/messaging/messaging-metrics.md#producer-metrics">producer * metrics. */ public final class MessagingProducerMetrics implements OperationListener { private static final double NANOS_PER_S = SECONDS.toNanos(1); + // copied from MessagingIncubatingAttributes + private static final AttributeKey MESSAGING_BATCH_MESSAGE_COUNT = + AttributeKey.longKey("messaging.batch.message_count"); + private static final AttributeKey MESSAGING_OPERATION = + AttributeKey.stringKey("messaging.operation"); + private static final AttributeKey MESSAGING_OPERATION_TYPE = + AttributeKey.stringKey("messaging.operation.type"); private static final ContextKey MESSAGING_PRODUCER_METRICS_STATE = ContextKey.named("messaging-producer-metrics-state"); private static final Logger logger = Logger.getLogger(MessagingProducerMetrics.class.getName()); - private final DoubleHistogram publishDurationHistogram; + private final boolean supportsStableSemconv; + @Nullable private final DoubleHistogram publishDurationHistogram; + @Nullable private final DoubleHistogram clientOperationDurationHistogram; + @Nullable private final LongCounter sentMessagesCounter; - private MessagingProducerMetrics(Meter meter) { - DoubleHistogramBuilder durationBuilder = - meter - .histogramBuilder("messaging.publish.duration") - .setDescription("Measures the duration of publish operation.") - .setExplicitBucketBoundariesAdvice(MessagingMetricsAdvice.DURATION_SECONDS_BUCKETS) - .setUnit("s"); - MessagingMetricsAdvice.applyPublishDurationAdvice(durationBuilder); - publishDurationHistogram = durationBuilder.build(); + private MessagingProducerMetrics(Meter meter, boolean supportsStableSemconv) { + this.supportsStableSemconv = supportsStableSemconv; + boolean emitOldSemconv = !supportsStableSemconv || emitOldMessagingSemconv(); + boolean emitStableSemconv = supportsStableSemconv && emitStableMessagingSemconv(); + publishDurationHistogram = emitOldSemconv ? buildPublishDuration(meter) : null; + clientOperationDurationHistogram = + emitStableSemconv ? buildClientOperationDuration(meter) : null; + sentMessagesCounter = emitStableSemconv ? buildSentMessages(meter) : null; } + /** Returns metrics for extractors configured with {@link MessageOperation}. */ public static OperationMetrics get() { - return OperationMetricsUtil.create("messaging producer", MessagingProducerMetrics::new); + return OperationMetricsUtil.create( + "messaging producer", meter -> new MessagingProducerMetrics(meter, false)); + } + + /** Returns metrics for extractors configured with {@link MessagingOperationType}. */ + public static OperationMetrics getForOperationType() { + return OperationMetricsUtil.create( + "messaging producer", meter -> new MessagingProducerMetrics(meter, true)); } @Override @@ -70,9 +93,64 @@ public void onEnd(Context context, Attributes endAttributes, long endNanos) { } Attributes attributes = state.startAttributes().toBuilder().putAll(endAttributes).build(); + double duration = (endNanos - state.startTimeNanos()) / NANOS_PER_S; - publishDurationHistogram.record( - (endNanos - state.startTimeNanos()) / NANOS_PER_S, attributes, context); + if (publishDurationHistogram != null + && (!supportsStableSemconv + || "publish".equals(attributes.get(MESSAGING_OPERATION)) + || MessagingOperationType.SEND + .value() + .equals(attributes.get(MESSAGING_OPERATION_TYPE)))) { + publishDurationHistogram.record(duration, attributes, context); + } + Attributes filteredAttributes = + clientOperationDurationHistogram != null || sentMessagesCounter != null + ? MessagingMetricsAdvice.filterAttributes(attributes) + : attributes; + if (clientOperationDurationHistogram != null) { + clientOperationDurationHistogram.record(duration, filteredAttributes, context); + } + if (sentMessagesCounter != null + && MessagingOperationType.SEND.value().equals(attributes.get(MESSAGING_OPERATION_TYPE))) { + Long batchMessageCount = attributes.get(MESSAGING_BATCH_MESSAGE_COUNT); + long sentMessagesCount = batchMessageCount == null ? 1 : batchMessageCount; + if (sentMessagesCount > 0) { + sentMessagesCounter.add(sentMessagesCount, filteredAttributes, context); + } + } + } + + private static DoubleHistogram buildPublishDuration(Meter meter) { + DoubleHistogramBuilder builder = + meter + .histogramBuilder("messaging.publish.duration") + .setDescription("Measures the duration of publish operation.") + .setExplicitBucketBoundariesAdvice(MessagingMetricsAdvice.DURATION_SECONDS_BUCKETS) + .setUnit("s"); + MessagingMetricsAdvice.applyOldDurationAdvice(builder); + return builder.build(); + } + + private static DoubleHistogram buildClientOperationDuration(Meter meter) { + DoubleHistogramBuilder builder = + meter + .histogramBuilder("messaging.client.operation.duration") + .setDescription( + "Duration of messaging operation initiated by a producer or consumer client.") + .setExplicitBucketBoundariesAdvice(MessagingMetricsAdvice.DURATION_SECONDS_BUCKETS) + .setUnit("s"); + MessagingMetricsAdvice.applyClientOperationDurationAdvice(builder); + return builder.build(); + } + + private static LongCounter buildSentMessages(Meter meter) { + LongCounterBuilder builder = + meter + .counterBuilder("messaging.client.sent.messages") + .setDescription("Number of messages producer attempted to send to the broker.") + .setUnit("{message}"); + MessagingMetricsAdvice.applySentMessagesAdvice(builder); + return builder.build(); } @AutoValue diff --git a/instrumentation-api-incubator/src/main/java/io/opentelemetry/instrumentation/api/incubator/semconv/messaging/MessagingSpanKindExtractor.java b/instrumentation-api-incubator/src/main/java/io/opentelemetry/instrumentation/api/incubator/semconv/messaging/MessagingSpanKindExtractor.java new file mode 100644 index 000000000000..4a7008c1420a --- /dev/null +++ b/instrumentation-api-incubator/src/main/java/io/opentelemetry/instrumentation/api/incubator/semconv/messaging/MessagingSpanKindExtractor.java @@ -0,0 +1,80 @@ +/* + * Copyright The OpenTelemetry Authors + * SPDX-License-Identifier: Apache-2.0 + */ + +package io.opentelemetry.instrumentation.api.incubator.semconv.messaging; + +import static io.opentelemetry.instrumentation.api.internal.SemconvStability.emitStableMessagingSemconv; + +import io.opentelemetry.api.trace.SpanKind; +import io.opentelemetry.instrumentation.api.instrumenter.SpanKindExtractor; + +/** Selects messaging span kinds according to the configured semantic convention version. */ +public final class MessagingSpanKindExtractor { + + /** + * Returns a span kind extractor following the v1.43 + * messaging span kind conventions. + */ + public static SpanKindExtractor create(MessagingOperationType operationType) { + return create(operationType, true); + } + + /** + * Returns a span kind extractor following the v1.43 + * messaging span kind conventions. + * + * @param isSpanContextPropagated whether the context of a {@link MessagingOperationType#SEND} + * span is propagated as the message creation context; ignored for other operation types + */ + public static SpanKindExtractor create( + MessagingOperationType operationType, boolean isSpanContextPropagated) { + SpanKind spanKind; + switch (operationType) { + case CREATE: + spanKind = SpanKind.PRODUCER; + break; + case SEND: + spanKind = + emitStableMessagingSemconv() && !isSpanContextPropagated + ? SpanKind.CLIENT + : SpanKind.PRODUCER; + break; + case RECEIVE: + spanKind = emitStableMessagingSemconv() ? SpanKind.CLIENT : SpanKind.CONSUMER; + break; + case PROCESS: + spanKind = SpanKind.CONSUMER; + break; + case SETTLE: + spanKind = SpanKind.CLIENT; + break; + default: + throw new IllegalStateException("Can't possibly happen"); + } + SpanKind result = spanKind; + return request -> result; + } + + /** Returns a span kind extractor for the given operation. */ + public static SpanKindExtractor create(MessageOperation operation) { + SpanKind spanKind; + switch (operation) { + case PUBLISH: + spanKind = SpanKind.PRODUCER; + break; + case RECEIVE: + case PROCESS: + spanKind = SpanKind.CONSUMER; + break; + default: + throw new IllegalStateException("Can't possibly happen"); + } + return request -> spanKind; + } + + private MessagingSpanKindExtractor() {} +} diff --git a/instrumentation-api-incubator/src/main/java/io/opentelemetry/instrumentation/api/incubator/semconv/messaging/MessagingSpanNameExtractor.java b/instrumentation-api-incubator/src/main/java/io/opentelemetry/instrumentation/api/incubator/semconv/messaging/MessagingSpanNameExtractor.java index 624d3b8e00bf..a6d6aa679747 100644 --- a/instrumentation-api-incubator/src/main/java/io/opentelemetry/instrumentation/api/incubator/semconv/messaging/MessagingSpanNameExtractor.java +++ b/instrumentation-api-incubator/src/main/java/io/opentelemetry/instrumentation/api/incubator/semconv/messaging/MessagingSpanNameExtractor.java @@ -5,35 +5,75 @@ package io.opentelemetry.instrumentation.api.incubator.semconv.messaging; +import static io.opentelemetry.instrumentation.api.internal.SemconvStability.emitStableMessagingSemconv; + import io.opentelemetry.instrumentation.api.instrumenter.SpanNameExtractor; public final class MessagingSpanNameExtractor implements SpanNameExtractor { /** * Returns a {@link SpanNameExtractor} that constructs the span name according to - * messaging semantic conventions: {@code }. + * href="https://github.com/open-telemetry/semantic-conventions/blob/v1.43.0/docs/messaging/messaging-spans.md#span-name"> + * messaging semantic conventions. * * @see MessagingAttributesGetter#getDestination(Object) used to extract {@code }. - * @see MessageOperation used to extract {@code }. + * @see MessagingOperationType used to extract {@code }. */ + public static SpanNameExtractor create( + MessagingAttributesGetter getter, MessagingOperationType operationType) { + return builder(getter, operationType).build(); + } + + /** Returns a messaging span name extractor for the given operation. */ public static SpanNameExtractor create( MessagingAttributesGetter getter, MessageOperation operation) { - return new MessagingSpanNameExtractor<>(getter, operation); + return builder(getter, operation).build(); } - private final MessagingAttributesGetter getter; - private final MessageOperation operation; + /** + * Returns a new {@link MessagingSpanNameExtractorBuilder} that can be used to configure the + * messaging span name extractor. + */ + public static MessagingSpanNameExtractorBuilder builder( + MessagingAttributesGetter getter, MessagingOperationType operationType) { + return new MessagingSpanNameExtractorBuilder<>(getter, operationType, true); + } - private MessagingSpanNameExtractor( + /** Returns a messaging span name extractor builder for the given operation. */ + public static MessagingSpanNameExtractorBuilder builder( MessagingAttributesGetter getter, MessageOperation operation) { + return new MessagingSpanNameExtractorBuilder<>(getter, operation.type(), false); + } + + private final MessagingAttributesGetter getter; + private final MessagingOperationType operationType; + private final String operationName; + private final boolean supportsStableSemconv; + + MessagingSpanNameExtractor( + MessagingAttributesGetter getter, + MessagingOperationType operationType, + String operationName, + boolean supportsStableSemconv) { this.getter = getter; - this.operation = operation; + this.operationType = operationType; + this.operationName = operationName; + this.supportsStableSemconv = supportsStableSemconv; } @Override public String extract(REQUEST request) { + if (supportsStableSemconv && emitStableMessagingSemconv()) { + String destinationName = getter.getDestinationTemplate(request); + if (destinationName == null + && !getter.isTemporaryDestination(request) + && !getter.isAnonymousDestination(request)) { + destinationName = getter.getDestination(request); + } + return destinationName == null ? operationName : operationName + " " + destinationName; + } + String destinationName = getter.isTemporaryDestination(request) ? MessagingAttributesExtractor.TEMP_DESTINATION_NAME @@ -42,6 +82,6 @@ public String extract(REQUEST request) { destinationName = "unknown"; } - return destinationName + " " + operation.operationName(); + return destinationName + " " + operationType.defaultOperationName(); } } diff --git a/instrumentation-api-incubator/src/main/java/io/opentelemetry/instrumentation/api/incubator/semconv/messaging/MessagingSpanNameExtractorBuilder.java b/instrumentation-api-incubator/src/main/java/io/opentelemetry/instrumentation/api/incubator/semconv/messaging/MessagingSpanNameExtractorBuilder.java new file mode 100644 index 000000000000..665ceaa58888 --- /dev/null +++ b/instrumentation-api-incubator/src/main/java/io/opentelemetry/instrumentation/api/incubator/semconv/messaging/MessagingSpanNameExtractorBuilder.java @@ -0,0 +1,49 @@ +/* + * Copyright The OpenTelemetry Authors + * SPDX-License-Identifier: Apache-2.0 + */ + +package io.opentelemetry.instrumentation.api.incubator.semconv.messaging; + +import static java.util.Objects.requireNonNull; + +import com.google.errorprone.annotations.CanIgnoreReturnValue; +import io.opentelemetry.instrumentation.api.instrumenter.SpanNameExtractor; + +/** A builder of {@link MessagingSpanNameExtractor}. */ +public final class MessagingSpanNameExtractorBuilder { + + private final MessagingAttributesGetter getter; + private final MessagingOperationType operationType; + private final boolean supportsStableSemconv; + private String operationName; + + MessagingSpanNameExtractorBuilder( + MessagingAttributesGetter getter, + MessagingOperationType operationType, + boolean supportsStableSemconv) { + this.getter = getter; + this.operationType = requireNonNull(operationType, "operationType"); + this.supportsStableSemconv = supportsStableSemconv; + this.operationName = operationType.defaultOperationName(); + } + + /** Configures the system-specific operation name used in the v1.43 messaging span name. */ + @CanIgnoreReturnValue + public MessagingSpanNameExtractorBuilder setOperationName(String operationName) { + if (!supportsStableSemconv) { + throw new IllegalStateException("Operation name is not configurable for legacy builders"); + } + this.operationName = requireNonNull(operationName, "operationName"); + return this; + } + + /** + * Returns a new {@link MessagingSpanNameExtractor} with the settings of this {@link + * MessagingSpanNameExtractorBuilder}. + */ + public SpanNameExtractor build() { + return new MessagingSpanNameExtractor<>( + getter, operationType, operationName, supportsStableSemconv); + } +} diff --git a/instrumentation-api-incubator/src/main/java/io/opentelemetry/instrumentation/api/incubator/semconv/messaging/internal/MessagingProcessContextCustomizer.java b/instrumentation-api-incubator/src/main/java/io/opentelemetry/instrumentation/api/incubator/semconv/messaging/internal/MessagingProcessContextCustomizer.java new file mode 100644 index 000000000000..03b45ddf5c86 --- /dev/null +++ b/instrumentation-api-incubator/src/main/java/io/opentelemetry/instrumentation/api/incubator/semconv/messaging/internal/MessagingProcessContextCustomizer.java @@ -0,0 +1,48 @@ +/* + * Copyright The OpenTelemetry Authors + * SPDX-License-Identifier: Apache-2.0 + */ + +package io.opentelemetry.instrumentation.api.incubator.semconv.messaging.internal; + +import io.opentelemetry.api.common.Attributes; +import io.opentelemetry.api.trace.Span; +import io.opentelemetry.context.Context; +import io.opentelemetry.context.propagation.TextMapGetter; +import io.opentelemetry.context.propagation.TextMapPropagator; +import io.opentelemetry.instrumentation.api.instrumenter.ContextCustomizer; +import java.util.function.BiFunction; + +/** + * This class is internal and is hence not for public use. Its APIs are unstable and can change at + * any time. + */ +public class MessagingProcessContextCustomizer implements ContextCustomizer { + + public static ContextCustomizer create( + TextMapPropagator propagator, TextMapGetter getter) { + return create((parentContext, request) -> propagator.extract(parentContext, request, getter)); + } + + public static ContextCustomizer create( + BiFunction producerContextExtractor) { + return new MessagingProcessContextCustomizer<>(producerContextExtractor); + } + + private final BiFunction producerContextExtractor; + + private MessagingProcessContextCustomizer( + BiFunction producerContextExtractor) { + this.producerContextExtractor = producerContextExtractor; + } + + @Override + public Context onStart(Context parentContext, REQUEST request, Attributes startAttributes) { + Context extractedContext = producerContextExtractor.apply(parentContext, request); + Span parentSpan = Span.fromContext(parentContext); + if (!parentSpan.getSpanContext().isValid()) { + return extractedContext; + } + return extractedContext.with(parentSpan); + } +} diff --git a/instrumentation-api-incubator/src/main/java/io/opentelemetry/instrumentation/api/incubator/semconv/messaging/internal/MessagingProcessInstrumenterFactory.java b/instrumentation-api-incubator/src/main/java/io/opentelemetry/instrumentation/api/incubator/semconv/messaging/internal/MessagingProcessInstrumenterFactory.java new file mode 100644 index 000000000000..726e5ae92194 --- /dev/null +++ b/instrumentation-api-incubator/src/main/java/io/opentelemetry/instrumentation/api/incubator/semconv/messaging/internal/MessagingProcessInstrumenterFactory.java @@ -0,0 +1,55 @@ +/* + * Copyright The OpenTelemetry Authors + * SPDX-License-Identifier: Apache-2.0 + */ + +package io.opentelemetry.instrumentation.api.incubator.semconv.messaging.internal; + +import static io.opentelemetry.instrumentation.api.internal.SemconvStability.emitStableMessagingSemconv; + +import io.opentelemetry.api.trace.Span; +import io.opentelemetry.api.trace.SpanContext; +import io.opentelemetry.context.propagation.TextMapGetter; +import io.opentelemetry.context.propagation.TextMapPropagator; +import io.opentelemetry.instrumentation.api.instrumenter.Instrumenter; +import io.opentelemetry.instrumentation.api.instrumenter.InstrumenterBuilder; +import io.opentelemetry.instrumentation.api.instrumenter.SpanKindExtractor; +import io.opentelemetry.instrumentation.api.internal.PropagatorBasedSpanLinksExtractor; + +/** + * This class is internal and is hence not for public use. Its APIs are unstable and can change at + * any time. + */ +public class MessagingProcessInstrumenterFactory { + + public static Instrumenter create( + InstrumenterBuilder builder, + TextMapPropagator propagator, + TextMapGetter getter, + boolean receiveInstrumentationEnabled) { + if (emitStableMessagingSemconv()) { + builder.addSpanLinksExtractor( + (spanLinks, parentContext, request) -> { + SpanContext parentSpanContext = Span.fromContext(parentContext).getSpanContext(); + SpanContext producerSpanContext = + Span.fromContext(propagator.extract(parentContext, request, getter)) + .getSpanContext(); + if (parentSpanContext.isValid() + && producerSpanContext.isValid() + && (!producerSpanContext.getTraceId().equals(parentSpanContext.getTraceId()) + || !producerSpanContext.getSpanId().equals(parentSpanContext.getSpanId()))) { + spanLinks.addLink(producerSpanContext); + } + }); + builder.addContextCustomizer(MessagingProcessContextCustomizer.create(propagator, getter)); + return builder.buildInstrumenter(SpanKindExtractor.alwaysConsumer()); + } + if (receiveInstrumentationEnabled) { + builder.addSpanLinksExtractor(new PropagatorBasedSpanLinksExtractor<>(propagator, getter)); + return builder.buildInstrumenter(SpanKindExtractor.alwaysConsumer()); + } + return builder.buildConsumerInstrumenter(getter); + } + + private MessagingProcessInstrumenterFactory() {} +} diff --git a/instrumentation-api-incubator/src/test/java/io/opentelemetry/instrumentation/api/incubator/semconv/messaging/MessagingAttributesExtractorTest.java b/instrumentation-api-incubator/src/test/java/io/opentelemetry/instrumentation/api/incubator/semconv/messaging/MessagingAttributesExtractorTest.java index a8d56f7e4f98..2a7959df2b08 100644 --- a/instrumentation-api-incubator/src/test/java/io/opentelemetry/instrumentation/api/incubator/semconv/messaging/MessagingAttributesExtractorTest.java +++ b/instrumentation-api-incubator/src/test/java/io/opentelemetry/instrumentation/api/incubator/semconv/messaging/MessagingAttributesExtractorTest.java @@ -6,7 +6,10 @@ package io.opentelemetry.instrumentation.api.incubator.semconv.messaging; import static io.opentelemetry.api.common.AttributeKey.stringKey; +import static io.opentelemetry.instrumentation.api.internal.SemconvStability.emitOldMessagingSemconv; +import static io.opentelemetry.instrumentation.api.internal.SemconvStability.emitStableMessagingSemconv; import static io.opentelemetry.sdk.testing.assertj.OpenTelemetryAssertions.assertThat; +import static io.opentelemetry.semconv.ErrorAttributes.ERROR_TYPE; import static io.opentelemetry.semconv.incubating.MessagingIncubatingAttributes.MESSAGING_BATCH_MESSAGE_COUNT; import static io.opentelemetry.semconv.incubating.MessagingIncubatingAttributes.MESSAGING_DESTINATION_ANONYMOUS; import static io.opentelemetry.semconv.incubating.MessagingIncubatingAttributes.MESSAGING_DESTINATION_NAME; @@ -17,15 +20,21 @@ import static io.opentelemetry.semconv.incubating.MessagingIncubatingAttributes.MESSAGING_MESSAGE_ENVELOPE_SIZE; import static io.opentelemetry.semconv.incubating.MessagingIncubatingAttributes.MESSAGING_MESSAGE_ID; import static io.opentelemetry.semconv.incubating.MessagingIncubatingAttributes.MESSAGING_OPERATION; +import static io.opentelemetry.semconv.incubating.MessagingIncubatingAttributes.MESSAGING_OPERATION_NAME; +import static io.opentelemetry.semconv.incubating.MessagingIncubatingAttributes.MESSAGING_OPERATION_TYPE; import static io.opentelemetry.semconv.incubating.MessagingIncubatingAttributes.MESSAGING_SYSTEM; import static java.util.Collections.emptyMap; +import static java.util.Collections.singletonMap; +import static org.assertj.core.api.Assertions.assertThatThrownBy; import static org.assertj.core.api.Assertions.entry; +import static org.junit.jupiter.params.provider.Arguments.argumentSet; import io.opentelemetry.api.common.AttributeKey; import io.opentelemetry.api.common.Attributes; import io.opentelemetry.api.common.AttributesBuilder; import io.opentelemetry.context.Context; import io.opentelemetry.instrumentation.api.instrumenter.AttributesExtractor; +import io.opentelemetry.instrumentation.api.internal.SpanKey; import java.util.ArrayList; import java.util.HashMap; import java.util.List; @@ -47,8 +56,8 @@ void shouldExtractAllAvailableAttributes( boolean temporary, boolean anonymous, String destination, - MessageOperation operation, - String expectedDestination) { + MessagingOperationType operationType, + String operationName) { // given Map request = new HashMap<>(); request.put("system", "myQueue"); @@ -63,13 +72,16 @@ void shouldExtractAllAvailableAttributes( } request.put("url", "http://broker/topic"); request.put("conversationId", "42"); + request.put("messageId", "42"); request.put("bodySize", "100"); request.put("envelopeSize", "120"); request.put("clientId", "43"); request.put("batchMessageCount", "2"); AttributesExtractor, String> underTest = - MessagingAttributesExtractor.create(TestGetter.INSTANCE, operation); + MessagingAttributesExtractor.builderForOperationType(TestGetter.INSTANCE, operationType) + .setOperationName(operationName) + .build(); Context context = Context.root(); @@ -78,16 +90,22 @@ void shouldExtractAllAvailableAttributes( underTest.onStart(startAttributes, context, request); AttributesBuilder endAttributes = Attributes.builder(); - underTest.onEnd(endAttributes, context, request, "42", null); + underTest.onEnd(endAttributes, context, request, "42", new IllegalStateException()); // then List, Object>> expectedEntries = new ArrayList<>(); expectedEntries.add(entry(MESSAGING_SYSTEM, "myQueue")); - expectedEntries.add(entry(MESSAGING_DESTINATION_NAME, expectedDestination)); if (temporary) { expectedEntries.add(entry(MESSAGING_DESTINATION_TEMPORARY, true)); + if (emitStableMessagingSemconv()) { + expectedEntries.add(entry(MESSAGING_DESTINATION_NAME, destination)); + expectedEntries.add(entry(MESSAGING_DESTINATION_TEMPLATE, destination)); + } else { + expectedEntries.add(entry(MESSAGING_DESTINATION_NAME, "(temporary)")); + } } else { - expectedEntries.add(entry(MESSAGING_DESTINATION_TEMPLATE, expectedDestination)); + expectedEntries.add(entry(MESSAGING_DESTINATION_NAME, destination)); + expectedEntries.add(entry(MESSAGING_DESTINATION_TEMPLATE, destination)); } if (anonymous) { expectedEntries.add(entry(MESSAGING_DESTINATION_ANONYMOUS, true)); @@ -95,22 +113,154 @@ void shouldExtractAllAvailableAttributes( expectedEntries.add(entry(MESSAGING_MESSAGE_CONVERSATION_ID, "42")); expectedEntries.add(entry(MESSAGING_MESSAGE_BODY_SIZE, 100L)); expectedEntries.add(entry(MESSAGING_MESSAGE_ENVELOPE_SIZE, 120L)); - expectedEntries.add(entry(stringKey("messaging.client_id"), "43")); - expectedEntries.add(entry(MESSAGING_OPERATION, operation.operationName())); + if (emitOldMessagingSemconv()) { + expectedEntries.add(entry(stringKey("messaging.client_id"), "43")); + expectedEntries.add(entry(MESSAGING_OPERATION, operationType.defaultOperationName())); + } + if (emitStableMessagingSemconv()) { + expectedEntries.add(entry(stringKey("messaging.client.id"), "43")); + expectedEntries.add(entry(MESSAGING_OPERATION_NAME, operationName)); + expectedEntries.add(entry(MESSAGING_OPERATION_TYPE, operationType.value())); + } @SuppressWarnings({"unchecked", "rawtypes"}) MapEntry, ?>[] expectedEntriesArr = expectedEntries.toArray(new MapEntry[0]); assertThat(startAttributes.build()).containsOnly(expectedEntriesArr); - assertThat(endAttributes.build()) - .containsOnly(entry(MESSAGING_MESSAGE_ID, "42"), entry(MESSAGING_BATCH_MESSAGE_COUNT, 2L)); + if (emitStableMessagingSemconv()) { + assertThat(endAttributes.build()) + .containsOnly( + entry(MESSAGING_MESSAGE_ID, "42"), + entry(MESSAGING_BATCH_MESSAGE_COUNT, 2L), + entry(ERROR_TYPE, IllegalStateException.class.getName())); + } else { + assertThat(endAttributes.build()) + .containsOnly( + entry(MESSAGING_MESSAGE_ID, "42"), entry(MESSAGING_BATCH_MESSAGE_COUNT, 2L)); + } } static Stream destinations() { return Stream.of( - Arguments.of(false, false, "destination", MessageOperation.RECEIVE, "destination"), - Arguments.of(true, true, null, MessageOperation.PROCESS, "(temporary)")); + argumentSet( + "create operation", + false, + false, + "destination", + MessagingOperationType.CREATE, + "create"), + argumentSet( + "regular destination", + false, + false, + "destination", + MessagingOperationType.RECEIVE, + "poll"), + argumentSet( + "temporary anonymous destination", + true, + true, + "generated-destination", + MessagingOperationType.PROCESS, + "process"), + argumentSet( + "settle operation", + false, + false, + "destination", + MessagingOperationType.SETTLE, + "settle")); + } + + @ParameterizedTest + @MethodSource("spanKeys") + void shouldReturnSpanKey(MessagingOperationType operationType, SpanKey spanKey) { + MessagingAttributesExtractor, String> underTest = + new MessagingAttributesExtractor<>( + TestGetter.INSTANCE, + operationType, + operationType.defaultOperationName(), + true, + new ArrayList<>()); + + assertThat(underTest.internalGetSpanKey()).isSameAs(spanKey); + } + + static Stream spanKeys() { + return Stream.of( + argumentSet("create", MessagingOperationType.CREATE, SpanKey.PRODUCER_CREATE), + argumentSet("send", MessagingOperationType.SEND, SpanKey.PRODUCER), + argumentSet("receive", MessagingOperationType.RECEIVE, SpanKey.CONSUMER_RECEIVE), + argumentSet("process", MessagingOperationType.PROCESS, SpanKey.CONSUMER_PROCESS), + argumentSet("settle", MessagingOperationType.SETTLE, SpanKey.CONSUMER_SETTLE)); + } + + @SuppressWarnings("deprecation") // testing deprecated API + @Test + void shouldSupportDeprecatedMessageOperation() { + AttributesExtractor, String> underTest = + MessagingAttributesExtractor.create(TestGetter.INSTANCE, MessageOperation.PUBLISH); + + AttributesBuilder attributes = Attributes.builder(); + underTest.onStart(attributes, Context.root(), singletonMap("anonymousDestination", "y")); + + assertThat(attributes.build()) + .containsOnly( + entry(MESSAGING_DESTINATION_ANONYMOUS, true), entry(MESSAGING_OPERATION, "publish")); + } + + @SuppressWarnings("deprecation") // testing deprecated API + @Test + void shouldRejectOperationNameForDeprecatedMessageOperation() { + assertThatThrownBy( + () -> + MessagingAttributesExtractor.builder(TestGetter.INSTANCE, MessageOperation.PUBLISH) + .setOperationName("send")) + .isInstanceOf(IllegalStateException.class) + .hasMessage("Operation name is not configurable for legacy builders"); + } + + @Test + void shouldExtractOperationNameWithoutOperationType() { + MessagingOperationType operationType = null; + AttributesExtractor, String> underTest = + MessagingAttributesExtractor.builderForOperationType(TestGetter.INSTANCE, operationType) + .setOperationName("ack") + .build(); + + AttributesBuilder attributes = Attributes.builder(); + underTest.onStart(attributes, Context.root(), emptyMap()); + + Attributes expected = + emitStableMessagingSemconv() + ? Attributes.of(MESSAGING_OPERATION_NAME, "ack") + : Attributes.empty(); + assertThat(attributes.build()).isEqualTo(expected); + } + + @Test + void shouldRequireOperationNameForStableSemconv() { + assertThatThrownBy( + () -> + MessagingAttributesExtractor.builderForOperationType(TestGetter.INSTANCE, null) + .build()) + .isInstanceOf(NullPointerException.class) + .hasMessage("operationName"); + } + + @Test + void shouldExtractErrorTypeFromResponse() { + AttributesExtractor, String> underTest = + MessagingAttributesExtractor.createForOperationType( + TestGetter.INSTANCE, MessagingOperationType.RECEIVE); + + AttributesBuilder attributes = Attributes.builder(); + underTest.onEnd(attributes, Context.root(), emptyMap(), "failure", null); + + Attributes expected = + emitStableMessagingSemconv() ? Attributes.of(ERROR_TYPE, "failure") : Attributes.empty(); + assertThat(attributes.build()).isEqualTo(expected); } @Test @@ -118,20 +268,24 @@ void shouldExtractNoAttributesIfNoneAreAvailable() { // given AttributesExtractor, String> underTest = MessagingAttributesExtractor.create(TestGetter.INSTANCE, null); + AttributesExtractor, String> builtUnderTest = + MessagingAttributesExtractor.builder(TestGetter.INSTANCE, null).build(); Context context = Context.root(); // when AttributesBuilder startAttributes = Attributes.builder(); underTest.onStart(startAttributes, context, emptyMap()); + AttributesBuilder builtStartAttributes = Attributes.builder(); + builtUnderTest.onStart(builtStartAttributes, context, emptyMap()); AttributesBuilder endAttributes = Attributes.builder(); underTest.onEnd(endAttributes, context, emptyMap(), null, null); // then - assertThat(startAttributes.build().isEmpty()).isTrue(); - - assertThat(endAttributes.build().isEmpty()).isTrue(); + assertThat(startAttributes.build()).isEmpty(); + assertThat(builtStartAttributes.build()).isEmpty(); + assertThat(endAttributes.build()).isEmpty(); } enum TestGetter implements MessagingAttributesGetter, String> { @@ -184,7 +338,7 @@ public Long getMessageEnvelopeSize(Map request) { @Override public String getMessageId(Map request, String response) { - return response; + return request.get("messageId"); } @Nullable @@ -199,5 +353,10 @@ public Long getBatchMessageCount(Map request, @Nullable String r String payloadSize = request.get("batchMessageCount"); return payloadSize == null ? null : Long.valueOf(payloadSize); } + + @Override + public String getErrorType(Map request, String response, Throwable error) { + return "failure".equals(response) ? response : null; + } } } diff --git a/instrumentation-api-incubator/src/test/java/io/opentelemetry/instrumentation/api/incubator/semconv/messaging/MessagingConsumerMetricsTest.java b/instrumentation-api-incubator/src/test/java/io/opentelemetry/instrumentation/api/incubator/semconv/messaging/MessagingConsumerMetricsTest.java new file mode 100644 index 000000000000..07579a6db3fe --- /dev/null +++ b/instrumentation-api-incubator/src/test/java/io/opentelemetry/instrumentation/api/incubator/semconv/messaging/MessagingConsumerMetricsTest.java @@ -0,0 +1,359 @@ +/* + * Copyright The OpenTelemetry Authors + * SPDX-License-Identifier: Apache-2.0 + */ + +package io.opentelemetry.instrumentation.api.incubator.semconv.messaging; + +import static io.opentelemetry.instrumentation.api.internal.SemconvStability.emitOldMessagingSemconv; +import static io.opentelemetry.instrumentation.api.internal.SemconvStability.emitStableMessagingSemconv; +import static io.opentelemetry.sdk.testing.assertj.OpenTelemetryAssertions.assertThat; +import static io.opentelemetry.sdk.testing.assertj.OpenTelemetryAssertions.equalTo; +import static io.opentelemetry.semconv.ErrorAttributes.ERROR_TYPE; +import static io.opentelemetry.semconv.incubating.MessagingIncubatingAttributes.MESSAGING_BATCH_MESSAGE_COUNT; +import static io.opentelemetry.semconv.incubating.MessagingIncubatingAttributes.MESSAGING_CONSUMER_GROUP_NAME; +import static io.opentelemetry.semconv.incubating.MessagingIncubatingAttributes.MESSAGING_DESTINATION_NAME; +import static io.opentelemetry.semconv.incubating.MessagingIncubatingAttributes.MESSAGING_DESTINATION_SUBSCRIPTION_NAME; +import static io.opentelemetry.semconv.incubating.MessagingIncubatingAttributes.MESSAGING_DESTINATION_TEMPLATE; +import static io.opentelemetry.semconv.incubating.MessagingIncubatingAttributes.MESSAGING_OPERATION; +import static io.opentelemetry.semconv.incubating.MessagingIncubatingAttributes.MESSAGING_OPERATION_NAME; +import static io.opentelemetry.semconv.incubating.MessagingIncubatingAttributes.MESSAGING_OPERATION_TYPE; +import static io.opentelemetry.semconv.incubating.MessagingIncubatingAttributes.MESSAGING_SYSTEM; +import static java.util.concurrent.TimeUnit.MILLISECONDS; +import static org.junit.jupiter.params.provider.Arguments.argumentSet; + +import io.opentelemetry.api.common.Attributes; +import io.opentelemetry.context.Context; +import io.opentelemetry.instrumentation.api.instrumenter.OperationListener; +import io.opentelemetry.sdk.metrics.SdkMeterProvider; +import io.opentelemetry.sdk.metrics.data.MetricData; +import io.opentelemetry.sdk.testing.exporter.InMemoryMetricReader; +import java.util.Collection; +import java.util.stream.Stream; +import org.junit.jupiter.api.Test; +import org.junit.jupiter.params.ParameterizedTest; +import org.junit.jupiter.params.provider.Arguments; +import org.junit.jupiter.params.provider.MethodSource; + +class MessagingConsumerMetricsTest { + + private static final double[] DURATION_BUCKETS = + MessagingMetricsAdvice.DURATION_SECONDS_BUCKETS.stream().mapToDouble(d -> d).toArray(); + + @Test + @SuppressWarnings("deprecation") // using deprecated semconv + void collectsMetricsAndCountsBatchOnce() { + InMemoryMetricReader metricReader = InMemoryMetricReader.createDelta(); + SdkMeterProvider meterProvider = + SdkMeterProvider.builder().registerMetricReader(metricReader).build(); + OperationListener listener = + MessagingConsumerMetrics.getForOperationType().create(meterProvider.get("test")); + + Attributes requestAttributes = + Attributes.builder() + .put(MESSAGING_SYSTEM, "pulsar") + .put(MESSAGING_DESTINATION_NAME, "topic") + .put(MESSAGING_DESTINATION_TEMPLATE, "topic-{id}") + .put(MESSAGING_OPERATION, emitOldMessagingSemconv() ? "receive" : null) + .put(MESSAGING_OPERATION_NAME, emitStableMessagingSemconv() ? "receive" : null) + .put(MESSAGING_OPERATION_TYPE, emitStableMessagingSemconv() ? "receive" : null) + .put(MESSAGING_CONSUMER_GROUP_NAME, "group") + .put(MESSAGING_DESTINATION_SUBSCRIPTION_NAME, "subscription") + .build(); + Attributes responseAttributes = + Attributes.builder() + .put(MESSAGING_BATCH_MESSAGE_COUNT, 3) + .put( + ERROR_TYPE, + emitStableMessagingSemconv() ? IllegalStateException.class.getName() : null) + .build(); + + Context context = listener.onStart(Context.root(), requestAttributes, nanos(100)); + listener.onEnd(context, responseAttributes, nanos(300)); + + Collection metrics = metricReader.collectAllMetrics(); + assertThat(metrics) + .hasSize((emitOldMessagingSemconv() ? 2 : 0) + (emitStableMessagingSemconv() ? 2 : 0)); + + if (emitOldMessagingSemconv()) { + assertThat(metrics) + .anySatisfy( + metric -> + assertThat(metric) + .hasName("messaging.receive.duration") + .hasUnit("s") + .hasDescription("Measures the duration of receive operation.") + .hasHistogramSatisfying( + histogram -> + histogram.hasPointsSatisfying( + point -> + point + .hasSum(0.2) + .hasBucketBoundaries(DURATION_BUCKETS) + .hasAttributesSatisfyingExactly( + equalTo(MESSAGING_SYSTEM, "pulsar"), + equalTo(MESSAGING_DESTINATION_NAME, "topic"), + equalTo(MESSAGING_DESTINATION_TEMPLATE, "topic-{id}"), + equalTo(MESSAGING_OPERATION, "receive"), + equalTo( + ERROR_TYPE, + emitStableMessagingSemconv() + ? IllegalStateException.class.getName() + : null))))) + .anySatisfy( + metric -> + assertThat(metric) + .hasName("messaging.receive.messages") + .hasUnit("{message}") + .hasDescription("Measures the number of received messages.") + .hasLongSumSatisfying( + sum -> + sum.hasPointsSatisfying( + point -> + point + .hasValue(3) + .hasAttributesSatisfyingExactly( + equalTo(MESSAGING_SYSTEM, "pulsar"), + equalTo(MESSAGING_DESTINATION_NAME, "topic"), + equalTo(MESSAGING_DESTINATION_TEMPLATE, "topic-{id}"), + equalTo(MESSAGING_OPERATION, "receive"), + equalTo( + ERROR_TYPE, + emitStableMessagingSemconv() + ? IllegalStateException.class.getName() + : null))))); + } + if (emitStableMessagingSemconv()) { + assertThat(metrics) + .anySatisfy( + metric -> + assertThat(metric) + .hasName("messaging.client.operation.duration") + .hasUnit("s") + .hasDescription( + "Duration of messaging operation initiated by a producer or consumer client.") + .hasHistogramSatisfying( + histogram -> + histogram.hasPointsSatisfying( + point -> + point + .hasSum(0.2) + .hasBucketBoundaries(DURATION_BUCKETS) + .hasAttributesSatisfyingExactly( + equalTo(MESSAGING_OPERATION_NAME, "receive"), + equalTo(MESSAGING_SYSTEM, "pulsar"), + equalTo(MESSAGING_CONSUMER_GROUP_NAME, "group"), + equalTo(MESSAGING_DESTINATION_TEMPLATE, "topic-{id}"), + equalTo( + MESSAGING_DESTINATION_SUBSCRIPTION_NAME, + "subscription"), + equalTo( + ERROR_TYPE, + IllegalStateException.class.getName()), + equalTo(MESSAGING_OPERATION_TYPE, "receive"))))) + .anySatisfy( + metric -> + assertThat(metric) + .hasName("messaging.client.consumed.messages") + .hasUnit("{message}") + .hasDescription("Number of messages that were delivered to the application.") + .hasLongSumSatisfying( + sum -> + sum.hasPointsSatisfying( + point -> + point + .hasValue(3) + .hasAttributesSatisfyingExactly( + equalTo(MESSAGING_OPERATION_NAME, "receive"), + equalTo(MESSAGING_SYSTEM, "pulsar"), + equalTo( + ERROR_TYPE, + IllegalStateException.class.getName()), + equalTo(MESSAGING_CONSUMER_GROUP_NAME, "group"), + equalTo(MESSAGING_DESTINATION_TEMPLATE, "topic-{id}"), + equalTo( + MESSAGING_DESTINATION_SUBSCRIPTION_NAME, + "subscription"))))); + } + } + + @Test + @SuppressWarnings("deprecation") // using deprecated semconv + void failedReceiveWithoutBatchCountCountsNoConsumedMessages() { + InMemoryMetricReader metricReader = InMemoryMetricReader.createDelta(); + SdkMeterProvider meterProvider = + SdkMeterProvider.builder().registerMetricReader(metricReader).build(); + OperationListener listener = + MessagingConsumerMetrics.getForOperationType().create(meterProvider.get("test")); + + Attributes requestAttributes = + Attributes.builder() + .put(MESSAGING_SYSTEM, "pulsar") + .put(MESSAGING_OPERATION, emitOldMessagingSemconv() ? "receive" : null) + .put(MESSAGING_OPERATION_NAME, emitStableMessagingSemconv() ? "receive" : null) + .put(MESSAGING_OPERATION_TYPE, emitStableMessagingSemconv() ? "receive" : null) + .build(); + Attributes responseAttributes = + Attributes.of(ERROR_TYPE, IllegalStateException.class.getName()); + + Context context = listener.onStart(Context.root(), requestAttributes, nanos(100)); + listener.onEnd(context, responseAttributes, nanos(300)); + + Collection metrics = metricReader.collectAllMetrics(); + if (emitOldMessagingSemconv()) { + assertThat(metrics) + .anySatisfy( + metric -> + assertThat(metric) + .hasName("messaging.receive.messages") + .hasLongSumSatisfying( + sum -> sum.hasPointsSatisfying(point -> point.hasValue(1)))); + } + if (emitStableMessagingSemconv()) { + assertThat(metrics) + .anySatisfy(metric -> assertThat(metric).hasName("messaging.client.operation.duration")) + .noneSatisfy(metric -> assertThat(metric).hasName("messaging.client.consumed.messages")); + } + } + + @Test + @SuppressWarnings("deprecation") // using deprecated semconv + void consumedMessagesOnlyCountsFailedDelivery() { + InMemoryMetricReader metricReader = InMemoryMetricReader.createDelta(); + SdkMeterProvider meterProvider = + SdkMeterProvider.builder().registerMetricReader(metricReader).build(); + OperationListener listener = + MessagingConsumerMetrics.getConsumedMessages().create(meterProvider.get("test")); + + Attributes attributes = + Attributes.builder() + .put(MESSAGING_SYSTEM, "pulsar") + .put(MESSAGING_DESTINATION_NAME, "topic") + .put(MESSAGING_OPERATION, emitOldMessagingSemconv() ? "process" : null) + .put(MESSAGING_OPERATION_NAME, emitStableMessagingSemconv() ? "process" : null) + .put(MESSAGING_OPERATION_TYPE, emitStableMessagingSemconv() ? "process" : null) + .build(); + Context context = listener.onStart(Context.root(), attributes, nanos(100)); + listener.onEnd( + context, Attributes.of(ERROR_TYPE, IllegalStateException.class.getName()), nanos(300)); + + Collection metrics = metricReader.collectAllMetrics(); + if (!emitStableMessagingSemconv()) { + assertThat(metrics).isEmpty(); + return; + } + assertThat(metrics) + .satisfiesExactly( + metric -> + assertThat(metric) + .hasName("messaging.client.consumed.messages") + .hasLongSumSatisfying( + sum -> + sum.hasPointsSatisfying( + point -> + point + .hasValue(1) + .hasAttributesSatisfyingExactly( + equalTo(MESSAGING_OPERATION_NAME, "process"), + equalTo(MESSAGING_SYSTEM, "pulsar"), + equalTo(MESSAGING_DESTINATION_NAME, "topic"), + equalTo( + ERROR_TYPE, + IllegalStateException.class.getName()))))); + } + + @ParameterizedTest + @MethodSource("nonReceiveOperations") + @SuppressWarnings("deprecation") // using deprecated semconv + void selectsStableMetricsByOperationType(String operationType, boolean recordsClientDuration) { + InMemoryMetricReader metricReader = InMemoryMetricReader.createDelta(); + SdkMeterProvider meterProvider = + SdkMeterProvider.builder().registerMetricReader(metricReader).build(); + OperationListener listener = + MessagingConsumerMetrics.getForOperationType().create(meterProvider.get("test")); + + Attributes attributes = + Attributes.builder() + .put(MESSAGING_OPERATION, emitOldMessagingSemconv() ? operationType : null) + .put(MESSAGING_OPERATION_NAME, emitStableMessagingSemconv() ? operationType : null) + .put(MESSAGING_OPERATION_TYPE, emitStableMessagingSemconv() ? operationType : null) + .build(); + Context context = listener.onStart(Context.root(), attributes, nanos(100)); + listener.onEnd(context, Attributes.empty(), nanos(300)); + + Collection metrics = metricReader.collectAllMetrics(); + assertThat( + metrics.stream() + .filter(metric -> metric.getName().equals("messaging.client.operation.duration")) + .count()) + .isEqualTo(emitStableMessagingSemconv() && recordsClientDuration ? 1 : 0); + assertThat( + metrics.stream() + .filter(metric -> metric.getName().equals("messaging.client.consumed.messages")) + .count()) + .isZero(); + assertThat( + metrics.stream() + .filter(metric -> metric.getName().equals("messaging.receive.duration")) + .count()) + .isZero(); + assertThat( + metrics.stream() + .filter(metric -> metric.getName().equals("messaging.receive.messages")) + .count()) + .isZero(); + } + + @Test + @SuppressWarnings("deprecation") // using deprecated semconv + void zeroBatchDoesNotCountReceivedMessages() { + InMemoryMetricReader metricReader = InMemoryMetricReader.createDelta(); + SdkMeterProvider meterProvider = + SdkMeterProvider.builder().registerMetricReader(metricReader).build(); + OperationListener listener = + MessagingConsumerMetrics.getForOperationType().create(meterProvider.get("test")); + + Attributes attributes = + Attributes.builder() + .put(MESSAGING_OPERATION, emitOldMessagingSemconv() ? "receive" : null) + .put(MESSAGING_OPERATION_NAME, emitStableMessagingSemconv() ? "receive" : null) + .put(MESSAGING_OPERATION_TYPE, emitStableMessagingSemconv() ? "receive" : null) + .put(MESSAGING_BATCH_MESSAGE_COUNT, 0) + .build(); + Context context = listener.onStart(Context.root(), attributes, nanos(100)); + listener.onEnd(context, Attributes.empty(), nanos(300)); + + assertThat(metricReader.collectAllMetrics()) + .noneSatisfy(metric -> assertThat(metric).hasName("messaging.receive.messages")); + } + + private static Stream nonReceiveOperations() { + return Stream.of( + argumentSet("process", "process", false), argumentSet("settle", "settle", true)); + } + + @Test + @SuppressWarnings("deprecation") // using deprecated semconv + void legacyEntryPointAlwaysCollectsLegacyMetrics() { + InMemoryMetricReader metricReader = InMemoryMetricReader.createDelta(); + SdkMeterProvider meterProvider = + SdkMeterProvider.builder().registerMetricReader(metricReader).build(); + OperationListener listener = MessagingConsumerMetrics.get().create(meterProvider.get("test")); + + Context context = + listener.onStart( + Context.root(), + Attributes.of(MESSAGING_SYSTEM, "pulsar", MESSAGING_OPERATION, "receive"), + nanos(100)); + listener.onEnd(context, Attributes.empty(), nanos(300)); + + assertThat(metricReader.collectAllMetrics()) + .hasSize(2) + .anySatisfy(metric -> assertThat(metric).hasName("messaging.receive.duration")) + .anySatisfy(metric -> assertThat(metric).hasName("messaging.receive.messages")); + } + + private static long nanos(int millis) { + return MILLISECONDS.toNanos(millis); + } +} diff --git a/instrumentation-api-incubator/src/test/java/io/opentelemetry/instrumentation/api/incubator/semconv/messaging/MessagingMetricsAdviceTest.java b/instrumentation-api-incubator/src/test/java/io/opentelemetry/instrumentation/api/incubator/semconv/messaging/MessagingMetricsAdviceTest.java new file mode 100644 index 000000000000..d070e72b9998 --- /dev/null +++ b/instrumentation-api-incubator/src/test/java/io/opentelemetry/instrumentation/api/incubator/semconv/messaging/MessagingMetricsAdviceTest.java @@ -0,0 +1,47 @@ +/* + * Copyright The OpenTelemetry Authors + * SPDX-License-Identifier: Apache-2.0 + */ + +package io.opentelemetry.instrumentation.api.incubator.semconv.messaging; + +import static io.opentelemetry.sdk.testing.assertj.OpenTelemetryAssertions.assertThat; +import static io.opentelemetry.semconv.incubating.MessagingIncubatingAttributes.MESSAGING_DESTINATION_ANONYMOUS; +import static io.opentelemetry.semconv.incubating.MessagingIncubatingAttributes.MESSAGING_DESTINATION_NAME; +import static io.opentelemetry.semconv.incubating.MessagingIncubatingAttributes.MESSAGING_DESTINATION_TEMPLATE; +import static io.opentelemetry.semconv.incubating.MessagingIncubatingAttributes.MESSAGING_DESTINATION_TEMPORARY; + +import io.opentelemetry.api.common.Attributes; +import org.junit.jupiter.api.Test; + +class MessagingMetricsAdviceTest { + + @Test + @SuppressWarnings("deprecation") // using deprecated semconv + void filtersHighCardinalityDestinationNames() { + Attributes lowCardinality = Attributes.of(MESSAGING_DESTINATION_NAME, "orders"); + assertThat(MessagingMetricsAdvice.filterAttributes(lowCardinality)).isSameAs(lowCardinality); + + assertThat( + MessagingMetricsAdvice.filterAttributes( + Attributes.builder() + .put(MESSAGING_DESTINATION_NAME, "orders-42") + .put(MESSAGING_DESTINATION_TEMPLATE, "orders-{id}") + .build())) + .isEqualTo(Attributes.of(MESSAGING_DESTINATION_TEMPLATE, "orders-{id}")); + assertThat( + MessagingMetricsAdvice.filterAttributes( + Attributes.builder() + .put(MESSAGING_DESTINATION_NAME, "tmp-42") + .put(MESSAGING_DESTINATION_TEMPORARY, true) + .build())) + .isEqualTo(Attributes.of(MESSAGING_DESTINATION_TEMPORARY, true)); + assertThat( + MessagingMetricsAdvice.filterAttributes( + Attributes.builder() + .put(MESSAGING_DESTINATION_NAME, "generated-42") + .put(MESSAGING_DESTINATION_ANONYMOUS, true) + .build())) + .isEqualTo(Attributes.of(MESSAGING_DESTINATION_ANONYMOUS, true)); + } +} diff --git a/instrumentation-api-incubator/src/test/java/io/opentelemetry/instrumentation/api/incubator/semconv/messaging/MessagingProcessMetricsTest.java b/instrumentation-api-incubator/src/test/java/io/opentelemetry/instrumentation/api/incubator/semconv/messaging/MessagingProcessMetricsTest.java new file mode 100644 index 000000000000..19b20b4888e6 --- /dev/null +++ b/instrumentation-api-incubator/src/test/java/io/opentelemetry/instrumentation/api/incubator/semconv/messaging/MessagingProcessMetricsTest.java @@ -0,0 +1,93 @@ +/* + * Copyright The OpenTelemetry Authors + * SPDX-License-Identifier: Apache-2.0 + */ + +package io.opentelemetry.instrumentation.api.incubator.semconv.messaging; + +import static io.opentelemetry.instrumentation.api.internal.SemconvStability.emitOldMessagingSemconv; +import static io.opentelemetry.instrumentation.api.internal.SemconvStability.emitStableMessagingSemconv; +import static io.opentelemetry.sdk.testing.assertj.OpenTelemetryAssertions.assertThat; +import static io.opentelemetry.sdk.testing.assertj.OpenTelemetryAssertions.equalTo; +import static io.opentelemetry.semconv.ErrorAttributes.ERROR_TYPE; +import static io.opentelemetry.semconv.incubating.MessagingIncubatingAttributes.MESSAGING_DESTINATION_NAME; +import static io.opentelemetry.semconv.incubating.MessagingIncubatingAttributes.MESSAGING_DESTINATION_TEMPLATE; +import static io.opentelemetry.semconv.incubating.MessagingIncubatingAttributes.MESSAGING_OPERATION; +import static io.opentelemetry.semconv.incubating.MessagingIncubatingAttributes.MESSAGING_OPERATION_NAME; +import static io.opentelemetry.semconv.incubating.MessagingIncubatingAttributes.MESSAGING_OPERATION_TYPE; +import static io.opentelemetry.semconv.incubating.MessagingIncubatingAttributes.MESSAGING_SYSTEM; +import static java.util.concurrent.TimeUnit.MILLISECONDS; + +import io.opentelemetry.api.common.Attributes; +import io.opentelemetry.context.Context; +import io.opentelemetry.instrumentation.api.instrumenter.OperationListener; +import io.opentelemetry.sdk.metrics.SdkMeterProvider; +import io.opentelemetry.sdk.testing.exporter.InMemoryMetricReader; +import org.junit.jupiter.api.Test; + +class MessagingProcessMetricsTest { + + private static final double[] DURATION_BUCKETS = + MessagingMetricsAdvice.DURATION_SECONDS_BUCKETS.stream().mapToDouble(d -> d).toArray(); + + @Test + @SuppressWarnings("deprecation") // using deprecated semconv + void emitsProcessDurationAccordingToConfiguration() { + InMemoryMetricReader metricReader = InMemoryMetricReader.createDelta(); + SdkMeterProvider meterProvider = + SdkMeterProvider.builder().registerMetricReader(metricReader).build(); + OperationListener listener = MessagingProcessMetrics.get().create(meterProvider.get("test")); + + Attributes attributes = + Attributes.builder() + .put(MESSAGING_SYSTEM, "pulsar") + .put(MESSAGING_DESTINATION_NAME, "topic") + .put(MESSAGING_DESTINATION_TEMPLATE, "topic-{id}") + .put(MESSAGING_OPERATION, emitOldMessagingSemconv() ? "process" : null) + .put(MESSAGING_OPERATION_NAME, emitStableMessagingSemconv() ? "process" : null) + .put(MESSAGING_OPERATION_TYPE, emitStableMessagingSemconv() ? "process" : null) + .build(); + + Context root = Context.root(); + Context context = listener.onStart(root, attributes, nanos(100)); + Attributes endAttributes = + Attributes.builder() + .put( + ERROR_TYPE, + emitStableMessagingSemconv() ? IllegalStateException.class.getName() : null) + .build(); + listener.onEnd(context, endAttributes, nanos(350)); + + if (!emitStableMessagingSemconv()) { + assertThat(context).isSameAs(root); + assertThat(metricReader.collectAllMetrics()).isEmpty(); + return; + } + + assertThat(metricReader.collectAllMetrics()) + .satisfiesExactly( + metric -> + assertThat(metric) + .hasName("messaging.process.duration") + .hasUnit("s") + .hasDescription("Duration of processing operation.") + .hasHistogramSatisfying( + histogram -> + histogram.hasPointsSatisfying( + point -> + point + .hasSum(0.25) + .hasBucketBoundaries(DURATION_BUCKETS) + .hasAttributesSatisfyingExactly( + equalTo(MESSAGING_OPERATION_NAME, "process"), + equalTo(MESSAGING_SYSTEM, "pulsar"), + equalTo(MESSAGING_DESTINATION_TEMPLATE, "topic-{id}"), + equalTo( + ERROR_TYPE, + IllegalStateException.class.getName()))))); + } + + private static long nanos(int millis) { + return MILLISECONDS.toNanos(millis); + } +} diff --git a/instrumentation-api-incubator/src/test/java/io/opentelemetry/instrumentation/api/incubator/semconv/messaging/MessagingProducerMetricsTest.java b/instrumentation-api-incubator/src/test/java/io/opentelemetry/instrumentation/api/incubator/semconv/messaging/MessagingProducerMetricsTest.java index f155a613b349..7b0fd694862e 100644 --- a/instrumentation-api-incubator/src/test/java/io/opentelemetry/instrumentation/api/incubator/semconv/messaging/MessagingProducerMetricsTest.java +++ b/instrumentation-api-incubator/src/test/java/io/opentelemetry/instrumentation/api/incubator/semconv/messaging/MessagingProducerMetricsTest.java @@ -5,26 +5,30 @@ package io.opentelemetry.instrumentation.api.incubator.semconv.messaging; +import static io.opentelemetry.instrumentation.api.internal.SemconvStability.emitOldMessagingSemconv; +import static io.opentelemetry.instrumentation.api.internal.SemconvStability.emitStableMessagingSemconv; import static io.opentelemetry.sdk.testing.assertj.OpenTelemetryAssertions.assertThat; import static io.opentelemetry.sdk.testing.assertj.OpenTelemetryAssertions.equalTo; +import static io.opentelemetry.semconv.ErrorAttributes.ERROR_TYPE; import static io.opentelemetry.semconv.ServerAttributes.SERVER_ADDRESS; import static io.opentelemetry.semconv.ServerAttributes.SERVER_PORT; +import static io.opentelemetry.semconv.incubating.MessagingIncubatingAttributes.MESSAGING_BATCH_MESSAGE_COUNT; import static io.opentelemetry.semconv.incubating.MessagingIncubatingAttributes.MESSAGING_DESTINATION_NAME; import static io.opentelemetry.semconv.incubating.MessagingIncubatingAttributes.MESSAGING_DESTINATION_PARTITION_ID; -import static io.opentelemetry.semconv.incubating.MessagingIncubatingAttributes.MESSAGING_MESSAGE_ID; +import static io.opentelemetry.semconv.incubating.MessagingIncubatingAttributes.MESSAGING_DESTINATION_TEMPLATE; import static io.opentelemetry.semconv.incubating.MessagingIncubatingAttributes.MESSAGING_OPERATION; +import static io.opentelemetry.semconv.incubating.MessagingIncubatingAttributes.MESSAGING_OPERATION_NAME; +import static io.opentelemetry.semconv.incubating.MessagingIncubatingAttributes.MESSAGING_OPERATION_TYPE; import static io.opentelemetry.semconv.incubating.MessagingIncubatingAttributes.MESSAGING_SYSTEM; import static java.util.concurrent.TimeUnit.MILLISECONDS; import io.opentelemetry.api.common.Attributes; -import io.opentelemetry.api.trace.Span; -import io.opentelemetry.api.trace.SpanContext; -import io.opentelemetry.api.trace.TraceFlags; -import io.opentelemetry.api.trace.TraceState; import io.opentelemetry.context.Context; import io.opentelemetry.instrumentation.api.instrumenter.OperationListener; import io.opentelemetry.sdk.metrics.SdkMeterProvider; +import io.opentelemetry.sdk.metrics.data.MetricData; import io.opentelemetry.sdk.testing.exporter.InMemoryMetricReader; +import java.util.Collection; import org.junit.jupiter.api.Test; class MessagingProducerMetricsTest { @@ -32,89 +36,196 @@ class MessagingProducerMetricsTest { private static final double[] DURATION_BUCKETS = MessagingMetricsAdvice.DURATION_SECONDS_BUCKETS.stream().mapToDouble(d -> d).toArray(); - @SuppressWarnings("deprecation") // using deprecated semconv @Test + @SuppressWarnings("deprecation") // using deprecated semconv void collectsMetrics() { - InMemoryMetricReader metricReader = InMemoryMetricReader.create(); + InMemoryMetricReader metricReader = InMemoryMetricReader.createDelta(); SdkMeterProvider meterProvider = SdkMeterProvider.builder().registerMetricReader(metricReader).build(); - - OperationListener listener = MessagingProducerMetrics.get().create(meterProvider.get("test")); + OperationListener listener = + MessagingProducerMetrics.getForOperationType().create(meterProvider.get("test")); Attributes requestAttributes = Attributes.builder() .put(MESSAGING_SYSTEM, "pulsar") - .put(MESSAGING_DESTINATION_NAME, "persistent://public/default/topic") - .put(MESSAGING_OPERATION, "publish") - .put(SERVER_PORT, 6650) + .put(MESSAGING_DESTINATION_NAME, "topic") + .put(MESSAGING_DESTINATION_TEMPLATE, "topic-{id}") + .put(MESSAGING_OPERATION, emitOldMessagingSemconv() ? "publish" : null) + .put(MESSAGING_OPERATION_NAME, emitStableMessagingSemconv() ? "send" : null) + .put(MESSAGING_OPERATION_TYPE, emitStableMessagingSemconv() ? "send" : null) .put(SERVER_ADDRESS, "localhost") + .put(SERVER_PORT, 6650) .build(); - Attributes responseAttributes = Attributes.builder() - .put(MESSAGING_MESSAGE_ID, "1:1:0:0") .put(MESSAGING_DESTINATION_PARTITION_ID, "1") + .put(MESSAGING_BATCH_MESSAGE_COUNT, 2) + .put( + ERROR_TYPE, + emitStableMessagingSemconv() ? IllegalStateException.class.getName() : null) .build(); - Context parent = - Context.root() - .with( - Span.wrap( - SpanContext.create( - "ff01020304050600ff0a0b0c0d0e0f00", - "090a0b0c0d0e0f00", - TraceFlags.getSampled(), - TraceState.getDefault()))); - - Context context1 = listener.onStart(parent, requestAttributes, nanos(100)); + Context context = listener.onStart(Context.root(), requestAttributes, nanos(100)); + listener.onEnd(context, responseAttributes, nanos(250)); + + Collection metrics = metricReader.collectAllMetrics(); + assertThat(metrics) + .hasSize((emitOldMessagingSemconv() ? 1 : 0) + (emitStableMessagingSemconv() ? 2 : 0)); + + if (emitOldMessagingSemconv()) { + assertThat(metrics) + .anySatisfy( + metric -> + assertThat(metric) + .hasName("messaging.publish.duration") + .hasUnit("s") + .hasDescription("Measures the duration of publish operation.") + .hasHistogramSatisfying( + histogram -> + histogram.hasPointsSatisfying( + point -> + point + .hasSum(0.15) + .hasBucketBoundaries(DURATION_BUCKETS) + .hasAttributesSatisfyingExactly( + equalTo(MESSAGING_SYSTEM, "pulsar"), + equalTo(MESSAGING_DESTINATION_NAME, "topic"), + equalTo(MESSAGING_OPERATION, "publish"), + equalTo(MESSAGING_DESTINATION_PARTITION_ID, "1"), + equalTo(MESSAGING_DESTINATION_TEMPLATE, "topic-{id}"), + equalTo( + ERROR_TYPE, + emitStableMessagingSemconv() + ? IllegalStateException.class.getName() + : null), + equalTo(SERVER_PORT, 6650), + equalTo(SERVER_ADDRESS, "localhost"))))); + } + if (emitStableMessagingSemconv()) { + assertThat(metrics) + .anySatisfy( + metric -> + assertThat(metric) + .hasName("messaging.client.operation.duration") + .hasUnit("s") + .hasDescription( + "Duration of messaging operation initiated by a producer or consumer client.") + .hasHistogramSatisfying( + histogram -> + histogram.hasPointsSatisfying( + point -> + point + .hasSum(0.15) + .hasBucketBoundaries(DURATION_BUCKETS) + .hasAttributesSatisfyingExactly( + equalTo(MESSAGING_OPERATION_NAME, "send"), + equalTo(MESSAGING_SYSTEM, "pulsar"), + equalTo(MESSAGING_DESTINATION_TEMPLATE, "topic-{id}"), + equalTo(MESSAGING_OPERATION_TYPE, "send"), + equalTo( + ERROR_TYPE, + IllegalStateException.class.getName()), + equalTo(MESSAGING_DESTINATION_PARTITION_ID, "1"))))) + .anySatisfy( + metric -> + assertThat(metric) + .hasName("messaging.client.sent.messages") + .hasUnit("{message}") + .hasDescription( + "Number of messages producer attempted to send to the broker.") + .hasLongSumSatisfying( + sum -> + sum.hasPointsSatisfying( + point -> + point + .hasValue(2) + .hasAttributesSatisfyingExactly( + equalTo(MESSAGING_OPERATION_NAME, "send"), + equalTo(MESSAGING_SYSTEM, "pulsar"), + equalTo( + ERROR_TYPE, + IllegalStateException.class.getName()), + equalTo(MESSAGING_DESTINATION_TEMPLATE, "topic-{id}"), + equalTo(MESSAGING_DESTINATION_PARTITION_ID, "1"))))); + } + } - assertThat(metricReader.collectAllMetrics()).isEmpty(); + @Test + @SuppressWarnings("deprecation") // using deprecated semconv + void createDoesNotCountSentMessages() { + InMemoryMetricReader metricReader = InMemoryMetricReader.createDelta(); + SdkMeterProvider meterProvider = + SdkMeterProvider.builder().registerMetricReader(metricReader).build(); + OperationListener listener = + MessagingProducerMetrics.getForOperationType().create(meterProvider.get("test")); - Context context2 = listener.onStart(Context.root(), requestAttributes, nanos(150)); + Attributes attributes = + Attributes.builder() + .put(MESSAGING_OPERATION, emitOldMessagingSemconv() ? "create" : null) + .put(MESSAGING_OPERATION_NAME, emitStableMessagingSemconv() ? "create" : null) + .put(MESSAGING_OPERATION_TYPE, emitStableMessagingSemconv() ? "create" : null) + .build(); + Context context = listener.onStart(Context.root(), attributes, nanos(100)); + listener.onEnd(context, Attributes.empty(), nanos(250)); + + Collection metrics = metricReader.collectAllMetrics(); + assertThat( + metrics.stream() + .filter(metric -> metric.getName().equals("messaging.client.operation.duration")) + .count()) + .isEqualTo(emitStableMessagingSemconv() ? 1 : 0); + assertThat( + metrics.stream() + .filter(metric -> metric.getName().equals("messaging.client.sent.messages")) + .count()) + .isZero(); + assertThat( + metrics.stream() + .filter(metric -> metric.getName().equals("messaging.publish.duration")) + .count()) + .isZero(); + } - assertThat(metricReader.collectAllMetrics()).isEmpty(); + @Test + @SuppressWarnings("deprecation") // using deprecated semconv + void zeroBatchDoesNotCountSentMessages() { + InMemoryMetricReader metricReader = InMemoryMetricReader.createDelta(); + SdkMeterProvider meterProvider = + SdkMeterProvider.builder().registerMetricReader(metricReader).build(); + OperationListener listener = + MessagingProducerMetrics.getForOperationType().create(meterProvider.get("test")); - listener.onEnd(context1, responseAttributes, nanos(250)); + Attributes attributes = + Attributes.builder() + .put(MESSAGING_OPERATION, emitOldMessagingSemconv() ? "publish" : null) + .put(MESSAGING_OPERATION_NAME, emitStableMessagingSemconv() ? "send" : null) + .put(MESSAGING_OPERATION_TYPE, emitStableMessagingSemconv() ? "send" : null) + .put(MESSAGING_BATCH_MESSAGE_COUNT, 0) + .build(); + Context context = listener.onStart(Context.root(), attributes, nanos(100)); + listener.onEnd(context, Attributes.empty(), nanos(250)); assertThat(metricReader.collectAllMetrics()) - .satisfiesExactlyInAnyOrder( - metric -> - assertThat(metric) - .hasName("messaging.publish.duration") - .hasUnit("s") - .hasDescription("Measures the duration of publish operation.") - .hasHistogramSatisfying( - histogram -> - histogram.hasPointsSatisfying( - point -> - point - .hasSum(0.15 /* seconds */) - .hasAttributesSatisfying( - equalTo(MESSAGING_SYSTEM, "pulsar"), - equalTo(MESSAGING_DESTINATION_PARTITION_ID, "1"), - equalTo( - MESSAGING_DESTINATION_NAME, - "persistent://public/default/topic"), - equalTo(SERVER_PORT, 6650), - equalTo(SERVER_ADDRESS, "localhost")) - .hasExemplarsSatisfying( - exemplar -> - exemplar - .hasTraceId("ff01020304050600ff0a0b0c0d0e0f00") - .hasSpanId("090a0b0c0d0e0f00")) - .hasBucketBoundaries(DURATION_BUCKETS)))); - - listener.onEnd(context2, responseAttributes, nanos(300)); + .noneSatisfy(metric -> assertThat(metric).hasName("messaging.client.sent.messages")); + } + + @Test + @SuppressWarnings("deprecation") // using deprecated semconv + void legacyEntryPointAlwaysCollectsLegacyMetrics() { + InMemoryMetricReader metricReader = InMemoryMetricReader.createDelta(); + SdkMeterProvider meterProvider = + SdkMeterProvider.builder().registerMetricReader(metricReader).build(); + OperationListener listener = MessagingProducerMetrics.get().create(meterProvider.get("test")); + + Context context = + listener.onStart( + Context.root(), + Attributes.of(MESSAGING_SYSTEM, "pulsar", MESSAGING_OPERATION, "publish"), + nanos(100)); + listener.onEnd(context, Attributes.empty(), nanos(250)); assertThat(metricReader.collectAllMetrics()) - .satisfiesExactlyInAnyOrder( - metric -> - assertThat(metric) - .hasName("messaging.publish.duration") - .hasHistogramSatisfying( - histogram -> - histogram.hasPointsSatisfying( - point -> point.hasSum(0.3 /* seconds */)))); + .satisfiesExactly(metric -> assertThat(metric).hasName("messaging.publish.duration")); } private static long nanos(int millis) { diff --git a/instrumentation-api-incubator/src/test/java/io/opentelemetry/instrumentation/api/incubator/semconv/messaging/MessagingSpanKindExtractorTest.java b/instrumentation-api-incubator/src/test/java/io/opentelemetry/instrumentation/api/incubator/semconv/messaging/MessagingSpanKindExtractorTest.java new file mode 100644 index 000000000000..a7dac2e5d31d --- /dev/null +++ b/instrumentation-api-incubator/src/test/java/io/opentelemetry/instrumentation/api/incubator/semconv/messaging/MessagingSpanKindExtractorTest.java @@ -0,0 +1,74 @@ +/* + * Copyright The OpenTelemetry Authors + * SPDX-License-Identifier: Apache-2.0 + */ + +package io.opentelemetry.instrumentation.api.incubator.semconv.messaging; + +import static io.opentelemetry.instrumentation.api.internal.SemconvStability.emitStableMessagingSemconv; +import static org.assertj.core.api.Assertions.assertThat; +import static org.junit.jupiter.params.provider.Arguments.argumentSet; + +import io.opentelemetry.api.trace.SpanKind; +import java.util.stream.Stream; +import org.junit.jupiter.api.Test; +import org.junit.jupiter.params.ParameterizedTest; +import org.junit.jupiter.params.provider.Arguments; +import org.junit.jupiter.params.provider.MethodSource; + +class MessagingSpanKindExtractorTest { + + @ParameterizedTest + @MethodSource("spanKinds") + void extractsSpanKind( + MessagingOperationType operationType, + boolean isSpanContextPropagated, + SpanKind oldKind, + SpanKind kind) { + SpanKind actualKind = + MessagingSpanKindExtractor.create(operationType, isSpanContextPropagated) + .extract(new Object()); + + assertThat(actualKind).isEqualTo(emitStableMessagingSemconv() ? kind : oldKind); + } + + @Test + void sendDefaultsToPropagatedSpanContext() { + SpanKind spanKind = + MessagingSpanKindExtractor.create(MessagingOperationType.SEND).extract(new Object()); + + assertThat(spanKind).isEqualTo(SpanKind.PRODUCER); + } + + @Test + void messageOperationUsesLegacySpanKind() { + SpanKind receiveKind = + MessagingSpanKindExtractor.create(MessageOperation.RECEIVE).extract(new Object()); + + assertThat(receiveKind).isEqualTo(SpanKind.CONSUMER); + } + + private static Stream spanKinds() { + return Stream.of( + argumentSet( + "create", MessagingOperationType.CREATE, true, SpanKind.PRODUCER, SpanKind.PRODUCER), + argumentSet( + "send with propagated context", + MessagingOperationType.SEND, + true, + SpanKind.PRODUCER, + SpanKind.PRODUCER), + argumentSet( + "send without propagated context", + MessagingOperationType.SEND, + false, + SpanKind.PRODUCER, + SpanKind.CLIENT), + argumentSet( + "receive", MessagingOperationType.RECEIVE, true, SpanKind.CONSUMER, SpanKind.CLIENT), + argumentSet( + "process", MessagingOperationType.PROCESS, true, SpanKind.CONSUMER, SpanKind.CONSUMER), + argumentSet( + "settle", MessagingOperationType.SETTLE, true, SpanKind.CLIENT, SpanKind.CLIENT)); + } +} diff --git a/instrumentation-api-incubator/src/test/java/io/opentelemetry/instrumentation/api/incubator/semconv/messaging/MessagingSpanNameExtractorTest.java b/instrumentation-api-incubator/src/test/java/io/opentelemetry/instrumentation/api/incubator/semconv/messaging/MessagingSpanNameExtractorTest.java index 2d658df59f87..4abd8e84a7a6 100644 --- a/instrumentation-api-incubator/src/test/java/io/opentelemetry/instrumentation/api/incubator/semconv/messaging/MessagingSpanNameExtractorTest.java +++ b/instrumentation-api-incubator/src/test/java/io/opentelemetry/instrumentation/api/incubator/semconv/messaging/MessagingSpanNameExtractorTest.java @@ -5,11 +5,17 @@ package io.opentelemetry.instrumentation.api.incubator.semconv.messaging; +import static io.opentelemetry.instrumentation.api.internal.SemconvStability.emitStableMessagingSemconv; import static org.assertj.core.api.Assertions.assertThat; +import static org.assertj.core.api.Assertions.assertThatThrownBy; +import static org.junit.jupiter.params.provider.Arguments.argumentSet; +import static org.mockito.Mockito.never; +import static org.mockito.Mockito.verify; import static org.mockito.Mockito.when; import io.opentelemetry.instrumentation.api.instrumenter.SpanNameExtractor; import java.util.stream.Stream; +import org.junit.jupiter.api.Test; import org.junit.jupiter.api.extension.ExtendWith; import org.junit.jupiter.params.ParameterizedTest; import org.junit.jupiter.params.provider.Arguments; @@ -22,36 +28,128 @@ class MessagingSpanNameExtractorTest { @Mock MessagingAttributesGetter getter; + @Test + void shouldKeepLegacyNameForMessageOperation() { + Message message = new Message(); + when(getter.isTemporaryDestination(message)).thenReturn(false); + when(getter.getDestination(message)).thenReturn("destination"); + + SpanNameExtractor underTest = + MessagingSpanNameExtractor.create(getter, MessageOperation.PUBLISH); + + assertThat(underTest.extract(message)).isEqualTo("destination publish"); + } + + @Test + void shouldRejectOperationNameForMessageOperation() { + assertThatThrownBy( + () -> + MessagingSpanNameExtractor.builder(getter, MessageOperation.PUBLISH) + .setOperationName("send")) + .isInstanceOf(IllegalStateException.class) + .hasMessage("Operation name is not configurable for legacy builders"); + } + @ParameterizedTest @MethodSource("spanNameParams") void shouldExtractSpanName( boolean isTemporaryQueue, + boolean isAnonymousQueue, String destinationName, - MessageOperation operation, - String expectedSpanName) { + String destinationTemplate, + MessagingOperationType operationType, + String operationName, + String oldSpanName, + String spanName) { // given Message message = new Message(); - if (isTemporaryQueue) { - when(getter.isTemporaryDestination(message)).thenReturn(true); + if (emitStableMessagingSemconv()) { + when(getter.getDestinationTemplate(message)).thenReturn(destinationTemplate); + if (destinationTemplate == null) { + when(getter.isTemporaryDestination(message)).thenReturn(isTemporaryQueue); + if (!isTemporaryQueue) { + when(getter.isAnonymousDestination(message)).thenReturn(isAnonymousQueue); + if (!isAnonymousQueue) { + when(getter.getDestination(message)).thenReturn(destinationName); + } + } + } } else { - when(getter.getDestination(message)).thenReturn(destinationName); + when(getter.isTemporaryDestination(message)).thenReturn(isTemporaryQueue); + if (!isTemporaryQueue) { + when(getter.getDestination(message)).thenReturn(destinationName); + } } - SpanNameExtractor underTest = MessagingSpanNameExtractor.create(getter, operation); + SpanNameExtractor underTest = + MessagingSpanNameExtractor.builder(getter, operationType) + .setOperationName(operationName) + .build(); // when - String spanName = underTest.extract(message); + String actualSpanName = underTest.extract(message); // then - assertThat(spanName).isEqualTo(expectedSpanName); + assertThat(actualSpanName).isEqualTo(emitStableMessagingSemconv() ? spanName : oldSpanName); + if (emitStableMessagingSemconv() && destinationTemplate != null) { + verify(getter, never()).isTemporaryDestination(message); + verify(getter, never()).isAnonymousDestination(message); + } } static Stream spanNameParams() { return Stream.of( - Arguments.of(false, "destination", MessageOperation.PUBLISH, "destination publish"), - Arguments.of(true, null, MessageOperation.PROCESS, "(temporary) process"), - Arguments.of(false, null, MessageOperation.RECEIVE, "unknown receive")); + argumentSet( + "operation name override", + false, + false, + "destination", + null, + MessagingOperationType.SEND, + "send", + "destination publish", + "send destination"), + argumentSet( + "temporary destination", + true, + false, + "generated", + "generated-{id}", + MessagingOperationType.PROCESS, + "process", + "(temporary) process", + "process generated-{id}"), + argumentSet( + "missing destination", + false, + false, + null, + null, + MessagingOperationType.RECEIVE, + "receive", + "unknown receive", + "receive"), + argumentSet( + "destination template", + false, + false, + "customer-42", + "customer-{id}", + MessagingOperationType.SEND, + "send", + "customer-42 publish", + "send customer-{id}"), + argumentSet( + "anonymous destination", + false, + true, + "generated", + "generated-{id}", + MessagingOperationType.PROCESS, + "process", + "generated process", + "process generated-{id}")); } static class Message {} diff --git a/instrumentation-api-incubator/src/test/java/io/opentelemetry/instrumentation/api/incubator/semconv/messaging/internal/MessagingProcessContextCustomizerTest.java b/instrumentation-api-incubator/src/test/java/io/opentelemetry/instrumentation/api/incubator/semconv/messaging/internal/MessagingProcessContextCustomizerTest.java new file mode 100644 index 000000000000..ebb92062489a --- /dev/null +++ b/instrumentation-api-incubator/src/test/java/io/opentelemetry/instrumentation/api/incubator/semconv/messaging/internal/MessagingProcessContextCustomizerTest.java @@ -0,0 +1,90 @@ +/* + * Copyright The OpenTelemetry Authors + * SPDX-License-Identifier: Apache-2.0 + */ + +package io.opentelemetry.instrumentation.api.incubator.semconv.messaging.internal; + +import static io.opentelemetry.sdk.testing.assertj.OpenTelemetryAssertions.assertThat; + +import io.opentelemetry.api.common.Attributes; +import io.opentelemetry.api.trace.Span; +import io.opentelemetry.api.trace.SpanContext; +import io.opentelemetry.api.trace.TraceFlags; +import io.opentelemetry.api.trace.TraceState; +import io.opentelemetry.api.trace.propagation.W3CTraceContextPropagator; +import io.opentelemetry.context.Context; +import io.opentelemetry.context.ContextKey; +import io.opentelemetry.context.propagation.TextMapGetter; +import io.opentelemetry.instrumentation.api.instrumenter.ContextCustomizer; +import java.util.Collections; +import java.util.HashMap; +import java.util.Map; +import org.junit.jupiter.api.Test; + +class MessagingProcessContextCustomizerTest { + + private static final TextMapGetter> getter = + new TextMapGetter>() { + @Override + public Iterable keys(Map carrier) { + return carrier.keySet(); + } + + @Override + public String get(Map carrier, String key) { + return carrier.get(key); + } + }; + + private static final ContextCustomizer> underTest = + MessagingProcessContextCustomizer.create(W3CTraceContextPropagator.getInstance(), getter); + + @Test + void preservesAmbientParent() { + Context ambient = context("11111111111111111111111111111111", "1111111111111111"); + Span ambientSpan = Span.fromContext(ambient); + + Context result = underTest.onStart(ambient, carrier(), Attributes.empty()); + + assertThat(Span.fromContext(result)).isSameAs(ambientSpan); + } + + @Test + void preservesPropagatedFieldsWithAmbientParent() { + ContextKey propagatedKey = ContextKey.named("propagated"); + ContextCustomizer customizer = + MessagingProcessContextCustomizer.create( + (parent, request) -> parent.with(propagatedKey, request)); + Context ambient = context("11111111111111111111111111111111", "1111111111111111"); + + Context result = customizer.onStart(ambient, "value", Attributes.empty()); + + assertThat(result.get(propagatedKey)).isEqualTo("value"); + assertThat(Span.fromContext(result).getSpanContext()) + .isEqualTo(Span.fromContext(ambient).getSpanContext()); + } + + @Test + void usesProducerWhenAmbientParentIsMissing() { + Context result = underTest.onStart(Context.root(), carrier(), Attributes.empty()); + + assertThat(Span.fromContext(result).getSpanContext()) + .isEqualTo(spanContext("22222222222222222222222222222222", "2222222222222222")); + } + + private static Map carrier() { + Map carrier = new HashMap<>(); + carrier.put("traceparent", "00-22222222222222222222222222222222-2222222222222222-01"); + return Collections.unmodifiableMap(carrier); + } + + private static Context context(String traceId, String spanId) { + return Context.root().with(Span.wrap(spanContext(traceId, spanId))); + } + + private static SpanContext spanContext(String traceId, String spanId) { + return SpanContext.createFromRemoteParent( + traceId, spanId, TraceFlags.getSampled(), TraceState.getDefault()); + } +} diff --git a/instrumentation-api-incubator/src/test/java/io/opentelemetry/instrumentation/api/incubator/semconv/messaging/internal/MessagingProcessInstrumenterFactoryTest.java b/instrumentation-api-incubator/src/test/java/io/opentelemetry/instrumentation/api/incubator/semconv/messaging/internal/MessagingProcessInstrumenterFactoryTest.java new file mode 100644 index 000000000000..81f007d9d377 --- /dev/null +++ b/instrumentation-api-incubator/src/test/java/io/opentelemetry/instrumentation/api/incubator/semconv/messaging/internal/MessagingProcessInstrumenterFactoryTest.java @@ -0,0 +1,166 @@ +/* + * Copyright The OpenTelemetry Authors + * SPDX-License-Identifier: Apache-2.0 + */ + +package io.opentelemetry.instrumentation.api.incubator.semconv.messaging.internal; + +import static io.opentelemetry.instrumentation.api.internal.SemconvStability.emitStableMessagingSemconv; +import static java.util.Collections.singletonMap; +import static org.junit.jupiter.api.Assumptions.assumeTrue; +import static org.junit.jupiter.params.provider.Arguments.argumentSet; + +import io.opentelemetry.api.trace.Span; +import io.opentelemetry.api.trace.SpanContext; +import io.opentelemetry.api.trace.SpanKind; +import io.opentelemetry.api.trace.TraceFlags; +import io.opentelemetry.api.trace.TraceState; +import io.opentelemetry.api.trace.propagation.W3CTraceContextPropagator; +import io.opentelemetry.context.Context; +import io.opentelemetry.context.propagation.TextMapGetter; +import io.opentelemetry.instrumentation.api.instrumenter.Instrumenter; +import io.opentelemetry.sdk.testing.junit5.OpenTelemetryExtension; +import io.opentelemetry.sdk.trace.data.LinkData; +import java.util.Map; +import java.util.stream.Stream; +import org.junit.jupiter.api.Test; +import org.junit.jupiter.api.extension.RegisterExtension; +import org.junit.jupiter.params.ParameterizedTest; +import org.junit.jupiter.params.provider.Arguments; +import org.junit.jupiter.params.provider.MethodSource; + +class MessagingProcessInstrumenterFactoryTest { + + private static final SpanContext ambientParent = + spanContext("11111111111111111111111111111111", "1111111111111111"); + private static final SpanContext producer = + spanContext("22222222222222222222222222222222", "2222222222222222"); + + private static final TextMapGetter> getter = + new TextMapGetter>() { + @Override + public Iterable keys(Map carrier) { + return carrier.keySet(); + } + + @Override + public String get(Map carrier, String key) { + return carrier.get(key); + } + }; + + @RegisterExtension + static final OpenTelemetryExtension otelTesting = OpenTelemetryExtension.create(); + + @Test + void stableUsesProducerAsParentWithoutLink() { + assumeTrue(emitStableMessagingSemconv()); + Instrumenter, Void> instrumenter = + MessagingProcessInstrumenterFactory.create( + Instrumenter., Void>builder( + otelTesting.getOpenTelemetry(), "test", unused -> "process"), + W3CTraceContextPropagator.getInstance(), + getter, + false); + + Map carrier = + singletonMap("traceparent", "00-22222222222222222222222222222222-2222222222222222-01"); + Context context = instrumenter.start(Context.root(), carrier); + instrumenter.end(context, carrier, null, null); + + otelTesting + .assertTraces() + .hasTracesSatisfyingExactly( + trace -> + trace.hasSpansSatisfyingExactly( + span -> + span.hasName("process") + .hasKind(SpanKind.CONSUMER) + .hasTraceId(producer.getTraceId()) + .hasParentSpanId(producer.getSpanId()) + .hasLinks())); + } + + @Test + void stableDoesNotLinkAmbientParent() { + assumeTrue(emitStableMessagingSemconv()); + SpanContext localProducer = + SpanContext.create( + producer.getTraceId(), + producer.getSpanId(), + producer.getTraceFlags(), + producer.getTraceState()); + Instrumenter, Void> instrumenter = + MessagingProcessInstrumenterFactory.create( + Instrumenter., Void>builder( + otelTesting.getOpenTelemetry(), "test", unused -> "process"), + W3CTraceContextPropagator.getInstance(), + getter, + false); + + Map carrier = + singletonMap("traceparent", "00-22222222222222222222222222222222-2222222222222222-01"); + Context context = instrumenter.start(Context.root().with(Span.wrap(localProducer)), carrier); + instrumenter.end(context, carrier, null, null); + + otelTesting + .assertTraces() + .hasTracesSatisfyingExactly( + trace -> + trace.hasSpansSatisfyingExactly( + span -> + span.hasName("process") + .hasKind(SpanKind.CONSUMER) + .hasTraceId(producer.getTraceId()) + .hasParentSpanId(producer.getSpanId()) + .hasLinks())); + } + + @ParameterizedTest + @MethodSource("receiveInstrumentationSettings") + void usesExpectedParentAndLink(boolean receiveInstrumentationEnabled, boolean producerIsParent) { + Instrumenter, Void> instrumenter = + MessagingProcessInstrumenterFactory.create( + Instrumenter., Void>builder( + otelTesting.getOpenTelemetry(), "test", unused -> "process"), + W3CTraceContextPropagator.getInstance(), + getter, + receiveInstrumentationEnabled); + + Map carrier = + singletonMap("traceparent", "00-22222222222222222222222222222222-2222222222222222-01"); + Context context = instrumenter.start(Context.root().with(Span.wrap(ambientParent)), carrier); + instrumenter.end(context, carrier, null, null); + + SpanContext expectedParent = producerIsParent ? producer : ambientParent; + otelTesting + .assertTraces() + .hasTracesSatisfyingExactly( + trace -> + trace.hasSpansSatisfyingExactly( + span -> { + span.hasName("process") + .hasKind(SpanKind.CONSUMER) + .hasTraceId(expectedParent.getTraceId()) + .hasParentSpanId(expectedParent.getSpanId()); + if (producerIsParent) { + span.hasLinks(); + } else { + span.hasLinks(LinkData.create(producer)); + } + })); + } + + private static Stream receiveInstrumentationSettings() { + boolean stable = emitStableMessagingSemconv(); + String semconv = stable ? "stable" : "old"; + return Stream.of( + argumentSet(semconv + " receive disabled", false, !stable), + argumentSet(semconv + " receive enabled", true, false)); + } + + private static SpanContext spanContext(String traceId, String spanId) { + return SpanContext.createFromRemoteParent( + traceId, spanId, TraceFlags.getSampled(), TraceState.getDefault()); + } +} diff --git a/instrumentation-api/src/main/java/io/opentelemetry/instrumentation/api/internal/SemconvStability.java b/instrumentation-api/src/main/java/io/opentelemetry/instrumentation/api/internal/SemconvStability.java index 8efdbfe4ee0b..d4465850c5ad 100644 --- a/instrumentation-api/src/main/java/io/opentelemetry/instrumentation/api/internal/SemconvStability.java +++ b/instrumentation-api/src/main/java/io/opentelemetry/instrumentation/api/internal/SemconvStability.java @@ -169,11 +169,14 @@ private static boolean emitStable(SemconvMode mode) { return mode.version() >= 1; } - public static boolean emitOldMessagingSemconv() { + public static boolean emitOldMessagingSemconv() { // to be removed in 3.0 return emitOldMessagingSemconv; } - public static boolean emitStableMessagingSemconv() { + // Returns whether the selected v1 experimental messaging semantic conventions should be emitted. + // The method name follows the existing pattern; it does not indicate that the messaging + // conventions are stable. + public static boolean emitStableMessagingSemconv() { // to be removed in 3.0 return emitStableMessagingSemconv; } diff --git a/instrumentation-api/src/main/java/io/opentelemetry/instrumentation/api/internal/SpanKey.java b/instrumentation-api/src/main/java/io/opentelemetry/instrumentation/api/internal/SpanKey.java index 0cf43cc6162a..a7e705ad8d30 100644 --- a/instrumentation-api/src/main/java/io/opentelemetry/instrumentation/api/internal/SpanKey.java +++ b/instrumentation-api/src/main/java/io/opentelemetry/instrumentation/api/internal/SpanKey.java @@ -43,12 +43,16 @@ public final class SpanKey { private static final ContextKey DB_CLIENT_KEY = ContextKey.named("opentelemetry-traces-span-key-db-client"); + private static final ContextKey PRODUCER_CREATE_KEY = + ContextKey.named("opentelemetry-traces-span-key-producer-create"); private static final ContextKey PRODUCER_KEY = ContextKey.named("opentelemetry-traces-span-key-producer"); private static final ContextKey CONSUMER_RECEIVE_KEY = ContextKey.named("opentelemetry-traces-span-key-consumer-receive"); private static final ContextKey CONSUMER_PROCESS_KEY = ContextKey.named("opentelemetry-traces-span-key-consumer-process"); + private static final ContextKey CONSUMER_SETTLE_KEY = + ContextKey.named("opentelemetry-traces-span-key-consumer-settle"); /* Span keys */ @@ -66,9 +70,11 @@ public final class SpanKey { public static final SpanKey RPC_CLIENT = new SpanKey(RPC_CLIENT_KEY); public static final SpanKey DB_CLIENT = new SpanKey(DB_CLIENT_KEY); + public static final SpanKey PRODUCER_CREATE = new SpanKey(PRODUCER_CREATE_KEY); public static final SpanKey PRODUCER = new SpanKey(PRODUCER_KEY); public static final SpanKey CONSUMER_RECEIVE = new SpanKey(CONSUMER_RECEIVE_KEY); public static final SpanKey CONSUMER_PROCESS = new SpanKey(CONSUMER_PROCESS_KEY); + public static final SpanKey CONSUMER_SETTLE = new SpanKey(CONSUMER_SETTLE_KEY); private final ContextKey key; diff --git a/instrumentation-api/src/test/java/io/opentelemetry/instrumentation/api/internal/SemconvStabilityTest.java b/instrumentation-api/src/test/java/io/opentelemetry/instrumentation/api/internal/SemconvStabilityTest.java index 32e316457df2..bc1d672f08bd 100644 --- a/instrumentation-api/src/test/java/io/opentelemetry/instrumentation/api/internal/SemconvStabilityTest.java +++ b/instrumentation-api/src/test/java/io/opentelemetry/instrumentation/api/internal/SemconvStabilityTest.java @@ -9,6 +9,7 @@ import static java.util.Collections.emptyList; import static java.util.Collections.emptySet; import static org.assertj.core.api.Assertions.assertThat; +import static org.junit.jupiter.params.provider.Arguments.argumentSet; import io.opentelemetry.api.incubator.config.DeclarativeConfigProperties; import io.opentelemetry.common.ComponentLoader; @@ -22,6 +23,8 @@ import java.util.stream.Collectors; import org.junit.jupiter.api.Test; import org.junit.jupiter.params.ParameterizedTest; +import org.junit.jupiter.params.provider.Arguments; +import org.junit.jupiter.params.provider.MethodSource; import org.junit.jupiter.params.provider.ValueSource; class SemconvStabilityTest { @@ -379,6 +382,69 @@ void previewFallbackAppliesToPreviewDomains(boolean v3Preview) { assertThat(messaging).isEqualTo(SemconvMode.V1_EXPERIMENTAL); } + @ParameterizedTest + @MethodSource("messagingSelectionModes") + void messagingSelectionMatrix( + boolean v3Preview, Set stableOptIn, Set preview, SemconvMode expectedMode) { + SemconvMode messaging = + new SemconvSelectionResolver(general(), v3Preview, stableOptIn, preview).messaging(); + + assertThat(messaging).isEqualTo(expectedMode); + } + + private static List messagingSelectionModes() { + return asList( + argumentSet("legacy default", false, noStableOptIn(), noPreview(), SemconvMode.V0_STABLE), + argumentSet( + "legacy opt-in property", + false, + stableOptIn("messaging"), + noPreview(), + SemconvMode.V1_EXPERIMENTAL), + argumentSet( + "preview property", + false, + noStableOptIn(), + preview("messaging"), + SemconvMode.V1_EXPERIMENTAL), + argumentSet( + "legacy opt-in dual emit", + false, + stableOptIn("messaging/dup"), + noPreview(), + SemconvMode.V1_EXPERIMENTAL.withDualEmit()), + argumentSet( + "preview dual emit", + false, + noStableOptIn(), + preview("messaging/dup"), + SemconvMode.V1_EXPERIMENTAL.withDualEmit()), + argumentSet( + "v3 activation remains staged", + true, + noStableOptIn(), + noPreview(), + SemconvMode.V0_STABLE), + argumentSet( + "v3 ignores legacy opt-in property", + true, + stableOptIn("messaging"), + noPreview(), + SemconvMode.V0_STABLE), + argumentSet( + "v3 ignores legacy opt-in dual emit", + true, + stableOptIn("messaging/dup"), + noPreview(), + SemconvMode.V0_STABLE), + argumentSet( + "v3 with explicit preview", + true, + noStableOptIn(), + preview("messaging"), + SemconvMode.V1_EXPERIMENTAL)); + } + @SafeVarargs private static DeclarativeConfigProperties general(Entry... entries) { Map result = new HashMap(); diff --git a/instrumentation/opentelemetry-instrumentation-api/opentelemetry-instrumentation-api-1.14/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/instrumentationapi/v1_14/SpanKeyBridging.java b/instrumentation/opentelemetry-instrumentation-api/opentelemetry-instrumentation-api-1.14/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/instrumentationapi/v1_14/SpanKeyBridging.java index 24be05a6e8d0..e588faf6bd38 100644 --- a/instrumentation/opentelemetry-instrumentation-api/opentelemetry-instrumentation-api-1.14/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/instrumentationapi/v1_14/SpanKeyBridging.java +++ b/instrumentation/opentelemetry-instrumentation-api/opentelemetry-instrumentation-api-1.14/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/instrumentationapi/v1_14/SpanKeyBridging.java @@ -51,6 +51,7 @@ public class SpanKeyBridging { application.io.opentelemetry.instrumentation.api.internal.SpanKey.DB_CLIENT, SpanKey.DB_CLIENT); + putIfPresent(map, "PRODUCER_CREATE", SpanKey.PRODUCER_CREATE); map.put( application.io.opentelemetry.instrumentation.api.internal.SpanKey.PRODUCER, SpanKey.PRODUCER); @@ -60,9 +61,26 @@ public class SpanKeyBridging { map.put( application.io.opentelemetry.instrumentation.api.internal.SpanKey.CONSUMER_PROCESS, SpanKey.CONSUMER_PROCESS); + putIfPresent(map, "CONSUMER_SETTLE", SpanKey.CONSUMER_SETTLE); return map; } + private static void putIfPresent( + Map map, + String fieldName, + SpanKey agentSpanKey) { + try { + application.io.opentelemetry.instrumentation.api.internal.SpanKey applicationSpanKey = + (application.io.opentelemetry.instrumentation.api.internal.SpanKey) + application.io.opentelemetry.instrumentation.api.internal.SpanKey.class + .getField(fieldName) + .get(null); + map.put(applicationSpanKey, agentSpanKey); + } catch (ReflectiveOperationException ignored) { + // The application may use an instrumentation-api version from before this key was added. + } + } + @Nullable public static SpanKey toAgentOrNull( application.io.opentelemetry.instrumentation.api.internal.SpanKey applicationSpanKey) { diff --git a/instrumentation/opentelemetry-instrumentation-api/opentelemetry-instrumentation-api-1.14/javaagent/src/test/java/io/opentelemetry/javaagent/instrumentation/instrumentationapi/v1_14/ContextBridgeTest.java b/instrumentation/opentelemetry-instrumentation-api/opentelemetry-instrumentation-api-1.14/javaagent/src/test/java/io/opentelemetry/javaagent/instrumentation/instrumentationapi/v1_14/ContextBridgeTest.java index 60ecc0f4201b..7322e0d9569c 100644 --- a/instrumentation/opentelemetry-instrumentation-api/opentelemetry-instrumentation-api-1.14/javaagent/src/test/java/io/opentelemetry/javaagent/instrumentation/instrumentationapi/v1_14/ContextBridgeTest.java +++ b/instrumentation/opentelemetry-instrumentation-api/opentelemetry-instrumentation-api-1.14/javaagent/src/test/java/io/opentelemetry/javaagent/instrumentation/instrumentationapi/v1_14/ContextBridgeTest.java @@ -68,9 +68,11 @@ void testSpanKeyBridge() { SpanKey.HTTP_CLIENT, SpanKey.RPC_CLIENT, SpanKey.DB_CLIENT, + SpanKey.PRODUCER_CREATE, SpanKey.PRODUCER, SpanKey.CONSUMER_RECEIVE, - SpanKey.CONSUMER_PROCESS); + SpanKey.CONSUMER_PROCESS, + SpanKey.CONSUMER_SETTLE); spanKeys.forEach( spanKey -> assertThat(spanKey.fromContextOrNull(Context.current())).isNotNull()); diff --git a/instrumentation/opentelemetry-instrumentation-api/opentelemetry-instrumentation-api-1.14/testing/src/main/java/io/opentelemetry/javaagent/instrumentation/testing/AgentSpanTestingInstrumenter.java b/instrumentation/opentelemetry-instrumentation-api/opentelemetry-instrumentation-api-1.14/testing/src/main/java/io/opentelemetry/javaagent/instrumentation/testing/AgentSpanTestingInstrumenter.java index e13499836749..74a821731111 100644 --- a/instrumentation/opentelemetry-instrumentation-api/opentelemetry-instrumentation-api-1.14/testing/src/main/java/io/opentelemetry/javaagent/instrumentation/testing/AgentSpanTestingInstrumenter.java +++ b/instrumentation/opentelemetry-instrumentation-api/opentelemetry-instrumentation-api-1.14/testing/src/main/java/io/opentelemetry/javaagent/instrumentation/testing/AgentSpanTestingInstrumenter.java @@ -73,9 +73,11 @@ private static SpanKey[] getAllSpanKeys() { SpanKey.HTTP_CLIENT, SpanKey.RPC_CLIENT, SpanKey.DB_CLIENT, + SpanKey.PRODUCER_CREATE, SpanKey.PRODUCER, SpanKey.CONSUMER_RECEIVE, SpanKey.CONSUMER_PROCESS, + SpanKey.CONSUMER_SETTLE, }; } diff --git a/instrumentation/rocketmq/rocketmq-client-4.8/javaagent/build.gradle.kts b/instrumentation/rocketmq/rocketmq-client-4.8/javaagent/build.gradle.kts index 27939ec56118..27473d2e7c61 100644 --- a/instrumentation/rocketmq/rocketmq-client-4.8/javaagent/build.gradle.kts +++ b/instrumentation/rocketmq/rocketmq-client-4.8/javaagent/build.gradle.kts @@ -46,7 +46,23 @@ tasks { systemProperty("metadataConfig", "otel.instrumentation.rocketmq-client.experimental-span-attributes=true") } + val testV3Preview = register("testV3Preview") { + testClassesDirs = sourceSets.test.get().output.classesDirs + classpath = sourceSets.test.get().runtimeClasspath + jvmArgs("-Dotel.instrumentation.common.v3-preview=true") + jvmArgs("-Dotel.semconv-stability.preview=messaging") + systemProperty("metadataConfig", "otel.instrumentation.common.v3-preview=true") + } + + val testBothSemconv = register("testBothSemconv") { + testClassesDirs = sourceSets.test.get().output.classesDirs + classpath = sourceSets.test.get().runtimeClasspath + jvmArgs("-Dotel.instrumentation.common.v3-preview=true") + jvmArgs("-Dotel.semconv-stability.preview=messaging/dup") + systemProperty("metadataConfig", "otel.semconv-stability.preview=messaging/dup") + } + check { - dependsOn(testExperimental) + dependsOn(testExperimental, testV3Preview, testBothSemconv) } } diff --git a/instrumentation/rocketmq/rocketmq-client-4.8/library/build.gradle.kts b/instrumentation/rocketmq/rocketmq-client-4.8/library/build.gradle.kts index 22f2c199e6ed..54ed7bc50611 100644 --- a/instrumentation/rocketmq/rocketmq-client-4.8/library/build.gradle.kts +++ b/instrumentation/rocketmq/rocketmq-client-4.8/library/build.gradle.kts @@ -13,14 +13,34 @@ dependencies { testImplementation(project(":instrumentation:rocketmq:rocketmq-client-4.8:testing")) } -tasks.test { - systemProperty("testLatestDeps", otelProps.testLatestDeps) - // required on jdk17 - jvmArgs("--add-opens=java.base/sun.nio.ch=ALL-UNNAMED") - jvmArgs("-XX:+IgnoreUnrecognizedVMOptions") - // with default settings tests will fail when disk is 90% full - jvmArgs("-Drocketmq.broker.diskSpaceWarningLevelRatio=1.0") - - // used for experimental attributes test assertion logic which looks for this property - jvmArgs("-Dotel.instrumentation.rocketmq-client.experimental-span-attributes=true") +tasks { + withType().configureEach { + systemProperty("testLatestDeps", otelProps.testLatestDeps) + // required on jdk17 + jvmArgs("--add-opens=java.base/sun.nio.ch=ALL-UNNAMED") + jvmArgs("-XX:+IgnoreUnrecognizedVMOptions") + // with default settings tests will fail when disk is 90% full + jvmArgs("-Drocketmq.broker.diskSpaceWarningLevelRatio=1.0") + + // used for experimental attributes test assertion logic which looks for this property + jvmArgs("-Dotel.instrumentation.rocketmq-client.experimental-span-attributes=true") + } + + val testV3Preview = register("testV3Preview") { + testClassesDirs = sourceSets.test.get().output.classesDirs + classpath = sourceSets.test.get().runtimeClasspath + jvmArgs("-Dotel.instrumentation.common.v3-preview=true") + jvmArgs("-Dotel.semconv-stability.preview=messaging") + } + + val testBothSemconv = register("testBothSemconv") { + testClassesDirs = sourceSets.test.get().output.classesDirs + classpath = sourceSets.test.get().runtimeClasspath + jvmArgs("-Dotel.instrumentation.common.v3-preview=true") + jvmArgs("-Dotel.semconv-stability.preview=messaging/dup") + } + + check { + dependsOn(testV3Preview, testBothSemconv) + } } diff --git a/instrumentation/rocketmq/rocketmq-client-4.8/library/src/main/java/io/opentelemetry/instrumentation/rocketmqclient/v4_8/ContextAndScope.java b/instrumentation/rocketmq/rocketmq-client-4.8/library/src/main/java/io/opentelemetry/instrumentation/rocketmqclient/v4_8/ContextAndScope.java index 1adade581392..672b151144a2 100644 --- a/instrumentation/rocketmq/rocketmq-client-4.8/library/src/main/java/io/opentelemetry/instrumentation/rocketmqclient/v4_8/ContextAndScope.java +++ b/instrumentation/rocketmq/rocketmq-client-4.8/library/src/main/java/io/opentelemetry/instrumentation/rocketmqclient/v4_8/ContextAndScope.java @@ -6,17 +6,17 @@ package io.opentelemetry.instrumentation.rocketmqclient.v4_8; import com.google.auto.value.AutoValue; -import io.opentelemetry.context.Context; import io.opentelemetry.context.Scope; @AutoValue abstract class ContextAndScope { - static ContextAndScope create(Context context, Scope scope) { - return new AutoValue_ContextAndScope(context, scope); + static ContextAndScope create( + RocketMqConsumerInstrumenter.ConsumerContext consumerContext, Scope scope) { + return new AutoValue_ContextAndScope(consumerContext, scope); } - abstract Context getContext(); + abstract RocketMqConsumerInstrumenter.ConsumerContext getConsumerContext(); abstract Scope getScope(); diff --git a/instrumentation/rocketmq/rocketmq-client-4.8/library/src/main/java/io/opentelemetry/instrumentation/rocketmqclient/v4_8/RocketMqConsumerAttributeGetter.java b/instrumentation/rocketmq/rocketmq-client-4.8/library/src/main/java/io/opentelemetry/instrumentation/rocketmqclient/v4_8/RocketMqConsumerAttributeGetter.java index dce80b6ea672..51c583cc53ca 100644 --- a/instrumentation/rocketmq/rocketmq-client-4.8/library/src/main/java/io/opentelemetry/instrumentation/rocketmqclient/v4_8/RocketMqConsumerAttributeGetter.java +++ b/instrumentation/rocketmq/rocketmq-client-4.8/library/src/main/java/io/opentelemetry/instrumentation/rocketmqclient/v4_8/RocketMqConsumerAttributeGetter.java @@ -11,76 +11,88 @@ import io.opentelemetry.instrumentation.api.incubator.semconv.messaging.MessagingAttributesGetter; import java.util.List; import javax.annotation.Nullable; -import org.apache.rocketmq.common.message.MessageExt; +import org.apache.rocketmq.client.hook.ConsumeMessageContext; -final class RocketMqConsumerAttributeGetter implements MessagingAttributesGetter { +final class RocketMqConsumerAttributeGetter + implements MessagingAttributesGetter { @Override - public String getSystem(MessageExt request) { + public String getSystem(RocketMqConsumerRequest request) { return "rocketmq"; } @Override - public String getDestination(MessageExt request) { - return request.getTopic(); + public String getDestination(RocketMqConsumerRequest request) { + return request.getMessage().getTopic(); } @Nullable @Override - public String getDestinationTemplate(MessageExt request) { + public String getDestinationTemplate(RocketMqConsumerRequest request) { return null; } @Override - public boolean isTemporaryDestination(MessageExt request) { + public boolean isTemporaryDestination(RocketMqConsumerRequest request) { return false; } @Override - public boolean isAnonymousDestination(MessageExt request) { + public boolean isAnonymousDestination(RocketMqConsumerRequest request) { return false; } @Nullable @Override - public String getConversationId(MessageExt request) { + public String getConversationId(RocketMqConsumerRequest request) { return null; } @Nullable @Override - public Long getMessageBodySize(MessageExt request) { - byte[] body = request.getBody(); + public Long getMessageBodySize(RocketMqConsumerRequest request) { + byte[] body = request.getMessage().getBody(); return body == null ? null : (long) body.length; } @Nullable @Override - public Long getMessageEnvelopeSize(MessageExt request) { + public Long getMessageEnvelopeSize(RocketMqConsumerRequest request) { return null; } @Nullable @Override - public String getMessageId(MessageExt request, @Nullable Void unused) { - return request.getMsgId(); + public String getMessageId( + RocketMqConsumerRequest request, @Nullable ConsumeMessageContext unused) { + return request.getMessage().getMsgId(); } @Nullable @Override - public String getClientId(MessageExt request) { + public String getClientId(RocketMqConsumerRequest request) { return null; } @Nullable @Override - public Long getBatchMessageCount(MessageExt request, @Nullable Void unused) { + public Long getBatchMessageCount( + RocketMqConsumerRequest request, @Nullable ConsumeMessageContext unused) { return null; } + @Nullable + @Override + public String getErrorType( + RocketMqConsumerRequest request, + @Nullable ConsumeMessageContext response, + @Nullable Throwable error) { + return response != null && !response.isSuccess() ? response.getStatus() : null; + } + @Override - public List getMessageHeader(MessageExt request, String name) { - String value = request.getProperties().get(name); + public List getMessageHeader(RocketMqConsumerRequest request, String name) { + String value = request.getMessage().getProperties().get(name); if (value != null) { return singletonList(value); } diff --git a/instrumentation/rocketmq/rocketmq-client-4.8/library/src/main/java/io/opentelemetry/instrumentation/rocketmqclient/v4_8/RocketMqConsumerExperimentalAttributeExtractor.java b/instrumentation/rocketmq/rocketmq-client-4.8/library/src/main/java/io/opentelemetry/instrumentation/rocketmqclient/v4_8/RocketMqConsumerExperimentalAttributeExtractor.java index 069757006724..252f34d96fc6 100644 --- a/instrumentation/rocketmq/rocketmq-client-4.8/library/src/main/java/io/opentelemetry/instrumentation/rocketmqclient/v4_8/RocketMqConsumerExperimentalAttributeExtractor.java +++ b/instrumentation/rocketmq/rocketmq-client-4.8/library/src/main/java/io/opentelemetry/instrumentation/rocketmqclient/v4_8/RocketMqConsumerExperimentalAttributeExtractor.java @@ -11,10 +11,11 @@ import io.opentelemetry.instrumentation.api.instrumenter.AttributesExtractor; import java.net.SocketAddress; import javax.annotation.Nullable; +import org.apache.rocketmq.client.hook.ConsumeMessageContext; import org.apache.rocketmq.common.message.MessageExt; final class RocketMqConsumerExperimentalAttributeExtractor - implements AttributesExtractor { + implements AttributesExtractor { // copied from MessagingIncubatingAttributes private static final AttributeKey MESSAGING_ROCKETMQ_MESSAGE_TAG = @@ -28,7 +29,9 @@ final class RocketMqConsumerExperimentalAttributeExtractor AttributeKey.stringKey("messaging.rocketmq.broker_address"); @Override - public void onStart(AttributesBuilder attributes, Context parentContext, MessageExt msg) { + public void onStart( + AttributesBuilder attributes, Context parentContext, RocketMqConsumerRequest request) { + MessageExt msg = request.getMessage(); attributes.put(MESSAGING_ROCKETMQ_MESSAGE_TAG, msg.getTags()); attributes.put(MESSAGING_ROCKETMQ_QUEUE_ID, msg.getQueueId()); attributes.put(MESSAGING_ROCKETMQ_QUEUE_OFFSET, msg.getQueueOffset()); @@ -46,7 +49,7 @@ private static String getBrokerHost(SocketAddress storeHost) { public void onEnd( AttributesBuilder attributes, Context context, - MessageExt consumeMessageContext, - @Nullable Void unused, + RocketMqConsumerRequest request, + @Nullable ConsumeMessageContext response, @Nullable Throwable error) {} } diff --git a/instrumentation/rocketmq/rocketmq-client-4.8/library/src/main/java/io/opentelemetry/instrumentation/rocketmqclient/v4_8/RocketMqConsumerInstrumenter.java b/instrumentation/rocketmq/rocketmq-client-4.8/library/src/main/java/io/opentelemetry/instrumentation/rocketmqclient/v4_8/RocketMqConsumerInstrumenter.java index 218cc5aa53e7..53fc3e0e85d8 100644 --- a/instrumentation/rocketmq/rocketmq-client-4.8/library/src/main/java/io/opentelemetry/instrumentation/rocketmqclient/v4_8/RocketMqConsumerInstrumenter.java +++ b/instrumentation/rocketmq/rocketmq-client-4.8/library/src/main/java/io/opentelemetry/instrumentation/rocketmqclient/v4_8/RocketMqConsumerInstrumenter.java @@ -5,55 +5,147 @@ package io.opentelemetry.instrumentation.rocketmqclient.v4_8; +import static io.opentelemetry.instrumentation.api.internal.SemconvStability.emitStableMessagingSemconv; +import static java.util.Collections.emptyList; + import io.opentelemetry.context.Context; import io.opentelemetry.instrumentation.api.instrumenter.Instrumenter; +import java.util.ArrayList; import java.util.List; +import javax.annotation.Nullable; +import org.apache.rocketmq.client.hook.ConsumeMessageContext; import org.apache.rocketmq.common.message.MessageExt; final class RocketMqConsumerInstrumenter { - private final Instrumenter singleProcessInstrumenter; - private final Instrumenter batchProcessInstrumenter; - private final Instrumenter batchReceiveInstrumenter; + private final Instrumenter + singleProcessInstrumenter; + private final Instrumenter + batchProcessInstrumenter; + private final Instrumenter batchReceiveInstrumenter; RocketMqConsumerInstrumenter( - Instrumenter singleProcessInstrumenter, - Instrumenter batchProcessInstrumenter, - Instrumenter batchReceiveInstrumenter) { + Instrumenter singleProcessInstrumenter, + Instrumenter batchProcessInstrumenter, + Instrumenter batchReceiveInstrumenter) { this.singleProcessInstrumenter = singleProcessInstrumenter; this.batchProcessInstrumenter = batchProcessInstrumenter; this.batchReceiveInstrumenter = batchReceiveInstrumenter; } - Context start(Context parentContext, List msgs) { + @Nullable + ConsumerContext start( + Context parentContext, + List msgs, + String consumerGroup, + @Nullable String namespace) { + int batchSize = msgs.size(); if (msgs.size() == 1) { - if (singleProcessInstrumenter.shouldStart(parentContext, msgs.get(0))) { - return singleProcessInstrumenter.start(parentContext, msgs.get(0)); + RocketMqConsumerRequest request = + new RocketMqConsumerRequest(msgs.get(0), consumerGroup, batchSize, namespace); + if (singleProcessInstrumenter.shouldStart(parentContext, request)) { + Context context = singleProcessInstrumenter.start(parentContext, request); + return new ConsumerContext(context, request, emptyList(), false); } } else { - if (batchReceiveInstrumenter.shouldStart(parentContext, null)) { - Context rootContext = batchReceiveInstrumenter.start(parentContext, null); - for (MessageExt message : msgs) { - createChildSpan(rootContext, message); - } - return rootContext; + RocketMqConsumerRequest request = + new RocketMqConsumerRequest(msgs.get(0), consumerGroup, batchSize, namespace); + boolean receiveStarted = batchReceiveInstrumenter.shouldStart(parentContext, request); + Context receiveContext = + receiveStarted ? batchReceiveInstrumenter.start(parentContext, request) : parentContext; + Context processParentContext = emitStableMessagingSemconv() ? parentContext : receiveContext; + List processSpans = new ArrayList<>(batchSize); + for (MessageExt message : msgs) { + createChildSpan( + processParentContext, message, consumerGroup, batchSize, namespace, processSpans); + } + if (receiveStarted || !processSpans.isEmpty()) { + return new ConsumerContext(receiveContext, request, processSpans, receiveStarted); } } - return parentContext; + return null; } - private void createChildSpan(Context parentContext, MessageExt msg) { - if (batchProcessInstrumenter.shouldStart(parentContext, msg)) { - Context context = batchProcessInstrumenter.start(parentContext, msg); - batchProcessInstrumenter.end(context, msg, null, null); + private void createChildSpan( + Context parentContext, + MessageExt msg, + String consumerGroup, + int batchSize, + @Nullable String namespace, + List processSpans) { + RocketMqConsumerRequest request = + new RocketMqConsumerRequest(msg, consumerGroup, batchSize, namespace); + if (batchProcessInstrumenter.shouldStart(parentContext, request)) { + Context context = batchProcessInstrumenter.start(parentContext, request); + processSpans.add(new StartedProcessSpan(context, request)); } } - void end(Context context, List msgs) { - if (msgs.size() == 1) { - singleProcessInstrumenter.end(context, msgs.get(0), null, null); + void end(ConsumerContext consumerContext, ConsumeMessageContext response) { + if (consumerContext.getRequest().getBatchSize() == 1) { + singleProcessInstrumenter.end( + consumerContext.getContext(), consumerContext.getRequest(), response, null); } else { - batchReceiveInstrumenter.end(context, null, null, null); + for (StartedProcessSpan processSpan : consumerContext.getProcessSpans()) { + batchProcessInstrumenter.end( + processSpan.getContext(), processSpan.getRequest(), response, null); + } + if (consumerContext.isReceiveStarted()) { + batchReceiveInstrumenter.end( + consumerContext.getContext(), consumerContext.getRequest(), null, null); + } + } + } + + static final class ConsumerContext { + private final Context context; + private final RocketMqConsumerRequest request; + private final List processSpans; + private final boolean receiveStarted; + + private ConsumerContext( + Context context, + RocketMqConsumerRequest request, + List processSpans, + boolean receiveStarted) { + this.context = context; + this.request = request; + this.processSpans = processSpans; + this.receiveStarted = receiveStarted; + } + + Context getContext() { + return context; + } + + RocketMqConsumerRequest getRequest() { + return request; + } + + private List getProcessSpans() { + return processSpans; + } + + private boolean isReceiveStarted() { + return receiveStarted; + } + } + + private static final class StartedProcessSpan { + private final Context context; + private final RocketMqConsumerRequest request; + + private StartedProcessSpan(Context context, RocketMqConsumerRequest request) { + this.context = context; + this.request = request; + } + + Context getContext() { + return context; + } + + RocketMqConsumerRequest getRequest() { + return request; } } } diff --git a/instrumentation/rocketmq/rocketmq-client-4.8/library/src/main/java/io/opentelemetry/instrumentation/rocketmqclient/v4_8/RocketMqConsumerRequest.java b/instrumentation/rocketmq/rocketmq-client-4.8/library/src/main/java/io/opentelemetry/instrumentation/rocketmqclient/v4_8/RocketMqConsumerRequest.java new file mode 100644 index 000000000000..fbd80434e4b8 --- /dev/null +++ b/instrumentation/rocketmq/rocketmq-client-4.8/library/src/main/java/io/opentelemetry/instrumentation/rocketmqclient/v4_8/RocketMqConsumerRequest.java @@ -0,0 +1,41 @@ +/* + * Copyright The OpenTelemetry Authors + * SPDX-License-Identifier: Apache-2.0 + */ + +package io.opentelemetry.instrumentation.rocketmqclient.v4_8; + +import javax.annotation.Nullable; +import org.apache.rocketmq.common.message.MessageExt; + +final class RocketMqConsumerRequest { + + private final MessageExt message; + private final String consumerGroup; + private final int batchSize; + private final String namespace; + + RocketMqConsumerRequest( + MessageExt message, String consumerGroup, int batchSize, @Nullable String namespace) { + this.message = message; + this.consumerGroup = RocketMqNamespaceUtil.withoutNamespace(consumerGroup, namespace); + this.batchSize = batchSize; + this.namespace = namespace == null ? "" : namespace; + } + + MessageExt getMessage() { + return message; + } + + String getConsumerGroup() { + return consumerGroup; + } + + int getBatchSize() { + return batchSize; + } + + String getNamespace() { + return namespace; + } +} diff --git a/instrumentation/rocketmq/rocketmq-client-4.8/library/src/main/java/io/opentelemetry/instrumentation/rocketmqclient/v4_8/RocketMqInstrumenterFactory.java b/instrumentation/rocketmq/rocketmq-client-4.8/library/src/main/java/io/opentelemetry/instrumentation/rocketmqclient/v4_8/RocketMqInstrumenterFactory.java index ef611cf66212..0941abe12c74 100644 --- a/instrumentation/rocketmq/rocketmq-client-4.8/library/src/main/java/io/opentelemetry/instrumentation/rocketmqclient/v4_8/RocketMqInstrumenterFactory.java +++ b/instrumentation/rocketmq/rocketmq-client-4.8/library/src/main/java/io/opentelemetry/instrumentation/rocketmqclient/v4_8/RocketMqInstrumenterFactory.java @@ -8,32 +8,50 @@ import static io.opentelemetry.instrumentation.api.incubator.semconv.messaging.internal.MessagingExceptionEventExtractors.setMessagingProcessExceptionEventExtractor; import static io.opentelemetry.instrumentation.api.incubator.semconv.messaging.internal.MessagingExceptionEventExtractors.setMessagingSendExceptionEventExtractor; import static io.opentelemetry.instrumentation.api.instrumenter.AttributesExtractor.constant; +import static io.opentelemetry.instrumentation.api.internal.SemconvStability.emitOldMessagingSemconv; +import static io.opentelemetry.instrumentation.api.internal.SemconvStability.emitStableMessagingSemconv; import io.opentelemetry.api.OpenTelemetry; import io.opentelemetry.api.common.AttributeKey; -import io.opentelemetry.instrumentation.api.incubator.semconv.messaging.MessageOperation; +import io.opentelemetry.api.common.AttributesBuilder; +import io.opentelemetry.api.trace.StatusCode; +import io.opentelemetry.context.Context; import io.opentelemetry.instrumentation.api.incubator.semconv.messaging.MessagingAttributesExtractor; import io.opentelemetry.instrumentation.api.incubator.semconv.messaging.MessagingAttributesGetter; +import io.opentelemetry.instrumentation.api.incubator.semconv.messaging.MessagingOperationType; +import io.opentelemetry.instrumentation.api.incubator.semconv.messaging.MessagingSpanKindExtractor; import io.opentelemetry.instrumentation.api.incubator.semconv.messaging.MessagingSpanNameExtractor; +import io.opentelemetry.instrumentation.api.incubator.semconv.messaging.internal.MessagingProcessInstrumenterFactory; import io.opentelemetry.instrumentation.api.instrumenter.AttributesExtractor; import io.opentelemetry.instrumentation.api.instrumenter.Instrumenter; import io.opentelemetry.instrumentation.api.instrumenter.InstrumenterBuilder; -import io.opentelemetry.instrumentation.api.instrumenter.SpanKindExtractor; -import io.opentelemetry.instrumentation.api.instrumenter.SpanLinksExtractor; -import io.opentelemetry.instrumentation.api.internal.PropagatorBasedSpanLinksExtractor; +import io.opentelemetry.instrumentation.api.instrumenter.SpanStatusExtractor; import java.util.List; +import javax.annotation.Nullable; +import org.apache.rocketmq.client.hook.ConsumeMessageContext; import org.apache.rocketmq.client.hook.SendMessageContext; -import org.apache.rocketmq.common.message.MessageExt; class RocketMqInstrumenterFactory { private static final String INSTRUMENTATION_NAME = "io.opentelemetry.rocketmq-client-4.8"; // copied from MessagingIncubatingAttributes + private static final AttributeKey MESSAGING_CONSUMER_GROUP_NAME = + AttributeKey.stringKey("messaging.consumer.group.name"); + private static final AttributeKey MESSAGING_DESTINATION_NAME = + AttributeKey.stringKey("messaging.destination.name"); private static final AttributeKey MESSAGING_OPERATION = AttributeKey.stringKey("messaging.operation"); + private static final AttributeKey MESSAGING_OPERATION_NAME = + AttributeKey.stringKey("messaging.operation.name"); + private static final AttributeKey MESSAGING_OPERATION_TYPE = + AttributeKey.stringKey("messaging.operation.type"); private static final AttributeKey MESSAGING_SYSTEM = AttributeKey.stringKey("messaging.system"); + private static final AttributeKey MESSAGING_ROCKETMQ_NAMESPACE = + AttributeKey.stringKey("messaging.rocketmq.namespace"); + private static final AttributeKey MESSAGING_BATCH_MESSAGE_COUNT = + AttributeKey.longKey("messaging.batch.message_count"); static Instrumenter createProducerInstrumenter( OpenTelemetry openTelemetry, @@ -41,15 +59,34 @@ static Instrumenter createProducerInstrumenter( boolean captureExperimentalSpanAttributes) { RocketMqProducerAttributeGetter getter = new RocketMqProducerAttributeGetter(); - MessageOperation operation = MessageOperation.PUBLISH; + MessagingOperationType operationType = MessagingOperationType.SEND; InstrumenterBuilder instrumenterBuilder = Instrumenter.builder( openTelemetry, INSTRUMENTATION_NAME, - MessagingSpanNameExtractor.create(getter, operation)) + MessagingSpanNameExtractor.create(getter, operationType)) .addAttributesExtractor( - buildMessagingAttributesExtractor(getter, operation, capturedHeaders)); + buildMessagingAttributesExtractor(getter, operationType, capturedHeaders)); + if (emitStableMessagingSemconv()) { + instrumenterBuilder.addAttributesExtractor( + new AttributesExtractor() { + @Override + public void onStart( + AttributesBuilder attributes, Context parentContext, SendMessageContext request) { + String namespace = RocketMqNamespaceUtil.getNamespace(request); + attributes.put(MESSAGING_ROCKETMQ_NAMESPACE, namespace == null ? "" : namespace); + } + + @Override + public void onEnd( + AttributesBuilder attributes, + Context context, + SendMessageContext request, + @Nullable Void unused, + @Nullable Throwable error) {} + }); + } if (captureExperimentalSpanAttributes) { instrumenterBuilder.addAttributesExtractor( new RocketMqProducerExperimentalAttributeExtractor()); @@ -64,66 +101,122 @@ static RocketMqConsumerInstrumenter createConsumerInstrumenter( List capturedHeaders, boolean captureExperimentalSpanAttributes) { - InstrumenterBuilder batchReceiveInstrumenterBuilder = - Instrumenter.builder( + InstrumenterBuilder batchReceiveInstrumenterBuilder = + Instrumenter.builder( openTelemetry, INSTRUMENTATION_NAME, RocketMqInstrumenterFactory::spanNameOnReceive) - .addAttributesExtractor(constant(MESSAGING_SYSTEM, "rocketmq")) - .addAttributesExtractor(constant(MESSAGING_OPERATION, "receive")); + .addAttributesExtractor(constant(MESSAGING_SYSTEM, "rocketmq")); + if (emitOldMessagingSemconv()) { + batchReceiveInstrumenterBuilder.addAttributesExtractor( + constant(MESSAGING_OPERATION, "receive")); + } + if (emitStableMessagingSemconv()) { + batchReceiveInstrumenterBuilder + .addAttributesExtractor(constant(MESSAGING_OPERATION_NAME, "receive")) + .addAttributesExtractor(constant(MESSAGING_OPERATION_TYPE, "receive")) + .addAttributesExtractor( + new AttributesExtractor() { + @Override + public void onStart( + AttributesBuilder attributes, + Context parentContext, + RocketMqConsumerRequest request) { + attributes.put(MESSAGING_BATCH_MESSAGE_COUNT, request.getBatchSize()); + attributes.put(MESSAGING_CONSUMER_GROUP_NAME, request.getConsumerGroup()); + attributes.put(MESSAGING_DESTINATION_NAME, request.getMessage().getTopic()); + attributes.put(MESSAGING_ROCKETMQ_NAMESPACE, request.getNamespace()); + } + + @Override + public void onEnd( + AttributesBuilder attributes, + Context context, + RocketMqConsumerRequest request, + @Nullable Void unused, + @Nullable Throwable error) {} + }); + } return new RocketMqConsumerInstrumenter( createProcessInstrumenter( openTelemetry, capturedHeaders, captureExperimentalSpanAttributes, false), createProcessInstrumenter( openTelemetry, capturedHeaders, captureExperimentalSpanAttributes, true), - batchReceiveInstrumenterBuilder.buildInstrumenter(SpanKindExtractor.alwaysConsumer())); + batchReceiveInstrumenterBuilder.buildInstrumenter( + MessagingSpanKindExtractor.create(MessagingOperationType.RECEIVE))); } - private static Instrumenter createProcessInstrumenter( - OpenTelemetry openTelemetry, - List capturedHeaders, - boolean captureExperimentalSpanAttributes, - boolean batch) { + private static Instrumenter + createProcessInstrumenter( + OpenTelemetry openTelemetry, + List capturedHeaders, + boolean captureExperimentalSpanAttributes, + boolean batch) { RocketMqConsumerAttributeGetter getter = new RocketMqConsumerAttributeGetter(); - MessageOperation operation = MessageOperation.PROCESS; + MessagingOperationType operationType = MessagingOperationType.PROCESS; - InstrumenterBuilder builder = + InstrumenterBuilder builder = Instrumenter.builder( openTelemetry, INSTRUMENTATION_NAME, - MessagingSpanNameExtractor.create(getter, operation)); + MessagingSpanNameExtractor.create(getter, operationType)); builder.addAttributesExtractor( - buildMessagingAttributesExtractor(getter, operation, capturedHeaders)); + buildMessagingAttributesExtractor(getter, operationType, capturedHeaders)); + if (emitStableMessagingSemconv()) { + builder.addAttributesExtractor( + new AttributesExtractor() { + @Override + public void onStart( + AttributesBuilder attributes, + Context parentContext, + RocketMqConsumerRequest request) { + attributes.put(MESSAGING_CONSUMER_GROUP_NAME, request.getConsumerGroup()); + attributes.put(MESSAGING_ROCKETMQ_NAMESPACE, request.getNamespace()); + } + + @Override + public void onEnd( + AttributesBuilder attributes, + Context context, + RocketMqConsumerRequest request, + @Nullable ConsumeMessageContext response, + @Nullable Throwable error) {} + }); + } if (captureExperimentalSpanAttributes) { builder.addAttributesExtractor(new RocketMqConsumerExperimentalAttributeExtractor()); } + builder.setSpanStatusExtractor( + (spanStatusBuilder, request, response, error) -> { + if (response != null && !response.isSuccess()) { + spanStatusBuilder.setStatus(StatusCode.ERROR); + } else { + SpanStatusExtractor.getDefault().extract(spanStatusBuilder, request, response, error); + } + }); setMessagingProcessExceptionEventExtractor(builder); - if (batch) { - SpanLinksExtractor spanLinksExtractor = - new PropagatorBasedSpanLinksExtractor<>( - openTelemetry.getPropagators().getTextMapPropagator(), new TextMapExtractAdapter()); - - return builder - .addSpanLinksExtractor(spanLinksExtractor) - .buildInstrumenter(SpanKindExtractor.alwaysConsumer()); - } else { - return builder.buildConsumerInstrumenter(new TextMapExtractAdapter()); - } + return MessagingProcessInstrumenterFactory.create( + builder, + openTelemetry.getPropagators().getTextMapPropagator(), + new TextMapExtractAdapter(), + batch); } - private static AttributesExtractor buildMessagingAttributesExtractor( - MessagingAttributesGetter getter, - MessageOperation operation, + private static AttributesExtractor buildMessagingAttributesExtractor( + MessagingAttributesGetter getter, + MessagingOperationType operationType, List capturedHeaders) { - return MessagingAttributesExtractor.builder(getter, operation) + return MessagingAttributesExtractor.builderForOperationType(getter, operationType) .setCapturedHeaders(capturedHeaders) .build(); } - private static String spanNameOnReceive(Void unused) { - return "multiple_sources receive"; + private static String spanNameOnReceive(RocketMqConsumerRequest request) { + return emitStableMessagingSemconv() + ? "receive " + request.getMessage().getTopic() + : "multiple_sources receive"; } private RocketMqInstrumenterFactory() {} diff --git a/instrumentation/rocketmq/rocketmq-client-4.8/library/src/main/java/io/opentelemetry/instrumentation/rocketmqclient/v4_8/RocketMqNamespaceUtil.java b/instrumentation/rocketmq/rocketmq-client-4.8/library/src/main/java/io/opentelemetry/instrumentation/rocketmqclient/v4_8/RocketMqNamespaceUtil.java new file mode 100644 index 000000000000..e51cad91da6a --- /dev/null +++ b/instrumentation/rocketmq/rocketmq-client-4.8/library/src/main/java/io/opentelemetry/instrumentation/rocketmqclient/v4_8/RocketMqNamespaceUtil.java @@ -0,0 +1,68 @@ +/* + * Copyright The OpenTelemetry Authors + * SPDX-License-Identifier: Apache-2.0 + */ + +package io.opentelemetry.instrumentation.rocketmqclient.v4_8; + +import java.lang.reflect.Method; +import javax.annotation.Nullable; + +final class RocketMqNamespaceUtil { + + private static final NamespaceAccessor noNamespaceAccessor = context -> null; + private static final ClassValue namespaceAccessors = + new ClassValue() { + @Override + protected NamespaceAccessor computeValue(Class type) { + try { + Method method = type.getMethod("getNamespace"); + return context -> invoke(method, context); + } catch (NoSuchMethodException ignored) { + return noNamespaceAccessor; + } + } + }; + + @Nullable + static String getNamespace(Object context) { + return namespaceAccessors.get(context.getClass()).get(context); + } + + @Nullable + private static String invoke(Method method, Object context) { + try { + return (String) method.invoke(context); + } catch (ReflectiveOperationException ignored) { + return null; + } + } + + static String withoutNamespace(String resource, @Nullable String namespace) { + if (resource.isEmpty() || namespace == null || namespace.isEmpty()) { + return resource; + } + + String prefix = ""; + String resourceWithoutPrefix = resource; + if (resource.startsWith("%RETRY%")) { + prefix = "%RETRY%"; + resourceWithoutPrefix = resource.substring(prefix.length()); + } else if (resource.startsWith("%DLQ%")) { + prefix = "%DLQ%"; + resourceWithoutPrefix = resource.substring(prefix.length()); + } + + String namespacePrefix = namespace + "%"; + return resourceWithoutPrefix.startsWith(namespacePrefix) + ? prefix + resourceWithoutPrefix.substring(namespacePrefix.length()) + : resource; + } + + private RocketMqNamespaceUtil() {} + + private interface NamespaceAccessor { + @Nullable + String get(Object context); + } +} diff --git a/instrumentation/rocketmq/rocketmq-client-4.8/library/src/main/java/io/opentelemetry/instrumentation/rocketmqclient/v4_8/RocketMqProducerAttributeGetter.java b/instrumentation/rocketmq/rocketmq-client-4.8/library/src/main/java/io/opentelemetry/instrumentation/rocketmqclient/v4_8/RocketMqProducerAttributeGetter.java index 4048995ba28a..e7e01694ee00 100644 --- a/instrumentation/rocketmq/rocketmq-client-4.8/library/src/main/java/io/opentelemetry/instrumentation/rocketmqclient/v4_8/RocketMqProducerAttributeGetter.java +++ b/instrumentation/rocketmq/rocketmq-client-4.8/library/src/main/java/io/opentelemetry/instrumentation/rocketmqclient/v4_8/RocketMqProducerAttributeGetter.java @@ -5,6 +5,7 @@ package io.opentelemetry.instrumentation.rocketmqclient.v4_8; +import static io.opentelemetry.instrumentation.api.internal.SemconvStability.emitStableMessagingSemconv; import static java.util.Collections.emptyList; import static java.util.Collections.singletonList; @@ -27,7 +28,10 @@ public String getSystem(SendMessageContext request) { @Override public String getDestination(SendMessageContext request) { Message message = request.getMessage(); - return message == null ? null : message.getTopic(); + return message == null + ? null + : RocketMqNamespaceUtil.withoutNamespace( + message.getTopic(), RocketMqNamespaceUtil.getNamespace(request)); } @Nullable @@ -80,6 +84,14 @@ public String getClientId(SendMessageContext request) { @Nullable @Override public Long getBatchMessageCount(SendMessageContext request, @Nullable Void unused) { + Message message = request.getMessage(); + if (emitStableMessagingSemconv() && message instanceof Iterable) { + long batchSize = 0; + for (Object ignored : (Iterable) message) { + batchSize++; + } + return batchSize; + } return null; } diff --git a/instrumentation/rocketmq/rocketmq-client-4.8/library/src/main/java/io/opentelemetry/instrumentation/rocketmqclient/v4_8/TextMapExtractAdapter.java b/instrumentation/rocketmq/rocketmq-client-4.8/library/src/main/java/io/opentelemetry/instrumentation/rocketmqclient/v4_8/TextMapExtractAdapter.java index 664c6d7ad7b2..a9e532667590 100644 --- a/instrumentation/rocketmq/rocketmq-client-4.8/library/src/main/java/io/opentelemetry/instrumentation/rocketmqclient/v4_8/TextMapExtractAdapter.java +++ b/instrumentation/rocketmq/rocketmq-client-4.8/library/src/main/java/io/opentelemetry/instrumentation/rocketmqclient/v4_8/TextMapExtractAdapter.java @@ -7,18 +7,17 @@ import io.opentelemetry.context.propagation.TextMapGetter; import javax.annotation.Nullable; -import org.apache.rocketmq.common.message.MessageExt; -final class TextMapExtractAdapter implements TextMapGetter { +final class TextMapExtractAdapter implements TextMapGetter { @Override - public Iterable keys(MessageExt carrier) { - return carrier.getProperties().keySet(); + public Iterable keys(RocketMqConsumerRequest carrier) { + return carrier.getMessage().getProperties().keySet(); } @Nullable @Override - public String get(@Nullable MessageExt carrier, String key) { - return carrier == null ? null : carrier.getProperties().get(key); + public String get(@Nullable RocketMqConsumerRequest carrier, String key) { + return carrier == null ? null : carrier.getMessage().getProperties().get(key); } } diff --git a/instrumentation/rocketmq/rocketmq-client-4.8/library/src/main/java/io/opentelemetry/instrumentation/rocketmqclient/v4_8/TracingConsumeMessageHookImpl.java b/instrumentation/rocketmq/rocketmq-client-4.8/library/src/main/java/io/opentelemetry/instrumentation/rocketmqclient/v4_8/TracingConsumeMessageHookImpl.java index e53244d2930d..f508d9baeec0 100644 --- a/instrumentation/rocketmq/rocketmq-client-4.8/library/src/main/java/io/opentelemetry/instrumentation/rocketmqclient/v4_8/TracingConsumeMessageHookImpl.java +++ b/instrumentation/rocketmq/rocketmq-client-4.8/library/src/main/java/io/opentelemetry/instrumentation/rocketmqclient/v4_8/TracingConsumeMessageHookImpl.java @@ -33,15 +33,21 @@ public void consumeMessageBefore(ConsumeMessageContext context) { return; } Context parentContext = Context.current(); - Context newContext = instrumenter.start(parentContext, context.getMsgList()); + RocketMqConsumerInstrumenter.ConsumerContext consumerContext = + instrumenter.start( + parentContext, + context.getMsgList(), + context.getConsumerGroup(), + RocketMqNamespaceUtil.getNamespace(context)); // it's safe to store the scope in the rocketMq message context, both before() and after() // methods are always called from the same thread; see: // - ConsumeMessageConcurrentlyService$ConsumeRequest#run() // - ConsumeMessageOrderlyService$ConsumeRequest#run() - if (newContext != parentContext) { + if (consumerContext != null) { + Context newContext = consumerContext.getContext(); CONTEXT_AND_SCOPE_FIELD.set( - context, ContextAndScope.create(newContext, newContext.makeCurrent())); + context, ContextAndScope.create(consumerContext, newContext.makeCurrent())); } } @@ -53,7 +59,7 @@ public void consumeMessageAfter(ConsumeMessageContext context) { ContextAndScope contextAndScope = CONTEXT_AND_SCOPE_FIELD.get(context); if (contextAndScope != null) { contextAndScope.close(); - instrumenter.end(contextAndScope.getContext(), context.getMsgList()); + instrumenter.end(contextAndScope.getConsumerContext(), context); } } } diff --git a/instrumentation/rocketmq/rocketmq-client-4.8/library/src/test/java/io/opentelemetry/instrumentation/rocketmqclient/v4_8/RocketMqConsumerInstrumenterTest.java b/instrumentation/rocketmq/rocketmq-client-4.8/library/src/test/java/io/opentelemetry/instrumentation/rocketmqclient/v4_8/RocketMqConsumerInstrumenterTest.java new file mode 100644 index 000000000000..5e7d8f2bba9d --- /dev/null +++ b/instrumentation/rocketmq/rocketmq-client-4.8/library/src/test/java/io/opentelemetry/instrumentation/rocketmqclient/v4_8/RocketMqConsumerInstrumenterTest.java @@ -0,0 +1,103 @@ +/* + * Copyright The OpenTelemetry Authors + * SPDX-License-Identifier: Apache-2.0 + */ + +package io.opentelemetry.instrumentation.rocketmqclient.v4_8; + +import static java.util.Arrays.asList; +import static java.util.Objects.requireNonNull; +import static org.assertj.core.api.Assertions.assertThat; +import static org.mockito.ArgumentMatchers.any; +import static org.mockito.ArgumentMatchers.same; +import static org.mockito.Mockito.mock; +import static org.mockito.Mockito.never; +import static org.mockito.Mockito.times; +import static org.mockito.Mockito.verify; +import static org.mockito.Mockito.verifyNoInteractions; +import static org.mockito.Mockito.when; + +import io.opentelemetry.context.Context; +import io.opentelemetry.instrumentation.api.instrumenter.Instrumenter; +import org.apache.rocketmq.client.hook.ConsumeMessageContext; +import org.apache.rocketmq.common.message.MessageExt; +import org.junit.jupiter.api.Test; +import org.junit.jupiter.api.extension.ExtendWith; +import org.mockito.Mock; +import org.mockito.junit.jupiter.MockitoExtension; + +@ExtendWith(MockitoExtension.class) +class RocketMqConsumerInstrumenterTest { + + @Mock + private Instrumenter singleProcessInstrumenter; + + @Mock + private Instrumenter batchProcessInstrumenter; + + @Mock private Instrumenter batchReceiveInstrumenter; + + @Test + void usesEmptyNamespaceByDefault() { + RocketMqConsumerRequest request = + new RocketMqConsumerRequest(mock(MessageExt.class), "consumer-group", 1, null); + + assertThat(request.getNamespace()).isEmpty(); + } + + @Test + void endsBatchReceiveWhenAllProcessSpansAreSuppressed() { + RocketMqConsumerInstrumenter instrumenter = + new RocketMqConsumerInstrumenter( + singleProcessInstrumenter, batchProcessInstrumenter, batchReceiveInstrumenter); + Context parentContext = Context.root(); + Context receiveContext = mock(Context.class); + when(batchReceiveInstrumenter.shouldStart(same(parentContext), any())).thenReturn(true); + when(batchReceiveInstrumenter.start(same(parentContext), any())).thenReturn(receiveContext); + + RocketMqConsumerInstrumenter.ConsumerContext consumerContext = + requireNonNull( + instrumenter.start( + parentContext, + asList(mock(MessageExt.class), mock(MessageExt.class)), + "consumer-group", + "namespace")); + ConsumeMessageContext response = mock(ConsumeMessageContext.class); + instrumenter.end(consumerContext, response); + + verify(batchProcessInstrumenter, times(2)).shouldStart(any(), any()); + verify(batchReceiveInstrumenter) + .end(same(receiveContext), same(consumerContext.getRequest()), same(null), same(null)); + verifyNoInteractions(singleProcessInstrumenter); + } + + @Test + void startsBatchProcessSpansWhenReceiveSpanIsSuppressed() { + RocketMqConsumerInstrumenter instrumenter = + new RocketMqConsumerInstrumenter( + singleProcessInstrumenter, batchProcessInstrumenter, batchReceiveInstrumenter); + Context parentContext = Context.root(); + Context processContext = mock(Context.class); + when(batchReceiveInstrumenter.shouldStart(same(parentContext), any())).thenReturn(false); + when(batchProcessInstrumenter.shouldStart(same(parentContext), any())).thenReturn(true); + when(batchProcessInstrumenter.start(same(parentContext), any())).thenReturn(processContext); + + RocketMqConsumerInstrumenter.ConsumerContext consumerContext = + requireNonNull( + instrumenter.start( + parentContext, + asList(mock(MessageExt.class), mock(MessageExt.class)), + "consumer-group", + "namespace")); + ConsumeMessageContext response = mock(ConsumeMessageContext.class); + instrumenter.end(consumerContext, response); + + assertThat(consumerContext.getContext()).isSameAs(parentContext); + verify(batchProcessInstrumenter, times(2)).start(same(parentContext), any()); + verify(batchProcessInstrumenter, times(2)) + .end(same(processContext), any(), same(response), same(null)); + verify(batchReceiveInstrumenter, never()).start(any(), any()); + verify(batchReceiveInstrumenter, never()).end(any(), any(), any(), any()); + verifyNoInteractions(singleProcessInstrumenter); + } +} diff --git a/instrumentation/rocketmq/rocketmq-client-4.8/library/src/test/java/io/opentelemetry/instrumentation/rocketmqclient/v4_8/RocketMqInstrumenterFactoryTest.java b/instrumentation/rocketmq/rocketmq-client-4.8/library/src/test/java/io/opentelemetry/instrumentation/rocketmqclient/v4_8/RocketMqInstrumenterFactoryTest.java new file mode 100644 index 000000000000..8f0cd9cfc37d --- /dev/null +++ b/instrumentation/rocketmq/rocketmq-client-4.8/library/src/test/java/io/opentelemetry/instrumentation/rocketmqclient/v4_8/RocketMqInstrumenterFactoryTest.java @@ -0,0 +1,72 @@ +/* + * Copyright The OpenTelemetry Authors + * SPDX-License-Identifier: Apache-2.0 + */ + +package io.opentelemetry.instrumentation.rocketmqclient.v4_8; + +import static io.opentelemetry.api.trace.SpanKind.PRODUCER; +import static io.opentelemetry.instrumentation.api.internal.SemconvStability.emitOldMessagingSemconv; +import static io.opentelemetry.instrumentation.api.internal.SemconvStability.emitStableMessagingSemconv; +import static io.opentelemetry.sdk.testing.assertj.OpenTelemetryAssertions.equalTo; +import static io.opentelemetry.semconv.incubating.MessagingIncubatingAttributes.MESSAGING_DESTINATION_NAME; +import static io.opentelemetry.semconv.incubating.MessagingIncubatingAttributes.MESSAGING_OPERATION; +import static io.opentelemetry.semconv.incubating.MessagingIncubatingAttributes.MESSAGING_OPERATION_NAME; +import static io.opentelemetry.semconv.incubating.MessagingIncubatingAttributes.MESSAGING_OPERATION_TYPE; +import static io.opentelemetry.semconv.incubating.MessagingIncubatingAttributes.MESSAGING_ROCKETMQ_NAMESPACE; +import static io.opentelemetry.semconv.incubating.MessagingIncubatingAttributes.MESSAGING_SYSTEM; +import static java.util.Collections.emptyList; +import static org.assertj.core.api.Assertions.assertThat; +import static org.mockito.Mockito.mock; +import static org.mockito.Mockito.when; + +import io.opentelemetry.context.Context; +import io.opentelemetry.instrumentation.api.instrumenter.Instrumenter; +import io.opentelemetry.instrumentation.testing.junit.InstrumentationExtension; +import io.opentelemetry.instrumentation.testing.junit.LibraryInstrumentationExtension; +import org.apache.rocketmq.client.hook.SendMessageContext; +import org.apache.rocketmq.common.message.Message; +import org.junit.jupiter.api.Test; +import org.junit.jupiter.api.extension.RegisterExtension; + +class RocketMqInstrumenterFactoryTest { + + @RegisterExtension + private static final InstrumentationExtension testing = LibraryInstrumentationExtension.create(); + + @Test + @SuppressWarnings("deprecation") // using deprecated semconv + void usesEmptyProducerNamespaceByDefault() { + SendMessageContext request = mock(SendMessageContext.class); + when(request.getMessage()).thenReturn(new Message("topic", new byte[0])); + Instrumenter instrumenter = + RocketMqInstrumenterFactory.createProducerInstrumenter( + testing.getOpenTelemetry(), emptyList(), false); + Context parentContext = Context.root(); + + assertThat(instrumenter.shouldStart(parentContext, request)).isTrue(); + Context context = instrumenter.start(parentContext, request); + instrumenter.end(context, request, null, null); + + testing.waitAndAssertTraces( + trace -> + trace.hasSpansSatisfyingExactly( + span -> + span.hasName(emitStableMessagingSemconv() ? "publish topic" : "topic publish") + .hasKind(PRODUCER) + .hasAttributesSatisfyingExactly( + equalTo(MESSAGING_SYSTEM, "rocketmq"), + equalTo(MESSAGING_DESTINATION_NAME, "topic"), + equalTo( + MESSAGING_OPERATION, emitOldMessagingSemconv() ? "publish" : null), + equalTo( + MESSAGING_OPERATION_NAME, + emitStableMessagingSemconv() ? "publish" : null), + equalTo( + MESSAGING_OPERATION_TYPE, + emitStableMessagingSemconv() ? "send" : null), + equalTo( + MESSAGING_ROCKETMQ_NAMESPACE, + emitStableMessagingSemconv() ? "" : null)))); + } +} diff --git a/instrumentation/rocketmq/rocketmq-client-4.8/library/src/test/java/io/opentelemetry/instrumentation/rocketmqclient/v4_8/RocketMqNamespaceUtilTest.java b/instrumentation/rocketmq/rocketmq-client-4.8/library/src/test/java/io/opentelemetry/instrumentation/rocketmqclient/v4_8/RocketMqNamespaceUtilTest.java new file mode 100644 index 000000000000..210a569c1ebe --- /dev/null +++ b/instrumentation/rocketmq/rocketmq-client-4.8/library/src/test/java/io/opentelemetry/instrumentation/rocketmqclient/v4_8/RocketMqNamespaceUtilTest.java @@ -0,0 +1,35 @@ +/* + * Copyright The OpenTelemetry Authors + * SPDX-License-Identifier: Apache-2.0 + */ + +package io.opentelemetry.instrumentation.rocketmqclient.v4_8; + +import static org.assertj.core.api.Assertions.assertThat; + +import org.junit.jupiter.api.Test; + +class RocketMqNamespaceUtilTest { + + @Test + void readsNamespaceFromSupportedContext() { + ContextWithNamespace context = new ContextWithNamespace(); + + assertThat(RocketMqNamespaceUtil.getNamespace(context)).isEqualTo("namespace"); + assertThat(RocketMqNamespaceUtil.getNamespace(context)).isEqualTo("namespace"); + } + + @Test + void handlesContextWithoutNamespace() { + Object context = new Object(); + + assertThat(RocketMqNamespaceUtil.getNamespace(context)).isNull(); + assertThat(RocketMqNamespaceUtil.getNamespace(context)).isNull(); + } + + public static class ContextWithNamespace { + public String getNamespace() { + return "namespace"; + } + } +} diff --git a/instrumentation/rocketmq/rocketmq-client-4.8/testing/src/main/java/io/opentelemetry/instrumentation/rocketmqclient/v4_8/AbstractRocketMqClientTest.java b/instrumentation/rocketmq/rocketmq-client-4.8/testing/src/main/java/io/opentelemetry/instrumentation/rocketmqclient/v4_8/AbstractRocketMqClientTest.java index 1fcd3d3db393..b5df750dd865 100644 --- a/instrumentation/rocketmq/rocketmq-client-4.8/testing/src/main/java/io/opentelemetry/instrumentation/rocketmqclient/v4_8/AbstractRocketMqClientTest.java +++ b/instrumentation/rocketmq/rocketmq-client-4.8/testing/src/main/java/io/opentelemetry/instrumentation/rocketmqclient/v4_8/AbstractRocketMqClientTest.java @@ -7,15 +7,26 @@ import static io.opentelemetry.api.common.AttributeKey.longKey; import static io.opentelemetry.api.common.AttributeKey.stringKey; +import static io.opentelemetry.api.trace.SpanKind.CLIENT; +import static io.opentelemetry.api.trace.SpanKind.CONSUMER; +import static io.opentelemetry.instrumentation.api.internal.SemconvStability.emitOldMessagingSemconv; +import static io.opentelemetry.instrumentation.api.internal.SemconvStability.emitStableMessagingSemconv; +import static io.opentelemetry.instrumentation.rocketmqclient.v4_8.base.BaseConf.NAMESPACE; import static io.opentelemetry.instrumentation.testing.junit.message.MessageHeaderUtil.headerAttributeKey; import static io.opentelemetry.instrumentation.testing.util.TestLatestDeps.testLatestDeps; import static io.opentelemetry.sdk.testing.assertj.OpenTelemetryAssertions.equalTo; import static io.opentelemetry.sdk.testing.assertj.OpenTelemetryAssertions.satisfies; +import static io.opentelemetry.semconv.ErrorAttributes.ERROR_TYPE; +import static io.opentelemetry.semconv.incubating.MessagingIncubatingAttributes.MESSAGING_BATCH_MESSAGE_COUNT; +import static io.opentelemetry.semconv.incubating.MessagingIncubatingAttributes.MESSAGING_CONSUMER_GROUP_NAME; import static io.opentelemetry.semconv.incubating.MessagingIncubatingAttributes.MESSAGING_DESTINATION_NAME; import static io.opentelemetry.semconv.incubating.MessagingIncubatingAttributes.MESSAGING_MESSAGE_BODY_SIZE; import static io.opentelemetry.semconv.incubating.MessagingIncubatingAttributes.MESSAGING_MESSAGE_ID; import static io.opentelemetry.semconv.incubating.MessagingIncubatingAttributes.MESSAGING_OPERATION; +import static io.opentelemetry.semconv.incubating.MessagingIncubatingAttributes.MESSAGING_OPERATION_NAME; +import static io.opentelemetry.semconv.incubating.MessagingIncubatingAttributes.MESSAGING_OPERATION_TYPE; import static io.opentelemetry.semconv.incubating.MessagingIncubatingAttributes.MESSAGING_ROCKETMQ_MESSAGE_TAG; +import static io.opentelemetry.semconv.incubating.MessagingIncubatingAttributes.MESSAGING_ROCKETMQ_NAMESPACE; import static io.opentelemetry.semconv.incubating.MessagingIncubatingAttributes.MESSAGING_SYSTEM; import static java.util.Collections.singletonList; import static java.util.concurrent.TimeUnit.SECONDS; @@ -25,7 +36,11 @@ import io.opentelemetry.api.trace.SpanKind; import io.opentelemetry.instrumentation.rocketmqclient.v4_8.base.BaseConf; import io.opentelemetry.instrumentation.testing.junit.InstrumentationExtension; +import io.opentelemetry.sdk.testing.assertj.AttributeAssertion; +import io.opentelemetry.sdk.testing.assertj.SpanDataAssert; import io.opentelemetry.sdk.trace.data.LinkData; +import io.opentelemetry.sdk.trace.data.SpanData; +import io.opentelemetry.sdk.trace.data.StatusData; import java.nio.charset.Charset; import java.util.ArrayList; import java.util.List; @@ -35,6 +50,7 @@ import java.util.concurrent.atomic.AtomicReference; import java.util.function.Consumer; import org.apache.rocketmq.client.consumer.DefaultMQPushConsumer; +import org.apache.rocketmq.client.consumer.listener.ConsumeOrderlyStatus; import org.apache.rocketmq.client.exception.MQClientException; import org.apache.rocketmq.client.producer.DefaultMQProducer; import org.apache.rocketmq.client.producer.SendCallback; @@ -60,6 +76,7 @@ abstract class AbstractRocketMqClientTest { private static final boolean EXPERIMENTAL_ATTRIBUTES = Boolean.getBoolean("otel.instrumentation.rocketmq-client.experimental-span-attributes"); + private static final String CONSUMER_GROUP = "consumerGroup"; private static final Logger logger = LoggerFactory.getLogger(AbstractRocketMqClientTest.class); @@ -165,12 +182,18 @@ public void onException(Throwable throwable) { trace -> trace.hasSpansSatisfyingExactly( span -> - span.hasName(sharedTopic + " publish") + span.hasName( + emitStableMessagingSemconv() + ? "publish " + sharedTopic + : sharedTopic + " publish") .hasKind(SpanKind.PRODUCER) .hasAttributesSatisfyingExactly( equalTo(MESSAGING_SYSTEM, "rocketmq"), + namespace(), equalTo(MESSAGING_DESTINATION_NAME, sharedTopic), - equalTo(MESSAGING_OPERATION, "publish"), + oldOperation("publish"), + operationName("publish"), + operationType("publish"), satisfies( MESSAGING_MESSAGE_ID, val -> val.isInstanceOf(String.class)), equalTo(MESSAGING_ROCKETMQ_MESSAGE_TAG, experimental("TagA")), @@ -181,13 +204,20 @@ public void onException(Throwable throwable) { stringKey("messaging.rocketmq.send_result"), experimental("SEND_OK"))), span -> - span.hasName(sharedTopic + " process") + span.hasName( + emitStableMessagingSemconv() + ? "process " + sharedTopic + : sharedTopic + " process") .hasKind(SpanKind.CONSUMER) .hasParent(trace.getSpan(0)) .hasAttributesSatisfyingExactly( equalTo(MESSAGING_SYSTEM, "rocketmq"), + namespace(), + consumerGroup(), equalTo(MESSAGING_DESTINATION_NAME, sharedTopic), - equalTo(MESSAGING_OPERATION, "process"), + oldOperation("process"), + operationName("process"), + operationType("process"), satisfies( MESSAGING_MESSAGE_BODY_SIZE, val -> val.isInstanceOf(Long.class)), @@ -227,13 +257,19 @@ void testRocketmqProduceAndConsume() throws Exception { trace.hasSpansSatisfyingExactly( span -> span.hasName("parent").hasKind(SpanKind.INTERNAL), span -> - span.hasName(sharedTopic + " publish") + span.hasName( + emitStableMessagingSemconv() + ? "publish " + sharedTopic + : sharedTopic + " publish") .hasKind(SpanKind.PRODUCER) .hasParent(trace.getSpan(0)) .hasAttributesSatisfyingExactly( equalTo(MESSAGING_SYSTEM, "rocketmq"), + namespace(), equalTo(MESSAGING_DESTINATION_NAME, sharedTopic), - equalTo(MESSAGING_OPERATION, "publish"), + oldOperation("publish"), + operationName("publish"), + operationType("publish"), satisfies( MESSAGING_MESSAGE_ID, val -> val.isInstanceOf(String.class)), equalTo(MESSAGING_ROCKETMQ_MESSAGE_TAG, experimental("TagA")), @@ -244,13 +280,20 @@ void testRocketmqProduceAndConsume() throws Exception { stringKey("messaging.rocketmq.send_result"), experimental("SEND_OK"))), span -> - span.hasName(sharedTopic + " process") + span.hasName( + emitStableMessagingSemconv() + ? "process " + sharedTopic + : sharedTopic + " process") .hasKind(SpanKind.CONSUMER) .hasParent(trace.getSpan(1)) .hasAttributesSatisfyingExactly( equalTo(MESSAGING_SYSTEM, "rocketmq"), + namespace(), + consumerGroup(), equalTo(MESSAGING_DESTINATION_NAME, sharedTopic), - equalTo(MESSAGING_OPERATION, "process"), + oldOperation("process"), + operationName("process"), + operationType("process"), satisfies( MESSAGING_MESSAGE_BODY_SIZE, val -> val.isInstanceOf(Long.class)), @@ -274,6 +317,16 @@ void testRocketmqProduceAndConsume() throws Exception { @Test void testRocketmqProduceAndBatchConsume() throws Exception { + runBatchConsumeTest(false); + } + + @Test + void testBatchConsumeFailure() throws Exception { + consumer.setMaxReconsumeTimes(0); + runBatchConsumeTest(true); + } + + private void runBatchConsumeTest(boolean failConsumption) throws Exception { // context propagation doesn't work for batch messages in 5.3.4 Assumptions.assumeFalse(testLatestDeps()); @@ -285,6 +338,9 @@ void testRocketmqProduceAndBatchConsume() throws Exception { int maxAttempts = 5; for (int i = 0; i < maxAttempts; i++) { tracingMessageListener.reset(); + if (failConsumption) { + tracingMessageListener.failNextMessage(); + } testing().runWithSpan("parent", () -> producer.send(msgs)); @@ -304,16 +360,34 @@ void testRocketmqProduceAndBatchConsume() throws Exception { testing() .waitAndAssertTraces( trace -> { - trace.hasSpansSatisfyingExactly( - span -> span.hasName("parent").hasKind(SpanKind.INTERNAL), + SpanContext spanContext = trace.getSpan(1).getSpanContext(); + producerSpanContext.set( + SpanContext.createFromRemoteParent( + spanContext.getTraceId(), + spanContext.getSpanId(), + spanContext.getTraceFlags(), + spanContext.getTraceState())); + + List> assertions = new ArrayList<>(); + assertions.add(span -> span.hasName("parent").hasKind(SpanKind.INTERNAL)); + assertions.add( span -> - span.hasName(sharedTopic + " publish") + span.hasName( + emitStableMessagingSemconv() + ? "publish " + sharedTopic + : sharedTopic + " publish") .hasKind(SpanKind.PRODUCER) .hasParent(trace.getSpan(0)) .hasAttributesSatisfyingExactly( equalTo(MESSAGING_SYSTEM, "rocketmq"), + namespace(), equalTo(MESSAGING_DESTINATION_NAME, sharedTopic), - equalTo(MESSAGING_OPERATION, "publish"), + equalTo( + MESSAGING_BATCH_MESSAGE_COUNT, + emitStableMessagingSemconv() ? Long.valueOf(2) : null), + oldOperation("publish"), + operationName("publish"), + operationType("publish"), satisfies( MESSAGING_MESSAGE_ID, val -> val.isInstanceOf(String.class)), satisfies( @@ -322,75 +396,110 @@ void testRocketmqProduceAndBatchConsume() throws Exception { equalTo( stringKey("messaging.rocketmq.send_result"), experimental("SEND_OK")))); - - SpanContext spanContext = trace.getSpan(1).getSpanContext(); - producerSpanContext.set( - SpanContext.createFromRemoteParent( - spanContext.getTraceId(), - spanContext.getSpanId(), - spanContext.getTraceFlags(), - spanContext.getTraceState())); - }, - trace -> - trace.hasSpansSatisfyingExactly( + if (emitStableMessagingSemconv()) { + assertions.add( span -> - span.hasName("multiple_sources receive") - .hasKind(SpanKind.CONSUMER) - .hasAttributesSatisfyingExactly( - equalTo(MESSAGING_SYSTEM, "rocketmq"), - equalTo(MESSAGING_OPERATION, "receive")), + assertBatchProcessSpan( + span, + trace.getSpan(1), + producerSpanContext.get(), + "TagA", + failConsumption)); + assertions.add( span -> - span.hasName(sharedTopic + " process") - .hasKind(SpanKind.CONSUMER) - .hasParent(trace.getSpan(0)) - .hasLinksSatisfying(links(producerSpanContext.get())) - .hasAttributesSatisfyingExactly( - equalTo(MESSAGING_SYSTEM, "rocketmq"), - equalTo(MESSAGING_DESTINATION_NAME, sharedTopic), - equalTo(MESSAGING_OPERATION, "process"), - satisfies( - MESSAGING_MESSAGE_BODY_SIZE, - val -> val.isInstanceOf(Long.class)), - satisfies( - MESSAGING_MESSAGE_ID, val -> val.isInstanceOf(String.class)), - equalTo(MESSAGING_ROCKETMQ_MESSAGE_TAG, experimental("TagA")), - satisfies( - stringKey("messaging.rocketmq.broker_address"), - val -> experimentalString(val)), - satisfies( - longKey("messaging.rocketmq.queue_id"), - val -> experimentalLong(val)), - satisfies( - longKey("messaging.rocketmq.queue_offset"), - val -> experimentalLong(val))), + assertBatchProcessSpan( + span, + trace.getSpan(1), + producerSpanContext.get(), + "TagB", + failConsumption)); + } + trace.hasSpansSatisfyingExactly(assertions); + }, + trace -> { + List> assertions = new ArrayList<>(); + assertions.add( + span -> + span.hasName( + emitStableMessagingSemconv() + ? "receive " + sharedTopic + : "multiple_sources receive") + .hasKind(emitStableMessagingSemconv() ? CLIENT : CONSUMER) + .hasAttributesSatisfyingExactly( + equalTo(MESSAGING_SYSTEM, "rocketmq"), + namespace(), + consumerGroup(), + equalTo( + MESSAGING_DESTINATION_NAME, + emitStableMessagingSemconv() ? sharedTopic : null), + equalTo( + MESSAGING_BATCH_MESSAGE_COUNT, + emitStableMessagingSemconv() ? Long.valueOf(2) : null), + oldOperation("receive"), + operationName("receive"), + operationType("receive"))); + if (!emitStableMessagingSemconv()) { + assertions.add( span -> - span.hasName(sharedTopic + " process") - .hasKind(SpanKind.CONSUMER) - .hasParent(trace.getSpan(0)) - .hasLinksSatisfying(links(producerSpanContext.get())) - .hasAttributesSatisfyingExactly( - equalTo(MESSAGING_SYSTEM, "rocketmq"), - equalTo(MESSAGING_DESTINATION_NAME, sharedTopic), - equalTo(MESSAGING_OPERATION, "process"), - satisfies( - MESSAGING_MESSAGE_BODY_SIZE, - val -> val.isInstanceOf(Long.class)), - satisfies( - MESSAGING_MESSAGE_ID, val -> val.isInstanceOf(String.class)), - equalTo(MESSAGING_ROCKETMQ_MESSAGE_TAG, experimental("TagB")), - satisfies( - stringKey("messaging.rocketmq.broker_address"), - val -> experimentalString(val)), - satisfies( - longKey("messaging.rocketmq.queue_id"), - val -> experimentalLong(val)), - satisfies( - longKey("messaging.rocketmq.queue_offset"), - val -> experimentalLong(val))), + assertBatchProcessSpan( + span, + trace.getSpan(0), + producerSpanContext.get(), + "TagA", + failConsumption)); + assertions.add( span -> - span.hasName("messageListener") - .hasParent(trace.getSpan(0)) - .hasKind(SpanKind.INTERNAL))); + assertBatchProcessSpan( + span, + trace.getSpan(0), + producerSpanContext.get(), + "TagB", + failConsumption)); + } + assertions.add( + span -> + span.hasName("messageListener") + .hasParent(trace.getSpan(0)) + .hasKind(SpanKind.INTERNAL)); + trace.hasSpansSatisfyingExactly(assertions); + }); + } + + private void assertBatchProcessSpan( + SpanDataAssert span, + SpanData parentSpan, + SpanContext producerSpanContext, + String messageTag, + boolean failed) { + span.hasName(emitStableMessagingSemconv() ? "process " + sharedTopic : sharedTopic + " process") + .hasKind(SpanKind.CONSUMER) + .hasParent(parentSpan) + .hasStatus(failed ? StatusData.error() : StatusData.unset()) + .hasAttributesSatisfyingExactly( + equalTo(MESSAGING_SYSTEM, "rocketmq"), + namespace(), + consumerGroup(), + equalTo(MESSAGING_DESTINATION_NAME, sharedTopic), + oldOperation("process"), + operationName("process"), + operationType("process"), + equalTo( + ERROR_TYPE, + emitStableMessagingSemconv() && failed + ? ConsumeOrderlyStatus.SUSPEND_CURRENT_QUEUE_A_MOMENT.name() + : null), + satisfies(MESSAGING_MESSAGE_BODY_SIZE, val -> val.isInstanceOf(Long.class)), + satisfies(MESSAGING_MESSAGE_ID, val -> val.isInstanceOf(String.class)), + equalTo(MESSAGING_ROCKETMQ_MESSAGE_TAG, experimental(messageTag)), + satisfies( + stringKey("messaging.rocketmq.broker_address"), val -> experimentalString(val)), + satisfies(longKey("messaging.rocketmq.queue_id"), val -> experimentalLong(val)), + satisfies(longKey("messaging.rocketmq.queue_offset"), val -> experimentalLong(val))); + if (emitStableMessagingSemconv()) { + span.hasTotalRecordedLinks(0); + } else { + span.hasLinksSatisfying(links(producerSpanContext)); + } } @Test @@ -417,13 +526,19 @@ void captureMessageHeaderAsSpanAttributes() throws Exception { trace.hasSpansSatisfyingExactly( span -> span.hasName("parent").hasKind(SpanKind.INTERNAL), span -> - span.hasName(sharedTopic + " publish") + span.hasName( + emitStableMessagingSemconv() + ? "publish " + sharedTopic + : sharedTopic + " publish") .hasKind(SpanKind.PRODUCER) .hasParent(trace.getSpan(0)) .hasAttributesSatisfyingExactly( equalTo(MESSAGING_SYSTEM, "rocketmq"), + namespace(), equalTo(MESSAGING_DESTINATION_NAME, sharedTopic), - equalTo(MESSAGING_OPERATION, "publish"), + oldOperation("publish"), + operationName("publish"), + operationType("publish"), satisfies( MESSAGING_MESSAGE_ID, val -> val.isInstanceOf(String.class)), equalTo(MESSAGING_ROCKETMQ_MESSAGE_TAG, experimental("TagA")), @@ -437,13 +552,20 @@ void captureMessageHeaderAsSpanAttributes() throws Exception { headerAttributeKey("Test-Message-Header"), singletonList("test"))), span -> - span.hasName(sharedTopic + " process") + span.hasName( + emitStableMessagingSemconv() + ? "process " + sharedTopic + : sharedTopic + " process") .hasKind(SpanKind.CONSUMER) .hasParent(trace.getSpan(1)) .hasAttributesSatisfyingExactly( equalTo(MESSAGING_SYSTEM, "rocketmq"), + namespace(), + consumerGroup(), equalTo(MESSAGING_DESTINATION_NAME, sharedTopic), - equalTo(MESSAGING_OPERATION, "process"), + oldOperation("process"), + operationName("process"), + operationType("process"), satisfies( MESSAGING_MESSAGE_BODY_SIZE, val -> val.isInstanceOf(Long.class)), @@ -480,25 +602,38 @@ void testRocketmqProduceOneway() throws Exception { trace.hasSpansSatisfyingExactly( span -> span.hasName("parent").hasKind(SpanKind.INTERNAL), span -> - span.hasName(sharedTopic + " publish") + span.hasName( + emitStableMessagingSemconv() + ? "publish " + sharedTopic + : sharedTopic + " publish") .hasKind(SpanKind.PRODUCER) .hasParent(trace.getSpan(0)) .hasAttributesSatisfyingExactly( equalTo(MESSAGING_SYSTEM, "rocketmq"), + namespace(), equalTo(MESSAGING_DESTINATION_NAME, sharedTopic), - equalTo(MESSAGING_OPERATION, "publish"), + oldOperation("publish"), + operationName("publish"), + operationType("publish"), equalTo(MESSAGING_ROCKETMQ_MESSAGE_TAG, experimental("TagA")), satisfies( stringKey("messaging.rocketmq.broker_address"), val -> experimentalString(val))), span -> - span.hasName(sharedTopic + " process") + span.hasName( + emitStableMessagingSemconv() + ? "process " + sharedTopic + : sharedTopic + " process") .hasKind(SpanKind.CONSUMER) .hasParent(trace.getSpan(1)) .hasAttributesSatisfyingExactly( equalTo(MESSAGING_SYSTEM, "rocketmq"), + namespace(), + consumerGroup(), equalTo(MESSAGING_DESTINATION_NAME, sharedTopic), - equalTo(MESSAGING_OPERATION, "process"), + oldOperation("process"), + operationName("process"), + operationType("process"), satisfies( MESSAGING_MESSAGE_BODY_SIZE, val -> val.isInstanceOf(Long.class)), @@ -538,4 +673,26 @@ private static Consumer> links(SpanContext... spanConte } }; } + + private static AttributeAssertion oldOperation(String operation) { + return equalTo(MESSAGING_OPERATION, emitOldMessagingSemconv() ? operation : null); + } + + private static AttributeAssertion consumerGroup() { + return equalTo( + MESSAGING_CONSUMER_GROUP_NAME, emitStableMessagingSemconv() ? CONSUMER_GROUP : null); + } + + private static AttributeAssertion namespace() { + return equalTo(MESSAGING_ROCKETMQ_NAMESPACE, emitStableMessagingSemconv() ? NAMESPACE : null); + } + + private static AttributeAssertion operationName(String operation) { + return equalTo(MESSAGING_OPERATION_NAME, emitStableMessagingSemconv() ? operation : null); + } + + private static AttributeAssertion operationType(String operation) { + String operationType = operation.equals("publish") ? "send" : operation; + return equalTo(MESSAGING_OPERATION_TYPE, emitStableMessagingSemconv() ? operationType : null); + } } diff --git a/instrumentation/rocketmq/rocketmq-client-4.8/testing/src/main/java/io/opentelemetry/instrumentation/rocketmqclient/v4_8/TracingMessageListener.java b/instrumentation/rocketmq/rocketmq-client-4.8/testing/src/main/java/io/opentelemetry/instrumentation/rocketmqclient/v4_8/TracingMessageListener.java index ef4b312f4b42..335d3e52f0f7 100644 --- a/instrumentation/rocketmq/rocketmq-client-4.8/testing/src/main/java/io/opentelemetry/instrumentation/rocketmqclient/v4_8/TracingMessageListener.java +++ b/instrumentation/rocketmq/rocketmq-client-4.8/testing/src/main/java/io/opentelemetry/instrumentation/rocketmqclient/v4_8/TracingMessageListener.java @@ -11,6 +11,7 @@ import java.util.List; import java.util.concurrent.CountDownLatch; +import java.util.concurrent.atomic.AtomicBoolean; import java.util.concurrent.atomic.AtomicInteger; import org.apache.rocketmq.client.consumer.listener.ConsumeOrderlyContext; import org.apache.rocketmq.client.consumer.listener.ConsumeOrderlyStatus; @@ -19,6 +20,7 @@ class TracingMessageListener implements MessageListenerOrderly { + private final AtomicBoolean failurePending = new AtomicBoolean(); private final AtomicInteger lastBatchSize = new AtomicInteger(); private volatile CountDownLatch messageReceived = new CountDownLatch(1); @@ -28,6 +30,9 @@ public ConsumeOrderlyStatus consumeMessage( lastBatchSize.set(list.size()); messageReceived.countDown(); runWithSpan("messageListener", () -> {}); + if (failurePending.compareAndSet(true, false)) { + return ConsumeOrderlyStatus.SUSPEND_CURRENT_QUEUE_A_MOMENT; + } return ConsumeOrderlyStatus.SUCCESS; } @@ -36,6 +41,10 @@ void reset() { lastBatchSize.set(0); } + void failNextMessage() { + failurePending.set(true); + } + void waitForMessages() throws InterruptedException { assertThat(messageReceived.await(30, SECONDS)).isTrue(); } diff --git a/instrumentation/rocketmq/rocketmq-client-4.8/testing/src/main/java/io/opentelemetry/instrumentation/rocketmqclient/v4_8/base/BaseConf.java b/instrumentation/rocketmq/rocketmq-client-4.8/testing/src/main/java/io/opentelemetry/instrumentation/rocketmqclient/v4_8/base/BaseConf.java index 0ae5ab1e97f8..d4a120d4bc01 100644 --- a/instrumentation/rocketmq/rocketmq-client-4.8/testing/src/main/java/io/opentelemetry/instrumentation/rocketmqclient/v4_8/base/BaseConf.java +++ b/instrumentation/rocketmq/rocketmq-client-4.8/testing/src/main/java/io/opentelemetry/instrumentation/rocketmqclient/v4_8/base/BaseConf.java @@ -18,6 +18,7 @@ import org.apache.rocketmq.test.util.RandomUtil; public class BaseConf { + public static final String NAMESPACE = "namespace"; public static final String nsAddr; private static final String clusterName; private static final NamesrvController namesrvController; @@ -36,7 +37,7 @@ private BaseConf() {} public static String initTopic() { String topic = MQRandomUtils.getRandomTopic(); - IntegrationTestBase.initTopic(topic, nsAddr, clusterName); + IntegrationTestBase.initTopic(NAMESPACE + "%" + topic, nsAddr, clusterName); return topic; } @@ -46,6 +47,7 @@ public static DefaultMQPushConsumer getConsumer( DefaultMQPushConsumer consumer = new DefaultMQPushConsumer("consumerGroup"); consumer.setInstanceName(RandomUtil.getStringByUUID()); consumer.setNamesrvAddr(nsAddr); + consumer.setNamespace(NAMESPACE); consumer.subscribe(topic, subExpression); consumer.setMessageListener(listener); consumer.start(); @@ -56,6 +58,7 @@ public static DefaultMQProducer getProducer(String ns) throws MQClientException DefaultMQProducer producer = new DefaultMQProducer(RandomUtil.getStringByUUID()); producer.setInstanceName(UUID.randomUUID().toString()); producer.setNamesrvAddr(ns); + producer.setNamespace(NAMESPACE); producer.start(); return producer; } diff --git a/instrumentation/rocketmq/rocketmq-client-5.0/javaagent/build.gradle.kts b/instrumentation/rocketmq/rocketmq-client-5.0/javaagent/build.gradle.kts index 83415cc2c975..39975b5d56db 100644 --- a/instrumentation/rocketmq/rocketmq-client-5.0/javaagent/build.gradle.kts +++ b/instrumentation/rocketmq/rocketmq-client-5.0/javaagent/build.gradle.kts @@ -35,6 +35,31 @@ tasks { include("**/RocketMqClientSuppressReceiveSpanTest.*") } + val testV3Preview = register("testV3Preview") { + testClassesDirs = sourceSets.test.get().output.classesDirs + classpath = sourceSets.test.get().runtimeClasspath + filter { + excludeTestsMatching("RocketMqClientSuppressReceiveSpanTest") + } + jvmArgs("-Dotel.instrumentation.messaging.experimental.receive-telemetry.enabled=true") + jvmArgs("-Dotel.instrumentation.common.v3-preview=true") + jvmArgs("-Dotel.semconv-stability.preview=messaging") + systemProperty("metadataConfig", "otel.instrumentation.common.v3-preview=true") + } + + val testBothSemconv = register("testBothSemconv") { + testClassesDirs = sourceSets.test.get().output.classesDirs + classpath = sourceSets.test.get().runtimeClasspath + filter { + includeTestsMatching("RocketMqClientTest.testSendAndConsumeNormalMessage") + includeTestsMatching("RocketMqClientTest.testConsumeFailure") + } + jvmArgs("-Dotel.instrumentation.messaging.experimental.receive-telemetry.enabled=true") + jvmArgs("-Dotel.instrumentation.common.v3-preview=true") + jvmArgs("-Dotel.semconv-stability.preview=messaging/dup") + systemProperty("metadataConfig", "otel.semconv-stability.preview=messaging/dup") + } + test { filter { excludeTestsMatching("RocketMqClientSuppressReceiveSpanTest") @@ -47,7 +72,7 @@ tasks { } check { - dependsOn(testReceiveSpanDisabled) + dependsOn(testReceiveSpanDisabled, testV3Preview, testBothSemconv) } if (otelProps.denyUnsafe) { diff --git a/instrumentation/rocketmq/rocketmq-client-5.0/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/rocketmqclient/v5_0/ProducerImplInstrumentation.java b/instrumentation/rocketmq/rocketmq-client-5.0/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/rocketmqclient/v5_0/ProducerImplInstrumentation.java index 733098b03749..b104360695de 100644 --- a/instrumentation/rocketmq/rocketmq-client-5.0/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/rocketmqclient/v5_0/ProducerImplInstrumentation.java +++ b/instrumentation/rocketmq/rocketmq-client-5.0/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/rocketmqclient/v5_0/ProducerImplInstrumentation.java @@ -25,6 +25,7 @@ import org.apache.rocketmq.client.apis.producer.SendReceipt; import org.apache.rocketmq.client.java.impl.producer.SendReceiptImpl; import org.apache.rocketmq.client.java.message.PublishingMessageImpl; +import org.apache.rocketmq.client.java.route.MessageQueueImpl; import org.apache.rocketmq.shaded.com.google.common.util.concurrent.Futures; import org.apache.rocketmq.shaded.com.google.common.util.concurrent.MoreExecutors; import org.apache.rocketmq.shaded.com.google.common.util.concurrent.SettableFuture; @@ -67,12 +68,15 @@ public static class SendAdvice { @Advice.OnMethodEnter(suppress = Throwable.class, inline = false) public static void onEnter( @Advice.Argument(0) SettableFuture> future0, + @Advice.Argument(3) List messageQueues, @Advice.Argument(4) List messages) { Instrumenter instrumenter = producerInstrumenter(); int count = messages.size(); List> futures = FutureConverter.convert(future0, count); + String namespace = messageQueues.get(0).getTopicResource().getNamespace(); for (int i = 0; i < count; i++) { PublishingMessageImpl message = messages.get(i); + VirtualFieldStore.setNamespaceByMessage(message, namespace); // Try to extract parent context. Context parentContext = VirtualFieldStore.getContextByMessage(message); diff --git a/instrumentation/rocketmq/rocketmq-client-5.0/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/rocketmqclient/v5_0/ReceiveSpanFinishingCallback.java b/instrumentation/rocketmq/rocketmq-client-5.0/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/rocketmqclient/v5_0/ReceiveSpanFinishingCallback.java index 3ea54e810ada..89c7a84107d9 100644 --- a/instrumentation/rocketmq/rocketmq-client-5.0/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/rocketmqclient/v5_0/ReceiveSpanFinishingCallback.java +++ b/instrumentation/rocketmq/rocketmq-client-5.0/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/rocketmqclient/v5_0/ReceiveSpanFinishingCallback.java @@ -5,6 +5,7 @@ package io.opentelemetry.javaagent.instrumentation.rocketmqclient.v5_0; +import static io.opentelemetry.instrumentation.api.internal.SemconvStability.emitStableMessagingSemconv; import static io.opentelemetry.javaagent.instrumentation.rocketmqclient.v5_0.RocketMqSingletons.consumerReceiveInstrumenter; import apache.rocketmq.v2.ReceiveMessageRequest; @@ -41,6 +42,9 @@ public void onSuccess(ReceiveMessageResult receiveMessageResult) { Instrumenter> receiveInstrumenter = consumerReceiveInstrumenter(); Context parentContext = Context.current(); + for (MessageView messageView : messageViews) { + VirtualFieldStore.setContextByMessage(messageView, parentContext); + } if (receiveInstrumenter.shouldStart(parentContext, request)) { Context context = InstrumenterUtil.startAndEnd( @@ -51,8 +55,10 @@ public void onSuccess(ReceiveMessageResult receiveMessageResult) { null, timer.startTime(), timer.now()); - for (MessageView messageView : messageViews) { - VirtualFieldStore.setContextByMessage(messageView, context); + if (!emitStableMessagingSemconv()) { + for (MessageView messageView : messageViews) { + VirtualFieldStore.setContextByMessage(messageView, context); + } } } } diff --git a/instrumentation/rocketmq/rocketmq-client-5.0/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/rocketmqclient/v5_0/RocketMqConsumerProcessAttributeExtractor.java b/instrumentation/rocketmq/rocketmq-client-5.0/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/rocketmqclient/v5_0/RocketMqConsumerProcessAttributeExtractor.java index fccff2b5a13e..903f2b220c48 100644 --- a/instrumentation/rocketmq/rocketmq-client-5.0/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/rocketmqclient/v5_0/RocketMqConsumerProcessAttributeExtractor.java +++ b/instrumentation/rocketmq/rocketmq-client-5.0/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/rocketmqclient/v5_0/RocketMqConsumerProcessAttributeExtractor.java @@ -5,11 +5,15 @@ package io.opentelemetry.javaagent.instrumentation.rocketmqclient.v5_0; +import static io.opentelemetry.instrumentation.api.internal.SemconvStability.emitOldMessagingSemconv; +import static io.opentelemetry.instrumentation.api.internal.SemconvStability.emitStableMessagingSemconv; +import static io.opentelemetry.semconv.incubating.MessagingIncubatingAttributes.MESSAGING_CONSUMER_GROUP_NAME; import static io.opentelemetry.semconv.incubating.MessagingIncubatingAttributes.MESSAGING_ROCKETMQ_CLIENT_GROUP; import static io.opentelemetry.semconv.incubating.MessagingIncubatingAttributes.MESSAGING_ROCKETMQ_MESSAGE_DELIVERY_TIMESTAMP; import static io.opentelemetry.semconv.incubating.MessagingIncubatingAttributes.MESSAGING_ROCKETMQ_MESSAGE_GROUP; import static io.opentelemetry.semconv.incubating.MessagingIncubatingAttributes.MESSAGING_ROCKETMQ_MESSAGE_KEYS; import static io.opentelemetry.semconv.incubating.MessagingIncubatingAttributes.MESSAGING_ROCKETMQ_MESSAGE_TAG; +import static io.opentelemetry.semconv.incubating.MessagingIncubatingAttributes.MESSAGING_ROCKETMQ_NAMESPACE; import io.opentelemetry.api.common.AttributesBuilder; import io.opentelemetry.context.Context; @@ -18,6 +22,7 @@ import javax.annotation.Nullable; import org.apache.rocketmq.client.apis.consumer.ConsumeResult; import org.apache.rocketmq.client.apis.message.MessageView; +import org.apache.rocketmq.client.java.message.MessageViewImpl; class RocketMqConsumerProcessAttributeExtractor implements AttributesExtractor { @@ -34,8 +39,16 @@ public void onStart( .getDeliveryTimestamp() .ifPresent(s -> attributes.put(MESSAGING_ROCKETMQ_MESSAGE_DELIVERY_TIMESTAMP, s)); attributes.put(MESSAGING_ROCKETMQ_MESSAGE_KEYS, new ArrayList<>(messageView.getKeys())); - attributes.put( - MESSAGING_ROCKETMQ_CLIENT_GROUP, VirtualFieldStore.getConsumerGroupByMessage(messageView)); + String consumerGroup = VirtualFieldStore.getConsumerGroupByMessage(messageView); + if (emitStableMessagingSemconv()) { + attributes.put(MESSAGING_CONSUMER_GROUP_NAME, consumerGroup); + attributes.put( + MESSAGING_ROCKETMQ_NAMESPACE, + ((MessageViewImpl) messageView).getMessageQueue().getTopicResource().getNamespace()); + } + if (emitOldMessagingSemconv()) { + attributes.put(MESSAGING_ROCKETMQ_CLIENT_GROUP, consumerGroup); + } } @Override diff --git a/instrumentation/rocketmq/rocketmq-client-5.0/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/rocketmqclient/v5_0/RocketMqConsumerProcessAttributeGetter.java b/instrumentation/rocketmq/rocketmq-client-5.0/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/rocketmqclient/v5_0/RocketMqConsumerProcessAttributeGetter.java index 4a4a01bc3087..32ff58ca7a06 100644 --- a/instrumentation/rocketmq/rocketmq-client-5.0/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/rocketmqclient/v5_0/RocketMqConsumerProcessAttributeGetter.java +++ b/instrumentation/rocketmq/rocketmq-client-5.0/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/rocketmqclient/v5_0/RocketMqConsumerProcessAttributeGetter.java @@ -77,6 +77,13 @@ public Long getBatchMessageCount(MessageView messageView, @Nullable ConsumeResul return null; } + @Nullable + @Override + public String getErrorType( + MessageView messageView, @Nullable ConsumeResult consumeResult, @Nullable Throwable error) { + return consumeResult == ConsumeResult.FAILURE ? ConsumeResult.FAILURE.name() : null; + } + @Override public List getMessageHeader(MessageView messageView, String name) { String value = messageView.getProperties().get(name); diff --git a/instrumentation/rocketmq/rocketmq-client-5.0/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/rocketmqclient/v5_0/RocketMqConsumerReceiveAttributeExtractor.java b/instrumentation/rocketmq/rocketmq-client-5.0/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/rocketmqclient/v5_0/RocketMqConsumerReceiveAttributeExtractor.java index fec9e7fdb1ed..f1ff9427a279 100644 --- a/instrumentation/rocketmq/rocketmq-client-5.0/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/rocketmqclient/v5_0/RocketMqConsumerReceiveAttributeExtractor.java +++ b/instrumentation/rocketmq/rocketmq-client-5.0/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/rocketmqclient/v5_0/RocketMqConsumerReceiveAttributeExtractor.java @@ -5,7 +5,11 @@ package io.opentelemetry.javaagent.instrumentation.rocketmqclient.v5_0; +import static io.opentelemetry.instrumentation.api.internal.SemconvStability.emitOldMessagingSemconv; +import static io.opentelemetry.instrumentation.api.internal.SemconvStability.emitStableMessagingSemconv; +import static io.opentelemetry.semconv.incubating.MessagingIncubatingAttributes.MESSAGING_CONSUMER_GROUP_NAME; import static io.opentelemetry.semconv.incubating.MessagingIncubatingAttributes.MESSAGING_ROCKETMQ_CLIENT_GROUP; +import static io.opentelemetry.semconv.incubating.MessagingIncubatingAttributes.MESSAGING_ROCKETMQ_NAMESPACE; import apache.rocketmq.v2.ReceiveMessageRequest; import io.opentelemetry.api.common.AttributesBuilder; @@ -31,6 +35,14 @@ public void onEnd( @Nullable List messageViews, @Nullable Throwable error) { String consumerGroup = request.getGroup().getName(); - attributes.put(MESSAGING_ROCKETMQ_CLIENT_GROUP, consumerGroup); + if (emitStableMessagingSemconv()) { + attributes.put(MESSAGING_CONSUMER_GROUP_NAME, consumerGroup); + attributes.put( + MESSAGING_ROCKETMQ_NAMESPACE, + request.getMessageQueue().getTopic().getResourceNamespace()); + } + if (emitOldMessagingSemconv()) { + attributes.put(MESSAGING_ROCKETMQ_CLIENT_GROUP, consumerGroup); + } } } diff --git a/instrumentation/rocketmq/rocketmq-client-5.0/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/rocketmqclient/v5_0/RocketMqInstrumenterFactory.java b/instrumentation/rocketmq/rocketmq-client-5.0/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/rocketmqclient/v5_0/RocketMqInstrumenterFactory.java index bb6ce5d1d276..c0f9f73e0439 100644 --- a/instrumentation/rocketmq/rocketmq-client-5.0/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/rocketmqclient/v5_0/RocketMqInstrumenterFactory.java +++ b/instrumentation/rocketmq/rocketmq-client-5.0/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/rocketmqclient/v5_0/RocketMqInstrumenterFactory.java @@ -12,17 +12,16 @@ import apache.rocketmq.v2.ReceiveMessageRequest; import io.opentelemetry.api.OpenTelemetry; import io.opentelemetry.api.trace.StatusCode; -import io.opentelemetry.instrumentation.api.incubator.semconv.messaging.MessageOperation; import io.opentelemetry.instrumentation.api.incubator.semconv.messaging.MessagingAttributesExtractor; import io.opentelemetry.instrumentation.api.incubator.semconv.messaging.MessagingAttributesGetter; +import io.opentelemetry.instrumentation.api.incubator.semconv.messaging.MessagingOperationType; +import io.opentelemetry.instrumentation.api.incubator.semconv.messaging.MessagingSpanKindExtractor; import io.opentelemetry.instrumentation.api.incubator.semconv.messaging.MessagingSpanNameExtractor; +import io.opentelemetry.instrumentation.api.incubator.semconv.messaging.internal.MessagingProcessInstrumenterFactory; import io.opentelemetry.instrumentation.api.instrumenter.AttributesExtractor; import io.opentelemetry.instrumentation.api.instrumenter.Instrumenter; import io.opentelemetry.instrumentation.api.instrumenter.InstrumenterBuilder; -import io.opentelemetry.instrumentation.api.instrumenter.SpanKindExtractor; -import io.opentelemetry.instrumentation.api.instrumenter.SpanLinksExtractor; import io.opentelemetry.instrumentation.api.instrumenter.SpanStatusExtractor; -import io.opentelemetry.instrumentation.api.internal.PropagatorBasedSpanLinksExtractor; import java.util.List; import org.apache.rocketmq.client.apis.consumer.ConsumeResult; import org.apache.rocketmq.client.apis.message.MessageView; @@ -37,16 +36,16 @@ private RocketMqInstrumenterFactory() {} public static Instrumenter createProducerInstrumenter( OpenTelemetry openTelemetry, List capturedHeaders) { RocketMqProducerAttributeGetter getter = new RocketMqProducerAttributeGetter(); - MessageOperation operation = MessageOperation.PUBLISH; + MessagingOperationType operationType = MessagingOperationType.SEND; AttributesExtractor attributesExtractor = - buildMessagingAttributesExtractor(getter, operation, capturedHeaders); + buildMessagingAttributesExtractor(getter, operationType, capturedHeaders); InstrumenterBuilder instrumenterBuilder = Instrumenter.builder( openTelemetry, INSTRUMENTATION_NAME, - MessagingSpanNameExtractor.create(getter, operation)) + MessagingSpanNameExtractor.create(getter, operationType)) .addAttributesExtractor(attributesExtractor) .addAttributesExtractor(new RocketMqProducerAttributeExtractor()); setMessagingSendExceptionEventExtractor(instrumenterBuilder); @@ -57,21 +56,21 @@ public static Instrumenter createProduce createConsumerReceiveInstrumenter( OpenTelemetry openTelemetry, List capturedHeaders, boolean enabled) { RocketMqConsumerReceiveAttributeGetter getter = new RocketMqConsumerReceiveAttributeGetter(); - MessageOperation operation = MessageOperation.RECEIVE; + MessagingOperationType operationType = MessagingOperationType.RECEIVE; AttributesExtractor> attributesExtractor = - buildMessagingAttributesExtractor(getter, operation, capturedHeaders); + buildMessagingAttributesExtractor(getter, operationType, capturedHeaders); InstrumenterBuilder> instrumenterBuilder = Instrumenter.>builder( openTelemetry, INSTRUMENTATION_NAME, - MessagingSpanNameExtractor.create(getter, operation)) + MessagingSpanNameExtractor.create(getter, operationType)) .setEnabled(enabled) .addAttributesExtractor(attributesExtractor) .addAttributesExtractor(new RocketMqConsumerReceiveAttributeExtractor()); setMessagingReceiveExceptionEventExtractor(instrumenterBuilder); - return instrumenterBuilder.buildInstrumenter(SpanKindExtractor.alwaysConsumer()); + return instrumenterBuilder.buildInstrumenter(MessagingSpanKindExtractor.create(operationType)); } public static Instrumenter createConsumerProcessInstrumenter( @@ -79,16 +78,16 @@ public static Instrumenter createConsumerProcessInst List capturedHeaders, boolean receiveInstrumentationEnabled) { RocketMqConsumerProcessAttributeGetter getter = new RocketMqConsumerProcessAttributeGetter(); - MessageOperation operation = MessageOperation.PROCESS; + MessagingOperationType operationType = MessagingOperationType.PROCESS; AttributesExtractor attributesExtractor = - buildMessagingAttributesExtractor(getter, operation, capturedHeaders); + buildMessagingAttributesExtractor(getter, operationType, capturedHeaders); InstrumenterBuilder instrumenterBuilder = Instrumenter.builder( openTelemetry, INSTRUMENTATION_NAME, - MessagingSpanNameExtractor.create(getter, operation)) + MessagingSpanNameExtractor.create(getter, operationType)) .addAttributesExtractor(attributesExtractor) .addAttributesExtractor(new RocketMqConsumerProcessAttributeExtractor()) .setSpanStatusExtractor( @@ -102,21 +101,18 @@ public static Instrumenter createConsumerProcessInst }); setMessagingProcessExceptionEventExtractor(instrumenterBuilder); - if (receiveInstrumentationEnabled) { - SpanLinksExtractor spanLinksExtractor = - new PropagatorBasedSpanLinksExtractor<>( - openTelemetry.getPropagators().getTextMapPropagator(), new MessageMapGetter()); - instrumenterBuilder.addSpanLinksExtractor(spanLinksExtractor); - return instrumenterBuilder.buildInstrumenter(SpanKindExtractor.alwaysConsumer()); - } - return instrumenterBuilder.buildConsumerInstrumenter(new MessageMapGetter()); + return MessagingProcessInstrumenterFactory.create( + instrumenterBuilder, + openTelemetry.getPropagators().getTextMapPropagator(), + new MessageMapGetter(), + receiveInstrumentationEnabled); } private static AttributesExtractor buildMessagingAttributesExtractor( MessagingAttributesGetter getter, - MessageOperation operation, + MessagingOperationType operationType, List capturedHeaders) { - return MessagingAttributesExtractor.builder(getter, operation) + return MessagingAttributesExtractor.builderForOperationType(getter, operationType) .setCapturedHeaders(capturedHeaders) .build(); } diff --git a/instrumentation/rocketmq/rocketmq-client-5.0/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/rocketmqclient/v5_0/RocketMqProducerAttributeExtractor.java b/instrumentation/rocketmq/rocketmq-client-5.0/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/rocketmqclient/v5_0/RocketMqProducerAttributeExtractor.java index 0b63bd4f6f4f..d6e1f672fc80 100644 --- a/instrumentation/rocketmq/rocketmq-client-5.0/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/rocketmqclient/v5_0/RocketMqProducerAttributeExtractor.java +++ b/instrumentation/rocketmq/rocketmq-client-5.0/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/rocketmqclient/v5_0/RocketMqProducerAttributeExtractor.java @@ -5,11 +5,13 @@ package io.opentelemetry.javaagent.instrumentation.rocketmqclient.v5_0; +import static io.opentelemetry.instrumentation.api.internal.SemconvStability.emitStableMessagingSemconv; import static io.opentelemetry.semconv.incubating.MessagingIncubatingAttributes.MESSAGING_ROCKETMQ_MESSAGE_DELIVERY_TIMESTAMP; import static io.opentelemetry.semconv.incubating.MessagingIncubatingAttributes.MESSAGING_ROCKETMQ_MESSAGE_GROUP; import static io.opentelemetry.semconv.incubating.MessagingIncubatingAttributes.MESSAGING_ROCKETMQ_MESSAGE_KEYS; import static io.opentelemetry.semconv.incubating.MessagingIncubatingAttributes.MESSAGING_ROCKETMQ_MESSAGE_TAG; import static io.opentelemetry.semconv.incubating.MessagingIncubatingAttributes.MESSAGING_ROCKETMQ_MESSAGE_TYPE; +import static io.opentelemetry.semconv.incubating.MessagingIncubatingAttributes.MESSAGING_ROCKETMQ_NAMESPACE; import io.opentelemetry.api.common.AttributesBuilder; import io.opentelemetry.context.Context; @@ -26,6 +28,10 @@ class RocketMqProducerAttributeExtractor @Override public void onStart( AttributesBuilder attributes, Context parentContext, PublishingMessageImpl message) { + if (emitStableMessagingSemconv()) { + attributes.put( + MESSAGING_ROCKETMQ_NAMESPACE, VirtualFieldStore.getNamespaceByMessage(message)); + } message.getTag().ifPresent(s -> attributes.put(MESSAGING_ROCKETMQ_MESSAGE_TAG, s)); message.getMessageGroup().ifPresent(s -> attributes.put(MESSAGING_ROCKETMQ_MESSAGE_GROUP, s)); message diff --git a/instrumentation/rocketmq/rocketmq-client-5.0/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/rocketmqclient/v5_0/VirtualFieldStore.java b/instrumentation/rocketmq/rocketmq-client-5.0/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/rocketmqclient/v5_0/VirtualFieldStore.java index 09e47d2007b0..1386bf08e993 100644 --- a/instrumentation/rocketmq/rocketmq-client-5.0/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/rocketmqclient/v5_0/VirtualFieldStore.java +++ b/instrumentation/rocketmq/rocketmq-client-5.0/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/rocketmqclient/v5_0/VirtualFieldStore.java @@ -19,6 +19,8 @@ public class VirtualFieldStore { VirtualField.find(MessageView.class, Context.class); private static final VirtualField> MESSAGE_EXTRA_PROPERTIES = VirtualField.find(PublishingMessageImpl.class, Map.class); + private static final VirtualField MESSAGE_NAMESPACE = + VirtualField.find(PublishingMessageImpl.class, String.class); private static final VirtualField MESSAGE_CONSUMER_GROUP = VirtualField.find(MessageView.class, String.class); @@ -52,6 +54,15 @@ public static void setExtraPropertiesByMessage( MESSAGE_EXTRA_PROPERTIES.set(message, extraProperties); } + @Nullable + public static String getNamespaceByMessage(PublishingMessageImpl message) { + return MESSAGE_NAMESPACE.get(message); + } + + public static void setNamespaceByMessage(PublishingMessageImpl message, String namespace) { + MESSAGE_NAMESPACE.set(message, namespace); + } + @Nullable public static String getConsumerGroupByMessage(MessageView messageView) { return MESSAGE_CONSUMER_GROUP.get(messageView); diff --git a/instrumentation/rocketmq/rocketmq-client-5.0/javaagent/src/test/java/io/opentelemetry/instrumentation/rocketmqclient/v5_0/AbstractRocketMqClientTest.java b/instrumentation/rocketmq/rocketmq-client-5.0/javaagent/src/test/java/io/opentelemetry/instrumentation/rocketmqclient/v5_0/AbstractRocketMqClientTest.java index 25e30c960b9f..1a25b10ced1b 100644 --- a/instrumentation/rocketmq/rocketmq-client-5.0/javaagent/src/test/java/io/opentelemetry/instrumentation/rocketmqclient/v5_0/AbstractRocketMqClientTest.java +++ b/instrumentation/rocketmq/rocketmq-client-5.0/javaagent/src/test/java/io/opentelemetry/instrumentation/rocketmqclient/v5_0/AbstractRocketMqClientTest.java @@ -5,20 +5,29 @@ package io.opentelemetry.instrumentation.rocketmqclient.v5_0; +import static io.opentelemetry.api.trace.SpanKind.CLIENT; +import static io.opentelemetry.api.trace.SpanKind.CONSUMER; +import static io.opentelemetry.instrumentation.api.internal.SemconvStability.emitOldMessagingSemconv; +import static io.opentelemetry.instrumentation.api.internal.SemconvStability.emitStableMessagingSemconv; import static io.opentelemetry.instrumentation.testing.junit.message.MessageHeaderUtil.headerAttributeKey; import static io.opentelemetry.instrumentation.testing.util.TelemetryDataUtil.orderByRootSpanKind; import static io.opentelemetry.sdk.testing.assertj.OpenTelemetryAssertions.equalTo; +import static io.opentelemetry.semconv.ErrorAttributes.ERROR_TYPE; import static io.opentelemetry.semconv.incubating.MessagingIncubatingAttributes.MESSAGING_BATCH_MESSAGE_COUNT; +import static io.opentelemetry.semconv.incubating.MessagingIncubatingAttributes.MESSAGING_CONSUMER_GROUP_NAME; import static io.opentelemetry.semconv.incubating.MessagingIncubatingAttributes.MESSAGING_DESTINATION_NAME; import static io.opentelemetry.semconv.incubating.MessagingIncubatingAttributes.MESSAGING_MESSAGE_BODY_SIZE; import static io.opentelemetry.semconv.incubating.MessagingIncubatingAttributes.MESSAGING_MESSAGE_ID; import static io.opentelemetry.semconv.incubating.MessagingIncubatingAttributes.MESSAGING_OPERATION; +import static io.opentelemetry.semconv.incubating.MessagingIncubatingAttributes.MESSAGING_OPERATION_NAME; +import static io.opentelemetry.semconv.incubating.MessagingIncubatingAttributes.MESSAGING_OPERATION_TYPE; import static io.opentelemetry.semconv.incubating.MessagingIncubatingAttributes.MESSAGING_ROCKETMQ_CLIENT_GROUP; import static io.opentelemetry.semconv.incubating.MessagingIncubatingAttributes.MESSAGING_ROCKETMQ_MESSAGE_DELIVERY_TIMESTAMP; import static io.opentelemetry.semconv.incubating.MessagingIncubatingAttributes.MESSAGING_ROCKETMQ_MESSAGE_GROUP; import static io.opentelemetry.semconv.incubating.MessagingIncubatingAttributes.MESSAGING_ROCKETMQ_MESSAGE_KEYS; import static io.opentelemetry.semconv.incubating.MessagingIncubatingAttributes.MESSAGING_ROCKETMQ_MESSAGE_TAG; import static io.opentelemetry.semconv.incubating.MessagingIncubatingAttributes.MESSAGING_ROCKETMQ_MESSAGE_TYPE; +import static io.opentelemetry.semconv.incubating.MessagingIncubatingAttributes.MESSAGING_ROCKETMQ_NAMESPACE; import static io.opentelemetry.semconv.incubating.MessagingIncubatingAttributes.MESSAGING_SYSTEM; import static io.opentelemetry.semconv.incubating.MessagingIncubatingAttributes.MessagingRocketmqMessageTypeIncubatingValues.DELAY; import static io.opentelemetry.semconv.incubating.MessagingIncubatingAttributes.MessagingRocketmqMessageTypeIncubatingValues.FIFO; @@ -41,6 +50,7 @@ import java.util.HashMap; import java.util.List; import java.util.Map; +import java.util.concurrent.atomic.AtomicBoolean; import java.util.concurrent.atomic.AtomicReference; import org.apache.rocketmq.client.apis.ClientConfiguration; import org.apache.rocketmq.client.apis.ClientException; @@ -74,6 +84,7 @@ abstract class AbstractRocketMqClientTest { @RegisterExtension static final AutoCleanupExtension cleanup = AutoCleanupExtension.create(); private final ClientServiceProvider provider = ClientServiceProvider.loadService(); + private final AtomicBoolean failurePending = new AtomicBoolean(); private PushConsumer consumer; private Producer producer; @@ -102,6 +113,9 @@ void setUp() throws ClientException { .setMessageListener( messageView -> { testing().runWithSpan("messageListener", () -> {}); + if (failurePending.compareAndSet(true, false)) { + return ConsumeResult.FAILURE; + } return ConsumeResult.SUCCESS; }) .build(); @@ -137,34 +151,145 @@ void testSendAndConsumeNormalMessage() throws ClientException { AtomicReference sendSpanData = new AtomicReference<>(); testing() .waitAndAssertSortedTraces( - orderByRootSpanKind(SpanKind.INTERNAL, SpanKind.CONSUMER), + orderByRootSpanKind( + SpanKind.INTERNAL, emitStableMessagingSemconv() ? CLIENT : CONSUMER), trace -> { - trace.hasSpansSatisfyingExactly( - span -> span.hasName("parent").hasKind(SpanKind.INTERNAL).hasNoParent(), - span -> - assertProducerSpan(span, NORMAL_TOPIC, TAG, keys, body, sendReceipt) - .hasParent(trace.getSpan(0))); - sendSpanData.set(trace.getSpan(1)); - }, - trace -> + if (emitStableMessagingSemconv()) { trace.hasSpansSatisfyingExactly( - span -> assertReceiveSpan(span, NORMAL_TOPIC, CONSUMER_GROUP), + span -> span.hasName("parent").hasKind(SpanKind.INTERNAL).hasNoParent(), + span -> + assertProducerSpan(span, NORMAL_TOPIC, TAG, keys, body, sendReceipt) + .hasParent(trace.getSpan(0)), span -> assertProcessSpan( span, - sendSpanData.get(), + trace.getSpan(1), NORMAL_TOPIC, CONSUMER_GROUP, TAG, keys, body, sendReceipt) - // As the child of receive span. + .hasParent(trace.getSpan(1)), + span -> + span.hasName("messageListener") + .hasKind(SpanKind.INTERNAL) + .hasParent(trace.getSpan(2))); + } else { + trace.hasSpansSatisfyingExactly( + span -> span.hasName("parent").hasKind(SpanKind.INTERNAL).hasNoParent(), + span -> + assertProducerSpan(span, NORMAL_TOPIC, TAG, keys, body, sendReceipt) + .hasParent(trace.getSpan(0))); + } + sendSpanData.set(trace.getSpan(1)); + }, + trace -> { + if (emitStableMessagingSemconv()) { + trace.hasSpansSatisfyingExactly( + span -> assertReceiveSpan(span, NORMAL_TOPIC, CONSUMER_GROUP)); + return; + } + trace.hasSpansSatisfyingExactly( + span -> assertReceiveSpan(span, NORMAL_TOPIC, CONSUMER_GROUP), + span -> + assertProcessSpan( + span, + sendSpanData.get(), + NORMAL_TOPIC, + CONSUMER_GROUP, + TAG, + keys, + body, + sendReceipt) + // As the child of receive span. + .hasParent(trace.getSpan(0)), + span -> + span.hasName("messageListener") + .hasKind(SpanKind.INTERNAL) + .hasParent(trace.getSpan(1))); + }); + } + + @Test + void testConsumeFailure() throws ClientException { + String[] keys = new String[] {"yourMessageKey-0", "yourMessageKey-1"}; + byte[] body = "foobar".getBytes(UTF_8); + Message message = + provider + .newMessageBuilder() + .setTopic(NORMAL_TOPIC) + .setTag(TAG) + .setKeys(keys) + .setBody(body) + .build(); + + failurePending.set(true); + SendReceipt sendReceipt = + testing() + .runWithSpan( + "parent", + (ThrowingSupplier) () -> producer.send(message)); + AtomicReference sendSpanData = new AtomicReference<>(); + testing() + .waitAndAssertSortedTraces( + orderByRootSpanKind( + SpanKind.INTERNAL, emitStableMessagingSemconv() ? CLIENT : CONSUMER), + trace -> { + if (emitStableMessagingSemconv()) { + trace.hasSpansSatisfyingExactly( + span -> span.hasName("parent").hasKind(SpanKind.INTERNAL).hasNoParent(), + span -> + assertProducerSpan(span, NORMAL_TOPIC, TAG, keys, body, sendReceipt) .hasParent(trace.getSpan(0)), + span -> + assertFailedProcessSpan( + span, + trace.getSpan(1), + NORMAL_TOPIC, + CONSUMER_GROUP, + TAG, + keys, + body, + sendReceipt) + .hasParent(trace.getSpan(1)), span -> span.hasName("messageListener") .hasKind(SpanKind.INTERNAL) - .hasParent(trace.getSpan(1)))); + .hasParent(trace.getSpan(2))); + } else { + trace.hasSpansSatisfyingExactly( + span -> span.hasName("parent").hasKind(SpanKind.INTERNAL).hasNoParent(), + span -> + assertProducerSpan(span, NORMAL_TOPIC, TAG, keys, body, sendReceipt) + .hasParent(trace.getSpan(0))); + } + sendSpanData.set(trace.getSpan(1)); + }, + trace -> { + if (emitStableMessagingSemconv()) { + trace.hasSpansSatisfyingExactly( + span -> assertReceiveSpan(span, NORMAL_TOPIC, CONSUMER_GROUP)); + return; + } + trace.hasSpansSatisfyingExactly( + span -> assertReceiveSpan(span, NORMAL_TOPIC, CONSUMER_GROUP), + span -> + assertFailedProcessSpan( + span, + sendSpanData.get(), + NORMAL_TOPIC, + CONSUMER_GROUP, + TAG, + keys, + body, + sendReceipt) + .hasParent(trace.getSpan(0)), + span -> + span.hasName("messageListener") + .hasKind(SpanKind.INTERNAL) + .hasParent(trace.getSpan(1))); + }); } @Test @@ -195,35 +320,66 @@ void testSendAsyncMessage() { AtomicReference sendSpanData = new AtomicReference<>(); testing() .waitAndAssertSortedTraces( - orderByRootSpanKind(SpanKind.INTERNAL, SpanKind.CONSUMER), + orderByRootSpanKind( + SpanKind.INTERNAL, emitStableMessagingSemconv() ? CLIENT : CONSUMER), trace -> { - trace.hasSpansSatisfyingExactly( - span -> span.hasName("parent"), - span -> - assertProducerSpan(span, NORMAL_TOPIC, TAG, keys, body, sendReceipt) - .hasParent(trace.getSpan(0)), - span -> span.hasName("child")); - sendSpanData.set(trace.getSpan(1)); - }, - trace -> + if (emitStableMessagingSemconv()) { trace.hasSpansSatisfyingExactly( - span -> assertReceiveSpan(span, NORMAL_TOPIC, CONSUMER_GROUP), + span -> span.hasName("parent"), + span -> + assertProducerSpan(span, NORMAL_TOPIC, TAG, keys, body, sendReceipt) + .hasParent(trace.getSpan(0)), span -> assertProcessSpan( span, - sendSpanData.get(), + trace.getSpan(1), NORMAL_TOPIC, CONSUMER_GROUP, TAG, keys, body, sendReceipt) - // As the child of receive span. - .hasParent(trace.getSpan(0)), + .hasParent(trace.getSpan(1)), span -> span.hasName("messageListener") .hasKind(SpanKind.INTERNAL) - .hasParent(trace.getSpan(1)))); + .hasParent(trace.getSpan(2)), + span -> span.hasName("child")); + } else { + trace.hasSpansSatisfyingExactly( + span -> span.hasName("parent"), + span -> + assertProducerSpan(span, NORMAL_TOPIC, TAG, keys, body, sendReceipt) + .hasParent(trace.getSpan(0)), + span -> span.hasName("child")); + } + sendSpanData.set(trace.getSpan(1)); + }, + trace -> { + if (emitStableMessagingSemconv()) { + trace.hasSpansSatisfyingExactly( + span -> assertReceiveSpan(span, NORMAL_TOPIC, CONSUMER_GROUP)); + return; + } + trace.hasSpansSatisfyingExactly( + span -> assertReceiveSpan(span, NORMAL_TOPIC, CONSUMER_GROUP), + span -> + assertProcessSpan( + span, + sendSpanData.get(), + NORMAL_TOPIC, + CONSUMER_GROUP, + TAG, + keys, + body, + sendReceipt) + // As the child of receive span. + .hasParent(trace.getSpan(0)), + span -> + span.hasName("messageListener") + .hasKind(SpanKind.INTERNAL) + .hasParent(trace.getSpan(1))); + }); } @Test @@ -249,23 +405,20 @@ void testSendAndConsumeFifoMessage() throws ClientException { AtomicReference sendSpanData = new AtomicReference<>(); testing() .waitAndAssertSortedTraces( - orderByRootSpanKind(SpanKind.INTERNAL, SpanKind.CONSUMER), + orderByRootSpanKind( + SpanKind.INTERNAL, emitStableMessagingSemconv() ? CLIENT : CONSUMER), trace -> { - trace.hasSpansSatisfyingExactly( - span -> span.hasName("parent").hasKind(SpanKind.INTERNAL).hasNoParent(), - span -> - assertProducerSpanWithFifoMessage( - span, FIFO_TOPIC, TAG, keys, messageGroup, body, sendReceipt) - .hasParent(trace.getSpan(0))); - sendSpanData.set(trace.getSpan(1)); - }, - trace -> + if (emitStableMessagingSemconv()) { trace.hasSpansSatisfyingExactly( - span -> assertReceiveSpan(span, FIFO_TOPIC, CONSUMER_GROUP), + span -> span.hasName("parent").hasKind(SpanKind.INTERNAL).hasNoParent(), + span -> + assertProducerSpanWithFifoMessage( + span, FIFO_TOPIC, TAG, keys, messageGroup, body, sendReceipt) + .hasParent(trace.getSpan(0)), span -> assertProcessSpanWithFifoMessage( span, - sendSpanData.get(), + trace.getSpan(1), FIFO_TOPIC, CONSUMER_GROUP, TAG, @@ -273,12 +426,47 @@ void testSendAndConsumeFifoMessage() throws ClientException { messageGroup, body, sendReceipt) - // As the child of receive span. - .hasParent(trace.getSpan(0)), + .hasParent(trace.getSpan(1)), span -> span.hasName("messageListener") .hasKind(SpanKind.INTERNAL) - .hasParent(trace.getSpan(1)))); + .hasParent(trace.getSpan(2))); + } else { + trace.hasSpansSatisfyingExactly( + span -> span.hasName("parent").hasKind(SpanKind.INTERNAL).hasNoParent(), + span -> + assertProducerSpanWithFifoMessage( + span, FIFO_TOPIC, TAG, keys, messageGroup, body, sendReceipt) + .hasParent(trace.getSpan(0))); + } + sendSpanData.set(trace.getSpan(1)); + }, + trace -> { + if (emitStableMessagingSemconv()) { + trace.hasSpansSatisfyingExactly( + span -> assertReceiveSpan(span, FIFO_TOPIC, CONSUMER_GROUP)); + return; + } + trace.hasSpansSatisfyingExactly( + span -> assertReceiveSpan(span, FIFO_TOPIC, CONSUMER_GROUP), + span -> + assertProcessSpanWithFifoMessage( + span, + sendSpanData.get(), + FIFO_TOPIC, + CONSUMER_GROUP, + TAG, + keys, + messageGroup, + body, + sendReceipt) + // As the child of receive span. + .hasParent(trace.getSpan(0)), + span -> + span.hasName("messageListener") + .hasKind(SpanKind.INTERNAL) + .hasParent(trace.getSpan(1))); + }); } @Test @@ -304,23 +492,20 @@ void testSendAndConsumeDelayMessage() throws ClientException { AtomicReference sendSpanData = new AtomicReference<>(); testing() .waitAndAssertSortedTraces( - orderByRootSpanKind(SpanKind.INTERNAL, SpanKind.CONSUMER), + orderByRootSpanKind( + SpanKind.INTERNAL, emitStableMessagingSemconv() ? CLIENT : CONSUMER), trace -> { - trace.hasSpansSatisfyingExactly( - span -> span.hasName("parent").hasKind(SpanKind.INTERNAL).hasNoParent(), - span -> - assertProducerSpanWithDelayMessage( - span, DELAY_TOPIC, TAG, keys, deliveryTimestamp, body, sendReceipt) - .hasParent(trace.getSpan(0))); - sendSpanData.set(trace.getSpan(1)); - }, - trace -> + if (emitStableMessagingSemconv()) { trace.hasSpansSatisfyingExactly( - span -> assertReceiveSpan(span, DELAY_TOPIC, CONSUMER_GROUP), + span -> span.hasName("parent").hasKind(SpanKind.INTERNAL).hasNoParent(), + span -> + assertProducerSpanWithDelayMessage( + span, DELAY_TOPIC, TAG, keys, deliveryTimestamp, body, sendReceipt) + .hasParent(trace.getSpan(0)), span -> assertProcessSpanWithDelayMessage( span, - sendSpanData.get(), + trace.getSpan(1), DELAY_TOPIC, CONSUMER_GROUP, TAG, @@ -328,12 +513,47 @@ void testSendAndConsumeDelayMessage() throws ClientException { deliveryTimestamp, body, sendReceipt) - // As the child of receive span. - .hasParent(trace.getSpan(0)), + .hasParent(trace.getSpan(1)), span -> span.hasName("messageListener") .hasKind(SpanKind.INTERNAL) - .hasParent(trace.getSpan(1)))); + .hasParent(trace.getSpan(2))); + } else { + trace.hasSpansSatisfyingExactly( + span -> span.hasName("parent").hasKind(SpanKind.INTERNAL).hasNoParent(), + span -> + assertProducerSpanWithDelayMessage( + span, DELAY_TOPIC, TAG, keys, deliveryTimestamp, body, sendReceipt) + .hasParent(trace.getSpan(0))); + } + sendSpanData.set(trace.getSpan(1)); + }, + trace -> { + if (emitStableMessagingSemconv()) { + trace.hasSpansSatisfyingExactly( + span -> assertReceiveSpan(span, DELAY_TOPIC, CONSUMER_GROUP)); + return; + } + trace.hasSpansSatisfyingExactly( + span -> assertReceiveSpan(span, DELAY_TOPIC, CONSUMER_GROUP), + span -> + assertProcessSpanWithDelayMessage( + span, + sendSpanData.get(), + DELAY_TOPIC, + CONSUMER_GROUP, + TAG, + keys, + deliveryTimestamp, + body, + sendReceipt) + // As the child of receive span. + .hasParent(trace.getSpan(0)), + span -> + span.hasName("messageListener") + .hasKind(SpanKind.INTERNAL) + .hasParent(trace.getSpan(1))); + }); } @Test @@ -359,30 +579,28 @@ void testCapturedMessageHeaders() throws ClientException { AtomicReference sendSpanData = new AtomicReference<>(); testing() .waitAndAssertSortedTraces( - orderByRootSpanKind(SpanKind.INTERNAL, SpanKind.CONSUMER), + orderByRootSpanKind( + SpanKind.INTERNAL, emitStableMessagingSemconv() ? CLIENT : CONSUMER), trace -> { - trace.hasSpansSatisfyingExactly( - span -> span.hasName("parent").hasKind(SpanKind.INTERNAL).hasNoParent(), - span -> - assertProducerSpan( - span, - NORMAL_TOPIC, - TAG, - keys, - body, - sendReceipt, - equalTo( - headerAttributeKey("Test-Message-Header"), singletonList("test"))) - .hasParent(trace.getSpan(0))); - sendSpanData.set(trace.getSpan(1)); - }, - trace -> + if (emitStableMessagingSemconv()) { trace.hasSpansSatisfyingExactly( - span -> assertReceiveSpan(span, NORMAL_TOPIC, CONSUMER_GROUP), + span -> span.hasName("parent").hasKind(SpanKind.INTERNAL).hasNoParent(), + span -> + assertProducerSpan( + span, + NORMAL_TOPIC, + TAG, + keys, + body, + sendReceipt, + equalTo( + headerAttributeKey("Test-Message-Header"), + singletonList("test"))) + .hasParent(trace.getSpan(0)), span -> assertProcessSpan( span, - sendSpanData.get(), + trace.getSpan(1), NORMAL_TOPIC, CONSUMER_GROUP, TAG, @@ -392,12 +610,56 @@ void testCapturedMessageHeaders() throws ClientException { equalTo( headerAttributeKey("Test-Message-Header"), singletonList("test"))) - // As the child of receive span. - .hasParent(trace.getSpan(0)), + .hasParent(trace.getSpan(1)), span -> span.hasName("messageListener") .hasKind(SpanKind.INTERNAL) - .hasParent(trace.getSpan(1)))); + .hasParent(trace.getSpan(2))); + } else { + trace.hasSpansSatisfyingExactly( + span -> span.hasName("parent").hasKind(SpanKind.INTERNAL).hasNoParent(), + span -> + assertProducerSpan( + span, + NORMAL_TOPIC, + TAG, + keys, + body, + sendReceipt, + equalTo( + headerAttributeKey("Test-Message-Header"), + singletonList("test"))) + .hasParent(trace.getSpan(0))); + } + sendSpanData.set(trace.getSpan(1)); + }, + trace -> { + if (emitStableMessagingSemconv()) { + trace.hasSpansSatisfyingExactly( + span -> assertReceiveSpan(span, NORMAL_TOPIC, CONSUMER_GROUP)); + return; + } + trace.hasSpansSatisfyingExactly( + span -> assertReceiveSpan(span, NORMAL_TOPIC, CONSUMER_GROUP), + span -> + assertProcessSpan( + span, + sendSpanData.get(), + NORMAL_TOPIC, + CONSUMER_GROUP, + TAG, + keys, + body, + sendReceipt, + equalTo( + headerAttributeKey("Test-Message-Header"), singletonList("test"))) + // As the child of receive span. + .hasParent(trace.getSpan(0)), + span -> + span.hasName("messageListener") + .hasKind(SpanKind.INTERNAL) + .hasParent(trace.getSpan(1))); + }); } private static SpanDataAssert assertProducerSpan( @@ -416,13 +678,16 @@ private static SpanDataAssert assertProducerSpan( equalTo(MESSAGING_ROCKETMQ_MESSAGE_TYPE, NORMAL), equalTo(MESSAGING_MESSAGE_BODY_SIZE, (long) body.length), equalTo(MESSAGING_SYSTEM, "rocketmq"), + namespace(), equalTo(MESSAGING_MESSAGE_ID, sendReceipt.getMessageId().toString()), equalTo(MESSAGING_DESTINATION_NAME, topic), - equalTo(MESSAGING_OPERATION, "publish"))); + oldOperation("publish"), + operationName("publish"), + operationType("publish"))); attributeAssertions.addAll(asList(extraAttributes)); return span.hasKind(SpanKind.PRODUCER) - .hasName(topic + " publish") + .hasName(emitStableMessagingSemconv() ? "publish " + topic : topic + " publish") .hasStatus(StatusData.unset()) .hasAttributesSatisfyingExactly(attributeAssertions); } @@ -445,13 +710,16 @@ private static SpanDataAssert assertProducerSpanWithFifoMessage( equalTo(MESSAGING_ROCKETMQ_MESSAGE_TYPE, FIFO), equalTo(MESSAGING_MESSAGE_BODY_SIZE, (long) body.length), equalTo(MESSAGING_SYSTEM, "rocketmq"), + namespace(), equalTo(MESSAGING_MESSAGE_ID, sendReceipt.getMessageId().toString()), equalTo(MESSAGING_DESTINATION_NAME, topic), - equalTo(MESSAGING_OPERATION, "publish"))); + oldOperation("publish"), + operationName("publish"), + operationType("publish"))); attributeAssertions.addAll(asList(extraAttributes)); return span.hasKind(SpanKind.PRODUCER) - .hasName(topic + " publish") + .hasName(emitStableMessagingSemconv() ? "publish " + topic : topic + " publish") .hasStatus(StatusData.unset()) .hasAttributesSatisfyingExactly(attributeAssertions); } @@ -474,30 +742,84 @@ private static SpanDataAssert assertProducerSpanWithDelayMessage( equalTo(MESSAGING_ROCKETMQ_MESSAGE_TYPE, DELAY), equalTo(MESSAGING_MESSAGE_BODY_SIZE, (long) body.length), equalTo(MESSAGING_SYSTEM, "rocketmq"), + namespace(), equalTo(MESSAGING_MESSAGE_ID, sendReceipt.getMessageId().toString()), equalTo(MESSAGING_DESTINATION_NAME, topic), - equalTo(MESSAGING_OPERATION, "publish"))); + oldOperation("publish"), + operationName("publish"), + operationType("publish"))); attributeAssertions.addAll(asList(extraAttributes)); return span.hasKind(SpanKind.PRODUCER) - .hasName(topic + " publish") + .hasName(emitStableMessagingSemconv() ? "publish " + topic : topic + " publish") .hasStatus(StatusData.unset()) .hasAttributesSatisfyingExactly(attributeAssertions); } private static SpanDataAssert assertReceiveSpan( SpanDataAssert span, String topic, String consumerGroup) { - return span.hasKind(SpanKind.CONSUMER) - .hasName(topic + " receive") + return span.hasKind(emitStableMessagingSemconv() ? CLIENT : CONSUMER) + .hasName(emitStableMessagingSemconv() ? "receive " + topic : topic + " receive") .hasStatus(StatusData.unset()) .hasAttributesSatisfyingExactly( - equalTo(MESSAGING_ROCKETMQ_CLIENT_GROUP, consumerGroup), + equalTo( + MESSAGING_CONSUMER_GROUP_NAME, emitStableMessagingSemconv() ? consumerGroup : null), + equalTo( + MESSAGING_ROCKETMQ_CLIENT_GROUP, emitOldMessagingSemconv() ? consumerGroup : null), equalTo(MESSAGING_SYSTEM, "rocketmq"), + namespace(), equalTo(MESSAGING_DESTINATION_NAME, topic), - equalTo(MESSAGING_OPERATION, "receive"), + oldOperation("receive"), + operationName("receive"), + operationType("receive"), equalTo(MESSAGING_BATCH_MESSAGE_COUNT, 1)); } + private static SpanDataAssert assertFailedProcessSpan( + SpanDataAssert span, + SpanData linkedSpan, + String topic, + String consumerGroup, + String tag, + String[] keys, + byte[] body, + SendReceipt sendReceipt) { + return assertProcessSpan( + span, + linkedSpan, + topic, + consumerGroup, + tag, + keys, + body, + sendReceipt, + StatusData.error(), + equalTo(ERROR_TYPE, emitStableMessagingSemconv() ? "FAILURE" : null)); + } + + private static SpanDataAssert assertProcessSpan( + SpanDataAssert span, + SpanData linkedSpan, + String topic, + String consumerGroup, + String tag, + String[] keys, + byte[] body, + SendReceipt sendReceipt, + AttributeAssertion... extraAttributes) { + return assertProcessSpan( + span, + linkedSpan, + topic, + consumerGroup, + tag, + keys, + body, + sendReceipt, + StatusData.unset(), + extraAttributes); + } + private static SpanDataAssert assertProcessSpan( SpanDataAssert span, SpanData linkedSpan, @@ -507,26 +829,37 @@ private static SpanDataAssert assertProcessSpan( String[] keys, byte[] body, SendReceipt sendReceipt, + StatusData status, AttributeAssertion... extraAttributes) { List attributeAssertions = new ArrayList<>( asList( - equalTo(MESSAGING_ROCKETMQ_CLIENT_GROUP, consumerGroup), + equalTo( + MESSAGING_CONSUMER_GROUP_NAME, + emitStableMessagingSemconv() ? consumerGroup : null), + equalTo( + MESSAGING_ROCKETMQ_CLIENT_GROUP, + emitOldMessagingSemconv() ? consumerGroup : null), equalTo(MESSAGING_ROCKETMQ_MESSAGE_TAG, tag), equalTo(MESSAGING_ROCKETMQ_MESSAGE_KEYS, asList(keys)), equalTo(MESSAGING_MESSAGE_BODY_SIZE, (long) body.length), equalTo(MESSAGING_SYSTEM, "rocketmq"), + namespace(), equalTo(MESSAGING_MESSAGE_ID, sendReceipt.getMessageId().toString()), equalTo(MESSAGING_DESTINATION_NAME, topic), - equalTo(MESSAGING_OPERATION, "process"))); + oldOperation("process"), + operationName("process"), + operationType("process"))); attributeAssertions.addAll(asList(extraAttributes)); - return span.hasKind(SpanKind.CONSUMER) - .hasName(topic + " process") - .hasStatus(StatusData.unset()) - // Link to send span. - .hasLinks(LinkData.create(linkedSpan.getSpanContext())) - .hasAttributesSatisfyingExactly(attributeAssertions); + SpanDataAssert result = + span.hasKind(SpanKind.CONSUMER) + .hasName(emitStableMessagingSemconv() ? "process " + topic : topic + " process") + .hasStatus(status) + .hasAttributesSatisfyingExactly(attributeAssertions); + return emitStableMessagingSemconv() + ? result.hasTotalRecordedLinks(0) + : result.hasLinks(LinkData.create(linkedSpan.getSpanContext())); } private static SpanDataAssert assertProcessSpanWithFifoMessage( @@ -543,23 +876,33 @@ private static SpanDataAssert assertProcessSpanWithFifoMessage( List attributeAssertions = new ArrayList<>( asList( - equalTo(MESSAGING_ROCKETMQ_CLIENT_GROUP, consumerGroup), + equalTo( + MESSAGING_CONSUMER_GROUP_NAME, + emitStableMessagingSemconv() ? consumerGroup : null), + equalTo( + MESSAGING_ROCKETMQ_CLIENT_GROUP, + emitOldMessagingSemconv() ? consumerGroup : null), equalTo(MESSAGING_ROCKETMQ_MESSAGE_TAG, tag), equalTo(MESSAGING_ROCKETMQ_MESSAGE_KEYS, asList(keys)), equalTo(MESSAGING_ROCKETMQ_MESSAGE_GROUP, messageGroup), equalTo(MESSAGING_MESSAGE_BODY_SIZE, (long) body.length), equalTo(MESSAGING_SYSTEM, "rocketmq"), + namespace(), equalTo(MESSAGING_MESSAGE_ID, sendReceipt.getMessageId().toString()), equalTo(MESSAGING_DESTINATION_NAME, topic), - equalTo(MESSAGING_OPERATION, "process"))); + oldOperation("process"), + operationName("process"), + operationType("process"))); attributeAssertions.addAll(asList(extraAttributes)); - return span.hasKind(SpanKind.CONSUMER) - .hasName(topic + " process") - .hasStatus(StatusData.unset()) - // Link to send span. - .hasLinks(LinkData.create(linkedSpan.getSpanContext())) - .hasAttributesSatisfyingExactly(attributeAssertions); + SpanDataAssert result = + span.hasKind(SpanKind.CONSUMER) + .hasName(emitStableMessagingSemconv() ? "process " + topic : topic + " process") + .hasStatus(StatusData.unset()) + .hasAttributesSatisfyingExactly(attributeAssertions); + return emitStableMessagingSemconv() + ? result.hasTotalRecordedLinks(0) + : result.hasLinks(LinkData.create(linkedSpan.getSpanContext())); } private static SpanDataAssert assertProcessSpanWithDelayMessage( @@ -576,22 +919,49 @@ private static SpanDataAssert assertProcessSpanWithDelayMessage( List attributeAssertions = new ArrayList<>( asList( - equalTo(MESSAGING_ROCKETMQ_CLIENT_GROUP, consumerGroup), + equalTo( + MESSAGING_CONSUMER_GROUP_NAME, + emitStableMessagingSemconv() ? consumerGroup : null), + equalTo( + MESSAGING_ROCKETMQ_CLIENT_GROUP, + emitOldMessagingSemconv() ? consumerGroup : null), equalTo(MESSAGING_ROCKETMQ_MESSAGE_TAG, tag), equalTo(MESSAGING_ROCKETMQ_MESSAGE_KEYS, asList(keys)), equalTo(MESSAGING_ROCKETMQ_MESSAGE_DELIVERY_TIMESTAMP, deliveryTimestamp), equalTo(MESSAGING_MESSAGE_BODY_SIZE, (long) body.length), equalTo(MESSAGING_SYSTEM, "rocketmq"), + namespace(), equalTo(MESSAGING_MESSAGE_ID, sendReceipt.getMessageId().toString()), equalTo(MESSAGING_DESTINATION_NAME, topic), - equalTo(MESSAGING_OPERATION, "process"))); + oldOperation("process"), + operationName("process"), + operationType("process"))); attributeAssertions.addAll(asList(extraAttributes)); - return span.hasKind(SpanKind.CONSUMER) - .hasName(topic + " process") - .hasStatus(StatusData.unset()) - // Link to send span. - .hasLinks(LinkData.create(linkedSpan.getSpanContext())) - .hasAttributesSatisfyingExactly(attributeAssertions); + SpanDataAssert result = + span.hasKind(SpanKind.CONSUMER) + .hasName(emitStableMessagingSemconv() ? "process " + topic : topic + " process") + .hasStatus(StatusData.unset()) + .hasAttributesSatisfyingExactly(attributeAssertions); + return emitStableMessagingSemconv() + ? result.hasTotalRecordedLinks(0) + : result.hasLinks(LinkData.create(linkedSpan.getSpanContext())); + } + + private static AttributeAssertion oldOperation(String operation) { + return equalTo(MESSAGING_OPERATION, emitOldMessagingSemconv() ? operation : null); + } + + private static AttributeAssertion namespace() { + return equalTo(MESSAGING_ROCKETMQ_NAMESPACE, emitStableMessagingSemconv() ? "" : null); + } + + private static AttributeAssertion operationName(String operation) { + return equalTo(MESSAGING_OPERATION_NAME, emitStableMessagingSemconv() ? operation : null); + } + + private static AttributeAssertion operationType(String operation) { + String operationType = operation.equals("publish") ? "send" : operation; + return equalTo(MESSAGING_OPERATION_TYPE, emitStableMessagingSemconv() ? operationType : null); } } diff --git a/testing-common/src/main/java/io/opentelemetry/instrumentation/testing/junit/message/SemconvMessagingStabilityUtil.java b/testing-common/src/main/java/io/opentelemetry/instrumentation/testing/junit/message/SemconvMessagingStabilityUtil.java new file mode 100644 index 000000000000..e5444956add0 --- /dev/null +++ b/testing-common/src/main/java/io/opentelemetry/instrumentation/testing/junit/message/SemconvMessagingStabilityUtil.java @@ -0,0 +1,36 @@ +/* + * Copyright The OpenTelemetry Authors + * SPDX-License-Identifier: Apache-2.0 + */ + +package io.opentelemetry.instrumentation.testing.junit.message; + +import static io.opentelemetry.api.common.AttributeKey.stringKey; +import static io.opentelemetry.instrumentation.api.internal.SemconvStability.emitStableMessagingSemconv; + +import io.opentelemetry.api.common.AttributeKey; +import java.util.HashMap; +import java.util.Map; + +// supports asserting on old messaging semconv, to be removed in 3.0 +public class SemconvMessagingStabilityUtil { + + private static final Map, AttributeKey> oldToNewMap = buildMap(); + + private static Map, AttributeKey> buildMap() { + Map, AttributeKey> map = new HashMap<>(); + map.put(stringKey("messaging.client_id"), stringKey("messaging.client.id")); + return map; + } + + @SuppressWarnings("unchecked") + public static AttributeKey effectiveKey(AttributeKey oldKey) { + // not testing messaging/dup + if (emitStableMessagingSemconv()) { + return (AttributeKey) oldToNewMap.getOrDefault(oldKey, oldKey); + } + return oldKey; + } + + private SemconvMessagingStabilityUtil() {} +}