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/aws-sdk/aws-sdk-1.11/library/build.gradle.kts b/instrumentation/aws-sdk/aws-sdk-1.11/library/build.gradle.kts index f506e594ed99..db1c0b0ade6e 100644 --- a/instrumentation/aws-sdk/aws-sdk-1.11/library/build.gradle.kts +++ b/instrumentation/aws-sdk/aws-sdk-1.11/library/build.gradle.kts @@ -58,6 +58,18 @@ tasks { jvmArgs("-Dotel.semconv-stability.opt-in=database") } + val testMessagingPreview = register("testMessagingPreview") { + testClassesDirs = sourceSets.test.get().output.classesDirs + classpath = sourceSets.test.get().runtimeClasspath + filter { + includeTestsMatching("SqsSuppressReceiveSpansTest.testAbandonedIteratorDoesNotParentNextProcessSpan") + includeTestsMatching("SqsTracingTest.testReceiveSpanLinksToProducer") + includeTestsMatching("SqsTracingTest.testBatchSendMessageCount") + includeTestsMatching("SqsTracingTest.testSimpleSqsProducerConsumerServicesWithParentSpan") + } + jvmArgs("-Dotel.semconv-stability.preview=messaging") + } + val testExceptionSignalLogs = register("testExceptionSignalLogs") { testClassesDirs = sourceSets.test.get().output.classesDirs classpath = sourceSets.test.get().runtimeClasspath @@ -65,6 +77,6 @@ tasks { } check { - dependsOn(testing.suites, testStableSemconv, testExceptionSignalLogs) + dependsOn(testing.suites, testStableSemconv, testMessagingPreview, testExceptionSignalLogs) } } diff --git a/instrumentation/aws-sdk/aws-sdk-1.11/library/src/main/java/io/opentelemetry/instrumentation/awssdk/v1_11/internal/AwsSdkInstrumenterFactory.java b/instrumentation/aws-sdk/aws-sdk-1.11/library/src/main/java/io/opentelemetry/instrumentation/awssdk/v1_11/internal/AwsSdkInstrumenterFactory.java index 3a96403c8843..e677b3f251e3 100644 --- a/instrumentation/aws-sdk/aws-sdk-1.11/library/src/main/java/io/opentelemetry/instrumentation/awssdk/v1_11/internal/AwsSdkInstrumenterFactory.java +++ b/instrumentation/aws-sdk/aws-sdk-1.11/library/src/main/java/io/opentelemetry/instrumentation/awssdk/v1_11/internal/AwsSdkInstrumenterFactory.java @@ -10,6 +10,7 @@ import static io.opentelemetry.instrumentation.api.incubator.semconv.messaging.internal.MessagingExceptionEventExtractors.setMessagingReceiveExceptionEventExtractor; import static io.opentelemetry.instrumentation.api.incubator.semconv.messaging.internal.MessagingExceptionEventExtractors.setMessagingSendExceptionEventExtractor; import static io.opentelemetry.instrumentation.api.incubator.semconv.rpc.internal.RpcExceptionEventExtractors.setRpcClientExceptionEventExtractor; +import static io.opentelemetry.instrumentation.api.internal.SemconvStability.emitStableMessagingSemconv; import static java.util.Arrays.asList; import static java.util.Collections.singletonList; @@ -18,12 +19,15 @@ import io.opentelemetry.api.OpenTelemetry; import io.opentelemetry.api.common.AttributesBuilder; import io.opentelemetry.api.trace.Span; +import io.opentelemetry.api.trace.SpanContext; import io.opentelemetry.context.Context; import io.opentelemetry.instrumentation.api.incubator.semconv.db.DbClientMetrics; -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.MessagingProcessContextCustomizer; import io.opentelemetry.instrumentation.api.incubator.semconv.rpc.RpcClientAttributesExtractor; import io.opentelemetry.instrumentation.api.instrumenter.AttributesExtractor; import io.opentelemetry.instrumentation.api.instrumenter.Instrumenter; @@ -96,51 +100,80 @@ private List, Response>> attributesExtractors( } private AttributesExtractor messagingAttributesExtractor( - MessagingAttributesGetter getter, MessageOperation operation) { - return MessagingAttributesExtractor.builder(getter, operation) + MessagingAttributesGetter getter, MessagingOperationType operationType) { + return MessagingAttributesExtractor.builderForOperationType(getter, operationType) .setCapturedHeaders(capturedHeaders) .build(); } public Instrumenter> consumerReceiveInstrumenter() { - MessageOperation operation = MessageOperation.RECEIVE; + MessagingOperationType operationType = MessagingOperationType.RECEIVE; SqsReceiveRequestAttributesGetter getter = new SqsReceiveRequestAttributesGetter(); AttributesExtractor> messagingAttributeExtractor = - messagingAttributesExtractor(getter, operation); + messagingAttributesExtractor(getter, operationType); return createInstrumenter( openTelemetry, - MessagingSpanNameExtractor.create(getter, operation), - SpanKindExtractor.alwaysConsumer(), + MessagingSpanNameExtractor.create(getter, operationType), + MessagingSpanKindExtractor.create(operationType), toSqsRequestExtractors(attributesExtractors()), singletonList(messagingAttributeExtractor), - builder -> setMessagingReceiveExceptionEventExtractor(builder), + builder -> { + setMessagingReceiveExceptionEventExtractor(builder); + if (emitStableMessagingSemconv()) { + builder.addSpanLinksExtractor( + (spanLinks, parentContext, request) -> { + for (SqsMessage message : request.getMessages()) { + SpanContext spanContext = + Span.fromContext(message.getCreationContext()).getSpanContext(); + if (spanContext.isValid()) { + spanLinks.addLink(spanContext); + } + } + }); + } + }, messagingReceiveInstrumentationEnabled); } public Instrumenter> consumerProcessInstrumenter() { - MessageOperation operation = MessageOperation.PROCESS; + MessagingOperationType operationType = MessagingOperationType.PROCESS; SqsProcessRequestAttributesGetter getter = new SqsProcessRequestAttributesGetter(); AttributesExtractor> messagingAttributeExtractor = - messagingAttributesExtractor(getter, operation); + messagingAttributesExtractor(getter, operationType); InstrumenterBuilder> builder = Instrumenter.>builder( openTelemetry, INSTRUMENTATION_NAME, - MessagingSpanNameExtractor.create(getter, operation)) + MessagingSpanNameExtractor.create(getter, operationType)) .addAttributesExtractors(toSqsRequestExtractors(attributesExtractors())) .addAttributesExtractor(messagingAttributeExtractor); setMessagingProcessExceptionEventExtractor(builder); - if (messagingReceiveInstrumentationEnabled) { + if (emitStableMessagingSemconv() || messagingReceiveInstrumentationEnabled) { builder.addSpanLinksExtractor( (spanLinks, parentContext, request) -> { - Context extracted = - SqsParentContext.ofSystemAttributes(request.getMessage().getAttributes()); - spanLinks.addLink(Span.fromContext(extracted).getSpanContext()); + SpanContext parentSpanContext = Span.fromContext(parentContext).getSpanContext(); + SpanContext creationSpanContext = + Span.fromContext(request.getMessage().getCreationContext()).getSpanContext(); + if (creationSpanContext.isValid() + && (!emitStableMessagingSemconv() + || (parentSpanContext.isValid() + && (!creationSpanContext.getTraceId().equals(parentSpanContext.getTraceId()) + || !creationSpanContext + .getSpanId() + .equals(parentSpanContext.getSpanId()))))) { + spanLinks.addLink(creationSpanContext); + } }); } + if (emitStableMessagingSemconv()) { + builder.addContextCustomizer( + MessagingProcessContextCustomizer.create( + (parentContext, request) -> + parentContext.with(Span.fromContext(request.getMessage().getCreationContext())))); + } return builder.buildInstrumenter(SpanKindExtractor.alwaysConsumer()); } @@ -173,14 +206,14 @@ public void onEnd( } public Instrumenter, Response> producerInstrumenter() { - MessageOperation operation = MessageOperation.PUBLISH; + MessagingOperationType operationType = MessagingOperationType.SEND; SqsAttributesGetter getter = new SqsAttributesGetter(); AttributesExtractor, Response> messagingAttributeExtractor = - messagingAttributesExtractor(getter, operation); + messagingAttributesExtractor(getter, operationType); return createInstrumenter( openTelemetry, - MessagingSpanNameExtractor.create(getter, operation), + MessagingSpanNameExtractor.create(getter, operationType), SpanKindExtractor.alwaysProducer(), attributesExtractors(), singletonList(messagingAttributeExtractor), diff --git a/instrumentation/aws-sdk/aws-sdk-1.11/library/src/main/java/io/opentelemetry/instrumentation/awssdk/v1_11/internal/SqsAccess.java b/instrumentation/aws-sdk/aws-sdk-1.11/library/src/main/java/io/opentelemetry/instrumentation/awssdk/v1_11/internal/SqsAccess.java index 22b81506940f..008df6f8cd60 100644 --- a/instrumentation/aws-sdk/aws-sdk-1.11/library/src/main/java/io/opentelemetry/instrumentation/awssdk/v1_11/internal/SqsAccess.java +++ b/instrumentation/aws-sdk/aws-sdk-1.11/library/src/main/java/io/opentelemetry/instrumentation/awssdk/v1_11/internal/SqsAccess.java @@ -32,6 +32,12 @@ static boolean beforeMarshalling(AmazonWebServiceRequest request) { return enabled && SqsImpl.beforeMarshalling(request); } + @NoMuzzle + @Nullable + static Long getBatchMessageCount(Request request) { + return enabled ? SqsImpl.getBatchMessageCount(request) : null; + } + @NoMuzzle @Nullable static String getMessageAttribute(Request request, String name) { diff --git a/instrumentation/aws-sdk/aws-sdk-1.11/library/src/main/java/io/opentelemetry/instrumentation/awssdk/v1_11/internal/SqsAttributesGetter.java b/instrumentation/aws-sdk/aws-sdk-1.11/library/src/main/java/io/opentelemetry/instrumentation/awssdk/v1_11/internal/SqsAttributesGetter.java index d2226e6695be..47b9918ab138 100644 --- a/instrumentation/aws-sdk/aws-sdk-1.11/library/src/main/java/io/opentelemetry/instrumentation/awssdk/v1_11/internal/SqsAttributesGetter.java +++ b/instrumentation/aws-sdk/aws-sdk-1.11/library/src/main/java/io/opentelemetry/instrumentation/awssdk/v1_11/internal/SqsAttributesGetter.java @@ -5,6 +5,7 @@ package io.opentelemetry.instrumentation.awssdk.v1_11.internal; +import static io.opentelemetry.instrumentation.api.internal.SemconvStability.emitStableMessagingSemconv; import static java.util.Collections.emptyList; import static java.util.Collections.singletonList; @@ -84,7 +85,7 @@ public String getClientId(Request request) { @Nullable @Override public Long getBatchMessageCount(Request request, @Nullable Response response) { - return null; + return emitStableMessagingSemconv() ? SqsAccess.getBatchMessageCount(request) : null; } @Override diff --git a/instrumentation/aws-sdk/aws-sdk-1.11/library/src/main/java/io/opentelemetry/instrumentation/awssdk/v1_11/internal/SqsImpl.java b/instrumentation/aws-sdk/aws-sdk-1.11/library/src/main/java/io/opentelemetry/instrumentation/awssdk/v1_11/internal/SqsImpl.java index eea79d900215..5bdfe71b188e 100644 --- a/instrumentation/aws-sdk/aws-sdk-1.11/library/src/main/java/io/opentelemetry/instrumentation/awssdk/v1_11/internal/SqsImpl.java +++ b/instrumentation/aws-sdk/aws-sdk-1.11/library/src/main/java/io/opentelemetry/instrumentation/awssdk/v1_11/internal/SqsImpl.java @@ -5,6 +5,8 @@ package io.opentelemetry.instrumentation.awssdk.v1_11.internal; +import static io.opentelemetry.instrumentation.api.internal.SemconvStability.emitStableMessagingSemconv; + import com.amazonaws.AmazonWebServiceRequest; import com.amazonaws.Request; import com.amazonaws.Response; @@ -12,6 +14,7 @@ import com.amazonaws.services.sqs.model.MessageAttributeValue; import com.amazonaws.services.sqs.model.ReceiveMessageRequest; import com.amazonaws.services.sqs.model.ReceiveMessageResult; +import com.amazonaws.services.sqs.model.SendMessageBatchRequest; import com.amazonaws.services.sqs.model.SendMessageRequest; import com.amazonaws.services.sqs.model.SendMessageResult; import io.opentelemetry.context.Context; @@ -78,8 +81,9 @@ private static void afterConsumerResponse( timer.now()); } + Context processParentContext = emitStableMessagingSemconv() ? parentContext : receiveContext; addTracing( - receiveMessageResult, request, response, consumerProcessInstrumenter, receiveContext); + receiveMessageResult, request, response, consumerProcessInstrumenter, processParentContext); } @Nullable private static final Field messagesField = getMessagesField(); @@ -100,7 +104,7 @@ private static void addTracing( Request request, Response response, Instrumenter> consumerProcessInstrumenter, - @Nullable Context receiveContext) { + @Nullable Context processParentContext) { if (messagesField == null) { return; } @@ -114,7 +118,7 @@ private static void addTracing( consumerProcessInstrumenter, request, response, - receiveContext)); + processParentContext)); } catch (IllegalAccessException ignored) { // should not happen, we call setAccessible on the field } @@ -131,6 +135,14 @@ static boolean beforeMarshalling(AmazonWebServiceRequest rawRequest) { return false; } + @Nullable + static Long getBatchMessageCount(Request request) { + if (request.getOriginalRequest() instanceof SendMessageBatchRequest) { + return (long) ((SendMessageBatchRequest) request.getOriginalRequest()).getEntries().size(); + } + return null; + } + @Nullable static String getMessageAttribute(Request request, String name) { if (request.getOriginalRequest() instanceof SendMessageRequest) { diff --git a/instrumentation/aws-sdk/aws-sdk-1.11/library/src/main/java/io/opentelemetry/instrumentation/awssdk/v1_11/internal/SqsMessage.java b/instrumentation/aws-sdk/aws-sdk-1.11/library/src/main/java/io/opentelemetry/instrumentation/awssdk/v1_11/internal/SqsMessage.java index ddab50a32d1d..59760d0ff5c3 100644 --- a/instrumentation/aws-sdk/aws-sdk-1.11/library/src/main/java/io/opentelemetry/instrumentation/awssdk/v1_11/internal/SqsMessage.java +++ b/instrumentation/aws-sdk/aws-sdk-1.11/library/src/main/java/io/opentelemetry/instrumentation/awssdk/v1_11/internal/SqsMessage.java @@ -5,6 +5,7 @@ package io.opentelemetry.instrumentation.awssdk.v1_11.internal; +import io.opentelemetry.context.Context; import java.util.Map; import javax.annotation.Nullable; @@ -14,6 +15,8 @@ */ interface SqsMessage { + Context getCreationContext(); + Map getAttributes(); @Nullable diff --git a/instrumentation/aws-sdk/aws-sdk-1.11/library/src/main/java/io/opentelemetry/instrumentation/awssdk/v1_11/internal/SqsMessageImpl.java b/instrumentation/aws-sdk/aws-sdk-1.11/library/src/main/java/io/opentelemetry/instrumentation/awssdk/v1_11/internal/SqsMessageImpl.java index c6df87eb67ce..dbba9f97992c 100644 --- a/instrumentation/aws-sdk/aws-sdk-1.11/library/src/main/java/io/opentelemetry/instrumentation/awssdk/v1_11/internal/SqsMessageImpl.java +++ b/instrumentation/aws-sdk/aws-sdk-1.11/library/src/main/java/io/opentelemetry/instrumentation/awssdk/v1_11/internal/SqsMessageImpl.java @@ -7,6 +7,7 @@ import com.amazonaws.services.sqs.model.Message; import com.amazonaws.services.sqs.model.MessageAttributeValue; +import io.opentelemetry.context.Context; import java.util.ArrayList; import java.util.List; import java.util.Map; @@ -32,6 +33,11 @@ static List wrap(List messages) { return result; } + @Override + public Context getCreationContext() { + return SqsParentContext.ofSystemAttributes(message.getAttributes()); + } + @Override public Map getAttributes() { return message.getAttributes(); diff --git a/instrumentation/aws-sdk/aws-sdk-1.11/library/src/main/java/io/opentelemetry/instrumentation/awssdk/v1_11/internal/SqsParentContext.java b/instrumentation/aws-sdk/aws-sdk-1.11/library/src/main/java/io/opentelemetry/instrumentation/awssdk/v1_11/internal/SqsParentContext.java index 8f624a0cd862..8188ef0b1325 100644 --- a/instrumentation/aws-sdk/aws-sdk-1.11/library/src/main/java/io/opentelemetry/instrumentation/awssdk/v1_11/internal/SqsParentContext.java +++ b/instrumentation/aws-sdk/aws-sdk-1.11/library/src/main/java/io/opentelemetry/instrumentation/awssdk/v1_11/internal/SqsParentContext.java @@ -35,9 +35,13 @@ public String get(@Nullable Map map, String s) { static final String AWS_TRACE_SYSTEM_ATTRIBUTE = "AWSTraceHeader"; static Context ofSystemAttributes(Map systemAttributes) { + return ofSystemAttributes(Context.root(), systemAttributes); + } + + static Context ofSystemAttributes(Context parentContext, Map systemAttributes) { String traceHeader = systemAttributes.get(AWS_TRACE_SYSTEM_ATTRIBUTE); return AwsXrayPropagator.getInstance() - .extract(Context.root(), singletonMap("X-Amzn-Trace-Id", traceHeader), new MapGetter()); + .extract(parentContext, singletonMap("X-Amzn-Trace-Id", traceHeader), new MapGetter()); } private SqsParentContext() {} diff --git a/instrumentation/aws-sdk/aws-sdk-1.11/library/src/main/java/io/opentelemetry/instrumentation/awssdk/v1_11/internal/TracingIterator.java b/instrumentation/aws-sdk/aws-sdk-1.11/library/src/main/java/io/opentelemetry/instrumentation/awssdk/v1_11/internal/TracingIterator.java index 54314671e579..d120f82f523e 100644 --- a/instrumentation/aws-sdk/aws-sdk-1.11/library/src/main/java/io/opentelemetry/instrumentation/awssdk/v1_11/internal/TracingIterator.java +++ b/instrumentation/aws-sdk/aws-sdk-1.11/library/src/main/java/io/opentelemetry/instrumentation/awssdk/v1_11/internal/TracingIterator.java @@ -5,22 +5,16 @@ package io.opentelemetry.instrumentation.awssdk.v1_11.internal; -import com.amazonaws.Request; -import com.amazonaws.Response; import com.amazonaws.services.sqs.model.Message; import io.opentelemetry.context.Context; import io.opentelemetry.context.Scope; -import io.opentelemetry.instrumentation.api.instrumenter.Instrumenter; import java.util.Iterator; import javax.annotation.Nullable; class TracingIterator implements Iterator { private final Iterator delegateIterator; - private final Instrumenter> instrumenter; - private final Request request; - private final Response response; - @Nullable private final Context receiveContext; + private final TracingList tracingList; /* * Note: this may potentially create problems if this iterator is used from different threads. But @@ -30,26 +24,13 @@ class TracingIterator implements Iterator { @Nullable private Context currentContext; @Nullable private Scope currentScope; - private TracingIterator( - Iterator delegateIterator, - Instrumenter> instrumenter, - Request request, - Response response, - @Nullable Context receiveContext) { + private TracingIterator(Iterator delegateIterator, TracingList tracingList) { this.delegateIterator = delegateIterator; - this.instrumenter = instrumenter; - this.request = request; - this.response = response; - this.receiveContext = receiveContext; + this.tracingList = tracingList; } - static Iterator wrap( - Iterator delegateIterator, - Instrumenter> instrumenter, - Request request, - Response response, - @Nullable Context receiveContext) { - return new TracingIterator(delegateIterator, instrumenter, request, response, receiveContext); + static Iterator wrap(Iterator delegateIterator, TracingList tracingList) { + return new TracingIterator(delegateIterator, tracingList); } @Override @@ -70,13 +51,14 @@ public Message next() { // (https://github.com/open-telemetry/opentelemetry-java-instrumentation/issues/1947) Message next = delegateIterator.next(); if (next != null) { - Context parentContext = receiveContext; + SqsMessage sqsMessage = SqsMessageImpl.wrap(next); + Context parentContext = tracingList.getProcessParentContext(); if (parentContext == null) { - parentContext = SqsParentContext.ofSystemAttributes(next.getAttributes()); + parentContext = sqsMessage.getCreationContext(); } - currentRequest = SqsProcessRequest.create(request, SqsMessageImpl.wrap(next)); - currentContext = instrumenter.start(parentContext, currentRequest); + currentRequest = SqsProcessRequest.create(tracingList.getRequest(), sqsMessage); + currentContext = tracingList.getInstrumenter().start(parentContext, currentRequest); currentScope = currentContext.makeCurrent(); } return next; @@ -85,7 +67,9 @@ public Message next() { private void closeScopeAndEndSpan() { if (currentScope != null) { currentScope.close(); - instrumenter.end(currentContext, currentRequest, response, null); + tracingList + .getInstrumenter() + .end(currentContext, currentRequest, tracingList.getResponse(), null); currentScope = null; currentRequest = null; currentContext = null; diff --git a/instrumentation/aws-sdk/aws-sdk-1.11/library/src/main/java/io/opentelemetry/instrumentation/awssdk/v1_11/internal/TracingList.java b/instrumentation/aws-sdk/aws-sdk-1.11/library/src/main/java/io/opentelemetry/instrumentation/awssdk/v1_11/internal/TracingList.java index b441feea3c7a..777926cab47f 100644 --- a/instrumentation/aws-sdk/aws-sdk-1.11/library/src/main/java/io/opentelemetry/instrumentation/awssdk/v1_11/internal/TracingList.java +++ b/instrumentation/aws-sdk/aws-sdk-1.11/library/src/main/java/io/opentelemetry/instrumentation/awssdk/v1_11/internal/TracingList.java @@ -23,29 +23,29 @@ class TracingList extends SdkInternalList { private final transient Instrumenter> instrumenter; private final transient Request request; private final transient Response response; - @Nullable private final transient Context receiveContext; + @Nullable private final transient Context processParentContext; private boolean firstIterator = true; - private TracingList( - List list, + static SdkInternalList wrap( + List messages, Instrumenter> instrumenter, Request request, Response response, - @Nullable Context receiveContext) { - super(list); - this.instrumenter = instrumenter; - this.request = request; - this.response = response; - this.receiveContext = receiveContext; + @Nullable Context processParentContext) { + return new TracingList(messages, instrumenter, request, response, processParentContext); } - static SdkInternalList wrap( - List list, + private TracingList( + List messages, Instrumenter> instrumenter, Request request, Response response, - @Nullable Context receiveContext) { - return new TracingList(list, instrumenter, request, response, receiveContext); + @Nullable Context processParentContext) { + super(messages); + this.instrumenter = instrumenter; + this.request = request; + this.response = response; + this.processParentContext = processParentContext; } @Override @@ -55,7 +55,7 @@ public Iterator iterator() { // However, this is not thread-safe, but usually the first (hopefully only) traversal of // List is performed in the same thread that called receiveMessage() if (firstIterator && !inAwsClient()) { - it = TracingIterator.wrap(super.iterator(), instrumenter, request, response, receiveContext); + it = TracingIterator.wrap(super.iterator(), this); firstIterator = false; } else { it = super.iterator(); @@ -64,6 +64,23 @@ public Iterator iterator() { return it; } + Instrumenter> getInstrumenter() { + return instrumenter; + } + + Request getRequest() { + return request; + } + + Response getResponse() { + return response; + } + + @Nullable + Context getProcessParentContext() { + return processParentContext; + } + @Override public void forEach(Consumer action) { for (Message message : this) { diff --git a/instrumentation/aws-sdk/aws-sdk-1.11/library/src/main/java/io/opentelemetry/instrumentation/awssdk/v1_11/internal/TracingRequestHandler.java b/instrumentation/aws-sdk/aws-sdk-1.11/library/src/main/java/io/opentelemetry/instrumentation/awssdk/v1_11/internal/TracingRequestHandler.java index f36515d783ff..e9a79e8ac300 100644 --- a/instrumentation/aws-sdk/aws-sdk-1.11/library/src/main/java/io/opentelemetry/instrumentation/awssdk/v1_11/internal/TracingRequestHandler.java +++ b/instrumentation/aws-sdk/aws-sdk-1.11/library/src/main/java/io/opentelemetry/instrumentation/awssdk/v1_11/internal/TracingRequestHandler.java @@ -5,6 +5,8 @@ package io.opentelemetry.instrumentation.awssdk.v1_11.internal; +import static io.opentelemetry.instrumentation.api.internal.SemconvStability.emitStableMessagingSemconv; + import com.amazonaws.AmazonWebServiceRequest; import com.amazonaws.Request; import com.amazonaws.Response; @@ -34,6 +36,8 @@ public final class TracingRequestHandler extends RequestHandler2 { ContextKey.named(TracingRequestHandler.class.getName() + ".Timer"); private static final ContextKey REQUEST_SPAN_SUPPRESSED_KEY = ContextKey.named(TracingRequestHandler.class.getName() + ".RequestSpanSuppressed"); + private static final String SEND_MESSAGE_BATCH_REQUEST_CLASS = + "com.amazonaws.services.sqs.model.SendMessageBatchRequest"; private static final String SEND_MESSAGE_REQUEST_CLASS = "com.amazonaws.services.sqs.model.SendMessageRequest"; private static final String DYNAMODBV2_CLASS_PREFIX = "com.amazonaws.services.dynamodbv2.model."; @@ -168,7 +172,8 @@ private Instrumenter, Response> getInstrumenter(Request request if (className.startsWith(DYNAMODBV2_CLASS_PREFIX)) { return dynamoDbInstrumenter; } - if (className.equals(SEND_MESSAGE_REQUEST_CLASS)) { + if (className.equals(SEND_MESSAGE_REQUEST_CLASS) + || (emitStableMessagingSemconv() && className.equals(SEND_MESSAGE_BATCH_REQUEST_CLASS))) { return producerInstrumenter; } return requestInstrumenter; diff --git a/instrumentation/aws-sdk/aws-sdk-1.11/library/src/test/java/io/opentelemetry/instrumentation/awssdk/v1_11/internal/SqsParentContextTest.java b/instrumentation/aws-sdk/aws-sdk-1.11/library/src/test/java/io/opentelemetry/instrumentation/awssdk/v1_11/internal/SqsParentContextTest.java new file mode 100644 index 000000000000..6e40ad1187f1 --- /dev/null +++ b/instrumentation/aws-sdk/aws-sdk-1.11/library/src/test/java/io/opentelemetry/instrumentation/awssdk/v1_11/internal/SqsParentContextTest.java @@ -0,0 +1,33 @@ +/* + * Copyright The OpenTelemetry Authors + * SPDX-License-Identifier: Apache-2.0 + */ + +package io.opentelemetry.instrumentation.awssdk.v1_11.internal; + +import static java.util.Collections.singletonMap; +import static org.assertj.core.api.Assertions.assertThat; + +import io.opentelemetry.api.trace.Span; +import io.opentelemetry.context.Context; +import io.opentelemetry.context.ContextKey; +import org.junit.jupiter.api.Test; + +class SqsParentContextTest { + + private static final ContextKey TEST_CONTEXT_KEY = ContextKey.named("test-context-key"); + private static final String TRACE_HEADER = + "Root=1-5759e988-bd862e3fe1be46a994272793;Parent=53995c3f42cd8ad8;Sampled=1"; + + @Test + void preservesParentContextValues() { + Context parentContext = Context.root().with(TEST_CONTEXT_KEY, "test-value"); + + Context extractedContext = + SqsParentContext.ofSystemAttributes( + parentContext, singletonMap(SqsParentContext.AWS_TRACE_SYSTEM_ATTRIBUTE, TRACE_HEADER)); + + assertThat(extractedContext.get(TEST_CONTEXT_KEY)).isEqualTo("test-value"); + assertThat(Span.fromContext(extractedContext).getSpanContext().isValid()).isTrue(); + } +} diff --git a/instrumentation/aws-sdk/aws-sdk-1.11/testing/src/main/java/io/opentelemetry/instrumentation/awssdk/v1_11/AbstractSqsSuppressReceiveSpansTest.java b/instrumentation/aws-sdk/aws-sdk-1.11/testing/src/main/java/io/opentelemetry/instrumentation/awssdk/v1_11/AbstractSqsSuppressReceiveSpansTest.java index 8b072338acc7..c88ac77c95f9 100644 --- a/instrumentation/aws-sdk/aws-sdk-1.11/testing/src/main/java/io/opentelemetry/instrumentation/awssdk/v1_11/AbstractSqsSuppressReceiveSpansTest.java +++ b/instrumentation/aws-sdk/aws-sdk-1.11/testing/src/main/java/io/opentelemetry/instrumentation/awssdk/v1_11/AbstractSqsSuppressReceiveSpansTest.java @@ -6,6 +6,7 @@ package io.opentelemetry.instrumentation.awssdk.v1_11; import static io.opentelemetry.api.common.AttributeKey.stringKey; +import static io.opentelemetry.instrumentation.api.internal.SemconvStability.emitStableMessagingSemconv; import static io.opentelemetry.sdk.testing.assertj.OpenTelemetryAssertions.equalTo; import static io.opentelemetry.sdk.testing.assertj.OpenTelemetryAssertions.satisfies; import static io.opentelemetry.semconv.HttpAttributes.HTTP_REQUEST_METHOD; @@ -25,6 +26,7 @@ import static io.opentelemetry.semconv.incubating.RpcIncubatingAttributes.RPC_SERVICE; import static io.opentelemetry.semconv.incubating.RpcIncubatingAttributes.RPC_SYSTEM; import static org.assertj.core.api.Assertions.assertThat; +import static org.junit.jupiter.api.Assumptions.assumeTrue; import com.amazonaws.auth.AWSStaticCredentialsProvider; import com.amazonaws.auth.BasicAWSCredentials; @@ -32,12 +34,14 @@ import com.amazonaws.services.sqs.AmazonSQSAsync; import com.amazonaws.services.sqs.AmazonSQSAsyncClient; import com.amazonaws.services.sqs.AmazonSQSAsyncClientBuilder; +import com.amazonaws.services.sqs.model.Message; import com.amazonaws.services.sqs.model.ReceiveMessageRequest; import com.amazonaws.services.sqs.model.ReceiveMessageResult; import com.amazonaws.services.sqs.model.SendMessageRequest; import io.opentelemetry.api.trace.SpanKind; import io.opentelemetry.instrumentation.test.utils.PortUtils; import io.opentelemetry.instrumentation.testing.junit.InstrumentationExtension; +import java.util.Iterator; import org.elasticmq.rest.sqs.SQSRestServer; import org.elasticmq.rest.sqs.SQSRestServerBuilder; import org.junit.jupiter.api.AfterEach; @@ -174,6 +178,41 @@ void testSimpleSqsProducerConsumerServices() { .hasTotalAttributeCount(0))); } + @Test + void testAbandonedIteratorDoesNotParentNextProcessSpan() { + assumeTrue(emitStableMessagingSemconv()); + String queueUrl = "http://localhost:" + sqsPort + "/000000000000/testSdkSqs"; + sqsClient.createQueue("testSdkSqs"); + + sqsClient.sendMessage(new SendMessageRequest(queueUrl, "first")); + ReceiveMessageResult firstResponse = sqsClient.receiveMessage(queueUrl); + sqsClient.sendMessage(new SendMessageRequest(queueUrl, "second")); + ReceiveMessageResult secondResponse = sqsClient.receiveMessage(queueUrl); + + Iterator firstIterator = firstResponse.getMessages().iterator(); + Iterator secondIterator = secondResponse.getMessages().iterator(); + assertThat(firstIterator.hasNext()).isTrue(); + firstIterator.next(); + assertThat(secondIterator.hasNext()).isTrue(); + secondIterator.next(); + assertThat(secondIterator.hasNext()).isFalse(); + assertThat(firstIterator.hasNext()).isFalse(); + + testing() + .waitAndAssertTraces( + trace -> + trace.hasSpansSatisfyingExactly( + span -> span.hasName("SQS.CreateQueue").hasNoParent()), + trace -> + trace.hasSpansSatisfyingExactly( + span -> span.hasName("publish testSdkSqs").hasNoParent(), + span -> span.hasName("process testSdkSqs").hasParent(trace.getSpan(0))), + trace -> + trace.hasSpansSatisfyingExactly( + span -> span.hasName("publish testSdkSqs").hasNoParent(), + span -> span.hasName("process testSdkSqs").hasParent(trace.getSpan(0)))); + } + @Test void testSimpleSqsProducerConsumerServicesWithParentSpan() { sqsClient.createQueue("testSdkSqs"); diff --git a/instrumentation/aws-sdk/aws-sdk-1.11/testing/src/main/java/io/opentelemetry/instrumentation/awssdk/v1_11/AbstractSqsTracingTest.java b/instrumentation/aws-sdk/aws-sdk-1.11/testing/src/main/java/io/opentelemetry/instrumentation/awssdk/v1_11/AbstractSqsTracingTest.java index 0f69fde6024c..7ccdb6393949 100644 --- a/instrumentation/aws-sdk/aws-sdk-1.11/testing/src/main/java/io/opentelemetry/instrumentation/awssdk/v1_11/AbstractSqsTracingTest.java +++ b/instrumentation/aws-sdk/aws-sdk-1.11/testing/src/main/java/io/opentelemetry/instrumentation/awssdk/v1_11/AbstractSqsTracingTest.java @@ -6,6 +6,7 @@ package io.opentelemetry.instrumentation.awssdk.v1_11; import static io.opentelemetry.api.common.AttributeKey.stringKey; +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.TestLatestDeps.testLatestDeps; import static io.opentelemetry.sdk.testing.assertj.OpenTelemetryAssertions.equalTo; @@ -22,6 +23,8 @@ import static io.opentelemetry.semconv.incubating.MessagingIncubatingAttributes.MESSAGING_DESTINATION_NAME; 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 io.opentelemetry.semconv.incubating.MessagingIncubatingAttributes.MessagingSystemIncubatingValues.AWS_SQS; import static io.opentelemetry.semconv.incubating.RpcIncubatingAttributes.RPC_METHOD; @@ -29,6 +32,7 @@ import static io.opentelemetry.semconv.incubating.RpcIncubatingAttributes.RPC_SYSTEM; import static java.util.Arrays.asList; import static org.assertj.core.api.Assertions.assertThat; +import static org.junit.jupiter.api.Assumptions.assumeTrue; import com.amazonaws.auth.AWSStaticCredentialsProvider; import com.amazonaws.auth.BasicAWSCredentials; @@ -40,6 +44,8 @@ import com.amazonaws.services.sqs.model.MessageAttributeValue; import com.amazonaws.services.sqs.model.ReceiveMessageRequest; import com.amazonaws.services.sqs.model.ReceiveMessageResult; +import com.amazonaws.services.sqs.model.SendMessageBatchRequest; +import com.amazonaws.services.sqs.model.SendMessageBatchRequestEntry; import com.amazonaws.services.sqs.model.SendMessageRequest; import io.opentelemetry.api.trace.SpanKind; import io.opentelemetry.instrumentation.test.utils.PortUtils; @@ -274,6 +280,87 @@ void testSimpleSqsProducerConsumerServicesCaptureHeaders(boolean testCaptureHead .hasTotalAttributeCount(0))); } + @Test + void testReceiveSpanLinksToProducer() { + assumeTrue(emitStableMessagingSemconv()); + String queueUrl = "http://localhost:" + sqsPort + "/000000000000/testSdkSqs"; + sqsClient.createQueue("testSdkSqs"); + sqsClient.sendMessage(new SendMessageRequest(queueUrl, "hello")); + sqsClient.receiveMessage(queueUrl); + + AtomicReference publishSpan = new AtomicReference<>(); + testing() + .waitAndAssertTraces( + trace -> + trace.hasSpansSatisfyingExactly( + span -> span.hasName("SQS.CreateQueue").hasKind(SpanKind.CLIENT)), + trace -> + trace.hasSpansSatisfyingExactly( + span -> { + publishSpan.set(trace.getSpan(0)); + span.hasName("publish testSdkSqs").hasKind(SpanKind.PRODUCER); + }), + trace -> + trace.hasSpansSatisfyingExactly( + span -> + span.hasName("receive testSdkSqs") + .hasKind(SpanKind.CLIENT) + .hasNoParent() + .hasLinksSatisfying( + links -> + assertThat(links) + .singleElement() + .satisfies( + link -> + assertThat(link.getSpanContext().getSpanId()) + .isEqualTo(publishSpan.get().getSpanId()))))); + } + + @Test + void testBatchSendMessageCount() { + assumeTrue(emitStableMessagingSemconv()); + String queueUrl = "http://localhost:" + sqsPort + "/000000000000/testSdkSqs"; + sqsClient.createQueue("testSdkSqs"); + sqsClient.sendMessageBatch( + new SendMessageBatchRequest() + .withQueueUrl(queueUrl) + .withEntries( + new SendMessageBatchRequestEntry("i1", "e1"), + new SendMessageBatchRequestEntry("i2", "e2"), + new SendMessageBatchRequestEntry("i3", "e3"))); + + testing() + .waitAndAssertTraces( + trace -> + trace.hasSpansSatisfyingExactly( + span -> span.hasName("SQS.CreateQueue").hasKind(SpanKind.CLIENT)), + trace -> + trace.hasSpansSatisfyingExactly( + span -> + span.hasName("publish testSdkSqs") + .hasKind(SpanKind.PRODUCER) + .hasNoParent() + .hasAttributesSatisfyingExactly( + equalTo(stringKey("aws.agent"), "java-aws-sdk"), + equalTo(AWS_SQS_QUEUE_URL, queueUrl), + satisfies( + AWS_REQUEST_ID, AbstractSqsTracingTest::assertAwsRequestId), + equalTo(RPC_SYSTEM, "aws-api"), + equalTo(RPC_SERVICE, "AmazonSQS"), + equalTo(RPC_METHOD, "SendMessageBatch"), + equalTo(HTTP_REQUEST_METHOD, "POST"), + equalTo(HTTP_RESPONSE_STATUS_CODE, 200), + equalTo(URL_FULL, "http://localhost:" + sqsPort), + equalTo(SERVER_ADDRESS, "localhost"), + equalTo(SERVER_PORT, sqsPort), + equalTo(MESSAGING_SYSTEM, AWS_SQS), + equalTo(MESSAGING_DESTINATION_NAME, "testSdkSqs"), + equalTo(MESSAGING_OPERATION_NAME, "publish"), + equalTo(MESSAGING_OPERATION_TYPE, "send"), + equalTo(MESSAGING_BATCH_MESSAGE_COUNT, 3), + equalTo(NETWORK_PROTOCOL_VERSION, "1.1")))); + } + @Test void testSimpleSqsProducerConsumerServicesWithParentSpan() { sqsClient.createQueue("testSdkSqs"); @@ -294,6 +381,69 @@ void testSimpleSqsProducerConsumerServicesWithParentSpan() { .forEach(message -> testing().runWithSpan("process child", () -> {})); }); + if (emitStableMessagingSemconv()) { + AtomicReference producerSpan = new AtomicReference<>(); + testing() + .waitAndAssertTraces( + trace -> + trace.hasSpansSatisfyingExactly( + span -> span.hasName("SQS.CreateQueue").hasKind(SpanKind.CLIENT)), + trace -> + trace.hasSpansSatisfyingExactly( + span -> { + producerSpan.set(trace.getSpan(0)); + span.hasName("publish testSdkSqs").hasKind(SpanKind.PRODUCER); + }), + trace -> { + Consumer receiveSpanAssertion = + span -> + span.hasName("receive testSdkSqs") + .hasKind(SpanKind.CLIENT) + .hasParent(trace.getSpan(0)) + .hasLinksSatisfying( + links -> + assertThat(links) + .singleElement() + .satisfies( + link -> + assertThat(link.getSpanContext().getSpanId()) + .isEqualTo(producerSpan.get().getSpanId()))); + Consumer sdkSpanAssertion = + span -> + span.hasName("SQS.ReceiveMessage") + .hasKind(SpanKind.CLIENT) + .hasParent(trace.getSpan(0)); + Consumer processSpanAssertion = + span -> + span.hasName("process testSdkSqs") + .hasKind(SpanKind.CONSUMER) + .hasParent(trace.getSpan(0)) + .hasLinksSatisfying( + links -> + assertThat(links) + .singleElement() + .satisfies( + link -> + assertThat(link.getSpanContext().getSpanId()) + .isEqualTo(producerSpan.get().getSpanId()))); + + List> assertions = + new ArrayList<>( + asList( + span -> span.hasName("parent").hasNoParent(), + receiveSpanAssertion, + sdkSpanAssertion, + processSpanAssertion, + span -> span.hasName("process child"))); + if ("SQS.ReceiveMessage".equals(trace.getSpan(1).getName())) { + assertions.set(1, sdkSpanAssertion); + assertions.set(2, receiveSpanAssertion); + } + trace.hasSpansSatisfyingExactly(assertions); + }); + return; + } + testing() .waitAndAssertTraces( trace -> diff --git a/instrumentation/aws-sdk/aws-sdk-2.2/library/build.gradle.kts b/instrumentation/aws-sdk/aws-sdk-2.2/library/build.gradle.kts index 032e0946228b..1a14ef94fa7e 100644 --- a/instrumentation/aws-sdk/aws-sdk-2.2/library/build.gradle.kts +++ b/instrumentation/aws-sdk/aws-sdk-2.2/library/build.gradle.kts @@ -82,6 +82,18 @@ tasks { jvmArgs("-Dotel.semconv-stability.opt-in=database") } + val testMessagingPreview = register("testMessagingPreview") { + testClassesDirs = sourceSets.test.get().output.classesDirs + classpath = sourceSets.test.get().runtimeClasspath + filter { + includeTestsMatching("Aws2SqsSuppressReceiveSpansW3cPropagatorTest.testAbandonedIteratorDoesNotParentNextProcessSpan") + includeTestsMatching("Aws2SqsDefaultPropagatorTest.testReceiveSpanLinksToProducer") + includeTestsMatching("Aws2SqsDefaultPropagatorTest.testBatchSendMessageCount") + includeTestsMatching("Aws2SqsDefaultPropagatorTest.testSimpleSqsProducerConsumerServicesWithParentSync") + } + jvmArgs("-Dotel.semconv-stability.preview=messaging") + } + val testCoreOnlyStableSemconv = register("testCoreOnlyStableSemconv") { val testCoreOnlySourceSet = sourceSets["testCoreOnly"] testClassesDirs = testCoreOnlySourceSet.output.classesDirs @@ -98,6 +110,12 @@ tasks { } check { - dependsOn(testing.suites, testStableSemconv, testCoreOnlyStableSemconv, testExceptionSignalLogs) + dependsOn( + testing.suites, + testStableSemconv, + testMessagingPreview, + testCoreOnlyStableSemconv, + testExceptionSignalLogs, + ) } } diff --git a/instrumentation/aws-sdk/aws-sdk-2.2/library/src/main/java/io/opentelemetry/instrumentation/awssdk/v2_2/internal/AwsSdkInstrumenterFactory.java b/instrumentation/aws-sdk/aws-sdk-2.2/library/src/main/java/io/opentelemetry/instrumentation/awssdk/v2_2/internal/AwsSdkInstrumenterFactory.java index c3b154e26a4f..aa7a67bd4b03 100644 --- a/instrumentation/aws-sdk/aws-sdk-2.2/library/src/main/java/io/opentelemetry/instrumentation/awssdk/v2_2/internal/AwsSdkInstrumenterFactory.java +++ b/instrumentation/aws-sdk/aws-sdk-2.2/library/src/main/java/io/opentelemetry/instrumentation/awssdk/v2_2/internal/AwsSdkInstrumenterFactory.java @@ -11,6 +11,7 @@ import static io.opentelemetry.instrumentation.api.incubator.semconv.messaging.internal.MessagingExceptionEventExtractors.setMessagingReceiveExceptionEventExtractor; import static io.opentelemetry.instrumentation.api.incubator.semconv.messaging.internal.MessagingExceptionEventExtractors.setMessagingSendExceptionEventExtractor; import static io.opentelemetry.instrumentation.api.incubator.semconv.rpc.internal.RpcExceptionEventExtractors.setRpcClientExceptionEventExtractor; +import static io.opentelemetry.instrumentation.api.internal.SemconvStability.emitStableMessagingSemconv; import static java.util.Arrays.asList; import static java.util.Collections.singletonList; @@ -18,16 +19,19 @@ import io.opentelemetry.api.common.AttributesBuilder; import io.opentelemetry.api.logs.Logger; import io.opentelemetry.api.trace.Span; +import io.opentelemetry.api.trace.SpanContext; import io.opentelemetry.context.Context; import io.opentelemetry.context.propagation.TextMapPropagator; import io.opentelemetry.instrumentation.api.incubator.semconv.db.DbClientMetrics; import io.opentelemetry.instrumentation.api.incubator.semconv.genai.GenAiAttributesExtractor; import io.opentelemetry.instrumentation.api.incubator.semconv.genai.GenAiClientMetrics; import io.opentelemetry.instrumentation.api.incubator.semconv.genai.GenAiSpanNameExtractor; -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.MessagingProcessContextCustomizer; import io.opentelemetry.instrumentation.api.incubator.semconv.rpc.RpcClientAttributesExtractor; import io.opentelemetry.instrumentation.api.instrumenter.AttributesExtractor; import io.opentelemetry.instrumentation.api.instrumenter.Instrumenter; @@ -125,50 +129,82 @@ private List> consumerAttribu } private AttributesExtractor messagingAttributesExtractor( - MessagingAttributesGetter getter, MessageOperation operation) { - return MessagingAttributesExtractor.builder(getter, operation) + MessagingAttributesGetter getter, MessagingOperationType operationType) { + return MessagingAttributesExtractor.builderForOperationType(getter, operationType) .setCapturedHeaders(capturedHeaders) .build(); } public Instrumenter consumerReceiveInstrumenter() { - MessageOperation operation = MessageOperation.RECEIVE; + MessagingOperationType operationType = MessagingOperationType.RECEIVE; SqsReceiveRequestAttributesGetter getter = new SqsReceiveRequestAttributesGetter(); AttributesExtractor messagingAttributeExtractor = - messagingAttributesExtractor(getter, operation); + messagingAttributesExtractor(getter, operationType); return createInstrumenter( openTelemetry, - MessagingSpanNameExtractor.create(getter, operation), - SpanKindExtractor.alwaysConsumer(), + MessagingSpanNameExtractor.create(getter, operationType), + MessagingSpanKindExtractor.create(operationType), toSqsRequestExtractors(consumerAttributesExtractors()), singletonList(messagingAttributeExtractor), - builder -> setMessagingReceiveExceptionEventExtractor(builder), + builder -> { + setMessagingReceiveExceptionEventExtractor(builder); + if (emitStableMessagingSemconv()) { + builder.addSpanLinksExtractor( + (spanLinks, parentContext, request) -> { + for (SqsMessage message : request.getMessages()) { + SpanContext spanContext = + Span.fromContext(message.getCreationContext()).getSpanContext(); + if (spanContext.isValid()) { + spanLinks.addLink(spanContext); + } + } + }); + } + }, messagingReceiveInstrumentationEnabled); } public Instrumenter consumerProcessInstrumenter() { - MessageOperation operation = MessageOperation.PROCESS; + MessagingOperationType operationType = MessagingOperationType.PROCESS; SqsProcessRequestAttributesGetter getter = new SqsProcessRequestAttributesGetter(); InstrumenterBuilder builder = Instrumenter.builder( openTelemetry, INSTRUMENTATION_NAME, - MessagingSpanNameExtractor.create(getter, operation)) + MessagingSpanNameExtractor.create(getter, operationType)) .addAttributesExtractors(toSqsRequestExtractors(consumerAttributesExtractors())) - .addAttributesExtractor(messagingAttributesExtractor(getter, operation)); + .addAttributesExtractor(messagingAttributesExtractor(getter, operationType)); setMessagingProcessExceptionEventExtractor(builder); - if (messagingReceiveInstrumentationEnabled) { + if (emitStableMessagingSemconv() || messagingReceiveInstrumentationEnabled) { builder.addSpanLinksExtractor( (spanLinks, parentContext, request) -> { - Context extracted = - SqsParentContext.ofMessage( - request.getMessage(), messagingPropagator, useXrayPropagator); - spanLinks.addLink(Span.fromContext(extracted).getSpanContext()); + SpanContext parentSpanContext = Span.fromContext(parentContext).getSpanContext(); + SpanContext creationSpanContext = + Span.fromContext(request.getMessage().getCreationContext()).getSpanContext(); + if (creationSpanContext.isValid() + && (!emitStableMessagingSemconv() + || (parentSpanContext.isValid() + && (!creationSpanContext.getTraceId().equals(parentSpanContext.getTraceId()) + || !creationSpanContext + .getSpanId() + .equals(parentSpanContext.getSpanId()))))) { + spanLinks.addLink(creationSpanContext); + } }); } + if (emitStableMessagingSemconv()) { + builder.addContextCustomizer( + MessagingProcessContextCustomizer.create( + (parentContext, request) -> + SqsParentContext.ofMessage( + parentContext, + request.getMessage(), + messagingPropagator, + useXrayPropagator))); + } return builder.buildInstrumenter(SpanKindExtractor.alwaysConsumer()); } @@ -201,14 +237,14 @@ public void onEnd( } public Instrumenter producerInstrumenter() { - MessageOperation operation = MessageOperation.PUBLISH; + MessagingOperationType operationType = MessagingOperationType.SEND; SqsAttributesGetter getter = new SqsAttributesGetter(); AttributesExtractor messagingAttributeExtractor = - messagingAttributesExtractor(getter, operation); + messagingAttributesExtractor(getter, operationType); return createInstrumenter( openTelemetry, - MessagingSpanNameExtractor.create(getter, operation), + MessagingSpanNameExtractor.create(getter, operationType), SpanKindExtractor.alwaysProducer(), attributesExtractors(), singletonList(messagingAttributeExtractor), diff --git a/instrumentation/aws-sdk/aws-sdk-2.2/library/src/main/java/io/opentelemetry/instrumentation/awssdk/v2_2/internal/SqsAccess.java b/instrumentation/aws-sdk/aws-sdk-2.2/library/src/main/java/io/opentelemetry/instrumentation/awssdk/v2_2/internal/SqsAccess.java index 5b1e32836d64..96d0ef0c85ba 100644 --- a/instrumentation/aws-sdk/aws-sdk-2.2/library/src/main/java/io/opentelemetry/instrumentation/awssdk/v2_2/internal/SqsAccess.java +++ b/instrumentation/aws-sdk/aws-sdk-2.2/library/src/main/java/io/opentelemetry/instrumentation/awssdk/v2_2/internal/SqsAccess.java @@ -57,6 +57,11 @@ static String getQueueUrl(SdkRequest request) { return enabled ? SqsImpl.getQueueUrl(request) : null; } + @NoMuzzle + static Long getBatchMessageCount(SdkRequest request) { + return enabled ? SqsImpl.getBatchMessageCount(request) : null; + } + @NoMuzzle static String getMessageAttribute(SdkRequest request, String name) { return enabled ? SqsImpl.getMessageAttribute(request, name) : null; diff --git a/instrumentation/aws-sdk/aws-sdk-2.2/library/src/main/java/io/opentelemetry/instrumentation/awssdk/v2_2/internal/SqsAttributesGetter.java b/instrumentation/aws-sdk/aws-sdk-2.2/library/src/main/java/io/opentelemetry/instrumentation/awssdk/v2_2/internal/SqsAttributesGetter.java index dbe19217c897..cb5f0c22aa31 100644 --- a/instrumentation/aws-sdk/aws-sdk-2.2/library/src/main/java/io/opentelemetry/instrumentation/awssdk/v2_2/internal/SqsAttributesGetter.java +++ b/instrumentation/aws-sdk/aws-sdk-2.2/library/src/main/java/io/opentelemetry/instrumentation/awssdk/v2_2/internal/SqsAttributesGetter.java @@ -5,6 +5,7 @@ package io.opentelemetry.instrumentation.awssdk.v2_2.internal; +import static io.opentelemetry.instrumentation.api.internal.SemconvStability.emitStableMessagingSemconv; import static java.util.Collections.emptyList; import static java.util.Collections.singletonList; @@ -91,7 +92,8 @@ public String getClientId(ExecutionAttributes request) { @Nullable @Override public Long getBatchMessageCount(ExecutionAttributes request, @Nullable Response response) { - return null; + SdkRequest sdkRequest = request.getAttribute(TracingExecutionInterceptor.SDK_REQUEST_ATTRIBUTE); + return emitStableMessagingSemconv() ? SqsAccess.getBatchMessageCount(sdkRequest) : null; } @Override diff --git a/instrumentation/aws-sdk/aws-sdk-2.2/library/src/main/java/io/opentelemetry/instrumentation/awssdk/v2_2/internal/SqsImpl.java b/instrumentation/aws-sdk/aws-sdk-2.2/library/src/main/java/io/opentelemetry/instrumentation/awssdk/v2_2/internal/SqsImpl.java index 8dc003fc5ade..6ab08a9248d1 100644 --- a/instrumentation/aws-sdk/aws-sdk-2.2/library/src/main/java/io/opentelemetry/instrumentation/awssdk/v2_2/internal/SqsImpl.java +++ b/instrumentation/aws-sdk/aws-sdk-2.2/library/src/main/java/io/opentelemetry/instrumentation/awssdk/v2_2/internal/SqsImpl.java @@ -5,6 +5,7 @@ package io.opentelemetry.instrumentation.awssdk.v2_2.internal; +import static io.opentelemetry.instrumentation.api.internal.SemconvStability.emitStableMessagingSemconv; import static io.opentelemetry.instrumentation.awssdk.v2_2.internal.TracingExecutionInterceptor.SDK_HTTP_REQUEST_ATTRIBUTE; import static io.opentelemetry.instrumentation.awssdk.v2_2.internal.TracingExecutionInterceptor.SDK_REQUEST_ATTRIBUTE; @@ -76,7 +77,8 @@ static boolean afterReceiveMessageExecution( config.getConsumerReceiveInstrumenter(); io.opentelemetry.context.Context receiveContext = null; SqsReceiveRequest receiveRequest = - SqsReceiveRequest.create(executionAttributes, SqsMessageImpl.wrap(response.messages())); + SqsReceiveRequest.create( + executionAttributes, SqsMessageImpl.wrap(response.messages(), config)); if (timer != null && consumerReceiveInstrumenter.shouldStart(parentContext, receiveRequest)) { receiveContext = InstrumenterUtil.startAndEnd( @@ -88,6 +90,8 @@ static boolean afterReceiveMessageExecution( timer.startTime(), timer.now()); } + io.opentelemetry.context.Context processParentContext = + emitStableMessagingSemconv() ? parentContext : receiveContext; // copy ExecutionAttributes as these will get cleared before the process spans are created ExecutionAttributes copy = new ExecutionAttributes(); copy.putAttribute( @@ -108,7 +112,7 @@ static boolean afterReceiveMessageExecution( copy, new Response(context.httpResponse(), response), config, - receiveContext); + processParentContext); // store tracing list in context so that our proxied SqsClient/SqsAsyncClient could pick it up SqsTracingContext.set(parentContext, tracingList); @@ -264,6 +268,13 @@ static String getQueueUrl(SdkRequest request) { return null; } + static Long getBatchMessageCount(SdkRequest request) { + if (request instanceof SendMessageBatchRequest) { + return (long) ((SendMessageBatchRequest) request).entries().size(); + } + return null; + } + static String getMessageAttribute(SdkRequest request, String name) { if (request instanceof SendMessageRequest) { MessageAttributeValue value = ((SendMessageRequest) request).messageAttributes().get(name); diff --git a/instrumentation/aws-sdk/aws-sdk-2.2/library/src/main/java/io/opentelemetry/instrumentation/awssdk/v2_2/internal/SqsMessage.java b/instrumentation/aws-sdk/aws-sdk-2.2/library/src/main/java/io/opentelemetry/instrumentation/awssdk/v2_2/internal/SqsMessage.java index 9e4b71a770e7..1d2db90b6433 100644 --- a/instrumentation/aws-sdk/aws-sdk-2.2/library/src/main/java/io/opentelemetry/instrumentation/awssdk/v2_2/internal/SqsMessage.java +++ b/instrumentation/aws-sdk/aws-sdk-2.2/library/src/main/java/io/opentelemetry/instrumentation/awssdk/v2_2/internal/SqsMessage.java @@ -5,6 +5,7 @@ package io.opentelemetry.instrumentation.awssdk.v2_2.internal; +import io.opentelemetry.context.Context; import java.util.Map; import software.amazon.awssdk.services.sqs.model.MessageAttributeValue; @@ -17,6 +18,8 @@ */ public interface SqsMessage { + Context getCreationContext(); + Map messageAttributes(); Map attributesAsStrings(); diff --git a/instrumentation/aws-sdk/aws-sdk-2.2/library/src/main/java/io/opentelemetry/instrumentation/awssdk/v2_2/internal/SqsMessageImpl.java b/instrumentation/aws-sdk/aws-sdk-2.2/library/src/main/java/io/opentelemetry/instrumentation/awssdk/v2_2/internal/SqsMessageImpl.java index 95bf7c388c6e..0b12bf4d5e60 100644 --- a/instrumentation/aws-sdk/aws-sdk-2.2/library/src/main/java/io/opentelemetry/instrumentation/awssdk/v2_2/internal/SqsMessageImpl.java +++ b/instrumentation/aws-sdk/aws-sdk-2.2/library/src/main/java/io/opentelemetry/instrumentation/awssdk/v2_2/internal/SqsMessageImpl.java @@ -5,9 +5,11 @@ package io.opentelemetry.instrumentation.awssdk.v2_2.internal; +import io.opentelemetry.context.Context; import java.util.ArrayList; import java.util.List; import java.util.Map; +import javax.annotation.Nullable; import software.amazon.awssdk.services.sqs.model.Message; import software.amazon.awssdk.services.sqs.model.MessageAttributeValue; @@ -18,23 +20,39 @@ public final class SqsMessageImpl implements SqsMessage { private final Message message; + @Nullable private final TracingExecutionInterceptor config; private SqsMessageImpl(Message message) { this.message = message; + this.config = null; + } + + private SqsMessageImpl(Message message, TracingExecutionInterceptor config) { + this.message = message; + this.config = config; } public static SqsMessage wrap(Message message) { return new SqsMessageImpl(message); } - static List wrap(List messages) { + public static SqsMessage wrap(Message message, TracingExecutionInterceptor config) { + return new SqsMessageImpl(message, config); + } + + static List wrap(List messages, TracingExecutionInterceptor config) { List result = new ArrayList<>(); for (Message message : messages) { - result.add(wrap(message)); + result.add(wrap(message, config)); } return result; } + @Override + public Context getCreationContext() { + return config != null ? SqsParentContext.ofMessage(this, config) : Context.root(); + } + @Override public Map messageAttributes() { return message.messageAttributes(); diff --git a/instrumentation/aws-sdk/aws-sdk-2.2/library/src/main/java/io/opentelemetry/instrumentation/awssdk/v2_2/internal/SqsParentContext.java b/instrumentation/aws-sdk/aws-sdk-2.2/library/src/main/java/io/opentelemetry/instrumentation/awssdk/v2_2/internal/SqsParentContext.java index b9d5037a755d..3afa7dc51d63 100644 --- a/instrumentation/aws-sdk/aws-sdk-2.2/library/src/main/java/io/opentelemetry/instrumentation/awssdk/v2_2/internal/SqsParentContext.java +++ b/instrumentation/aws-sdk/aws-sdk-2.2/library/src/main/java/io/opentelemetry/instrumentation/awssdk/v2_2/internal/SqsParentContext.java @@ -7,6 +7,7 @@ import static java.util.Collections.singletonMap; +import io.opentelemetry.api.trace.Span; import io.opentelemetry.context.Context; import io.opentelemetry.context.propagation.TextMapGetter; import io.opentelemetry.context.propagation.TextMapPropagator; @@ -65,34 +66,60 @@ public String get(@Nullable Map map, String s) { static Context ofMessageAttributes( Map messageAttributes, TextMapPropagator propagator) { + return ofMessageAttributes(Context.root(), messageAttributes, propagator); + } + + static Context ofMessageAttributes( + Context parentContext, + Map messageAttributes, + TextMapPropagator propagator) { return propagator.extract( - Context.root(), messageAttributes, MessageAttributeValueMapGetter.INSTANCE); + parentContext, messageAttributes, MessageAttributeValueMapGetter.INSTANCE); } static Context ofSystemAttributes(Map systemAttributes) { + return ofSystemAttributes(Context.root(), systemAttributes); + } + + static Context ofSystemAttributes(Context parentContext, Map systemAttributes) { String traceHeader = systemAttributes.get(AWS_TRACE_SYSTEM_ATTRIBUTE); return AwsXrayPropagator.getInstance() .extract( - Context.root(), singletonMap("X-Amzn-Trace-Id", traceHeader), StringMapGetter.INSTANCE); + parentContext, singletonMap("X-Amzn-Trace-Id", traceHeader), StringMapGetter.INSTANCE); } public static Context ofMessage(SqsMessage message, TracingExecutionInterceptor config) { - return ofMessage(message, config.getMessagingPropagator(), config.shouldUseXrayPropagator()); + return ofMessage(Context.root(), message, config); + } + + public static Context ofMessage( + Context parentContext, SqsMessage message, TracingExecutionInterceptor config) { + return ofMessage( + parentContext, message, config.getMessagingPropagator(), config.shouldUseXrayPropagator()); } static Context ofMessage( SqsMessage message, TextMapPropagator messagingPropagator, boolean shouldUseXrayPropagator) { - Context parentContext = Context.root(); + return ofMessage(Context.root(), message, messagingPropagator, shouldUseXrayPropagator); + } + + static Context ofMessage( + Context parentContext, + SqsMessage message, + TextMapPropagator messagingPropagator, + boolean shouldUseXrayPropagator) { + Context extractedContext = parentContext; if (messagingPropagator != null) { - parentContext = ofMessageAttributes(message.messageAttributes(), messagingPropagator); + extractedContext = + ofMessageAttributes(parentContext, message.messageAttributes(), messagingPropagator); } - if (shouldUseXrayPropagator && parentContext == Context.root()) { - parentContext = ofSystemAttributes(message.attributesAsStrings()); + if (shouldUseXrayPropagator && !Span.fromContext(extractedContext).getSpanContext().isValid()) { + extractedContext = ofSystemAttributes(extractedContext, message.attributesAsStrings()); } - return parentContext; + return extractedContext; } private SqsParentContext() {} diff --git a/instrumentation/aws-sdk/aws-sdk-2.2/library/src/main/java/io/opentelemetry/instrumentation/awssdk/v2_2/internal/TracingIterator.java b/instrumentation/aws-sdk/aws-sdk-2.2/library/src/main/java/io/opentelemetry/instrumentation/awssdk/v2_2/internal/TracingIterator.java index 74bf989ed540..7e2a8801287d 100644 --- a/instrumentation/aws-sdk/aws-sdk-2.2/library/src/main/java/io/opentelemetry/instrumentation/awssdk/v2_2/internal/TracingIterator.java +++ b/instrumentation/aws-sdk/aws-sdk-2.2/library/src/main/java/io/opentelemetry/instrumentation/awssdk/v2_2/internal/TracingIterator.java @@ -7,20 +7,14 @@ import io.opentelemetry.context.Context; import io.opentelemetry.context.Scope; -import io.opentelemetry.instrumentation.api.instrumenter.Instrumenter; import java.util.Iterator; import javax.annotation.Nullable; -import software.amazon.awssdk.core.interceptor.ExecutionAttributes; import software.amazon.awssdk.services.sqs.model.Message; class TracingIterator implements Iterator { private final Iterator delegateIterator; - private final Instrumenter instrumenter; - private final ExecutionAttributes request; - private final Response response; - private final TracingExecutionInterceptor config; - private final Context receiveContext; + private final TracingList tracingList; /* * Note: this may potentially create problems if this iterator is used from different threads. But @@ -30,30 +24,14 @@ class TracingIterator implements Iterator { @Nullable private Context currentContext; @Nullable private Scope currentScope; - private TracingIterator( - Iterator delegateIterator, - Instrumenter instrumenter, - ExecutionAttributes request, - Response response, - TracingExecutionInterceptor config, - Context receiveContext) { + private TracingIterator(Iterator delegateIterator, TracingList tracingList) { this.delegateIterator = delegateIterator; - this.instrumenter = instrumenter; - this.request = request; - this.response = response; - this.config = config; - this.receiveContext = receiveContext; + this.tracingList = tracingList; } public static Iterator wrap( - Iterator delegateIterator, - Instrumenter instrumenter, - ExecutionAttributes request, - Response response, - TracingExecutionInterceptor config, - Context receiveContext) { - return new TracingIterator( - delegateIterator, instrumenter, request, response, config, receiveContext); + Iterator delegateIterator, TracingList tracingList) { + return new TracingIterator(delegateIterator, tracingList); } @Override @@ -74,14 +52,14 @@ public Message next() { // (https://github.com/open-telemetry/opentelemetry-java-instrumentation/issues/1947) Message next = delegateIterator.next(); if (next != null) { - SqsMessage sqsMessage = SqsMessageImpl.wrap(next); - Context parentContext = receiveContext; + SqsMessage sqsMessage = SqsMessageImpl.wrap(next, tracingList.getConfig()); + Context parentContext = tracingList.getProcessParentContext(); if (parentContext == null) { - parentContext = SqsParentContext.ofMessage(sqsMessage, config); + parentContext = sqsMessage.getCreationContext(); } - currentRequest = SqsProcessRequest.create(request, sqsMessage); - currentContext = instrumenter.start(parentContext, currentRequest); + currentRequest = SqsProcessRequest.create(tracingList.getRequest(), sqsMessage); + currentContext = tracingList.getInstrumenter().start(parentContext, currentRequest); currentScope = currentContext.makeCurrent(); } return next; @@ -90,7 +68,9 @@ public Message next() { private void closeScopeAndEndSpan() { if (currentScope != null) { currentScope.close(); - instrumenter.end(currentContext, currentRequest, response, null); + tracingList + .getInstrumenter() + .end(currentContext, currentRequest, tracingList.getResponse(), null); currentScope = null; currentRequest = null; currentContext = null; diff --git a/instrumentation/aws-sdk/aws-sdk-2.2/library/src/main/java/io/opentelemetry/instrumentation/awssdk/v2_2/internal/TracingList.java b/instrumentation/aws-sdk/aws-sdk-2.2/library/src/main/java/io/opentelemetry/instrumentation/awssdk/v2_2/internal/TracingList.java index 6243b38fb959..82c7bd3bb1f2 100644 --- a/instrumentation/aws-sdk/aws-sdk-2.2/library/src/main/java/io/opentelemetry/instrumentation/awssdk/v2_2/internal/TracingList.java +++ b/instrumentation/aws-sdk/aws-sdk-2.2/library/src/main/java/io/opentelemetry/instrumentation/awssdk/v2_2/internal/TracingList.java @@ -11,6 +11,7 @@ import java.util.Iterator; import java.util.List; import java.util.function.Consumer; +import javax.annotation.Nullable; import software.amazon.awssdk.core.interceptor.ExecutionAttributes; import software.amazon.awssdk.services.sqs.model.Message; @@ -25,32 +26,32 @@ public final class TracingList extends ArrayList { private final ExecutionAttributes request; private final Response response; private final TracingExecutionInterceptor config; - private final Context receiveContext; + @Nullable private final Context processParentContext; private boolean firstIterator = true; - private TracingList( - List list, + public static TracingList wrap( + List messages, Instrumenter instrumenter, ExecutionAttributes request, Response response, TracingExecutionInterceptor config, - Context receiveContext) { - super(list); - this.instrumenter = instrumenter; - this.request = request; - this.response = response; - this.config = config; - this.receiveContext = receiveContext; + @Nullable Context processParentContext) { + return new TracingList(messages, instrumenter, request, response, config, processParentContext); } - public static TracingList wrap( - List list, + private TracingList( + List messages, Instrumenter instrumenter, ExecutionAttributes request, Response response, TracingExecutionInterceptor config, - Context receiveContext) { - return new TracingList(list, instrumenter, request, response, config, receiveContext); + @Nullable Context processParentContext) { + super(messages); + this.instrumenter = instrumenter; + this.request = request; + this.response = response; + this.config = config; + this.processParentContext = processParentContext; } public void disableTracing() { @@ -65,9 +66,7 @@ public Iterator iterator() { // However, this is not thread-safe, but usually the first (hopefully only) traversal of // List is performed in the same thread that called receiveMessage() if (firstIterator) { - it = - TracingIterator.wrap( - super.iterator(), instrumenter, request, response, config, receiveContext); + it = TracingIterator.wrap(super.iterator(), this); firstIterator = false; } else { it = super.iterator(); @@ -99,7 +98,8 @@ public TracingExecutionInterceptor getConfig() { return config; } - public Context getReceiveContext() { - return receiveContext; + @Nullable + public Context getProcessParentContext() { + return processParentContext; } } diff --git a/instrumentation/aws-sdk/aws-sdk-2.2/library/src/test/java/io/opentelemetry/instrumentation/awssdk/v2_2/internal/SqsParentContextTest.java b/instrumentation/aws-sdk/aws-sdk-2.2/library/src/test/java/io/opentelemetry/instrumentation/awssdk/v2_2/internal/SqsParentContextTest.java new file mode 100644 index 000000000000..87da6c616994 --- /dev/null +++ b/instrumentation/aws-sdk/aws-sdk-2.2/library/src/test/java/io/opentelemetry/instrumentation/awssdk/v2_2/internal/SqsParentContextTest.java @@ -0,0 +1,94 @@ +/* + * Copyright The OpenTelemetry Authors + * SPDX-License-Identifier: Apache-2.0 + */ + +package io.opentelemetry.instrumentation.awssdk.v2_2.internal; + +import static java.util.Collections.emptyList; +import static java.util.Collections.emptyMap; +import static java.util.Collections.singletonMap; +import static org.assertj.core.api.Assertions.assertThat; + +import io.opentelemetry.api.trace.Span; +import io.opentelemetry.context.Context; +import io.opentelemetry.context.ContextKey; +import io.opentelemetry.context.propagation.TextMapGetter; +import io.opentelemetry.context.propagation.TextMapPropagator; +import io.opentelemetry.context.propagation.TextMapSetter; +import java.util.List; +import java.util.Map; +import org.junit.jupiter.api.Test; +import software.amazon.awssdk.services.sqs.model.MessageAttributeValue; + +class SqsParentContextTest { + + private static final ContextKey TEST_CONTEXT_KEY = ContextKey.named("test-context-key"); + private static final String TRACE_HEADER = + "Root=1-5759e988-bd862e3fe1be46a994272793;Parent=53995c3f42cd8ad8;Sampled=1"; + + @Test + void preservesParentContextValues() { + Context parentContext = Context.root().with(TEST_CONTEXT_KEY, "test-value"); + + Context extractedContext = + SqsParentContext.ofMessage(parentContext, messageWithTraceHeader(), null, true); + + assertThat(extractedContext.get(TEST_CONTEXT_KEY)).isEqualTo("test-value"); + assertThat(Span.fromContext(extractedContext).getSpanContext().isValid()).isTrue(); + } + + @Test + void preservesNonSpanExtractedValuesWhenUsingXrayFallback() { + TextMapPropagator propagator = + new TextMapPropagator() { + @Override + public void inject(Context context, C carrier, TextMapSetter setter) {} + + @Override + public Context extract(Context context, C carrier, TextMapGetter getter) { + return context.with(TEST_CONTEXT_KEY, "extracted-value"); + } + + @Override + public List fields() { + return emptyList(); + } + }; + + Context extractedContext = + SqsParentContext.ofMessage(Context.root(), messageWithTraceHeader(), propagator, true); + + assertThat(extractedContext.get(TEST_CONTEXT_KEY)).isEqualTo("extracted-value"); + assertThat(Span.fromContext(extractedContext).getSpanContext().isValid()).isTrue(); + } + + private static SqsMessage messageWithTraceHeader() { + return new SqsMessage() { + @Override + public Context getCreationContext() { + return Context.root(); + } + + @Override + public Map messageAttributes() { + return emptyMap(); + } + + @Override + public Map attributesAsStrings() { + return singletonMap(SqsParentContext.AWS_TRACE_SYSTEM_ATTRIBUTE, TRACE_HEADER); + } + + @Override + public String getMessageAttribute(String name) { + return ""; + } + + @Override + public String getMessageId() { + return ""; + } + }; + } +} diff --git a/instrumentation/aws-sdk/aws-sdk-2.2/testing/src/main/java/io/opentelemetry/instrumentation/awssdk/v2_2/AbstractAws2SqsSuppressReceiveSpansTest.java b/instrumentation/aws-sdk/aws-sdk-2.2/testing/src/main/java/io/opentelemetry/instrumentation/awssdk/v2_2/AbstractAws2SqsSuppressReceiveSpansTest.java index a162d8e67668..2f23c46e79d6 100644 --- a/instrumentation/aws-sdk/aws-sdk-2.2/testing/src/main/java/io/opentelemetry/instrumentation/awssdk/v2_2/AbstractAws2SqsSuppressReceiveSpansTest.java +++ b/instrumentation/aws-sdk/aws-sdk-2.2/testing/src/main/java/io/opentelemetry/instrumentation/awssdk/v2_2/AbstractAws2SqsSuppressReceiveSpansTest.java @@ -6,6 +6,7 @@ package io.opentelemetry.instrumentation.awssdk.v2_2; import static io.opentelemetry.api.common.AttributeKey.stringKey; +import static io.opentelemetry.instrumentation.api.internal.SemconvStability.emitStableMessagingSemconv; import static io.opentelemetry.sdk.testing.assertj.OpenTelemetryAssertions.equalTo; import static io.opentelemetry.sdk.testing.assertj.OpenTelemetryAssertions.satisfies; import static io.opentelemetry.semconv.HttpAttributes.HTTP_REQUEST_METHOD; @@ -26,16 +27,19 @@ import static java.util.Arrays.asList; import static java.util.Collections.singletonList; import static org.assertj.core.api.Assertions.assertThat; +import static org.junit.jupiter.api.Assumptions.assumeTrue; import io.opentelemetry.api.trace.SpanKind; import io.opentelemetry.sdk.testing.assertj.SpanDataAssert; import io.opentelemetry.sdk.testing.assertj.TraceAssert; import java.util.ArrayList; +import java.util.Iterator; import java.util.List; import java.util.function.Consumer; import org.junit.jupiter.api.Test; import software.amazon.awssdk.services.sqs.SqsClient; import software.amazon.awssdk.services.sqs.SqsClientBuilder; +import software.amazon.awssdk.services.sqs.model.Message; import software.amazon.awssdk.services.sqs.model.ReceiveMessageResponse; @SuppressWarnings("deprecation") // using deprecated semconv @@ -93,6 +97,43 @@ protected void assertSqsTraces(boolean withParent, boolean captureHeaders) { getTesting().waitAndAssertTraces(traceAsserts); } + @Test + void testAbandonedIteratorDoesNotParentNextProcessSpan() { + assumeTrue(emitStableMessagingSemconv()); + SqsClientBuilder builder = SqsClient.builder(); + configureSdkClient(builder); + SqsClient client = configureSqsClient(builder.build()); + + client.createQueue(createQueueRequest); + client.sendMessage(sendMessageRequest.toBuilder().messageBody("first").build()); + ReceiveMessageResponse firstResponse = client.receiveMessage(receiveMessageRequest); + client.sendMessage(sendMessageRequest.toBuilder().messageBody("second").build()); + ReceiveMessageResponse secondResponse = client.receiveMessage(receiveMessageRequest); + + Iterator firstIterator = firstResponse.messages().iterator(); + Iterator secondIterator = secondResponse.messages().iterator(); + assertThat(firstIterator.hasNext()).isTrue(); + firstIterator.next(); + assertThat(secondIterator.hasNext()).isTrue(); + secondIterator.next(); + assertThat(secondIterator.hasNext()).isFalse(); + assertThat(firstIterator.hasNext()).isFalse(); + + getTesting() + .waitAndAssertTraces( + trace -> + trace.hasSpansSatisfyingExactly( + span -> span.hasName("Sqs.CreateQueue").hasNoParent()), + trace -> + trace.hasSpansSatisfyingExactly( + span -> span.hasName("publish testSdkSqs").hasNoParent(), + span -> span.hasName("process testSdkSqs").hasParent(trace.getSpan(0))), + trace -> + trace.hasSpansSatisfyingExactly( + span -> span.hasName("publish testSdkSqs").hasNoParent(), + span -> span.hasName("process testSdkSqs").hasParent(trace.getSpan(0)))); + } + @Test @SuppressWarnings("deprecation") // using deprecated semconv void testBatchSqsProducerConsumerServicesSync() { diff --git a/instrumentation/aws-sdk/aws-sdk-2.2/testing/src/main/java/io/opentelemetry/instrumentation/awssdk/v2_2/AbstractAws2SqsTracingTest.java b/instrumentation/aws-sdk/aws-sdk-2.2/testing/src/main/java/io/opentelemetry/instrumentation/awssdk/v2_2/AbstractAws2SqsTracingTest.java index 92a952e69b37..ab043c96ecd9 100644 --- a/instrumentation/aws-sdk/aws-sdk-2.2/testing/src/main/java/io/opentelemetry/instrumentation/awssdk/v2_2/AbstractAws2SqsTracingTest.java +++ b/instrumentation/aws-sdk/aws-sdk-2.2/testing/src/main/java/io/opentelemetry/instrumentation/awssdk/v2_2/AbstractAws2SqsTracingTest.java @@ -6,6 +6,7 @@ package io.opentelemetry.instrumentation.awssdk.v2_2; import static io.opentelemetry.api.common.AttributeKey.stringKey; +import static io.opentelemetry.instrumentation.api.internal.SemconvStability.emitStableMessagingSemconv; import static io.opentelemetry.instrumentation.testing.junit.message.MessageHeaderUtil.headerAttributeKey; import static io.opentelemetry.sdk.testing.assertj.OpenTelemetryAssertions.equalTo; import static io.opentelemetry.sdk.testing.assertj.OpenTelemetryAssertions.satisfies; @@ -20,6 +21,8 @@ import static io.opentelemetry.semconv.incubating.MessagingIncubatingAttributes.MESSAGING_DESTINATION_NAME; 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 io.opentelemetry.semconv.incubating.MessagingIncubatingAttributes.MessagingSystemIncubatingValues.AWS_SQS; import static io.opentelemetry.semconv.incubating.RpcIncubatingAttributes.RPC_METHOD; @@ -28,6 +31,7 @@ import static java.util.Arrays.asList; import static java.util.Collections.singletonList; import static org.assertj.core.api.Assertions.assertThat; +import static org.junit.jupiter.api.Assumptions.assumeTrue; import io.opentelemetry.api.trace.SpanKind; import io.opentelemetry.sdk.testing.assertj.AttributeAssertion; @@ -87,18 +91,27 @@ protected void assertSqsTraces(boolean withParent, boolean captureHeaders) { equalTo(SERVER_PORT, sqsPort), equalTo(MESSAGING_SYSTEM, AWS_SQS), equalTo(MESSAGING_DESTINATION_NAME, "testSdkSqs"), - equalTo(MESSAGING_OPERATION, "publish"), satisfies( MESSAGING_MESSAGE_ID, val -> val.isInstanceOf(String.class)))); + if (emitStableMessagingSemconv()) { + attributes.add(equalTo(MESSAGING_OPERATION_NAME, "publish")); + attributes.add(equalTo(MESSAGING_OPERATION_TYPE, "send")); + } else { + attributes.add(equalTo(MESSAGING_OPERATION, "publish")); + } + if (captureHeaders) { attributes.add( satisfies( headerAttributeKey("Test-Message-Header"), val -> val.isEqualTo(ImmutableList.of("test")))); } - span.hasName("testSdkSqs publish") + span.hasName( + emitStableMessagingSemconv() + ? "publish testSdkSqs" + : "testSdkSqs publish") .hasKind(SpanKind.PRODUCER) .hasNoParent() .hasAttributesSatisfyingExactly(attributes); @@ -161,9 +174,15 @@ protected void assertSqsTraces(boolean withParent, boolean captureHeaders) { equalTo(SERVER_PORT, sqsPort), equalTo(MESSAGING_SYSTEM, AWS_SQS), equalTo(MESSAGING_DESTINATION_NAME, "testSdkSqs"), - equalTo(MESSAGING_OPERATION, "receive"), equalTo(MESSAGING_BATCH_MESSAGE_COUNT, 1))); + if (emitStableMessagingSemconv()) { + attributes.add(equalTo(MESSAGING_OPERATION_NAME, "receive")); + attributes.add(equalTo(MESSAGING_OPERATION_TYPE, "receive")); + } else { + attributes.add(equalTo(MESSAGING_OPERATION, "receive")); + } + if (captureHeaders) { attributes.add( satisfies( @@ -177,10 +196,25 @@ protected void assertSqsTraces(boolean withParent, boolean captureHeaders) { span.hasNoParent(); } - span.hasName("testSdkSqs receive") - .hasKind(SpanKind.CONSUMER) - .hasTotalRecordedLinks(0) + span.hasName( + emitStableMessagingSemconv() + ? "receive testSdkSqs" + : "testSdkSqs receive") + .hasKind( + emitStableMessagingSemconv() ? SpanKind.CLIENT : SpanKind.CONSUMER) .hasAttributesSatisfyingExactly(attributes); + if (emitStableMessagingSemconv()) { + span.hasLinksSatisfying( + links -> + assertThat(links) + .singleElement() + .satisfies( + link -> + assertThat(link.getSpanContext().getSpanId()) + .isEqualTo(publishSpan.get().getSpanId()))); + } else { + span.hasTotalRecordedLinks(0); + } }, span -> { List attributes = @@ -199,11 +233,17 @@ protected void assertSqsTraces(boolean withParent, boolean captureHeaders) { equalTo(SERVER_PORT, sqsPort), equalTo(MESSAGING_SYSTEM, AWS_SQS), equalTo(MESSAGING_DESTINATION_NAME, "testSdkSqs"), - equalTo(MESSAGING_OPERATION, "process"), satisfies( MESSAGING_MESSAGE_ID, val -> val.isInstanceOf(String.class)))); + if (emitStableMessagingSemconv()) { + attributes.add(equalTo(MESSAGING_OPERATION_NAME, "process")); + attributes.add(equalTo(MESSAGING_OPERATION_TYPE, "process")); + } else { + attributes.add(equalTo(MESSAGING_OPERATION, "process")); + } + if (captureHeaders) { attributes.add( satisfies( @@ -211,8 +251,14 @@ protected void assertSqsTraces(boolean withParent, boolean captureHeaders) { val -> val.isEqualTo(singletonList("test")))); } - span.hasName("testSdkSqs process") - .hasParent(trace.getSpan(0 + offset)) + span.hasName( + emitStableMessagingSemconv() + ? "process testSdkSqs" + : "testSdkSqs process") + .hasParent( + emitStableMessagingSemconv() && withParent + ? trace.getSpan(0) + : trace.getSpan(0 + offset)) .hasKind(SpanKind.CONSUMER) .hasLinksSatisfying( links -> @@ -261,6 +307,90 @@ void testCaptureMessageHeaderAsAttributeSpan() { assertSqsTraces(false, true); } + @Test + void testReceiveSpanLinksToProducer() { + assumeTrue(emitStableMessagingSemconv()); + SqsClientBuilder builder = SqsClient.builder(); + configureSdkClient(builder); + SqsClient client = configureSqsClient(builder.build()); + + client.createQueue(createQueueRequest); + client.sendMessage(sendMessageRequest); + client.receiveMessage(receiveMessageRequest); + + AtomicReference publishSpan = new AtomicReference<>(); + getTesting() + .waitAndAssertTraces( + trace -> + trace.hasSpansSatisfyingExactly( + span -> span.hasName("Sqs.CreateQueue").hasKind(SpanKind.CLIENT)), + trace -> + trace.hasSpansSatisfyingExactly( + span -> { + publishSpan.set(trace.getSpan(0)); + span.hasName("publish testSdkSqs").hasKind(SpanKind.PRODUCER); + }), + trace -> + trace.hasSpansSatisfyingExactly( + span -> + span.hasName("receive testSdkSqs") + .hasKind(SpanKind.CLIENT) + .hasNoParent() + .hasLinksSatisfying( + links -> + assertThat(links) + .singleElement() + .satisfies( + link -> + assertThat(link.getSpanContext().getSpanId()) + .isEqualTo(publishSpan.get().getSpanId()))))); + } + + @Test + void testBatchSendMessageCount() { + assumeTrue(emitStableMessagingSemconv()); + SqsClientBuilder builder = SqsClient.builder(); + configureSdkClient(builder); + SqsClient client = configureSqsClient(builder.build()); + + client.createQueue(createQueueRequest); + client.sendMessageBatch(sendMessageBatchRequest); + + getTesting() + .waitAndAssertTraces( + trace -> + trace.hasSpansSatisfyingExactly( + span -> span.hasName("Sqs.CreateQueue").hasKind(SpanKind.CLIENT)), + trace -> + trace.hasSpansSatisfyingExactly( + span -> + span.hasName("publish testSdkSqs") + .hasKind(SpanKind.PRODUCER) + .hasNoParent() + .hasAttributesSatisfyingExactly( + equalTo(stringKey("aws.agent"), "java-aws-sdk"), + equalTo(AWS_SQS_QUEUE_URL, queueUrl), + satisfies( + AWS_REQUEST_ID, + val -> + val.matches( + "\\s*00000000-0000-0000-0000-000000000000\\s*|UNKNOWN")), + equalTo(RPC_SYSTEM, "aws-api"), + equalTo(RPC_SERVICE, "Sqs"), + equalTo(RPC_METHOD, "SendMessageBatch"), + equalTo(HTTP_REQUEST_METHOD, "POST"), + equalTo(HTTP_RESPONSE_STATUS_CODE, 200), + satisfies( + URL_FULL, val -> val.startsWith("http://localhost:" + sqsPort)), + equalTo(SERVER_ADDRESS, "localhost"), + equalTo(SERVER_PORT, sqsPort), + equalTo(MESSAGING_SYSTEM, AWS_SQS), + equalTo(MESSAGING_DESTINATION_NAME, "testSdkSqs"), + equalTo(MESSAGING_OPERATION_NAME, "publish"), + equalTo(MESSAGING_OPERATION_TYPE, "send"), + equalTo(MESSAGING_BATCH_MESSAGE_COUNT, 3)))); + } + @Test void testBatchSqsProducerConsumerServicesSync() { SqsClientBuilder builder = SqsClient.builder(); 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/spring/spring-cloud-aws-3.0/javaagent/build.gradle.kts b/instrumentation/spring/spring-cloud-aws-3.0/javaagent/build.gradle.kts index 41d06eb02698..8e8485f92ae5 100644 --- a/instrumentation/spring/spring-cloud-aws-3.0/javaagent/build.gradle.kts +++ b/instrumentation/spring/spring-cloud-aws-3.0/javaagent/build.gradle.kts @@ -28,6 +28,21 @@ otelJava { minJavaVersionSupported.set(JavaVersion.VERSION_17) } +tasks { + val testMessagingPreview = register("testMessagingPreview") { + testClassesDirs = sourceSets.test.get().output.classesDirs + classpath = sourceSets.test.get().runtimeClasspath + filter { + includeTestsMatching("io.opentelemetry.javaagent.instrumentation.spring.cloud.aws.v3_0.AwsSqsTest") + } + jvmArgs("-Dotel.semconv-stability.preview=messaging") + } + + check { + dependsOn(testMessagingPreview) + } +} + if (otelProps.denyUnsafe) { // org.elasticmq:elasticmq-rest-sqs_2.13 uses unsafe. Future versions are likely to fix this. tasks.withType().configureEach { diff --git a/instrumentation/spring/spring-cloud-aws-3.0/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/spring/cloud/aws/v3_0/SpringAwsUtil.java b/instrumentation/spring/spring-cloud-aws-3.0/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/spring/cloud/aws/v3_0/SpringAwsUtil.java index fe02d827b412..cf4b1024feda 100644 --- a/instrumentation/spring/spring-cloud-aws-3.0/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/spring/cloud/aws/v3_0/SpringAwsUtil.java +++ b/instrumentation/spring/spring-cloud-aws-3.0/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/spring/cloud/aws/v3_0/SpringAwsUtil.java @@ -5,6 +5,7 @@ package io.opentelemetry.javaagent.instrumentation.spring.cloud.aws.v3_0; +import io.opentelemetry.api.trace.Span; import io.opentelemetry.context.Context; import io.opentelemetry.context.Scope; import io.opentelemetry.instrumentation.api.instrumenter.Instrumenter; @@ -83,10 +84,14 @@ public static Scope handleBatch(Collection> messages) { if (tracingContext == null) { return null; } - SqsMessage wrappedMessage = SqsMessageImpl.wrap(tracingContext.sqsMessage); - Context parentContext = tracingContext.receiveContext; + SqsMessage wrappedMessage = + SqsMessageImpl.wrap(tracingContext.sqsMessage, tracingContext.config); + Context parentContext = tracingContext.processParentContext; if (parentContext == null) { - parentContext = SqsParentContext.ofMessage(wrappedMessage, tracingContext.config); + parentContext = wrappedMessage.getCreationContext(); + } else if (!Span.fromContext(parentContext).getSpanContext().isValid()) { + parentContext = + SqsParentContext.ofMessage(parentContext, wrappedMessage, tracingContext.config); } return parentContext.makeCurrent(); } @@ -121,7 +126,7 @@ private static class TracingContext { private final Response response; private final Instrumenter instrumenter; private final TracingExecutionInterceptor config; - @Nullable private final Context receiveContext; + @Nullable private final Context processParentContext; private final software.amazon.awssdk.services.sqs.model.Message sqsMessage; private TracingContext( @@ -130,16 +135,16 @@ private TracingContext( this.response = tracingList.getResponse(); this.instrumenter = tracingList.getInstrumenter(); this.config = tracingList.getConfig(); - this.receiveContext = tracingList.getReceiveContext(); + this.processParentContext = tracingList.getProcessParentContext(); this.sqsMessage = sqsMessage; } @Nullable MessageScope trace() { - SqsMessage wrappedMessage = SqsMessageImpl.wrap(sqsMessage); - Context parentContext = receiveContext; + SqsMessage wrappedMessage = SqsMessageImpl.wrap(sqsMessage, config); + Context parentContext = processParentContext; if (parentContext == null) { - parentContext = SqsParentContext.ofMessage(wrappedMessage, config); + parentContext = wrappedMessage.getCreationContext(); } SqsProcessRequest processRequest = SqsProcessRequest.create(request, wrappedMessage); if (!instrumenter.shouldStart(parentContext, processRequest)) { diff --git a/instrumentation/spring/spring-cloud-aws-3.0/javaagent/src/test/java/io/opentelemetry/javaagent/instrumentation/spring/cloud/aws/v3_0/AwsSqsTest.java b/instrumentation/spring/spring-cloud-aws-3.0/javaagent/src/test/java/io/opentelemetry/javaagent/instrumentation/spring/cloud/aws/v3_0/AwsSqsTest.java index 67f86215e11a..d065445cf80b 100644 --- a/instrumentation/spring/spring-cloud-aws-3.0/javaagent/src/test/java/io/opentelemetry/javaagent/instrumentation/spring/cloud/aws/v3_0/AwsSqsTest.java +++ b/instrumentation/spring/spring-cloud-aws-3.0/javaagent/src/test/java/io/opentelemetry/javaagent/instrumentation/spring/cloud/aws/v3_0/AwsSqsTest.java @@ -5,6 +5,7 @@ package io.opentelemetry.javaagent.instrumentation.spring.cloud.aws.v3_0; +import static io.opentelemetry.instrumentation.api.internal.SemconvStability.emitStableMessagingSemconv; import static io.opentelemetry.sdk.testing.assertj.OpenTelemetryAssertions.equalTo; import static io.opentelemetry.sdk.testing.assertj.OpenTelemetryAssertions.satisfies; import static io.opentelemetry.semconv.HttpAttributes.HTTP_REQUEST_METHOD; @@ -18,6 +19,8 @@ import static io.opentelemetry.semconv.incubating.MessagingIncubatingAttributes.MESSAGING_DESTINATION_NAME; 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 io.opentelemetry.semconv.incubating.MessagingIncubatingAttributes.MessagingSystemIncubatingValues.AWS_SQS; import static io.opentelemetry.semconv.incubating.RpcIncubatingAttributes.RPC_METHOD; @@ -103,7 +106,10 @@ void sqsListener() throws Exception { "http://localhost:" + AwsSqsTestApplication.sqsPort)), satisfies(AWS_REQUEST_ID, val -> val.isInstanceOf(String.class))), span -> - span.hasName("test-queue publish") + span.hasName( + emitStableMessagingSemconv() + ? "publish test-queue" + : "test-queue publish") .hasKind(SpanKind.PRODUCER) .hasParent(trace.getSpan(0)) .hasAttributesSatisfyingExactly( @@ -121,7 +127,15 @@ void sqsListener() throws Exception { "http://localhost:" + AwsSqsTestApplication.sqsPort)), equalTo(MESSAGING_SYSTEM, AWS_SQS), satisfies(MESSAGING_MESSAGE_ID, AbstractStringAssert::isNotBlank), - equalTo(MESSAGING_OPERATION, "publish"), + equalTo( + MESSAGING_OPERATION, + emitStableMessagingSemconv() ? null : "publish"), + equalTo( + MESSAGING_OPERATION_NAME, + emitStableMessagingSemconv() ? "publish" : null), + equalTo( + MESSAGING_OPERATION_TYPE, + emitStableMessagingSemconv() ? "send" : null), equalTo(MESSAGING_DESTINATION_NAME, "test-queue"), equalTo( AWS_SQS_QUEUE_URL, @@ -129,27 +143,41 @@ void sqsListener() throws Exception { + AwsSqsTestApplication.sqsPort + "/000000000000/test-queue"), satisfies(AWS_REQUEST_ID, val -> val.isInstanceOf(String.class))), - span -> - span.hasName("test-queue process") - .hasKind(SpanKind.CONSUMER) - .hasParent(trace.getSpan(2)) - .hasAttributesSatisfyingExactly( - equalTo(RPC_SYSTEM, "aws-api"), - equalTo(RPC_METHOD, "ReceiveMessage"), - equalTo(RPC_SERVICE, "Sqs"), - equalTo(HTTP_REQUEST_METHOD, POST), - equalTo(HTTP_RESPONSE_STATUS_CODE, 200), - equalTo(SERVER_ADDRESS, "localhost"), - equalTo(SERVER_PORT, AwsSqsTestApplication.sqsPort), - satisfies( - URL_FULL, - val -> - val.startsWith( - "http://localhost:" + AwsSqsTestApplication.sqsPort)), - equalTo(MESSAGING_SYSTEM, AWS_SQS), - satisfies(MESSAGING_MESSAGE_ID, AbstractStringAssert::isNotBlank), - equalTo(MESSAGING_OPERATION, "process"), - equalTo(MESSAGING_DESTINATION_NAME, "test-queue")), + span -> { + span.hasName( + emitStableMessagingSemconv() + ? "process test-queue" + : "test-queue process") + .hasKind(SpanKind.CONSUMER) + .hasParent(trace.getSpan(2)) + .hasAttributesSatisfyingExactly( + equalTo(RPC_SYSTEM, "aws-api"), + equalTo(RPC_METHOD, "ReceiveMessage"), + equalTo(RPC_SERVICE, "Sqs"), + equalTo(HTTP_REQUEST_METHOD, POST), + equalTo(HTTP_RESPONSE_STATUS_CODE, 200), + equalTo(SERVER_ADDRESS, "localhost"), + equalTo(SERVER_PORT, AwsSqsTestApplication.sqsPort), + satisfies( + URL_FULL, + val -> + val.startsWith( + "http://localhost:" + AwsSqsTestApplication.sqsPort)), + equalTo(MESSAGING_SYSTEM, AWS_SQS), + satisfies(MESSAGING_MESSAGE_ID, AbstractStringAssert::isNotBlank), + equalTo( + MESSAGING_OPERATION, emitStableMessagingSemconv() ? null : "process"), + equalTo( + MESSAGING_OPERATION_NAME, + emitStableMessagingSemconv() ? "process" : null), + equalTo( + MESSAGING_OPERATION_TYPE, + emitStableMessagingSemconv() ? "process" : null), + equalTo(MESSAGING_DESTINATION_NAME, "test-queue")); + if (emitStableMessagingSemconv()) { + span.hasTotalRecordedLinks(0); + } + }, span -> span.hasName("callback").hasKind(SpanKind.INTERNAL).hasParent(trace.getSpan(3)), span -> 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() {} +}