From 6ffabd5b391e692faf13d1272d1fdd5bb3082244 Mon Sep 17 00:00:00 2001 From: Trask Stalnaker Date: Wed, 15 Jul 2026 17:58:59 -0700 Subject: [PATCH 1/4] Pin messaging semantic conventions to v1.43 behind preview --- .../build.gradle.kts | 18 +- .../semconv/db/SqlQueryAnalyzer.java | 4 +- .../semconv/messaging/MessageOperation.java | 7 +- .../MessagingAttributesExtractor.java | 74 +++++- .../MessagingAttributesExtractorBuilder.java | 10 +- .../messaging/MessagingConsumerMetrics.java | 104 +++++++-- .../messaging/MessagingMetricsAdvice.java | 91 +++++++- .../semconv/messaging/MessagingOperation.java | 54 +++++ .../messaging/MessagingProcessMetrics.java | 97 ++++++++ .../messaging/MessagingProducerMetrics.java | 78 ++++++- .../messaging/MessagingSpanKindExtractor.java | 41 ++++ .../messaging/MessagingSpanNameExtractor.java | 33 ++- .../MessagingAttributesExtractorTest.java | 58 ++++- .../MessagingConsumerMetricsTest.java | 218 ++++++++++++++++++ .../messaging/MessagingMetricsAdviceTest.java | 47 ++++ .../MessagingProcessMetricsTest.java | 93 ++++++++ .../MessagingProducerMetricsTest.java | 180 +++++++++------ .../MessagingSpanKindExtractorTest.java | 34 +++ .../MessagingSpanNameExtractorTest.java | 86 ++++++- .../api/internal/SemconvStability.java | 4 + .../api/internal/SemconvStabilityTest.java | 66 ++++++ .../v0_11/KafkaClientDefaultTest.java | 61 ++++- .../v0_11/internal/KafkaClientBaseTest.java | 30 ++- .../v2_6/AbstractInterceptorsTest.java | 6 +- .../InterceptorsSuppressReceiveSpansTest.java | 4 +- .../v2_6/WrapperSuppressReceiveSpansTest.java | 4 +- .../kafkaclients/v2_6/WrapperTest.java | 6 +- .../v2_8/telemetry/PulsarSingletons.java | 4 +- 28 files changed, 1324 insertions(+), 188 deletions(-) create mode 100644 instrumentation-api-incubator/src/main/java/io/opentelemetry/instrumentation/api/incubator/semconv/messaging/MessagingOperation.java create mode 100644 instrumentation-api-incubator/src/main/java/io/opentelemetry/instrumentation/api/incubator/semconv/messaging/MessagingProcessMetrics.java create mode 100644 instrumentation-api-incubator/src/main/java/io/opentelemetry/instrumentation/api/incubator/semconv/messaging/MessagingSpanKindExtractor.java create mode 100644 instrumentation-api-incubator/src/test/java/io/opentelemetry/instrumentation/api/incubator/semconv/messaging/MessagingConsumerMetricsTest.java create mode 100644 instrumentation-api-incubator/src/test/java/io/opentelemetry/instrumentation/api/incubator/semconv/messaging/MessagingMetricsAdviceTest.java create mode 100644 instrumentation-api-incubator/src/test/java/io/opentelemetry/instrumentation/api/incubator/semconv/messaging/MessagingProcessMetricsTest.java create mode 100644 instrumentation-api-incubator/src/test/java/io/opentelemetry/instrumentation/api/incubator/semconv/messaging/MessagingSpanKindExtractorTest.java diff --git a/instrumentation-api-incubator/build.gradle.kts b/instrumentation-api-incubator/build.gradle.kts index 1a59ad1364a8..2c1404df92ee 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,15 @@ 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) + } + + val testV3Preview = register("testV3Preview") { + testClassesDirs = sourceSets.test.get().output.classesDirs + classpath = sourceSets.test.get().runtimeClasspath + jvmArgs("-Dotel.instrumentation.common.v3-preview=true") + jvmArgs("-Dotel.semconv-stability.preview=messaging") inputs.dir(jflexOutputDir) } @@ -117,6 +127,12 @@ tasks { } check { - dependsOn(testStableSemconv, testBothSemconv, testExceptionSignalLogs, testExceptionSignalLogsDup) + dependsOn( + testStableSemconv, + testBothSemconv, + testV3Preview, + testExceptionSignalLogs, + testExceptionSignalLogsDup, + ) } } diff --git a/instrumentation-api-incubator/src/main/java/io/opentelemetry/instrumentation/api/incubator/semconv/db/SqlQueryAnalyzer.java b/instrumentation-api-incubator/src/main/java/io/opentelemetry/instrumentation/api/incubator/semconv/db/SqlQueryAnalyzer.java index 6e4841154818..efea8d828d78 100644 --- a/instrumentation-api-incubator/src/main/java/io/opentelemetry/instrumentation/api/incubator/semconv/db/SqlQueryAnalyzer.java +++ b/instrumentation-api-incubator/src/main/java/io/opentelemetry/instrumentation/api/incubator/semconv/db/SqlQueryAnalyzer.java @@ -78,7 +78,9 @@ private static SqlQuery analyzeWithSummaryImpl(String query, SqlDialect dialect) // visible for tests static boolean isCached(String query, SqlDialect dialect) { - return sqlToQueryCache.get(CacheKey.create(query, dialect)) != null; + Cache cache = + SemconvStability.v3Preview() ? sqlToQueryCacheWithSummary : sqlToQueryCache; + return cache.get(CacheKey.create(query, dialect)) != null; } @AutoValue 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..ef87253e22a1 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 @@ -9,7 +9,7 @@ /** * Represents type of operations + * href="https://github.com/open-telemetry/semantic-conventions/blob/v1.43.0/docs/messaging/messaging-spans.md#operation-types">operations * that may be used in a messaging system. */ public enum MessageOperation { @@ -18,9 +18,8 @@ public enum MessageOperation { PROCESS; /** - * Returns the operation name as defined in the - * specification. + * Returns the legacy operation name. The v1.43 operation name defaults to this value unless an + * instrumentation supplies a system-specific override. */ String operationName() { return name().toLowerCase(Locale.ROOT); 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..b93a5abb734d 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,6 +57,10 @@ 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"); @@ -61,26 +71,51 @@ public final class MessagingAttributesExtractor * with default configuration. */ public static AttributesExtractor create( - MessagingAttributesGetter getter, MessageOperation operation) { + MessagingAttributesGetter getter, @Nullable MessageOperation operation) { return builder(getter, operation).build(); } + /** + * Creates the messaging attributes extractor with a system-specific v1.43 operation name. + * + *

The {@code operationName} is emitted as {@code messaging.operation.name}. The legacy {@code + * messaging.operation} value remains derived from {@code operation}. + */ + public static AttributesExtractor create( + MessagingAttributesGetter getter, + MessageOperation operation, + String operationName) { + return builder(getter, operation, operationName).build(); + } + /** * Returns a new {@link MessagingAttributesExtractorBuilder} for the given {@link MessageOperation * operation} that can be used to configure the messaging attributes extractor. */ public static MessagingAttributesExtractorBuilder builder( - MessagingAttributesGetter getter, MessageOperation operation) { + MessagingAttributesGetter getter, @Nullable MessageOperation operation) { return new MessagingAttributesExtractorBuilder<>(getter, operation); } + /** + * Returns a new {@link MessagingAttributesExtractorBuilder} with a system-specific v1.43 + * operation name. + */ + public static MessagingAttributesExtractorBuilder builder( + MessagingAttributesGetter getter, + MessageOperation operation, + String operationName) { + return new MessagingAttributesExtractorBuilder<>( + getter, MessagingOperation.create(operation, operationName)); + } + private final MessagingAttributesGetter getter; - private final MessageOperation operation; + @Nullable private final MessagingOperation operation; private final List capturedHeaders; MessagingAttributesExtractor( MessagingAttributesGetter getter, - MessageOperation operation, + @Nullable MessagingOperation operation, List capturedHeaders) { this.getter = getter; this.operation = operation; @@ -93,7 +128,12 @@ public void onStart(AttributesBuilder attributes, Context parentContext, REQUEST boolean isTemporaryDestination = getter.isTemporaryDestination(request); if (isTemporaryDestination) { attributes.put(MESSAGING_DESTINATION_TEMPORARY, true); - attributes.put(MESSAGING_DESTINATION_NAME, TEMP_DESTINATION_NAME); + if (emitStableMessagingSemconv()) { + 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 +146,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 (emitOldMessagingSemconv()) { + attributes.put(MESSAGING_CLIENT_ID_OLD, getter.getClientId(request)); + } + if (emitStableMessagingSemconv()) { + attributes.put(MESSAGING_CLIENT_ID, getter.getClientId(request)); + } if (operation != null) { - attributes.put(MESSAGING_OPERATION, operation.operationName()); + if (emitOldMessagingSemconv()) { + attributes.put(MESSAGING_OPERATION, operation.operation().operationName()); + } + if (emitStableMessagingSemconv()) { + attributes.put(MESSAGING_OPERATION_NAME, operation.name()); + attributes.put(MESSAGING_OPERATION_TYPE, operation.type()); + } } } @@ -121,6 +172,9 @@ 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 (emitStableMessagingSemconv() && error != null) { + attributes.put(ERROR_TYPE, error.getClass().getName()); + } for (String name : capturedHeaders) { List values = getter.getMessageHeader(request, name); @@ -141,7 +195,7 @@ public SpanKey internalGetSpanKey() { return null; } - switch (operation) { + switch (operation.operation()) { case PUBLISH: return SpanKey.PRODUCER; case RECEIVE: 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..fc1035e91389 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 @@ -12,16 +12,22 @@ 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 final MessagingOperation operation; List capturedHeaders = emptyList(); MessagingAttributesExtractorBuilder( - MessagingAttributesGetter getter, MessageOperation operation) { + MessagingAttributesGetter getter, @Nullable MessageOperation operation) { + this(getter, MessagingOperation.createNullable(operation)); + } + + MessagingAttributesExtractorBuilder( + MessagingAttributesGetter getter, @Nullable MessagingOperation operation) { this.getter = getter; this.operation = operation; } 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..f642643e8c67 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 { @@ -39,26 +43,17 @@ public final class MessagingConsumerMetrics implements OperationListener { ContextKey.named("messaging-consumer-metrics-state"); private static final Logger logger = Logger.getLogger(MessagingConsumerMetrics.class.getName()); - private final DoubleHistogram receiveDurationHistogram; - private final LongCounter receiveMessageCount; + @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(); - - LongCounterBuilder longCounterBuilder = - meter - .counterBuilder("messaging.receive.messages") - .setDescription("Measures the number of received messages.") - .setUnit("{message}"); - MessagingMetricsAdvice.applyReceiveMessagesAdvice(longCounterBuilder); - receiveMessageCount = longCounterBuilder.build(); + receiveDurationHistogram = emitOldMessagingSemconv() ? buildReceiveDuration(meter) : null; + receiveMessageCount = emitOldMessagingSemconv() ? buildReceiveMessages(meter) : null; + clientOperationDurationHistogram = + emitStableMessagingSemconv() ? buildClientOperationDuration(meter) : null; + consumedMessagesCounter = emitStableMessagingSemconv() ? buildConsumedMessages(meter) : null; } public static OperationMetrics get() { @@ -85,11 +80,26 @@ 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; + if (receiveDurationHistogram != null) { + receiveDurationHistogram.record(duration, attributes, context); + } + Attributes filteredAttributes = + clientOperationDurationHistogram != null || consumedMessagesCounter != null + ? MessagingMetricsAdvice.filterAttributes(attributes) + : attributes; + if (clientOperationDurationHistogram != null) { + clientOperationDurationHistogram.record(duration, filteredAttributes, context); + } long receiveMessagesCount = getReceiveMessagesCount(state.startAttributes(), endAttributes); - receiveMessageCount.add(receiveMessagesCount, attributes, context); + if (receiveMessageCount != null) { + receiveMessageCount.add(receiveMessagesCount, attributes, context); + } + if (consumedMessagesCounter != null) { + consumedMessagesCounter.add( + getConsumedMessagesCount(attributes, receiveMessagesCount), filteredAttributes, context); + } } private static long getReceiveMessagesCount(Attributes... attributesList) { @@ -102,6 +112,56 @@ private static long getReceiveMessagesCount(Attributes... attributesList) { return 1; } + private static long getConsumedMessagesCount(Attributes attributes, long receiveMessagesCount) { + return attributes.get(MESSAGING_BATCH_MESSAGE_COUNT) == null + && attributes.get(ERROR_TYPE) != null + ? 0 + : receiveMessagesCount; + } + + 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 abstract static class State { 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..eab44d157a68 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); + private static final List> SENT_MESSAGES_ATTRIBUTES = + buildAttributes(false, false); + private static final List> CONSUMED_MESSAGES_ATTRIBUTES = + buildAttributes(true, false); + private static final List> PROCESS_DURATION_ATTRIBUTES = + buildAttributes(true, false); + + private static List> buildAttributes( + boolean includeConsumerAttributes, boolean includeOperationType) { + List> attributes = new ArrayList<>(); + attributes.add(MESSAGING_OPERATION_NAME); + attributes.add(MESSAGING_SYSTEM); + 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(SERVER_ADDRESS); + attributes.add(MESSAGING_DESTINATION_PARTITION_ID); + attributes.add(SERVER_PORT); + 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(OLD_ATTRIBUTES); + } + + static void applyClientOperationDurationAdvice(DoubleHistogramBuilder builder) { if (!(builder instanceof ExtendedDoubleHistogramBuilder)) { return; } - ((ExtendedDoubleHistogramBuilder) builder).setAttributesAdvice(MESSAGING_ATTRIBUTES); + ((ExtendedDoubleHistogramBuilder) builder) + .setAttributesAdvice(CLIENT_OPERATION_DURATION_ATTRIBUTES); } - static void applyReceiveDurationAdvice(DoubleHistogramBuilder builder) { + static void applyProcessDurationAdvice(DoubleHistogramBuilder builder) { if (!(builder instanceof ExtendedDoubleHistogramBuilder)) { return; } - ((ExtendedDoubleHistogramBuilder) builder).setAttributesAdvice(MESSAGING_ATTRIBUTES); + ((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/MessagingOperation.java b/instrumentation-api-incubator/src/main/java/io/opentelemetry/instrumentation/api/incubator/semconv/messaging/MessagingOperation.java new file mode 100644 index 000000000000..3c1d763d9261 --- /dev/null +++ b/instrumentation-api-incubator/src/main/java/io/opentelemetry/instrumentation/api/incubator/semconv/messaging/MessagingOperation.java @@ -0,0 +1,54 @@ +/* + * 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 javax.annotation.Nullable; + +final class MessagingOperation { + + static MessagingOperation create(MessageOperation operation) { + return create(operation, operation.operationName()); + } + + static MessagingOperation create(MessageOperation operation, String name) { + return new MessagingOperation(operation, name); + } + + @Nullable + static MessagingOperation createNullable(@Nullable MessageOperation operation) { + return operation == null ? null : create(operation, operation.operationName()); + } + + private final MessageOperation operation; + private final String name; + + private MessagingOperation(MessageOperation operation, String name) { + this.operation = requireNonNull(operation, "operation"); + this.name = requireNonNull(name, "name"); + } + + MessageOperation operation() { + return operation; + } + + String name() { + return name; + } + + String type() { + switch (operation) { + case PUBLISH: + return "send"; + case RECEIVE: + return "receive"; + case PROCESS: + return "process"; + } + throw new IllegalStateException("Can't possibly happen"); + } +} 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..8368ad7320ed 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,30 +25,32 @@ 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 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; + @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(); + publishDurationHistogram = emitOldMessagingSemconv() ? buildPublishDuration(meter) : null; + clientOperationDurationHistogram = + emitStableMessagingSemconv() ? buildClientOperationDuration(meter) : null; + sentMessagesCounter = emitStableMessagingSemconv() ? buildSentMessages(meter) : null; } public static OperationMetrics get() { @@ -70,9 +77,56 @@ 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; + + if (publishDurationHistogram != null) { + 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) { + Long batchMessageCount = attributes.get(MESSAGING_BATCH_MESSAGE_COUNT); + sentMessagesCounter.add( + batchMessageCount == null ? 1 : batchMessageCount, filteredAttributes, context); + } + } - publishDurationHistogram.record( - (endNanos - state.startTimeNanos()) / NANOS_PER_S, attributes, 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..5372abd194e1 --- /dev/null +++ b/instrumentation-api-incubator/src/main/java/io/opentelemetry/instrumentation/api/incubator/semconv/messaging/MessagingSpanKindExtractor.java @@ -0,0 +1,41 @@ +/* + * 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 when latest messaging conventions are enabled. + */ + public static SpanKindExtractor create(MessageOperation operation) { + SpanKind spanKind; + switch (operation) { + case PUBLISH: + spanKind = SpanKind.PRODUCER; + break; + case RECEIVE: + spanKind = emitStableMessagingSemconv() ? SpanKind.CLIENT : SpanKind.CONSUMER; + break; + case PROCESS: + spanKind = SpanKind.CONSUMER; + break; + default: + throw new IllegalStateException("Can't possibly happen"); + } + SpanKind result = spanKind; + return request -> result; + } + + 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..ec6f5fa4e56c 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,14 +5,16 @@ 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 }. @@ -20,20 +22,39 @@ public final class MessagingSpanNameExtractor implements SpanNameExtrac */ public static SpanNameExtractor create( MessagingAttributesGetter getter, MessageOperation operation) { - return new MessagingSpanNameExtractor<>(getter, operation); + return new MessagingSpanNameExtractor<>(getter, MessagingOperation.create(operation)); + } + + /** Returns a {@link SpanNameExtractor} with a system-specific v1.43 operation name. */ + public static SpanNameExtractor create( + MessagingAttributesGetter getter, + MessageOperation operation, + String operationName) { + return new MessagingSpanNameExtractor<>( + getter, MessagingOperation.create(operation, operationName)); } private final MessagingAttributesGetter getter; - private final MessageOperation operation; + private final MessagingOperation operation; private MessagingSpanNameExtractor( - MessagingAttributesGetter getter, MessageOperation operation) { + MessagingAttributesGetter getter, MessagingOperation operation) { this.getter = getter; this.operation = operation; } @Override public String extract(REQUEST request) { + if (emitStableMessagingSemconv()) { + String destinationName = getter.getDestinationTemplate(request); + if (destinationName == null + && !getter.isTemporaryDestination(request) + && !getter.isAnonymousDestination(request)) { + destinationName = getter.getDestination(request); + } + return destinationName == null ? operation.name() : operation.name() + " " + destinationName; + } + String destinationName = getter.isTemporaryDestination(request) ? MessagingAttributesExtractor.TEMP_DESTINATION_NAME @@ -42,6 +63,6 @@ public String extract(REQUEST request) { destinationName = "unknown"; } - return destinationName + " " + operation.operationName(); + return destinationName + " " + operation.operation().operationName(); } } 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..41dfc31371ec 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,9 +20,12 @@ 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 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; @@ -48,7 +54,7 @@ void shouldExtractAllAvailableAttributes( boolean anonymous, String destination, MessageOperation operation, - String expectedDestination) { + String operationName) { // given Map request = new HashMap<>(); request.put("system", "myQueue"); @@ -69,7 +75,7 @@ void shouldExtractAllAvailableAttributes( request.put("batchMessageCount", "2"); AttributesExtractor, String> underTest = - MessagingAttributesExtractor.create(TestGetter.INSTANCE, operation); + MessagingAttributesExtractor.create(TestGetter.INSTANCE, operation, operationName); Context context = Context.root(); @@ -78,16 +84,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 +107,46 @@ 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, operation.operationName())); + } + if (emitStableMessagingSemconv()) { + expectedEntries.add(entry(stringKey("messaging.client.id"), "43")); + expectedEntries.add(entry(MESSAGING_OPERATION_NAME, operationName)); + expectedEntries.add( + entry(MESSAGING_OPERATION_TYPE, MessagingOperation.create(operation).type())); + } @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( + "regular destination", false, false, "destination", MessageOperation.RECEIVE, "poll"), + argumentSet( + "temporary anonymous destination", + true, + true, + "generated-destination", + MessageOperation.PROCESS, + "process")); } @Test 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..9d519ee02cbe --- /dev/null +++ b/instrumentation-api-incubator/src/test/java/io/opentelemetry/instrumentation/api/incubator/semconv/messaging/MessagingConsumerMetricsTest.java @@ -0,0 +1,218 @@ +/* + * 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 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 org.junit.jupiter.api.Test; + +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.get().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(MESSAGING_CONSUMER_GROUP_NAME, "group"), + equalTo(MESSAGING_DESTINATION_TEMPLATE, "topic-{id}"), + equalTo( + MESSAGING_DESTINATION_SUBSCRIPTION_NAME, + "subscription"), + equalTo( + ERROR_TYPE, + IllegalStateException.class.getName()))))); + } + } + + @Test + @SuppressWarnings("deprecation") // using deprecated semconv + void failedReceiveWithoutBatchCountCountsNoConsumedMessages() { + InMemoryMetricReader metricReader = InMemoryMetricReader.createDelta(); + SdkMeterProvider meterProvider = + SdkMeterProvider.builder().registerMetricReader(metricReader).build(); + OperationListener listener = MessagingConsumerMetrics.get().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) + .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.consumed.messages") + .hasLongSumSatisfying( + sum -> sum.hasPointsSatisfying(point -> point.hasValue(0)))); + } + } + + 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..1f2d32d82b71 --- /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 emitsOnlyLatestProcessDuration() { + 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..946eec949c84 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,121 @@ 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")); 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)); - - assertThat(metricReader.collectAllMetrics()).isEmpty(); - - Context context2 = listener.onStart(Context.root(), requestAttributes, nanos(150)); - - assertThat(metricReader.collectAllMetrics()).isEmpty(); - - listener.onEnd(context1, responseAttributes, 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)); - - assertThat(metricReader.collectAllMetrics()) - .satisfiesExactlyInAnyOrder( - metric -> - assertThat(metric) - .hasName("messaging.publish.duration") - .hasHistogramSatisfying( - histogram -> - histogram.hasPointsSatisfying( - point -> point.hasSum(0.3 /* seconds */)))); + 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(SERVER_ADDRESS, "localhost"), + equalTo(MESSAGING_DESTINATION_PARTITION_ID, "1"), + equalTo(SERVER_PORT, 6650))))) + .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(MESSAGING_DESTINATION_TEMPLATE, "topic-{id}"), + equalTo( + ERROR_TYPE, + IllegalStateException.class.getName()), + equalTo(SERVER_ADDRESS, "localhost"), + equalTo(MESSAGING_DESTINATION_PARTITION_ID, "1"), + equalTo(SERVER_PORT, 6650))))); + } } 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..458a832a2f70 --- /dev/null +++ b/instrumentation-api-incubator/src/test/java/io/opentelemetry/instrumentation/api/incubator/semconv/messaging/MessagingSpanKindExtractorTest.java @@ -0,0 +1,34 @@ +/* + * 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.params.ParameterizedTest; +import org.junit.jupiter.params.provider.Arguments; +import org.junit.jupiter.params.provider.MethodSource; + +class MessagingSpanKindExtractorTest { + + @ParameterizedTest + @MethodSource("spanKinds") + void extractsSpanKind(MessageOperation operation, SpanKind oldKind, SpanKind kind) { + SpanKind actualKind = MessagingSpanKindExtractor.create(operation).extract(new Object()); + + assertThat(actualKind).isEqualTo(emitStableMessagingSemconv() ? kind : oldKind); + } + + private static Stream spanKinds() { + return Stream.of( + argumentSet("publish", MessageOperation.PUBLISH, SpanKind.PRODUCER, SpanKind.PRODUCER), + argumentSet("receive", MessageOperation.RECEIVE, SpanKind.CONSUMER, SpanKind.CLIENT), + argumentSet("process", MessageOperation.PROCESS, SpanKind.CONSUMER, SpanKind.CONSUMER)); + } +} 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..a98517b68f3c 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,7 +5,9 @@ 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 static org.mockito.Mockito.when; import io.opentelemetry.instrumentation.api.instrumenter.SpanNameExtractor; @@ -26,32 +28,96 @@ class MessagingSpanNameExtractorTest { @MethodSource("spanNameParams") void shouldExtractSpanName( boolean isTemporaryQueue, + boolean isAnonymousQueue, String destinationName, + String destinationTemplate, MessageOperation operation, - String expectedSpanName) { + 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.create(getter, operation, operationName); // when - String spanName = underTest.extract(message); + String actualSpanName = underTest.extract(message); // then - assertThat(spanName).isEqualTo(expectedSpanName); + assertThat(actualSpanName).isEqualTo(emitStableMessagingSemconv() ? spanName : oldSpanName); } 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, + MessageOperation.PUBLISH, + "send", + "destination publish", + "send destination"), + argumentSet( + "temporary destination", + true, + false, + "generated", + null, + MessageOperation.PROCESS, + "process", + "(temporary) process", + "process"), + argumentSet( + "missing destination", + false, + false, + null, + null, + MessageOperation.RECEIVE, + "receive", + "unknown receive", + "receive"), + argumentSet( + "destination template", + false, + false, + "customer-42", + "customer-{id}", + MessageOperation.PUBLISH, + "send", + "customer-42 publish", + "send customer-{id}"), + argumentSet( + "anonymous destination", + false, + true, + "generated", + null, + MessageOperation.PROCESS, + "process", + "generated process", + "process")); } static class Message {} 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..bd6935a2817d 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 @@ -173,6 +173,10 @@ public static boolean emitOldMessagingSemconv() { return emitOldMessagingSemconv; } + /** + * Returns whether the selected v1 experimental messaging semantic conventions should be emitted. + * The method name is retained for 2.x compatibility with other semconv selectors. + */ public static boolean emitStableMessagingSemconv() { return emitStableMessagingSemconv; } 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/kafka/kafka-clients/kafka-clients-0.11/javaagent/src/test/java/io/opentelemetry/javaagent/instrumentation/kafkaclients/v0_11/KafkaClientDefaultTest.java b/instrumentation/kafka/kafka-clients/kafka-clients-0.11/javaagent/src/test/java/io/opentelemetry/javaagent/instrumentation/kafkaclients/v0_11/KafkaClientDefaultTest.java index fbcb2b086025..ea8055f306e1 100644 --- a/instrumentation/kafka/kafka-clients/kafka-clients-0.11/javaagent/src/test/java/io/opentelemetry/javaagent/instrumentation/kafkaclients/v0_11/KafkaClientDefaultTest.java +++ b/instrumentation/kafka/kafka-clients/kafka-clients-0.11/javaagent/src/test/java/io/opentelemetry/javaagent/instrumentation/kafkaclients/v0_11/KafkaClientDefaultTest.java @@ -5,6 +5,7 @@ package io.opentelemetry.javaagent.instrumentation.kafkaclients.v0_11; +import static io.opentelemetry.instrumentation.api.internal.SemconvStability.emitStableMessagingSemconv; import static io.opentelemetry.instrumentation.testing.util.TelemetryDataUtil.orderByRootSpanKind; import static io.opentelemetry.sdk.testing.assertj.OpenTelemetryAssertions.assertThat; import static java.nio.charset.StandardCharsets.UTF_8; @@ -82,7 +83,10 @@ void testKafkaProducerAndConsumerSpan(boolean testHeaders) throws Exception { trace.hasSpansSatisfyingExactly( span -> span.hasName("parent").hasKind(SpanKind.INTERNAL).hasNoParent(), span -> - span.hasName(SHARED_TOPIC + " publish") + span.hasName( + emitStableMessagingSemconv() + ? "publish " + SHARED_TOPIC + : SHARED_TOPIC + " publish") .hasKind(SpanKind.PRODUCER) .hasParent(trace.getSpan(0)) .hasAttributesSatisfyingExactly(sendAttributes("10", greeting, testHeaders)), @@ -95,12 +99,18 @@ void testKafkaProducerAndConsumerSpan(boolean testHeaders) throws Exception { trace -> trace.hasSpansSatisfyingExactly( span -> - span.hasName(SHARED_TOPIC + " receive") + span.hasName( + emitStableMessagingSemconv() + ? "receive " + SHARED_TOPIC + : SHARED_TOPIC + " receive") .hasKind(SpanKind.CONSUMER) .hasNoParent() .hasAttributesSatisfyingExactly(receiveAttributes(testHeaders)), span -> - span.hasName(SHARED_TOPIC + " process") + span.hasName( + emitStableMessagingSemconv() + ? "process " + SHARED_TOPIC + : SHARED_TOPIC + " process") .hasKind(SpanKind.CONSUMER) .hasLinks(LinkData.create(producerSpan.get().getSpanContext())) .hasParent(trace.getSpan(0)) @@ -129,7 +139,10 @@ void testPassThroughTombstone() throws Exception { trace -> { trace.hasSpansSatisfyingExactly( span -> - span.hasName(SHARED_TOPIC + " publish") + span.hasName( + emitStableMessagingSemconv() + ? "publish " + SHARED_TOPIC + : SHARED_TOPIC + " publish") .hasKind(SpanKind.PRODUCER) .hasNoParent() .hasAttributesSatisfyingExactly(sendAttributes(null, null, false))); @@ -138,12 +151,18 @@ void testPassThroughTombstone() throws Exception { trace -> trace.hasSpansSatisfyingExactly( span -> - span.hasName(SHARED_TOPIC + " receive") + span.hasName( + emitStableMessagingSemconv() + ? "receive " + SHARED_TOPIC + : SHARED_TOPIC + " receive") .hasKind(SpanKind.CONSUMER) .hasNoParent() .hasAttributesSatisfyingExactly(receiveAttributes(false)), span -> - span.hasName(SHARED_TOPIC + " process") + span.hasName( + emitStableMessagingSemconv() + ? "process " + SHARED_TOPIC + : SHARED_TOPIC + " process") .hasKind(SpanKind.CONSUMER) .hasLinks(LinkData.create(producerSpan.get().getSpanContext())) .hasParent(trace.getSpan(0)) @@ -188,7 +207,10 @@ void testRecordsWithTopicPartitionKafkaConsume(boolean testListIterator) throws trace -> { trace.hasSpansSatisfyingExactly( span -> - span.hasName(SHARED_TOPIC + " publish") + span.hasName( + emitStableMessagingSemconv() + ? "publish " + SHARED_TOPIC + : SHARED_TOPIC + " publish") .hasKind(SpanKind.PRODUCER) .hasNoParent() .hasAttributesSatisfyingExactly(sendAttributes(null, greeting, false))); @@ -197,12 +219,18 @@ void testRecordsWithTopicPartitionKafkaConsume(boolean testListIterator) throws trace -> trace.hasSpansSatisfyingExactly( span -> - span.hasName(SHARED_TOPIC + " receive") + span.hasName( + emitStableMessagingSemconv() + ? "receive " + SHARED_TOPIC + : SHARED_TOPIC + " receive") .hasKind(SpanKind.CONSUMER) .hasNoParent() .hasAttributesSatisfyingExactly(receiveAttributes(false)), span -> - span.hasName(SHARED_TOPIC + " process") + span.hasName( + emitStableMessagingSemconv() + ? "process " + SHARED_TOPIC + : SHARED_TOPIC + " process") .hasKind(SpanKind.CONSUMER) .hasLinks(LinkData.create(producerSpan.get().getSpanContext())) .hasParent(trace.getSpan(0)) @@ -253,7 +281,10 @@ void testKafkaHeaderNull() throws Exception { trace.hasSpansSatisfyingExactly( span -> span.hasName("parent").hasKind(SpanKind.INTERNAL).hasNoParent(), span -> - span.hasName(SHARED_TOPIC + " publish") + span.hasName( + emitStableMessagingSemconv() + ? "publish " + SHARED_TOPIC + : SHARED_TOPIC + " publish") .hasKind(SpanKind.PRODUCER) .hasParent(trace.getSpan(0)) .hasAttributesSatisfyingExactly(sendAttributes("10", greeting, false)), @@ -266,12 +297,18 @@ void testKafkaHeaderNull() throws Exception { trace -> trace.hasSpansSatisfyingExactly( span -> - span.hasName(SHARED_TOPIC + " receive") + span.hasName( + emitStableMessagingSemconv() + ? "receive " + SHARED_TOPIC + : SHARED_TOPIC + " receive") .hasKind(SpanKind.CONSUMER) .hasNoParent() .hasAttributesSatisfyingExactly(receiveAttributes(false)), span -> - span.hasName(SHARED_TOPIC + " process") + span.hasName( + emitStableMessagingSemconv() + ? "process " + SHARED_TOPIC + : SHARED_TOPIC + " process") .hasKind(SpanKind.CONSUMER) .hasLinks(LinkData.create(producerSpan.get().getSpanContext())) .hasParent(trace.getSpan(0)) diff --git a/instrumentation/kafka/kafka-clients/kafka-clients-0.11/testing/src/main/java/io/opentelemetry/instrumentation/kafkaclients/common/v0_11/internal/KafkaClientBaseTest.java b/instrumentation/kafka/kafka-clients/kafka-clients-0.11/testing/src/main/java/io/opentelemetry/instrumentation/kafkaclients/common/v0_11/internal/KafkaClientBaseTest.java index 8dde894d4afd..32ffc0518ad4 100644 --- a/instrumentation/kafka/kafka-clients/kafka-clients-0.11/testing/src/main/java/io/opentelemetry/instrumentation/kafkaclients/common/v0_11/internal/KafkaClientBaseTest.java +++ b/instrumentation/kafka/kafka-clients/kafka-clients-0.11/testing/src/main/java/io/opentelemetry/instrumentation/kafkaclients/common/v0_11/internal/KafkaClientBaseTest.java @@ -23,6 +23,8 @@ import static io.opentelemetry.semconv.incubating.MessagingIncubatingAttributes.MESSAGING_KAFKA_OFFSET; import static io.opentelemetry.semconv.incubating.MessagingIncubatingAttributes.MESSAGING_MESSAGE_BODY_SIZE; 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.nio.charset.StandardCharsets.UTF_8; import static java.util.Arrays.asList; @@ -74,8 +76,10 @@ public abstract class KafkaClientBaseTest { @RegisterExtension final AutoCleanupExtension cleanup = AutoCleanupExtension.create(); protected static final String SHARED_TOPIC = "shared.topic"; - protected static final AttributeKey MESSAGING_CLIENT_ID = + protected 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 KafkaContainer kafka; protected Producer producer; @@ -181,8 +185,12 @@ protected static List sendAttributes( asList( equalTo(MESSAGING_SYSTEM, "kafka"), equalTo(MESSAGING_DESTINATION_NAME, SHARED_TOPIC), - equalTo(MESSAGING_OPERATION, "publish"), - satisfies(MESSAGING_CLIENT_ID, val -> val.startsWith("producer")), + equalTo(MESSAGING_OPERATION, emitOldMessagingSemconv() ? "publish" : null), + equalTo(MESSAGING_OPERATION_NAME, emitStableMessagingSemconv() ? "publish" : null), + equalTo(MESSAGING_OPERATION_TYPE, emitStableMessagingSemconv() ? "send" : null), + satisfies( + emitStableMessagingSemconv() ? MESSAGING_CLIENT_ID : MESSAGING_CLIENT_ID_OLD, + val -> val.startsWith("producer")), satisfies(MESSAGING_DESTINATION_PARTITION_ID, AbstractStringAssert::isNotEmpty))); if (emitOldMessagingSemconv()) { assertions.add(satisfies(MESSAGING_KAFKA_MESSAGE_OFFSET, AbstractLongAssert::isNotNegative)); @@ -215,8 +223,12 @@ protected static List receiveAttributes(boolean testHeaders) asList( equalTo(MESSAGING_SYSTEM, "kafka"), equalTo(MESSAGING_DESTINATION_NAME, SHARED_TOPIC), - equalTo(MESSAGING_OPERATION, "receive"), - satisfies(MESSAGING_CLIENT_ID, val -> val.startsWith("consumer")), + equalTo(MESSAGING_OPERATION, emitOldMessagingSemconv() ? "receive" : null), + equalTo(MESSAGING_OPERATION_NAME, emitStableMessagingSemconv() ? "receive" : null), + equalTo(MESSAGING_OPERATION_TYPE, emitStableMessagingSemconv() ? "receive" : null), + satisfies( + emitStableMessagingSemconv() ? MESSAGING_CLIENT_ID : MESSAGING_CLIENT_ID_OLD, + val -> val.startsWith("consumer")), satisfies(MESSAGING_BATCH_MESSAGE_COUNT, AbstractLongAssert::isPositive))); // consumer group is not available in version 0.11 if (testLatestDeps()) { @@ -236,8 +248,12 @@ protected static List processAttributes( asList( equalTo(MESSAGING_SYSTEM, "kafka"), equalTo(MESSAGING_DESTINATION_NAME, SHARED_TOPIC), - equalTo(MESSAGING_OPERATION, "process"), - satisfies(MESSAGING_CLIENT_ID, val -> val.startsWith("consumer")), + equalTo(MESSAGING_OPERATION, emitOldMessagingSemconv() ? "process" : null), + equalTo(MESSAGING_OPERATION_NAME, emitStableMessagingSemconv() ? "process" : null), + equalTo(MESSAGING_OPERATION_TYPE, emitStableMessagingSemconv() ? "process" : null), + satisfies( + emitStableMessagingSemconv() ? MESSAGING_CLIENT_ID : MESSAGING_CLIENT_ID_OLD, + val -> val.startsWith("consumer")), satisfies(MESSAGING_DESTINATION_PARTITION_ID, AbstractStringAssert::isNotEmpty))); if (EXPERIMENTAL_ATTRIBUTES) { assertions.add( diff --git a/instrumentation/kafka/kafka-clients/kafka-clients-2.6/library/src/test/java/io/opentelemetry/instrumentation/kafkaclients/v2_6/AbstractInterceptorsTest.java b/instrumentation/kafka/kafka-clients/kafka-clients-2.6/library/src/test/java/io/opentelemetry/instrumentation/kafkaclients/v2_6/AbstractInterceptorsTest.java index a62c8e475f19..31d5f1a5b0e0 100644 --- a/instrumentation/kafka/kafka-clients/kafka-clients-2.6/library/src/test/java/io/opentelemetry/instrumentation/kafkaclients/v2_6/AbstractInterceptorsTest.java +++ b/instrumentation/kafka/kafka-clients/kafka-clients-2.6/library/src/test/java/io/opentelemetry/instrumentation/kafkaclients/v2_6/AbstractInterceptorsTest.java @@ -164,7 +164,7 @@ private static List publishAttributes(boolean experimental) equalTo(MESSAGING_SYSTEM, "kafka"), equalTo(MESSAGING_DESTINATION_NAME, SHARED_TOPIC), equalTo(MESSAGING_OPERATION, "publish"), - satisfies(MESSAGING_CLIENT_ID, val -> val.startsWith("producer")), + satisfies(MESSAGING_CLIENT_ID_OLD, val -> val.startsWith("producer")), satisfies( stringKey("messaging.kafka.bootstrap.servers"), val -> { @@ -181,7 +181,7 @@ private static List receiveAttributes() { equalTo(MESSAGING_DESTINATION_NAME, SHARED_TOPIC), equalTo(MESSAGING_OPERATION, "receive"), equalTo(MESSAGING_KAFKA_CONSUMER_GROUP, "test"), - satisfies(MESSAGING_CLIENT_ID, val -> val.startsWith("consumer")), + satisfies(MESSAGING_CLIENT_ID_OLD, val -> val.startsWith("consumer")), equalTo(MESSAGING_BATCH_MESSAGE_COUNT, 1)); } @@ -195,7 +195,7 @@ private static List processAttributes(boolean experimental) satisfies(MESSAGING_DESTINATION_PARTITION_ID, AbstractStringAssert::isNotEmpty), satisfies(MESSAGING_KAFKA_MESSAGE_OFFSET, AbstractLongAssert::isNotNegative), equalTo(MESSAGING_KAFKA_CONSUMER_GROUP, "test"), - satisfies(MESSAGING_CLIENT_ID, val -> val.startsWith("consumer")), + satisfies(MESSAGING_CLIENT_ID_OLD, val -> val.startsWith("consumer")), satisfies( longKey("kafka.record.queue_time_ms"), val -> { diff --git a/instrumentation/kafka/kafka-clients/kafka-clients-2.6/library/src/test/java/io/opentelemetry/instrumentation/kafkaclients/v2_6/InterceptorsSuppressReceiveSpansTest.java b/instrumentation/kafka/kafka-clients/kafka-clients-2.6/library/src/test/java/io/opentelemetry/instrumentation/kafkaclients/v2_6/InterceptorsSuppressReceiveSpansTest.java index 8555895bd51c..dd5082d33c26 100644 --- a/instrumentation/kafka/kafka-clients/kafka-clients-2.6/library/src/test/java/io/opentelemetry/instrumentation/kafkaclients/v2_6/InterceptorsSuppressReceiveSpansTest.java +++ b/instrumentation/kafka/kafka-clients/kafka-clients-2.6/library/src/test/java/io/opentelemetry/instrumentation/kafkaclients/v2_6/InterceptorsSuppressReceiveSpansTest.java @@ -51,7 +51,7 @@ void assertTraces() { equalTo(MESSAGING_SYSTEM, "kafka"), equalTo(MESSAGING_DESTINATION_NAME, SHARED_TOPIC), equalTo(MESSAGING_OPERATION, "publish"), - satisfies(MESSAGING_CLIENT_ID, val -> val.startsWith("producer"))), + satisfies(MESSAGING_CLIENT_ID_OLD, val -> val.startsWith("producer"))), span -> span.hasName(SHARED_TOPIC + " process") .hasKind(SpanKind.CONSUMER) @@ -67,7 +67,7 @@ void assertTraces() { satisfies( MESSAGING_KAFKA_MESSAGE_OFFSET, AbstractLongAssert::isNotNegative), equalTo(MESSAGING_KAFKA_CONSUMER_GROUP, "test"), - satisfies(MESSAGING_CLIENT_ID, val -> val.startsWith("consumer")), + satisfies(MESSAGING_CLIENT_ID_OLD, val -> val.startsWith("consumer")), equalTo(stringKey("test-baggage-key-1"), "test-baggage-value-1"), equalTo(stringKey("test-baggage-key-2"), "test-baggage-value-2")), span -> diff --git a/instrumentation/kafka/kafka-clients/kafka-clients-2.6/library/src/test/java/io/opentelemetry/instrumentation/kafkaclients/v2_6/WrapperSuppressReceiveSpansTest.java b/instrumentation/kafka/kafka-clients/kafka-clients-2.6/library/src/test/java/io/opentelemetry/instrumentation/kafkaclients/v2_6/WrapperSuppressReceiveSpansTest.java index a549ce1aa7f4..efb45c1dd6b5 100644 --- a/instrumentation/kafka/kafka-clients/kafka-clients-2.6/library/src/test/java/io/opentelemetry/instrumentation/kafkaclients/v2_6/WrapperSuppressReceiveSpansTest.java +++ b/instrumentation/kafka/kafka-clients/kafka-clients-2.6/library/src/test/java/io/opentelemetry/instrumentation/kafkaclients/v2_6/WrapperSuppressReceiveSpansTest.java @@ -71,7 +71,7 @@ static List sendAttributes(boolean testHeaders, boolean test equalTo(MESSAGING_SYSTEM, "kafka"), equalTo(MESSAGING_DESTINATION_NAME, SHARED_TOPIC), equalTo(MESSAGING_OPERATION, "publish"), - satisfies(MESSAGING_CLIENT_ID, val -> val.startsWith("producer")), + satisfies(MESSAGING_CLIENT_ID_OLD, val -> val.startsWith("producer")), satisfies(MESSAGING_DESTINATION_PARTITION_ID, AbstractStringAssert::isNotEmpty), satisfies(MESSAGING_KAFKA_MESSAGE_OFFSET, AbstractLongAssert::isNotNegative))); if (testHeaders) { @@ -98,7 +98,7 @@ static List processAttributes( satisfies(MESSAGING_DESTINATION_PARTITION_ID, AbstractStringAssert::isNotEmpty), satisfies(MESSAGING_KAFKA_MESSAGE_OFFSET, AbstractLongAssert::isNotNegative), equalTo(MESSAGING_KAFKA_CONSUMER_GROUP, "test"), - satisfies(MESSAGING_CLIENT_ID, val -> val.startsWith("consumer")))); + satisfies(MESSAGING_CLIENT_ID_OLD, val -> val.startsWith("consumer")))); if (testHeaders) { assertions.add(equalTo(headerAttributeKey("Test-Message-Header"), singletonList("test"))); } diff --git a/instrumentation/kafka/kafka-clients/kafka-clients-2.6/library/src/test/java/io/opentelemetry/instrumentation/kafkaclients/v2_6/WrapperTest.java b/instrumentation/kafka/kafka-clients/kafka-clients-2.6/library/src/test/java/io/opentelemetry/instrumentation/kafkaclients/v2_6/WrapperTest.java index c9f784651554..45e22fcf8e1e 100644 --- a/instrumentation/kafka/kafka-clients/kafka-clients-2.6/library/src/test/java/io/opentelemetry/instrumentation/kafkaclients/v2_6/WrapperTest.java +++ b/instrumentation/kafka/kafka-clients/kafka-clients-2.6/library/src/test/java/io/opentelemetry/instrumentation/kafkaclients/v2_6/WrapperTest.java @@ -106,7 +106,7 @@ protected static List sendAttributes( equalTo(MESSAGING_SYSTEM, "kafka"), equalTo(MESSAGING_DESTINATION_NAME, SHARED_TOPIC), equalTo(MESSAGING_OPERATION, "publish"), - satisfies(MESSAGING_CLIENT_ID, val -> val.startsWith("producer")), + satisfies(MESSAGING_CLIENT_ID_OLD, val -> val.startsWith("producer")), satisfies(MESSAGING_DESTINATION_PARTITION_ID, AbstractStringAssert::isNotEmpty), satisfies(MESSAGING_KAFKA_MESSAGE_OFFSET, AbstractLongAssert::isNotNegative))); if (testHeaders) { @@ -135,7 +135,7 @@ private static List processAttributes( satisfies(MESSAGING_DESTINATION_PARTITION_ID, AbstractStringAssert::isNotEmpty), satisfies(MESSAGING_KAFKA_MESSAGE_OFFSET, AbstractLongAssert::isNotNegative), equalTo(MESSAGING_KAFKA_CONSUMER_GROUP, "test"), - satisfies(MESSAGING_CLIENT_ID, val -> val.startsWith("consumer")))); + satisfies(MESSAGING_CLIENT_ID_OLD, val -> val.startsWith("consumer")))); if (testHeaders) { assertions.add( equalTo( @@ -156,7 +156,7 @@ protected static List receiveAttributes(boolean testHeaders) equalTo(MESSAGING_DESTINATION_NAME, SHARED_TOPIC), equalTo(MESSAGING_OPERATION, "receive"), equalTo(MESSAGING_KAFKA_CONSUMER_GROUP, "test"), - satisfies(MESSAGING_CLIENT_ID, val -> val.startsWith("consumer")), + satisfies(MESSAGING_CLIENT_ID_OLD, val -> val.startsWith("consumer")), equalTo(MESSAGING_BATCH_MESSAGE_COUNT, 1))); if (testHeaders) { assertions.add( diff --git a/instrumentation/pulsar/pulsar-2.8/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/pulsar/v2_8/telemetry/PulsarSingletons.java b/instrumentation/pulsar/pulsar-2.8/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/pulsar/v2_8/telemetry/PulsarSingletons.java index 4cd04c0a4a32..d235b487720d 100644 --- a/instrumentation/pulsar/pulsar-2.8/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/pulsar/v2_8/telemetry/PulsarSingletons.java +++ b/instrumentation/pulsar/pulsar-2.8/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/pulsar/v2_8/telemetry/PulsarSingletons.java @@ -19,6 +19,7 @@ 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.MessagingConsumerMetrics; +import io.opentelemetry.instrumentation.api.incubator.semconv.messaging.MessagingProcessMetrics; import io.opentelemetry.instrumentation.api.incubator.semconv.messaging.MessagingProducerMetrics; import io.opentelemetry.instrumentation.api.incubator.semconv.messaging.MessagingSpanNameExtractor; import io.opentelemetry.instrumentation.api.instrumenter.AttributesExtractor; @@ -122,7 +123,8 @@ private static Instrumenter createConsumerProcessInstrument INSTRUMENTATION_NAME, MessagingSpanNameExtractor.create(getter, MessageOperation.PROCESS)) .addAttributesExtractor( - createMessagingAttributesExtractor(getter, MessageOperation.PROCESS)); + createMessagingAttributesExtractor(getter, MessageOperation.PROCESS)) + .addOperationMetrics(MessagingProcessMetrics.get()); setMessagingProcessExceptionEventExtractor(instrumenterBuilder); if (receiveInstrumentationEnabled) { From 49704b0305bb7354be820e494f06deceb7ff60d3 Mon Sep 17 00:00:00 2001 From: Trask Stalnaker Date: Thu, 16 Jul 2026 15:57:05 -0700 Subject: [PATCH 2/4] Address review comment from trask --- .../semconv/messaging/MessageOperation.java | 14 ++++- .../MessagingAttributesExtractor.java | 45 ++++++++++------ .../MessagingAttributesExtractorBuilder.java | 18 +++---- .../messaging/MessagingConsumerMetrics.java | 3 ++ .../semconv/messaging/MessagingOperation.java | 54 ------------------- .../messaging/MessagingSpanKindExtractor.java | 2 +- .../messaging/MessagingSpanNameExtractor.java | 25 +++++---- .../MessagingAttributesExtractorTest.java | 5 +- .../MessagingProcessMetricsTest.java | 2 +- .../api/internal/SemconvStability.java | 11 ++-- .../v0_11/internal/KafkaClientBaseTest.java | 17 ++---- .../v2_6/AbstractInterceptorsTest.java | 6 +-- .../InterceptorsSuppressReceiveSpansTest.java | 4 +- .../v2_6/WrapperSuppressReceiveSpansTest.java | 4 +- .../kafkaclients/v2_6/WrapperTest.java | 6 +-- .../pulsar-2.8/javaagent/build.gradle.kts | 16 +++++- .../pulsar/v2_8/AbstractPulsarClientTest.java | 2 +- .../pulsar/v2_8/PulsarClientTest.java | 26 +++++++++ .../SemconvMessagingStabilityUtil.java | 36 +++++++++++++ 19 files changed, 170 insertions(+), 126 deletions(-) delete mode 100644 instrumentation-api-incubator/src/main/java/io/opentelemetry/instrumentation/api/incubator/semconv/messaging/MessagingOperation.java create mode 100644 testing-common/src/main/java/io/opentelemetry/instrumentation/testing/junit/message/SemconvMessagingStabilityUtil.java 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 ef87253e22a1..e2d3ffccdb16 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 @@ -21,7 +21,19 @@ public enum MessageOperation { * Returns the legacy operation name. The v1.43 operation name defaults to this value unless an * instrumentation supplies a system-specific override. */ - String operationName() { + String legacyOperationName() { return name().toLowerCase(Locale.ROOT); } + + String operationType() { + switch (this) { + case PUBLISH: + return "send"; + case RECEIVE: + return "receive"; + case PROCESS: + return "process"; + } + throw new IllegalStateException("Can't possibly happen"); + } } 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 b93a5abb734d..bfed16beb2e3 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 @@ -8,6 +8,7 @@ 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.Objects.requireNonNull; import io.opentelemetry.api.common.AttributeKey; import io.opentelemetry.api.common.AttributesBuilder; @@ -71,8 +72,9 @@ public final class MessagingAttributesExtractor * with default configuration. */ public static AttributesExtractor create( - MessagingAttributesGetter getter, @Nullable MessageOperation operation) { - return builder(getter, operation).build(); + MessagingAttributesGetter getter, + @Nullable MessageOperation messageOperation) { + return builder(getter, messageOperation).build(); } /** @@ -83,9 +85,9 @@ public static AttributesExtractor create( */ public static AttributesExtractor create( MessagingAttributesGetter getter, - MessageOperation operation, + MessageOperation messageOperation, String operationName) { - return builder(getter, operation, operationName).build(); + return builder(getter, messageOperation, operationName).build(); } /** @@ -93,8 +95,12 @@ public static AttributesExtractor create( * operation} that can be used to configure the messaging attributes extractor. */ public static MessagingAttributesExtractorBuilder builder( - MessagingAttributesGetter getter, @Nullable MessageOperation operation) { - return new MessagingAttributesExtractorBuilder<>(getter, operation); + MessagingAttributesGetter getter, + @Nullable MessageOperation messageOperation) { + return new MessagingAttributesExtractorBuilder<>( + getter, + messageOperation, + messageOperation == null ? null : messageOperation.legacyOperationName()); } /** @@ -103,22 +109,27 @@ public static MessagingAttributesExtractorBuilder MessagingAttributesExtractorBuilder builder( MessagingAttributesGetter getter, - MessageOperation operation, + MessageOperation messageOperation, String operationName) { return new MessagingAttributesExtractorBuilder<>( - getter, MessagingOperation.create(operation, operationName)); + getter, + requireNonNull(messageOperation, "messageOperation"), + requireNonNull(operationName, "operationName")); } private final MessagingAttributesGetter getter; - @Nullable private final MessagingOperation operation; + @Nullable private final MessageOperation messageOperation; + @Nullable private final String operationName; private final List capturedHeaders; MessagingAttributesExtractor( MessagingAttributesGetter getter, - @Nullable MessagingOperation operation, + @Nullable MessageOperation messageOperation, + @Nullable String operationName, List capturedHeaders) { this.getter = getter; - this.operation = operation; + this.messageOperation = messageOperation; + this.operationName = operationName; this.capturedHeaders = new ArrayList<>(capturedHeaders); } @@ -152,13 +163,13 @@ public void onStart(AttributesBuilder attributes, Context parentContext, REQUEST if (emitStableMessagingSemconv()) { attributes.put(MESSAGING_CLIENT_ID, getter.getClientId(request)); } - if (operation != null) { + if (messageOperation != null) { if (emitOldMessagingSemconv()) { - attributes.put(MESSAGING_OPERATION, operation.operation().operationName()); + attributes.put(MESSAGING_OPERATION, messageOperation.legacyOperationName()); } if (emitStableMessagingSemconv()) { - attributes.put(MESSAGING_OPERATION_NAME, operation.name()); - attributes.put(MESSAGING_OPERATION_TYPE, operation.type()); + attributes.put(MESSAGING_OPERATION_NAME, operationName); + attributes.put(MESSAGING_OPERATION_TYPE, messageOperation.operationType()); } } } @@ -191,11 +202,11 @@ public void onEnd( @Override @Nullable public SpanKey internalGetSpanKey() { - if (operation == null) { + if (messageOperation == null) { return null; } - switch (operation.operation()) { + switch (messageOperation) { case PUBLISH: return SpanKey.PRODUCER; case RECEIVE: 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 fc1035e91389..67ef5906e7eb 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 @@ -18,18 +18,17 @@ public final class MessagingAttributesExtractorBuilder { final MessagingAttributesGetter getter; - @Nullable final MessagingOperation operation; + @Nullable final MessageOperation messageOperation; + @Nullable final String operationName; List capturedHeaders = emptyList(); MessagingAttributesExtractorBuilder( - MessagingAttributesGetter getter, @Nullable MessageOperation operation) { - this(getter, MessagingOperation.createNullable(operation)); - } - - MessagingAttributesExtractorBuilder( - MessagingAttributesGetter getter, @Nullable MessagingOperation operation) { + MessagingAttributesGetter getter, + @Nullable MessageOperation messageOperation, + @Nullable String operationName) { this.getter = getter; - this.operation = operation; + this.messageOperation = messageOperation; + this.operationName = operationName; } /** @@ -53,6 +52,7 @@ public MessagingAttributesExtractorBuilder setCapturedHeaders * MessagingAttributesExtractorBuilder}. */ public AttributesExtractor build() { - return new MessagingAttributesExtractor<>(getter, operation, capturedHeaders); + return new MessagingAttributesExtractor<>( + getter, messageOperation, operationName, capturedHeaders); } } 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 f642643e8c67..16358c158261 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 @@ -84,6 +84,9 @@ public void onEnd(Context context, Attributes endAttributes, long endNanos) { if (receiveDurationHistogram != null) { 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) diff --git a/instrumentation-api-incubator/src/main/java/io/opentelemetry/instrumentation/api/incubator/semconv/messaging/MessagingOperation.java b/instrumentation-api-incubator/src/main/java/io/opentelemetry/instrumentation/api/incubator/semconv/messaging/MessagingOperation.java deleted file mode 100644 index 3c1d763d9261..000000000000 --- a/instrumentation-api-incubator/src/main/java/io/opentelemetry/instrumentation/api/incubator/semconv/messaging/MessagingOperation.java +++ /dev/null @@ -1,54 +0,0 @@ -/* - * 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 javax.annotation.Nullable; - -final class MessagingOperation { - - static MessagingOperation create(MessageOperation operation) { - return create(operation, operation.operationName()); - } - - static MessagingOperation create(MessageOperation operation, String name) { - return new MessagingOperation(operation, name); - } - - @Nullable - static MessagingOperation createNullable(@Nullable MessageOperation operation) { - return operation == null ? null : create(operation, operation.operationName()); - } - - private final MessageOperation operation; - private final String name; - - private MessagingOperation(MessageOperation operation, String name) { - this.operation = requireNonNull(operation, "operation"); - this.name = requireNonNull(name, "name"); - } - - MessageOperation operation() { - return operation; - } - - String name() { - return name; - } - - String type() { - switch (operation) { - case PUBLISH: - return "send"; - case RECEIVE: - return "receive"; - case PROCESS: - return "process"; - } - throw new IllegalStateException("Can't possibly happen"); - } -} 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 index 5372abd194e1..4de6aa855b8a 100644 --- 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 @@ -16,7 +16,7 @@ public final class MessagingSpanKindExtractor { /** * Returns a span kind extractor following the v1.43 - * messaging span kind conventions when latest messaging conventions are enabled. + * messaging span kind conventions. */ public static SpanKindExtractor create(MessageOperation operation) { SpanKind spanKind; 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 ec6f5fa4e56c..0214fd3fc23f 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 @@ -6,6 +6,7 @@ package io.opentelemetry.instrumentation.api.incubator.semconv.messaging; import static io.opentelemetry.instrumentation.api.internal.SemconvStability.emitStableMessagingSemconv; +import static java.util.Objects.requireNonNull; import io.opentelemetry.instrumentation.api.instrumenter.SpanNameExtractor; @@ -21,26 +22,30 @@ public final class MessagingSpanNameExtractor implements SpanNameExtrac * @see MessageOperation used to extract {@code }. */ public static SpanNameExtractor create( - MessagingAttributesGetter getter, MessageOperation operation) { - return new MessagingSpanNameExtractor<>(getter, MessagingOperation.create(operation)); + MessagingAttributesGetter getter, MessageOperation messageOperation) { + return new MessagingSpanNameExtractor<>( + getter, messageOperation, messageOperation.legacyOperationName()); } /** Returns a {@link SpanNameExtractor} with a system-specific v1.43 operation name. */ public static SpanNameExtractor create( MessagingAttributesGetter getter, - MessageOperation operation, + MessageOperation messageOperation, String operationName) { - return new MessagingSpanNameExtractor<>( - getter, MessagingOperation.create(operation, operationName)); + return new MessagingSpanNameExtractor<>(getter, messageOperation, operationName); } private final MessagingAttributesGetter getter; - private final MessagingOperation operation; + private final MessageOperation messageOperation; + private final String operationName; private MessagingSpanNameExtractor( - MessagingAttributesGetter getter, MessagingOperation operation) { + MessagingAttributesGetter getter, + MessageOperation messageOperation, + String operationName) { this.getter = getter; - this.operation = operation; + this.messageOperation = requireNonNull(messageOperation, "messageOperation"); + this.operationName = requireNonNull(operationName, "operationName"); } @Override @@ -52,7 +57,7 @@ public String extract(REQUEST request) { && !getter.isAnonymousDestination(request)) { destinationName = getter.getDestination(request); } - return destinationName == null ? operation.name() : operation.name() + " " + destinationName; + return destinationName == null ? operationName : operationName + " " + destinationName; } String destinationName = @@ -63,6 +68,6 @@ public String extract(REQUEST request) { destinationName = "unknown"; } - return destinationName + " " + operation.operation().operationName(); + return destinationName + " " + messageOperation.legacyOperationName(); } } 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 41dfc31371ec..30418f464171 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 @@ -109,13 +109,12 @@ void shouldExtractAllAvailableAttributes( expectedEntries.add(entry(MESSAGING_MESSAGE_ENVELOPE_SIZE, 120L)); if (emitOldMessagingSemconv()) { expectedEntries.add(entry(stringKey("messaging.client_id"), "43")); - expectedEntries.add(entry(MESSAGING_OPERATION, operation.operationName())); + expectedEntries.add(entry(MESSAGING_OPERATION, operation.legacyOperationName())); } if (emitStableMessagingSemconv()) { expectedEntries.add(entry(stringKey("messaging.client.id"), "43")); expectedEntries.add(entry(MESSAGING_OPERATION_NAME, operationName)); - expectedEntries.add( - entry(MESSAGING_OPERATION_TYPE, MessagingOperation.create(operation).type())); + expectedEntries.add(entry(MESSAGING_OPERATION_TYPE, operation.operationType())); } @SuppressWarnings({"unchecked", "rawtypes"}) 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 index 1f2d32d82b71..19b20b4888e6 100644 --- 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 @@ -32,7 +32,7 @@ class MessagingProcessMetricsTest { @Test @SuppressWarnings("deprecation") // using deprecated semconv - void emitsOnlyLatestProcessDuration() { + void emitsProcessDurationAccordingToConfiguration() { InMemoryMetricReader metricReader = InMemoryMetricReader.createDelta(); SdkMeterProvider meterProvider = SdkMeterProvider.builder().registerMetricReader(metricReader).build(); 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 bd6935a2817d..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,15 +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; } - /** - * Returns whether the selected v1 experimental messaging semantic conventions should be emitted. - * The method name is retained for 2.x compatibility with other semconv selectors. - */ - 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/kafka/kafka-clients/kafka-clients-0.11/testing/src/main/java/io/opentelemetry/instrumentation/kafkaclients/common/v0_11/internal/KafkaClientBaseTest.java b/instrumentation/kafka/kafka-clients/kafka-clients-0.11/testing/src/main/java/io/opentelemetry/instrumentation/kafkaclients/common/v0_11/internal/KafkaClientBaseTest.java index 32ffc0518ad4..c6a8301f571e 100644 --- a/instrumentation/kafka/kafka-clients/kafka-clients-0.11/testing/src/main/java/io/opentelemetry/instrumentation/kafkaclients/common/v0_11/internal/KafkaClientBaseTest.java +++ b/instrumentation/kafka/kafka-clients/kafka-clients-0.11/testing/src/main/java/io/opentelemetry/instrumentation/kafkaclients/common/v0_11/internal/KafkaClientBaseTest.java @@ -10,6 +10,7 @@ import static io.opentelemetry.instrumentation.api.internal.SemconvStability.emitOldMessagingSemconv; import static io.opentelemetry.instrumentation.api.internal.SemconvStability.emitStableMessagingSemconv; import static io.opentelemetry.instrumentation.testing.junit.message.MessageHeaderUtil.headerAttributeKey; +import static io.opentelemetry.instrumentation.testing.junit.message.SemconvMessagingStabilityUtil.effectiveKey; import static io.opentelemetry.instrumentation.testing.util.TestLatestDeps.testLatestDeps; import static io.opentelemetry.sdk.testing.assertj.OpenTelemetryAssertions.equalTo; import static io.opentelemetry.sdk.testing.assertj.OpenTelemetryAssertions.satisfies; @@ -76,10 +77,8 @@ public abstract class KafkaClientBaseTest { @RegisterExtension final AutoCleanupExtension cleanup = AutoCleanupExtension.create(); protected static final String SHARED_TOPIC = "shared.topic"; - protected static final AttributeKey MESSAGING_CLIENT_ID_OLD = + protected static final AttributeKey MESSAGING_CLIENT_ID = AttributeKey.stringKey("messaging.client_id"); - private static final AttributeKey MESSAGING_CLIENT_ID = - AttributeKey.stringKey("messaging.client.id"); private KafkaContainer kafka; protected Producer producer; @@ -188,9 +187,7 @@ protected static List sendAttributes( equalTo(MESSAGING_OPERATION, emitOldMessagingSemconv() ? "publish" : null), equalTo(MESSAGING_OPERATION_NAME, emitStableMessagingSemconv() ? "publish" : null), equalTo(MESSAGING_OPERATION_TYPE, emitStableMessagingSemconv() ? "send" : null), - satisfies( - emitStableMessagingSemconv() ? MESSAGING_CLIENT_ID : MESSAGING_CLIENT_ID_OLD, - val -> val.startsWith("producer")), + satisfies(effectiveKey(MESSAGING_CLIENT_ID), val -> val.startsWith("producer")), satisfies(MESSAGING_DESTINATION_PARTITION_ID, AbstractStringAssert::isNotEmpty))); if (emitOldMessagingSemconv()) { assertions.add(satisfies(MESSAGING_KAFKA_MESSAGE_OFFSET, AbstractLongAssert::isNotNegative)); @@ -226,9 +223,7 @@ protected static List receiveAttributes(boolean testHeaders) equalTo(MESSAGING_OPERATION, emitOldMessagingSemconv() ? "receive" : null), equalTo(MESSAGING_OPERATION_NAME, emitStableMessagingSemconv() ? "receive" : null), equalTo(MESSAGING_OPERATION_TYPE, emitStableMessagingSemconv() ? "receive" : null), - satisfies( - emitStableMessagingSemconv() ? MESSAGING_CLIENT_ID : MESSAGING_CLIENT_ID_OLD, - val -> val.startsWith("consumer")), + satisfies(effectiveKey(MESSAGING_CLIENT_ID), val -> val.startsWith("consumer")), satisfies(MESSAGING_BATCH_MESSAGE_COUNT, AbstractLongAssert::isPositive))); // consumer group is not available in version 0.11 if (testLatestDeps()) { @@ -251,9 +246,7 @@ protected static List processAttributes( equalTo(MESSAGING_OPERATION, emitOldMessagingSemconv() ? "process" : null), equalTo(MESSAGING_OPERATION_NAME, emitStableMessagingSemconv() ? "process" : null), equalTo(MESSAGING_OPERATION_TYPE, emitStableMessagingSemconv() ? "process" : null), - satisfies( - emitStableMessagingSemconv() ? MESSAGING_CLIENT_ID : MESSAGING_CLIENT_ID_OLD, - val -> val.startsWith("consumer")), + satisfies(effectiveKey(MESSAGING_CLIENT_ID), val -> val.startsWith("consumer")), satisfies(MESSAGING_DESTINATION_PARTITION_ID, AbstractStringAssert::isNotEmpty))); if (EXPERIMENTAL_ATTRIBUTES) { assertions.add( diff --git a/instrumentation/kafka/kafka-clients/kafka-clients-2.6/library/src/test/java/io/opentelemetry/instrumentation/kafkaclients/v2_6/AbstractInterceptorsTest.java b/instrumentation/kafka/kafka-clients/kafka-clients-2.6/library/src/test/java/io/opentelemetry/instrumentation/kafkaclients/v2_6/AbstractInterceptorsTest.java index 31d5f1a5b0e0..a62c8e475f19 100644 --- a/instrumentation/kafka/kafka-clients/kafka-clients-2.6/library/src/test/java/io/opentelemetry/instrumentation/kafkaclients/v2_6/AbstractInterceptorsTest.java +++ b/instrumentation/kafka/kafka-clients/kafka-clients-2.6/library/src/test/java/io/opentelemetry/instrumentation/kafkaclients/v2_6/AbstractInterceptorsTest.java @@ -164,7 +164,7 @@ private static List publishAttributes(boolean experimental) equalTo(MESSAGING_SYSTEM, "kafka"), equalTo(MESSAGING_DESTINATION_NAME, SHARED_TOPIC), equalTo(MESSAGING_OPERATION, "publish"), - satisfies(MESSAGING_CLIENT_ID_OLD, val -> val.startsWith("producer")), + satisfies(MESSAGING_CLIENT_ID, val -> val.startsWith("producer")), satisfies( stringKey("messaging.kafka.bootstrap.servers"), val -> { @@ -181,7 +181,7 @@ private static List receiveAttributes() { equalTo(MESSAGING_DESTINATION_NAME, SHARED_TOPIC), equalTo(MESSAGING_OPERATION, "receive"), equalTo(MESSAGING_KAFKA_CONSUMER_GROUP, "test"), - satisfies(MESSAGING_CLIENT_ID_OLD, val -> val.startsWith("consumer")), + satisfies(MESSAGING_CLIENT_ID, val -> val.startsWith("consumer")), equalTo(MESSAGING_BATCH_MESSAGE_COUNT, 1)); } @@ -195,7 +195,7 @@ private static List processAttributes(boolean experimental) satisfies(MESSAGING_DESTINATION_PARTITION_ID, AbstractStringAssert::isNotEmpty), satisfies(MESSAGING_KAFKA_MESSAGE_OFFSET, AbstractLongAssert::isNotNegative), equalTo(MESSAGING_KAFKA_CONSUMER_GROUP, "test"), - satisfies(MESSAGING_CLIENT_ID_OLD, val -> val.startsWith("consumer")), + satisfies(MESSAGING_CLIENT_ID, val -> val.startsWith("consumer")), satisfies( longKey("kafka.record.queue_time_ms"), val -> { diff --git a/instrumentation/kafka/kafka-clients/kafka-clients-2.6/library/src/test/java/io/opentelemetry/instrumentation/kafkaclients/v2_6/InterceptorsSuppressReceiveSpansTest.java b/instrumentation/kafka/kafka-clients/kafka-clients-2.6/library/src/test/java/io/opentelemetry/instrumentation/kafkaclients/v2_6/InterceptorsSuppressReceiveSpansTest.java index dd5082d33c26..8555895bd51c 100644 --- a/instrumentation/kafka/kafka-clients/kafka-clients-2.6/library/src/test/java/io/opentelemetry/instrumentation/kafkaclients/v2_6/InterceptorsSuppressReceiveSpansTest.java +++ b/instrumentation/kafka/kafka-clients/kafka-clients-2.6/library/src/test/java/io/opentelemetry/instrumentation/kafkaclients/v2_6/InterceptorsSuppressReceiveSpansTest.java @@ -51,7 +51,7 @@ void assertTraces() { equalTo(MESSAGING_SYSTEM, "kafka"), equalTo(MESSAGING_DESTINATION_NAME, SHARED_TOPIC), equalTo(MESSAGING_OPERATION, "publish"), - satisfies(MESSAGING_CLIENT_ID_OLD, val -> val.startsWith("producer"))), + satisfies(MESSAGING_CLIENT_ID, val -> val.startsWith("producer"))), span -> span.hasName(SHARED_TOPIC + " process") .hasKind(SpanKind.CONSUMER) @@ -67,7 +67,7 @@ void assertTraces() { satisfies( MESSAGING_KAFKA_MESSAGE_OFFSET, AbstractLongAssert::isNotNegative), equalTo(MESSAGING_KAFKA_CONSUMER_GROUP, "test"), - satisfies(MESSAGING_CLIENT_ID_OLD, val -> val.startsWith("consumer")), + satisfies(MESSAGING_CLIENT_ID, val -> val.startsWith("consumer")), equalTo(stringKey("test-baggage-key-1"), "test-baggage-value-1"), equalTo(stringKey("test-baggage-key-2"), "test-baggage-value-2")), span -> diff --git a/instrumentation/kafka/kafka-clients/kafka-clients-2.6/library/src/test/java/io/opentelemetry/instrumentation/kafkaclients/v2_6/WrapperSuppressReceiveSpansTest.java b/instrumentation/kafka/kafka-clients/kafka-clients-2.6/library/src/test/java/io/opentelemetry/instrumentation/kafkaclients/v2_6/WrapperSuppressReceiveSpansTest.java index efb45c1dd6b5..a549ce1aa7f4 100644 --- a/instrumentation/kafka/kafka-clients/kafka-clients-2.6/library/src/test/java/io/opentelemetry/instrumentation/kafkaclients/v2_6/WrapperSuppressReceiveSpansTest.java +++ b/instrumentation/kafka/kafka-clients/kafka-clients-2.6/library/src/test/java/io/opentelemetry/instrumentation/kafkaclients/v2_6/WrapperSuppressReceiveSpansTest.java @@ -71,7 +71,7 @@ static List sendAttributes(boolean testHeaders, boolean test equalTo(MESSAGING_SYSTEM, "kafka"), equalTo(MESSAGING_DESTINATION_NAME, SHARED_TOPIC), equalTo(MESSAGING_OPERATION, "publish"), - satisfies(MESSAGING_CLIENT_ID_OLD, val -> val.startsWith("producer")), + satisfies(MESSAGING_CLIENT_ID, val -> val.startsWith("producer")), satisfies(MESSAGING_DESTINATION_PARTITION_ID, AbstractStringAssert::isNotEmpty), satisfies(MESSAGING_KAFKA_MESSAGE_OFFSET, AbstractLongAssert::isNotNegative))); if (testHeaders) { @@ -98,7 +98,7 @@ static List processAttributes( satisfies(MESSAGING_DESTINATION_PARTITION_ID, AbstractStringAssert::isNotEmpty), satisfies(MESSAGING_KAFKA_MESSAGE_OFFSET, AbstractLongAssert::isNotNegative), equalTo(MESSAGING_KAFKA_CONSUMER_GROUP, "test"), - satisfies(MESSAGING_CLIENT_ID_OLD, val -> val.startsWith("consumer")))); + satisfies(MESSAGING_CLIENT_ID, val -> val.startsWith("consumer")))); if (testHeaders) { assertions.add(equalTo(headerAttributeKey("Test-Message-Header"), singletonList("test"))); } diff --git a/instrumentation/kafka/kafka-clients/kafka-clients-2.6/library/src/test/java/io/opentelemetry/instrumentation/kafkaclients/v2_6/WrapperTest.java b/instrumentation/kafka/kafka-clients/kafka-clients-2.6/library/src/test/java/io/opentelemetry/instrumentation/kafkaclients/v2_6/WrapperTest.java index 45e22fcf8e1e..c9f784651554 100644 --- a/instrumentation/kafka/kafka-clients/kafka-clients-2.6/library/src/test/java/io/opentelemetry/instrumentation/kafkaclients/v2_6/WrapperTest.java +++ b/instrumentation/kafka/kafka-clients/kafka-clients-2.6/library/src/test/java/io/opentelemetry/instrumentation/kafkaclients/v2_6/WrapperTest.java @@ -106,7 +106,7 @@ protected static List sendAttributes( equalTo(MESSAGING_SYSTEM, "kafka"), equalTo(MESSAGING_DESTINATION_NAME, SHARED_TOPIC), equalTo(MESSAGING_OPERATION, "publish"), - satisfies(MESSAGING_CLIENT_ID_OLD, val -> val.startsWith("producer")), + satisfies(MESSAGING_CLIENT_ID, val -> val.startsWith("producer")), satisfies(MESSAGING_DESTINATION_PARTITION_ID, AbstractStringAssert::isNotEmpty), satisfies(MESSAGING_KAFKA_MESSAGE_OFFSET, AbstractLongAssert::isNotNegative))); if (testHeaders) { @@ -135,7 +135,7 @@ private static List processAttributes( satisfies(MESSAGING_DESTINATION_PARTITION_ID, AbstractStringAssert::isNotEmpty), satisfies(MESSAGING_KAFKA_MESSAGE_OFFSET, AbstractLongAssert::isNotNegative), equalTo(MESSAGING_KAFKA_CONSUMER_GROUP, "test"), - satisfies(MESSAGING_CLIENT_ID_OLD, val -> val.startsWith("consumer")))); + satisfies(MESSAGING_CLIENT_ID, val -> val.startsWith("consumer")))); if (testHeaders) { assertions.add( equalTo( @@ -156,7 +156,7 @@ protected static List receiveAttributes(boolean testHeaders) equalTo(MESSAGING_DESTINATION_NAME, SHARED_TOPIC), equalTo(MESSAGING_OPERATION, "receive"), equalTo(MESSAGING_KAFKA_CONSUMER_GROUP, "test"), - satisfies(MESSAGING_CLIENT_ID_OLD, val -> val.startsWith("consumer")), + satisfies(MESSAGING_CLIENT_ID, val -> val.startsWith("consumer")), equalTo(MESSAGING_BATCH_MESSAGE_COUNT, 1))); if (testHeaders) { assertions.add( diff --git a/instrumentation/pulsar/pulsar-2.8/javaagent/build.gradle.kts b/instrumentation/pulsar/pulsar-2.8/javaagent/build.gradle.kts index 5bcbd464c1c0..2d027dc7745b 100644 --- a/instrumentation/pulsar/pulsar-2.8/javaagent/build.gradle.kts +++ b/instrumentation/pulsar/pulsar-2.8/javaagent/build.gradle.kts @@ -48,6 +48,20 @@ tasks { systemProperty("metadataConfig", "otel.instrumentation.pulsar.experimental-span-attributes=true") } + // The task name follows the existing pattern; it does not indicate that the messaging + // conventions are stable. + val testStableSemconv = register("testStableSemconv") { + testClassesDirs = sourceSets.test.get().output.classesDirs + classpath = sourceSets.test.get().runtimeClasspath + filter { + includeTestsMatching("PulsarClientTest.testConsumeNonPartitionedTopic") + } + jvmArgs("-Dotel.instrumentation.messaging.experimental.receive-telemetry.enabled=true") + jvmArgs("-Dotel.semconv-stability.preview=messaging") + jvmArgs("-Dotel.instrumentation.common.v3-preview=true") + systemProperty("metadataConfig", "otel.semconv-stability.opt-in=messaging") + } + test { filter { excludeTestsMatching("PulsarClientSuppressReceiveSpansTest") @@ -60,7 +74,7 @@ tasks { } check { - dependsOn(testReceiveSpanDisabled, testExperimental) + dependsOn(testReceiveSpanDisabled, testExperimental, testStableSemconv) } if (otelProps.denyUnsafe) { diff --git a/instrumentation/pulsar/pulsar-2.8/javaagent/src/test/java/io/opentelemetry/javaagent/instrumentation/pulsar/v2_8/AbstractPulsarClientTest.java b/instrumentation/pulsar/pulsar-2.8/javaagent/src/test/java/io/opentelemetry/javaagent/instrumentation/pulsar/v2_8/AbstractPulsarClientTest.java index 083ceac22210..26ce8f5b6d36 100644 --- a/instrumentation/pulsar/pulsar-2.8/javaagent/src/test/java/io/opentelemetry/javaagent/instrumentation/pulsar/v2_8/AbstractPulsarClientTest.java +++ b/instrumentation/pulsar/pulsar-2.8/javaagent/src/test/java/io/opentelemetry/javaagent/instrumentation/pulsar/v2_8/AbstractPulsarClientTest.java @@ -67,7 +67,7 @@ static T experimental(T value) { private static final Logger logger = LoggerFactory.getLogger(AbstractPulsarClientTest.class); - private static final String INSTRUMENTATION_NAME = "io.opentelemetry.pulsar-2.8"; + static final String INSTRUMENTATION_NAME = "io.opentelemetry.pulsar-2.8"; private static final DockerImageName DEFAULT_IMAGE_NAME = DockerImageName.parse("apachepulsar/pulsar:2.8.0"); diff --git a/instrumentation/pulsar/pulsar-2.8/javaagent/src/test/java/io/opentelemetry/javaagent/instrumentation/pulsar/v2_8/PulsarClientTest.java b/instrumentation/pulsar/pulsar-2.8/javaagent/src/test/java/io/opentelemetry/javaagent/instrumentation/pulsar/v2_8/PulsarClientTest.java index 9d3603afa177..3199f39a9680 100644 --- a/instrumentation/pulsar/pulsar-2.8/javaagent/src/test/java/io/opentelemetry/javaagent/instrumentation/pulsar/v2_8/PulsarClientTest.java +++ b/instrumentation/pulsar/pulsar-2.8/javaagent/src/test/java/io/opentelemetry/javaagent/instrumentation/pulsar/v2_8/PulsarClientTest.java @@ -5,6 +5,7 @@ package io.opentelemetry.javaagent.instrumentation.pulsar.v2_8; +import static io.opentelemetry.instrumentation.api.internal.SemconvStability.emitStableMessagingSemconv; import static io.opentelemetry.instrumentation.testing.util.TelemetryDataUtil.orderByRootSpanKind; import static io.opentelemetry.instrumentation.testing.util.TelemetryDataUtil.orderByRootSpanName; import static io.opentelemetry.sdk.testing.assertj.OpenTelemetryAssertions.assertThat; @@ -13,6 +14,7 @@ import static io.opentelemetry.semconv.ServerAttributes.SERVER_PORT; import static io.opentelemetry.semconv.incubating.MessagingIncubatingAttributes.MESSAGING_DESTINATION_NAME; import static io.opentelemetry.semconv.incubating.MessagingIncubatingAttributes.MESSAGING_OPERATION; +import static io.opentelemetry.semconv.incubating.MessagingIncubatingAttributes.MESSAGING_OPERATION_NAME; import static io.opentelemetry.semconv.incubating.MessagingIncubatingAttributes.MESSAGING_SYSTEM; import static java.util.Arrays.asList; import static java.util.concurrent.TimeUnit.MINUTES; @@ -63,6 +65,30 @@ void testConsumeNonPartitionedTopic() throws Exception { latch.await(1, MINUTES); + if (emitStableMessagingSemconv()) { + testing.waitAndAssertMetrics( + INSTRUMENTATION_NAME, + "messaging.process.duration", + metrics -> + metrics.satisfiesExactly( + metric -> + assertThat(metric) + .hasUnit("s") + .hasDescription("Duration of processing operation.") + .hasHistogramSatisfying( + histogram -> + histogram.hasPointsSatisfying( + point -> + point + .hasSumGreaterThan(0.0) + .hasAttributesSatisfyingExactly( + equalTo(MESSAGING_OPERATION_NAME, "process"), + equalTo(MESSAGING_SYSTEM, "pulsar"), + equalTo(MESSAGING_DESTINATION_NAME, topic)) + .hasBucketBoundaries(DURATION_BUCKETS))))); + return; + } + AtomicReference producerSpan = new AtomicReference<>(); testing.waitAndAssertSortedTraces( orderByRootSpanKind(SpanKind.INTERNAL, SpanKind.CONSUMER), 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..1da1081527d8 --- /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.get(oldKey); + } + return oldKey; + } + + private SemconvMessagingStabilityUtil() {} +} From fd4f3284dbb9d51614a4bb70b0258166d7b3dbff Mon Sep 17 00:00:00 2001 From: Trask Stalnaker Date: Thu, 16 Jul 2026 18:11:01 -0700 Subject: [PATCH 3/4] Address more review comments from trask --- CHANGELOG.md | 2 + .../semconv/messaging/MessageOperation.java | 37 ++---- .../MessagingAttributesExtractor.java | 86 ++++++------ .../MessagingAttributesExtractorBuilder.java | 22 +++- .../messaging/MessagingAttributesGetter.java | 15 +++ .../messaging/MessagingConsumerMetrics.java | 23 ++-- .../messaging/MessagingOperationType.java | 35 +++++ .../messaging/MessagingSpanKindExtractor.java | 36 ++++- .../messaging/MessagingSpanNameExtractor.java | 51 ++++--- .../MessagingSpanNameExtractorBuilder.java | 41 ++++++ .../MessagingAttributesExtractorTest.java | 124 ++++++++++++++++-- .../MessagingSpanKindExtractorTest.java | 42 +++++- .../MessagingSpanNameExtractorTest.java | 16 ++- .../instrumentation/api/internal/SpanKey.java | 6 + .../internal/AwsSdkInstrumenterFactory.java | 24 ++-- .../internal/AwsSdkInstrumenterFactory.java | 24 ++-- .../common/v1_1/JmsInstrumenterFactory.java | 24 ++-- .../internal/KafkaInstrumenterFactory.java | 30 ++--- .../v2_6/KafkaConnectSingletons.java | 6 +- .../internal/NatsInstrumenterFactory.java | 10 +- .../v2_8/telemetry/PulsarSingletons.java | 22 ++-- .../rabbitmq/v2_7/RabbitSingletons.java | 13 +- .../v4_8/RocketMqInstrumenterFactory.java | 18 +-- ...ocketMqConsumerProcessAttributeGetter.java | 7 + .../v5_0/RocketMqInstrumenterFactory.java | 24 ++-- .../SpringIntegrationTelemetryBuilder.java | 10 +- .../pulsar/v1_0/SpringPulsarSingletons.java | 8 +- .../rabbit/v1_0/SpringRabbitSingletons.java | 8 +- 28 files changed, 527 insertions(+), 237 deletions(-) create mode 100644 instrumentation-api-incubator/src/main/java/io/opentelemetry/instrumentation/api/incubator/semconv/messaging/MessagingOperationType.java create mode 100644 instrumentation-api-incubator/src/main/java/io/opentelemetry/instrumentation/api/incubator/semconv/messaging/MessagingSpanNameExtractorBuilder.java diff --git a/CHANGELOG.md b/CHANGELOG.md index aa7a222aa6ea..4d926d16ac1d 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,6 +4,8 @@ ### 🚫 Deprecations +- Deprecate `MessageOperation` in favor of `MessagingOperationType`. + ([#19233](https://github.com/open-telemetry/opentelemetry-java-instrumentation/pull/19233)) - Deprecate `DeclarativeConfigPropertiesBridgeBuilder`. Read declarative component configuration through `DeclarativeConfigProperties` directly. To expose `ConfigProperties` through the declarative configuration API, use `ConfigPropertiesBackedConfigProvider`. 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 e2d3ffccdb16..43dd28e2834f 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,35 +5,24 @@ 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. + * + * @deprecated Use {@link MessagingOperationType}. Will be removed in 3.0. */ +@Deprecated // to be removed in 3.0 public enum MessageOperation { - PUBLISH, - RECEIVE, - PROCESS; + PUBLISH(MessagingOperationType.SEND), + RECEIVE(MessagingOperationType.RECEIVE), + PROCESS(MessagingOperationType.PROCESS); + + private final MessagingOperationType operationType; - /** - * Returns the legacy operation name. The v1.43 operation name defaults to this value unless an - * instrumentation supplies a system-specific override. - */ - String legacyOperationName() { - return name().toLowerCase(Locale.ROOT); + MessageOperation(MessagingOperationType operationType) { + this.operationType = operationType; } - String operationType() { - switch (this) { - case PUBLISH: - return "send"; - case RECEIVE: - return "receive"; - case PROCESS: - return "process"; - } - throw new IllegalStateException("Can't possibly happen"); + 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 bfed16beb2e3..4a26f57d3fc5 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 @@ -8,7 +8,6 @@ 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.Objects.requireNonNull; import io.opentelemetry.api.common.AttributeKey; import io.opentelemetry.api.common.AttributesBuilder; @@ -67,68 +66,55 @@ public final class MessagingAttributesExtractor 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 create( MessagingAttributesGetter getter, - @Nullable MessageOperation messageOperation) { - return builder(getter, messageOperation).build(); + @Nullable MessagingOperationType operationType) { + return builder(getter, operationType).build(); } /** - * Creates the messaging attributes extractor with a system-specific v1.43 operation name. - * - *

The {@code operationName} is emitted as {@code messaging.operation.name}. The legacy {@code - * messaging.operation} value remains derived from {@code operation}. + * @deprecated Use {@link #create(MessagingAttributesGetter, MessagingOperationType)}. Will be + * removed in 3.0. */ + @Deprecated // to be removed in 3.0 public static AttributesExtractor create( - MessagingAttributesGetter getter, - MessageOperation messageOperation, - String operationName) { - return builder(getter, messageOperation, operationName).build(); + MessagingAttributesGetter getter, @Nullable MessageOperation operation) { + return create(getter, operation == null ? null : operation.type()); } /** - * 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 builder( MessagingAttributesGetter getter, - @Nullable MessageOperation messageOperation) { - return new MessagingAttributesExtractorBuilder<>( - getter, - messageOperation, - messageOperation == null ? null : messageOperation.legacyOperationName()); + @Nullable MessagingOperationType operationType) { + return new MessagingAttributesExtractorBuilder<>(getter, operationType); } /** - * Returns a new {@link MessagingAttributesExtractorBuilder} with a system-specific v1.43 - * operation name. + * @deprecated Use {@link #builder(MessagingAttributesGetter, MessagingOperationType)}. Will be + * removed in 3.0. */ + @Deprecated // to be removed in 3.0 public static MessagingAttributesExtractorBuilder builder( - MessagingAttributesGetter getter, - MessageOperation messageOperation, - String operationName) { - return new MessagingAttributesExtractorBuilder<>( - getter, - requireNonNull(messageOperation, "messageOperation"), - requireNonNull(operationName, "operationName")); + MessagingAttributesGetter getter, @Nullable MessageOperation operation) { + return builder(getter, operation == null ? null : operation.type()); } private final MessagingAttributesGetter getter; - @Nullable private final MessageOperation messageOperation; + @Nullable private final MessagingOperationType operationType; @Nullable private final String operationName; private final List capturedHeaders; MessagingAttributesExtractor( MessagingAttributesGetter getter, - @Nullable MessageOperation messageOperation, + @Nullable MessagingOperationType operationType, @Nullable String operationName, List capturedHeaders) { this.getter = getter; - this.messageOperation = messageOperation; + this.operationType = operationType; this.operationName = operationName; this.capturedHeaders = new ArrayList<>(capturedHeaders); } @@ -163,13 +149,13 @@ public void onStart(AttributesBuilder attributes, Context parentContext, REQUEST if (emitStableMessagingSemconv()) { attributes.put(MESSAGING_CLIENT_ID, getter.getClientId(request)); } - if (messageOperation != null) { - if (emitOldMessagingSemconv()) { - attributes.put(MESSAGING_OPERATION, messageOperation.legacyOperationName()); - } - if (emitStableMessagingSemconv()) { - attributes.put(MESSAGING_OPERATION_NAME, operationName); - attributes.put(MESSAGING_OPERATION_TYPE, messageOperation.operationType()); + if (emitOldMessagingSemconv() && operationType != null) { + attributes.put(MESSAGING_OPERATION, operationType.defaultOperationName()); + } + if (emitStableMessagingSemconv()) { + attributes.put(MESSAGING_OPERATION_NAME, operationName); + if (operationType != null) { + attributes.put(MESSAGING_OPERATION_TYPE, operationType.value()); } } } @@ -183,8 +169,12 @@ 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 (emitStableMessagingSemconv() && error != null) { - attributes.put(ERROR_TYPE, error.getClass().getName()); + if (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) { @@ -202,17 +192,21 @@ public void onEnd( @Override @Nullable public SpanKey internalGetSpanKey() { - if (messageOperation == null) { + if (operationType == null) { return null; } - switch (messageOperation) { - 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 67ef5906e7eb..1055863eda52 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,6 +6,7 @@ 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; @@ -18,17 +19,24 @@ public final class MessagingAttributesExtractorBuilder { final MessagingAttributesGetter getter; - @Nullable final MessageOperation messageOperation; - @Nullable final String operationName; + @Nullable MessagingOperationType operationType; + @Nullable String operationName; List capturedHeaders = emptyList(); MessagingAttributesExtractorBuilder( MessagingAttributesGetter getter, - @Nullable MessageOperation messageOperation, - @Nullable String operationName) { + @Nullable MessagingOperationType operationType) { this.getter = getter; - this.messageOperation = messageOperation; - this.operationName = operationName; + this.operationType = operationType; + this.operationName = operationType == null ? null : operationType.defaultOperationName(); + } + + /** Configures the system-specific operation name emitted as {@code messaging.operation.name}. */ + @CanIgnoreReturnValue + public MessagingAttributesExtractorBuilder setOperationName( + String operationName) { + this.operationName = requireNonNull(operationName, "operationName"); + return this; } /** @@ -53,6 +61,6 @@ public MessagingAttributesExtractorBuilder setCapturedHeaders */ public AttributesExtractor build() { return new MessagingAttributesExtractor<>( - getter, messageOperation, operationName, capturedHeaders); + getter, operationType, operationName, 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 16358c158261..2329d65776db 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 @@ -95,31 +95,34 @@ public void onEnd(Context context, Attributes endAttributes, long endNanos) { clientOperationDurationHistogram.record(duration, filteredAttributes, context); } - long receiveMessagesCount = getReceiveMessagesCount(state.startAttributes(), endAttributes); + Long batchMessageCount = getBatchMessageCount(state.startAttributes(), endAttributes); if (receiveMessageCount != null) { - receiveMessageCount.add(receiveMessagesCount, attributes, context); + receiveMessageCount.add( + batchMessageCount == null ? 1 : batchMessageCount, attributes, context); } if (consumedMessagesCounter != null) { consumedMessagesCounter.add( - getConsumedMessagesCount(attributes, receiveMessagesCount), filteredAttributes, context); + getConsumedMessagesCount(attributes, batchMessageCount), 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, long receiveMessagesCount) { - return attributes.get(MESSAGING_BATCH_MESSAGE_COUNT) == null - && attributes.get(ERROR_TYPE) != null - ? 0 - : receiveMessagesCount; + private static long getConsumedMessagesCount( + Attributes attributes, @Nullable Long batchMessageCount) { + if (batchMessageCount != null) { + return batchMessageCount; + } + return attributes.get(ERROR_TYPE) == null ? 1 : 0; } private static DoubleHistogram buildReceiveDuration(Meter meter) { 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/MessagingSpanKindExtractor.java b/instrumentation-api-incubator/src/main/java/io/opentelemetry/instrumentation/api/incubator/semconv/messaging/MessagingSpanKindExtractor.java index 4de6aa855b8a..3759bcd3e388 100644 --- 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 @@ -18,18 +18,40 @@ public final class MessagingSpanKindExtractor { * href="https://github.com/open-telemetry/semantic-conventions/blob/v1.43.0/docs/messaging/messaging-spans.md#span-kind">v1.43 * messaging span kind conventions. */ - public static SpanKindExtractor create(MessageOperation operation) { + 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 (operation) { - case PUBLISH: + 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"); } @@ -37,5 +59,13 @@ public static SpanKindExtractor create(MessageOperation opera return request -> result; } + /** + * @deprecated Use {@link #create(MessagingOperationType)}. Will be removed in 3.0. + */ + @Deprecated // to be removed in 3.0 + public static SpanKindExtractor create(MessageOperation operation) { + return create(operation.type()); + } + 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 0214fd3fc23f..3c56d08d475c 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 @@ -6,7 +6,6 @@ package io.opentelemetry.instrumentation.api.incubator.semconv.messaging; import static io.opentelemetry.instrumentation.api.internal.SemconvStability.emitStableMessagingSemconv; -import static java.util.Objects.requireNonNull; import io.opentelemetry.instrumentation.api.instrumenter.SpanNameExtractor; @@ -19,33 +18,53 @@ public final class MessagingSpanNameExtractor implements SpanNameExtrac * * @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, MessageOperation messageOperation) { - return new MessagingSpanNameExtractor<>( - getter, messageOperation, messageOperation.legacyOperationName()); + MessagingAttributesGetter getter, MessagingOperationType operationType) { + return builder(getter, operationType).build(); } - /** Returns a {@link SpanNameExtractor} with a system-specific v1.43 operation name. */ + /** + * @deprecated Use {@link #create(MessagingAttributesGetter, MessagingOperationType)}. Will be + * removed in 3.0. + */ + @Deprecated // to be removed in 3.0 public static SpanNameExtractor create( - MessagingAttributesGetter getter, - MessageOperation messageOperation, - String operationName) { - return new MessagingSpanNameExtractor<>(getter, messageOperation, operationName); + MessagingAttributesGetter getter, MessageOperation operation) { + return create(getter, operation.type()); + } + + /** + * 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); + } + + /** + * @deprecated Use {@link #builder(MessagingAttributesGetter, MessagingOperationType)}. Will be + * removed in 3.0. + */ + @Deprecated // to be removed in 3.0 + public static MessagingSpanNameExtractorBuilder builder( + MessagingAttributesGetter getter, MessageOperation operation) { + return builder(getter, operation.type()); } private final MessagingAttributesGetter getter; - private final MessageOperation messageOperation; + private final MessagingOperationType operationType; private final String operationName; - private MessagingSpanNameExtractor( + MessagingSpanNameExtractor( MessagingAttributesGetter getter, - MessageOperation messageOperation, + MessagingOperationType operationType, String operationName) { this.getter = getter; - this.messageOperation = requireNonNull(messageOperation, "messageOperation"); - this.operationName = requireNonNull(operationName, "operationName"); + this.operationType = operationType; + this.operationName = operationName; } @Override @@ -68,6 +87,6 @@ public String extract(REQUEST request) { destinationName = "unknown"; } - return destinationName + " " + messageOperation.legacyOperationName(); + 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..661c83ad173f --- /dev/null +++ b/instrumentation-api-incubator/src/main/java/io/opentelemetry/instrumentation/api/incubator/semconv/messaging/MessagingSpanNameExtractorBuilder.java @@ -0,0 +1,41 @@ +/* + * 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 String operationName; + + MessagingSpanNameExtractorBuilder( + MessagingAttributesGetter getter, MessagingOperationType operationType) { + this.getter = getter; + this.operationType = requireNonNull(operationType, "operationType"); + this.operationName = operationType.defaultOperationName(); + } + + /** Configures the system-specific operation name used in the v1.43 messaging span name. */ + @CanIgnoreReturnValue + public MessagingSpanNameExtractorBuilder setOperationName(String operationName) { + 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); + } +} 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 30418f464171..db89597abce6 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 @@ -32,6 +32,7 @@ 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; @@ -53,7 +54,7 @@ void shouldExtractAllAvailableAttributes( boolean temporary, boolean anonymous, String destination, - MessageOperation operation, + MessagingOperationType operationType, String operationName) { // given Map request = new HashMap<>(); @@ -69,13 +70,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, operationName); + MessagingAttributesExtractor.builder(TestGetter.INSTANCE, operationType) + .setOperationName(operationName) + .build(); Context context = Context.root(); @@ -109,12 +113,12 @@ void shouldExtractAllAvailableAttributes( expectedEntries.add(entry(MESSAGING_MESSAGE_ENVELOPE_SIZE, 120L)); if (emitOldMessagingSemconv()) { expectedEntries.add(entry(stringKey("messaging.client_id"), "43")); - expectedEntries.add(entry(MESSAGING_OPERATION, operation.legacyOperationName())); + 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, operation.operationType())); + expectedEntries.add(entry(MESSAGING_OPERATION_TYPE, operationType.value())); } @SuppressWarnings({"unchecked", "rawtypes"}) @@ -138,21 +142,118 @@ void shouldExtractAllAvailableAttributes( static Stream destinations() { return Stream.of( argumentSet( - "regular destination", false, false, "destination", MessageOperation.RECEIVE, "poll"), + "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", - MessageOperation.PROCESS, - "process")); + 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(), + 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(), emptyMap()); + + List, Object>> expectedEntries = new ArrayList<>(); + if (emitOldMessagingSemconv()) { + expectedEntries.add(entry(MESSAGING_OPERATION, "publish")); + } + if (emitStableMessagingSemconv()) { + expectedEntries.add(entry(MESSAGING_OPERATION_NAME, "publish")); + expectedEntries.add(entry(MESSAGING_OPERATION_TYPE, "send")); + } + @SuppressWarnings({"unchecked", "rawtypes"}) + MapEntry, ?>[] expectedEntriesArr = + expectedEntries.toArray(new MapEntry[0]); + assertThat(attributes.build()).containsOnly(expectedEntriesArr); + } + + @Test + void shouldExtractOperationNameWithoutOperationType() { + MessagingOperationType operationType = null; + AttributesExtractor, String> underTest = + MessagingAttributesExtractor.builder(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 shouldExtractErrorTypeFromResponse() { + MessagingOperationType operationType = null; + AttributesExtractor, String> underTest = + MessagingAttributesExtractor.create(TestGetter.INSTANCE, operationType); + + 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 void shouldExtractNoAttributesIfNoneAreAvailable() { // given + MessagingOperationType operationType = null; AttributesExtractor, String> underTest = - MessagingAttributesExtractor.create(TestGetter.INSTANCE, null); + MessagingAttributesExtractor.create(TestGetter.INSTANCE, operationType); Context context = Context.root(); @@ -219,7 +320,7 @@ public Long getMessageEnvelopeSize(Map request) { @Override public String getMessageId(Map request, String response) { - return response; + return request.get("messageId"); } @Nullable @@ -234,5 +335,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/MessagingSpanKindExtractorTest.java b/instrumentation-api-incubator/src/test/java/io/opentelemetry/instrumentation/api/incubator/semconv/messaging/MessagingSpanKindExtractorTest.java index 458a832a2f70..5ef04cd89bd9 100644 --- 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 @@ -11,6 +11,7 @@ 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; @@ -19,16 +20,47 @@ class MessagingSpanKindExtractorTest { @ParameterizedTest @MethodSource("spanKinds") - void extractsSpanKind(MessageOperation operation, SpanKind oldKind, SpanKind kind) { - SpanKind actualKind = MessagingSpanKindExtractor.create(operation).extract(new Object()); + 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); + } + private static Stream spanKinds() { return Stream.of( - argumentSet("publish", MessageOperation.PUBLISH, SpanKind.PRODUCER, SpanKind.PRODUCER), - argumentSet("receive", MessageOperation.RECEIVE, SpanKind.CONSUMER, SpanKind.CLIENT), - argumentSet("process", MessageOperation.PROCESS, SpanKind.CONSUMER, SpanKind.CONSUMER)); + 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 a98517b68f3c..088901a04894 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 @@ -31,7 +31,7 @@ void shouldExtractSpanName( boolean isAnonymousQueue, String destinationName, String destinationTemplate, - MessageOperation operation, + MessagingOperationType operationType, String operationName, String oldSpanName, String spanName) { @@ -57,7 +57,9 @@ void shouldExtractSpanName( } SpanNameExtractor underTest = - MessagingSpanNameExtractor.create(getter, operation, operationName); + MessagingSpanNameExtractor.builder(getter, operationType) + .setOperationName(operationName) + .build(); // when String actualSpanName = underTest.extract(message); @@ -74,7 +76,7 @@ static Stream spanNameParams() { false, "destination", null, - MessageOperation.PUBLISH, + MessagingOperationType.SEND, "send", "destination publish", "send destination"), @@ -84,7 +86,7 @@ static Stream spanNameParams() { false, "generated", null, - MessageOperation.PROCESS, + MessagingOperationType.PROCESS, "process", "(temporary) process", "process"), @@ -94,7 +96,7 @@ static Stream spanNameParams() { false, null, null, - MessageOperation.RECEIVE, + MessagingOperationType.RECEIVE, "receive", "unknown receive", "receive"), @@ -104,7 +106,7 @@ static Stream spanNameParams() { false, "customer-42", "customer-{id}", - MessageOperation.PUBLISH, + MessagingOperationType.SEND, "send", "customer-42 publish", "send customer-{id}"), @@ -114,7 +116,7 @@ static Stream spanNameParams() { true, "generated", null, - MessageOperation.PROCESS, + MessagingOperationType.PROCESS, "process", "generated process", "process")); 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/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..80f62466c5e3 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 @@ -20,9 +20,9 @@ import io.opentelemetry.api.trace.Span; 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.MessagingSpanNameExtractor; import io.opentelemetry.instrumentation.api.incubator.semconv.rpc.RpcClientAttributesExtractor; import io.opentelemetry.instrumentation.api.instrumenter.AttributesExtractor; @@ -96,21 +96,21 @@ private List, Response>> attributesExtractors( } private AttributesExtractor messagingAttributesExtractor( - MessagingAttributesGetter getter, MessageOperation operation) { - return MessagingAttributesExtractor.builder(getter, operation) + MessagingAttributesGetter getter, MessagingOperationType operationType) { + return MessagingAttributesExtractor.builder(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), + MessagingSpanNameExtractor.create(getter, operationType), SpanKindExtractor.alwaysConsumer(), toSqsRequestExtractors(attributesExtractors()), singletonList(messagingAttributeExtractor), @@ -119,16 +119,16 @@ public Instrumenter> consumerReceiveInstrumenter( } 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); @@ -173,14 +173,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-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..ccc56687f632 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 @@ -24,9 +24,9 @@ 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.MessagingSpanNameExtractor; import io.opentelemetry.instrumentation.api.incubator.semconv.rpc.RpcClientAttributesExtractor; import io.opentelemetry.instrumentation.api.instrumenter.AttributesExtractor; @@ -125,21 +125,21 @@ private List> consumerAttribu } private AttributesExtractor messagingAttributesExtractor( - MessagingAttributesGetter getter, MessageOperation operation) { - return MessagingAttributesExtractor.builder(getter, operation) + MessagingAttributesGetter getter, MessagingOperationType operationType) { + return MessagingAttributesExtractor.builder(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), + MessagingSpanNameExtractor.create(getter, operationType), SpanKindExtractor.alwaysConsumer(), toSqsRequestExtractors(consumerAttributesExtractors()), singletonList(messagingAttributeExtractor), @@ -148,16 +148,16 @@ public Instrumenter consumerReceiveInstrumenter() { } 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) { @@ -201,14 +201,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/jms/jms-common-1.1/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/jms/common/v1_1/JmsInstrumenterFactory.java b/instrumentation/jms/jms-common-1.1/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/jms/common/v1_1/JmsInstrumenterFactory.java index 21cd1f4b198b..9a2c9a23ef23 100644 --- a/instrumentation/jms/jms-common-1.1/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/jms/common/v1_1/JmsInstrumenterFactory.java +++ b/instrumentation/jms/jms-common-1.1/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/jms/common/v1_1/JmsInstrumenterFactory.java @@ -12,8 +12,8 @@ import com.google.errorprone.annotations.CanIgnoreReturnValue; import io.opentelemetry.api.OpenTelemetry; -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.MessagingOperationType; import io.opentelemetry.instrumentation.api.incubator.semconv.messaging.MessagingSpanNameExtractor; import io.opentelemetry.instrumentation.api.instrumenter.AttributesExtractor; import io.opentelemetry.instrumentation.api.instrumenter.Instrumenter; @@ -51,28 +51,28 @@ public JmsInstrumenterFactory setMessagingReceiveTelemetryEnabled( public Instrumenter createProducerInstrumenter() { JmsMessageAttributesGetter getter = new JmsMessageAttributesGetter(); - MessageOperation operation = MessageOperation.PUBLISH; + MessagingOperationType operationType = MessagingOperationType.SEND; InstrumenterBuilder builder = Instrumenter.builder( openTelemetry, instrumentationName, - MessagingSpanNameExtractor.create(getter, operation)) - .addAttributesExtractor(createMessagingAttributesExtractor(operation)); + MessagingSpanNameExtractor.create(getter, operationType)) + .addAttributesExtractor(createMessagingAttributesExtractor(operationType)); setMessagingSendExceptionEventExtractor(builder); return builder.buildProducerInstrumenter(new MessagePropertySetter()); } public Instrumenter createConsumerReceiveInstrumenter() { JmsMessageAttributesGetter getter = new JmsMessageAttributesGetter(); - MessageOperation operation = MessageOperation.RECEIVE; + MessagingOperationType operationType = MessagingOperationType.RECEIVE; InstrumenterBuilder builder = Instrumenter.builder( openTelemetry, instrumentationName, - MessagingSpanNameExtractor.create(getter, operation)) - .addAttributesExtractor(createMessagingAttributesExtractor(operation)); + MessagingSpanNameExtractor.create(getter, operationType)) + .addAttributesExtractor(createMessagingAttributesExtractor(operationType)); setMessagingReceiveExceptionEventExtractor(builder); if (messagingReceiveInstrumentationEnabled) { builder.addSpanLinksExtractor( @@ -86,14 +86,14 @@ public Instrumenter createConsumerReceiveInstrumen public Instrumenter createConsumerProcessInstrumenter( boolean canHaveReceiveInstrumentation) { JmsMessageAttributesGetter getter = new JmsMessageAttributesGetter(); - MessageOperation operation = MessageOperation.PROCESS; + MessagingOperationType operationType = MessagingOperationType.PROCESS; InstrumenterBuilder builder = Instrumenter.builder( openTelemetry, instrumentationName, - MessagingSpanNameExtractor.create(getter, operation)) - .addAttributesExtractor(createMessagingAttributesExtractor(operation)); + MessagingSpanNameExtractor.create(getter, operationType)) + .addAttributesExtractor(createMessagingAttributesExtractor(operationType)); setMessagingProcessExceptionEventExtractor(builder); if (canHaveReceiveInstrumentation && messagingReceiveInstrumentationEnabled) { builder.addSpanLinksExtractor( @@ -106,8 +106,8 @@ public Instrumenter createConsumerProcessInstrumen } private AttributesExtractor createMessagingAttributesExtractor( - MessageOperation operation) { - return MessagingAttributesExtractor.builder(new JmsMessageAttributesGetter(), operation) + MessagingOperationType operationType) { + return MessagingAttributesExtractor.builder(new JmsMessageAttributesGetter(), operationType) .setCapturedHeaders(capturedHeaders) .build(); } diff --git a/instrumentation/kafka/kafka-clients/kafka-clients-common-0.11/library/src/main/java/io/opentelemetry/instrumentation/kafkaclients/common/v0_11/internal/KafkaInstrumenterFactory.java b/instrumentation/kafka/kafka-clients/kafka-clients-common-0.11/library/src/main/java/io/opentelemetry/instrumentation/kafkaclients/common/v0_11/internal/KafkaInstrumenterFactory.java index 3a0654f4b34c..977f0ec3140f 100644 --- a/instrumentation/kafka/kafka-clients/kafka-clients-common-0.11/library/src/main/java/io/opentelemetry/instrumentation/kafkaclients/common/v0_11/internal/KafkaInstrumenterFactory.java +++ b/instrumentation/kafka/kafka-clients/kafka-clients-common-0.11/library/src/main/java/io/opentelemetry/instrumentation/kafkaclients/common/v0_11/internal/KafkaInstrumenterFactory.java @@ -12,9 +12,9 @@ import com.google.errorprone.annotations.CanIgnoreReturnValue; import io.opentelemetry.api.OpenTelemetry; -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.MessagingSpanNameExtractor; import io.opentelemetry.instrumentation.api.instrumenter.AttributesExtractor; import io.opentelemetry.instrumentation.api.instrumenter.ErrorCauseExtractor; @@ -79,15 +79,15 @@ public Instrumenter createProducerInstrume Iterable> extractors) { KafkaProducerAttributesGetter getter = new KafkaProducerAttributesGetter(); - MessageOperation operation = MessageOperation.PUBLISH; + MessagingOperationType operationType = MessagingOperationType.SEND; InstrumenterBuilder builder = Instrumenter.builder( openTelemetry, instrumentationName, - MessagingSpanNameExtractor.create(getter, operation)) + MessagingSpanNameExtractor.create(getter, operationType)) .addAttributesExtractor( - buildMessagingAttributesExtractor(getter, operation, capturedHeaders)) + buildMessagingAttributesExtractor(getter, operationType, capturedHeaders)) .addAttributesExtractors(extractors) .addAttributesExtractor(new KafkaProducerAttributesExtractor()) .setErrorCauseExtractor(errorCauseExtractor); @@ -105,15 +105,15 @@ public Instrumenter createConsumerReceiveInstrumenter public Instrumenter createConsumerReceiveInstrumenter( Iterable> extractors) { KafkaReceiveAttributesGetter getter = new KafkaReceiveAttributesGetter(); - MessageOperation operation = MessageOperation.RECEIVE; + MessagingOperationType operationType = MessagingOperationType.RECEIVE; InstrumenterBuilder builder = Instrumenter.builder( openTelemetry, instrumentationName, - MessagingSpanNameExtractor.create(getter, operation)) + MessagingSpanNameExtractor.create(getter, operationType)) .addAttributesExtractor( - buildMessagingAttributesExtractor(getter, operation, capturedHeaders)) + buildMessagingAttributesExtractor(getter, operationType, capturedHeaders)) .addAttributesExtractor(new KafkaReceiveAttributesExtractor()) .addAttributesExtractors(extractors) .setErrorCauseExtractor(errorCauseExtractor) @@ -129,15 +129,15 @@ public Instrumenter createConsumerProcessInstrumenter public Instrumenter createConsumerProcessInstrumenter( Iterable> extractors) { KafkaConsumerAttributesGetter getter = new KafkaConsumerAttributesGetter(); - MessageOperation operation = MessageOperation.PROCESS; + MessagingOperationType operationType = MessagingOperationType.PROCESS; InstrumenterBuilder builder = Instrumenter.builder( openTelemetry, instrumentationName, - MessagingSpanNameExtractor.create(getter, operation)) + MessagingSpanNameExtractor.create(getter, operationType)) .addAttributesExtractor( - buildMessagingAttributesExtractor(getter, operation, capturedHeaders)) + buildMessagingAttributesExtractor(getter, operationType, capturedHeaders)) .addAttributesExtractor(new KafkaConsumerAttributesExtractor()) .addAttributesExtractors(extractors) .setErrorCauseExtractor(errorCauseExtractor); @@ -159,15 +159,15 @@ public Instrumenter createConsumerProcessInstrumenter public Instrumenter createBatchProcessInstrumenter() { KafkaReceiveAttributesGetter getter = new KafkaReceiveAttributesGetter(); - MessageOperation operation = MessageOperation.PROCESS; + MessagingOperationType operationType = MessagingOperationType.PROCESS; InstrumenterBuilder builder = Instrumenter.builder( openTelemetry, instrumentationName, - MessagingSpanNameExtractor.create(getter, operation)) + MessagingSpanNameExtractor.create(getter, operationType)) .addAttributesExtractor( - buildMessagingAttributesExtractor(getter, operation, capturedHeaders)) + buildMessagingAttributesExtractor(getter, operationType, capturedHeaders)) .addAttributesExtractor(new KafkaReceiveAttributesExtractor()) .addSpanLinksExtractor( new KafkaBatchProcessSpanLinksExtractor( @@ -180,9 +180,9 @@ public Instrumenter createBatchProcessInstrumenter() private static AttributesExtractor buildMessagingAttributesExtractor( MessagingAttributesGetter getter, - MessageOperation operation, + MessagingOperationType operationType, List capturedHeaders) { - return MessagingAttributesExtractor.builder(getter, operation) + return MessagingAttributesExtractor.builder(getter, operationType) .setCapturedHeaders(capturedHeaders) .build(); } diff --git a/instrumentation/kafka/kafka-connect-2.6/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/kafkaconnect/v2_6/KafkaConnectSingletons.java b/instrumentation/kafka/kafka-connect-2.6/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/kafkaconnect/v2_6/KafkaConnectSingletons.java index 21d1fa944a28..a594f59bb6bd 100644 --- a/instrumentation/kafka/kafka-connect-2.6/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/kafkaconnect/v2_6/KafkaConnectSingletons.java +++ b/instrumentation/kafka/kafka-connect-2.6/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/kafkaconnect/v2_6/KafkaConnectSingletons.java @@ -9,8 +9,8 @@ import io.opentelemetry.api.GlobalOpenTelemetry; import io.opentelemetry.context.propagation.TextMapPropagator; -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.MessagingOperationType; import io.opentelemetry.instrumentation.api.incubator.semconv.messaging.MessagingSpanNameExtractor; import io.opentelemetry.instrumentation.api.instrumenter.Instrumenter; import io.opentelemetry.instrumentation.api.instrumenter.InstrumenterBuilder; @@ -33,10 +33,10 @@ public class KafkaConnectSingletons { GlobalOpenTelemetry.get(), INSTRUMENTATION_NAME, MessagingSpanNameExtractor.create( - new KafkaConnectAttributesGetter(), MessageOperation.PROCESS)) + new KafkaConnectAttributesGetter(), MessagingOperationType.PROCESS)) .addAttributesExtractor( MessagingAttributesExtractor.builder( - new KafkaConnectAttributesGetter(), MessageOperation.PROCESS) + new KafkaConnectAttributesGetter(), MessagingOperationType.PROCESS) .build()) .addSpanLinksExtractor(spanLinksExtractor); setMessagingProcessExceptionEventExtractor(builder); diff --git a/instrumentation/nats/nats-2.17/library/src/main/java/io/opentelemetry/instrumentation/nats/v2_17/internal/NatsInstrumenterFactory.java b/instrumentation/nats/nats-2.17/library/src/main/java/io/opentelemetry/instrumentation/nats/v2_17/internal/NatsInstrumenterFactory.java index 3faa961994b5..3e27d43de43d 100644 --- a/instrumentation/nats/nats-2.17/library/src/main/java/io/opentelemetry/instrumentation/nats/v2_17/internal/NatsInstrumenterFactory.java +++ b/instrumentation/nats/nats-2.17/library/src/main/java/io/opentelemetry/instrumentation/nats/v2_17/internal/NatsInstrumenterFactory.java @@ -9,8 +9,8 @@ import static io.opentelemetry.instrumentation.api.incubator.semconv.messaging.internal.MessagingExceptionEventExtractors.setMessagingSendExceptionEventExtractor; import io.opentelemetry.api.OpenTelemetry; -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.MessagingOperationType; import io.opentelemetry.instrumentation.api.incubator.semconv.messaging.MessagingSpanNameExtractor; import io.opentelemetry.instrumentation.api.instrumenter.Instrumenter; import io.opentelemetry.instrumentation.api.instrumenter.InstrumenterBuilder; @@ -30,10 +30,10 @@ public static Instrumenter createProducerInstrumenter( openTelemetry, INSTRUMENTATION_NAME, MessagingSpanNameExtractor.create( - new NatsRequestMessagingAttributesGetter(), MessageOperation.PUBLISH)) + new NatsRequestMessagingAttributesGetter(), MessagingOperationType.SEND)) .addAttributesExtractor( MessagingAttributesExtractor.builder( - new NatsRequestMessagingAttributesGetter(), MessageOperation.PUBLISH) + new NatsRequestMessagingAttributesGetter(), MessagingOperationType.SEND) .setCapturedHeaders(capturedHeaders) .build()); setMessagingSendExceptionEventExtractor(builder); @@ -47,10 +47,10 @@ public static Instrumenter createConsumerProcessInstrumenter( openTelemetry, INSTRUMENTATION_NAME, MessagingSpanNameExtractor.create( - new NatsRequestMessagingAttributesGetter(), MessageOperation.PROCESS)) + new NatsRequestMessagingAttributesGetter(), MessagingOperationType.PROCESS)) .addAttributesExtractor( MessagingAttributesExtractor.builder( - new NatsRequestMessagingAttributesGetter(), MessageOperation.PROCESS) + new NatsRequestMessagingAttributesGetter(), MessagingOperationType.PROCESS) .setCapturedHeaders(capturedHeaders) .build()); setMessagingProcessExceptionEventExtractor(builder); diff --git a/instrumentation/pulsar/pulsar-2.8/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/pulsar/v2_8/telemetry/PulsarSingletons.java b/instrumentation/pulsar/pulsar-2.8/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/pulsar/v2_8/telemetry/PulsarSingletons.java index d235b487720d..4f55d13b7ebe 100644 --- a/instrumentation/pulsar/pulsar-2.8/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/pulsar/v2_8/telemetry/PulsarSingletons.java +++ b/instrumentation/pulsar/pulsar-2.8/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/pulsar/v2_8/telemetry/PulsarSingletons.java @@ -15,10 +15,10 @@ import io.opentelemetry.context.Scope; import io.opentelemetry.context.propagation.TextMapPropagator; import io.opentelemetry.instrumentation.api.incubator.config.internal.DeclarativeConfigUtil; -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.MessagingConsumerMetrics; +import io.opentelemetry.instrumentation.api.incubator.semconv.messaging.MessagingOperationType; import io.opentelemetry.instrumentation.api.incubator.semconv.messaging.MessagingProcessMetrics; import io.opentelemetry.instrumentation.api.incubator.semconv.messaging.MessagingProducerMetrics; import io.opentelemetry.instrumentation.api.incubator.semconv.messaging.MessagingSpanNameExtractor; @@ -78,9 +78,9 @@ private static Instrumenter createConsumerReceiveInstrument Instrumenter.builder( telemetry, INSTRUMENTATION_NAME, - MessagingSpanNameExtractor.create(getter, MessageOperation.RECEIVE)) + MessagingSpanNameExtractor.create(getter, MessagingOperationType.RECEIVE)) .addAttributesExtractor( - createMessagingAttributesExtractor(getter, MessageOperation.RECEIVE)) + createMessagingAttributesExtractor(getter, MessagingOperationType.RECEIVE)) .addOperationMetrics(MessagingConsumerMetrics.get()) .addAttributesExtractor( ServerAttributesExtractor.create(new PulsarNetClientAttributesGetter())); @@ -103,9 +103,9 @@ private static Instrumenter createConsumerBatchReceive Instrumenter.builder( telemetry, INSTRUMENTATION_NAME, - MessagingSpanNameExtractor.create(getter, MessageOperation.RECEIVE)) + MessagingSpanNameExtractor.create(getter, MessagingOperationType.RECEIVE)) .addAttributesExtractor( - createMessagingAttributesExtractor(getter, MessageOperation.RECEIVE)) + createMessagingAttributesExtractor(getter, MessagingOperationType.RECEIVE)) .addAttributesExtractor( ServerAttributesExtractor.create(new PulsarNetClientAttributesGetter())) .addSpanLinksExtractor(new PulsarBatchRequestSpanLinksExtractor(propagator)) @@ -121,9 +121,9 @@ private static Instrumenter createConsumerProcessInstrument Instrumenter.builder( telemetry, INSTRUMENTATION_NAME, - MessagingSpanNameExtractor.create(getter, MessageOperation.PROCESS)) + MessagingSpanNameExtractor.create(getter, MessagingOperationType.PROCESS)) .addAttributesExtractor( - createMessagingAttributesExtractor(getter, MessageOperation.PROCESS)) + createMessagingAttributesExtractor(getter, MessagingOperationType.PROCESS)) .addOperationMetrics(MessagingProcessMetrics.get()); setMessagingProcessExceptionEventExtractor(instrumenterBuilder); @@ -143,9 +143,9 @@ private static Instrumenter createProducerInstrumenter() { Instrumenter.builder( telemetry, INSTRUMENTATION_NAME, - MessagingSpanNameExtractor.create(getter, MessageOperation.PUBLISH)) + MessagingSpanNameExtractor.create(getter, MessagingOperationType.SEND)) .addAttributesExtractor( - createMessagingAttributesExtractor(getter, MessageOperation.PUBLISH)) + createMessagingAttributesExtractor(getter, MessagingOperationType.SEND)) .addAttributesExtractor( ServerAttributesExtractor.create(new PulsarNetClientAttributesGetter())) .addOperationMetrics(MessagingProducerMetrics.get()); @@ -160,8 +160,8 @@ private static Instrumenter createProducerInstrumenter() { } private static AttributesExtractor createMessagingAttributesExtractor( - MessagingAttributesGetter getter, MessageOperation operation) { - return MessagingAttributesExtractor.builder(getter, operation) + MessagingAttributesGetter getter, MessagingOperationType operationType) { + return MessagingAttributesExtractor.builder(getter, operationType) .setCapturedHeaders(capturedHeaders) .build(); } diff --git a/instrumentation/rabbitmq-2.7/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/rabbitmq/v2_7/RabbitSingletons.java b/instrumentation/rabbitmq-2.7/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/rabbitmq/v2_7/RabbitSingletons.java index 7664c4a358f4..4821020c72b7 100644 --- a/instrumentation/rabbitmq-2.7/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/rabbitmq/v2_7/RabbitSingletons.java +++ b/instrumentation/rabbitmq-2.7/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/rabbitmq/v2_7/RabbitSingletons.java @@ -14,9 +14,9 @@ import com.rabbitmq.client.GetResponse; import io.opentelemetry.api.GlobalOpenTelemetry; import io.opentelemetry.context.ContextKey; -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.instrumenter.AttributesExtractor; import io.opentelemetry.instrumentation.api.instrumenter.Instrumenter; import io.opentelemetry.instrumentation.api.instrumenter.InstrumenterBuilder; @@ -63,7 +63,8 @@ private static Instrumenter createChannelInstrumenter(bo GlobalOpenTelemetry.get(), INSTRUMENTATION_NAME, ChannelAndMethod::getMethod) .addAttributesExtractor( buildMessagingAttributesExtractor( - new RabbitChannelAttributesGetter(), publish ? MessageOperation.PUBLISH : null)) + new RabbitChannelAttributesGetter(), + publish ? MessagingOperationType.SEND : null)) .addAttributesExtractor( NetworkAttributesExtractor.create(new RabbitChannelNetAttributesGetter())) .addContextCustomizer( @@ -80,7 +81,7 @@ private static Instrumenter createReceiveInstrument List> extractors = new ArrayList<>(); extractors.add( buildMessagingAttributesExtractor( - new RabbitReceiveAttributesGetter(), MessageOperation.RECEIVE)); + new RabbitReceiveAttributesGetter(), MessagingOperationType.RECEIVE)); extractors.add(NetworkAttributesExtractor.create(new RabbitReceiveNetAttributesGetter())); if (RabbitInstrumenterHelper.CAPTURE_EXPERIMENTAL_SPAN_ATTRIBUTES) { extractors.add(new RabbitReceiveExperimentalAttributesExtractor()); @@ -103,7 +104,7 @@ private static Instrumenter createDeliverInstrumenter() { List> extractors = new ArrayList<>(); extractors.add( buildMessagingAttributesExtractor( - new RabbitDeliveryAttributesGetter(), MessageOperation.PROCESS)); + new RabbitDeliveryAttributesGetter(), MessagingOperationType.PROCESS)); extractors.add(NetworkAttributesExtractor.create(new RabbitDeliveryNetAttributesGetter())); extractors.add(new RabbitDeliveryExtraAttributesExtractor()); if (RabbitInstrumenterHelper.CAPTURE_EXPERIMENTAL_SPAN_ATTRIBUTES) { @@ -119,8 +120,8 @@ private static Instrumenter createDeliverInstrumenter() { } private static AttributesExtractor buildMessagingAttributesExtractor( - MessagingAttributesGetter getter, @Nullable MessageOperation operation) { - return MessagingAttributesExtractor.builder(getter, operation) + MessagingAttributesGetter getter, @Nullable MessagingOperationType operationType) { + return MessagingAttributesExtractor.builder(getter, operationType) .setCapturedHeaders(ExperimentalConfig.get().getMessagingHeaders()) .build(); } diff --git a/instrumentation/rocketmq/rocketmq-client-4.8/library/src/main/java/io/opentelemetry/instrumentation/rocketmqclient/v4_8/RocketMqInstrumenterFactory.java b/instrumentation/rocketmq/rocketmq-client-4.8/library/src/main/java/io/opentelemetry/instrumentation/rocketmqclient/v4_8/RocketMqInstrumenterFactory.java index ef611cf66212..ec363a342b62 100644 --- a/instrumentation/rocketmq/rocketmq-client-4.8/library/src/main/java/io/opentelemetry/instrumentation/rocketmqclient/v4_8/RocketMqInstrumenterFactory.java +++ b/instrumentation/rocketmq/rocketmq-client-4.8/library/src/main/java/io/opentelemetry/instrumentation/rocketmqclient/v4_8/RocketMqInstrumenterFactory.java @@ -11,9 +11,9 @@ import io.opentelemetry.api.OpenTelemetry; import io.opentelemetry.api.common.AttributeKey; -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.MessagingSpanNameExtractor; import io.opentelemetry.instrumentation.api.instrumenter.AttributesExtractor; import io.opentelemetry.instrumentation.api.instrumenter.Instrumenter; @@ -41,15 +41,15 @@ static Instrumenter createProducerInstrumenter( boolean captureExperimentalSpanAttributes) { RocketMqProducerAttributeGetter getter = new RocketMqProducerAttributeGetter(); - MessageOperation operation = MessageOperation.PUBLISH; + MessagingOperationType operationType = MessagingOperationType.SEND; InstrumenterBuilder instrumenterBuilder = Instrumenter.builder( openTelemetry, INSTRUMENTATION_NAME, - MessagingSpanNameExtractor.create(getter, operation)) + MessagingSpanNameExtractor.create(getter, operationType)) .addAttributesExtractor( - buildMessagingAttributesExtractor(getter, operation, capturedHeaders)); + buildMessagingAttributesExtractor(getter, operationType, capturedHeaders)); if (captureExperimentalSpanAttributes) { instrumenterBuilder.addAttributesExtractor( new RocketMqProducerExperimentalAttributeExtractor()); @@ -85,16 +85,16 @@ private static Instrumenter createProcessInstrumenter( boolean batch) { RocketMqConsumerAttributeGetter getter = new RocketMqConsumerAttributeGetter(); - MessageOperation operation = MessageOperation.PROCESS; + MessagingOperationType operationType = MessagingOperationType.PROCESS; InstrumenterBuilder builder = Instrumenter.builder( openTelemetry, INSTRUMENTATION_NAME, - MessagingSpanNameExtractor.create(getter, operation)); + MessagingSpanNameExtractor.create(getter, operationType)); builder.addAttributesExtractor( - buildMessagingAttributesExtractor(getter, operation, capturedHeaders)); + buildMessagingAttributesExtractor(getter, operationType, capturedHeaders)); if (captureExperimentalSpanAttributes) { builder.addAttributesExtractor(new RocketMqConsumerExperimentalAttributeExtractor()); } @@ -115,9 +115,9 @@ private static Instrumenter createProcessInstrumenter( private static AttributesExtractor buildMessagingAttributesExtractor( MessagingAttributesGetter getter, - MessageOperation operation, + MessagingOperationType operationType, List capturedHeaders) { - return MessagingAttributesExtractor.builder(getter, operation) + return MessagingAttributesExtractor.builder(getter, operationType) .setCapturedHeaders(capturedHeaders) .build(); } diff --git a/instrumentation/rocketmq/rocketmq-client-5.0/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/rocketmqclient/v5_0/RocketMqConsumerProcessAttributeGetter.java b/instrumentation/rocketmq/rocketmq-client-5.0/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/rocketmqclient/v5_0/RocketMqConsumerProcessAttributeGetter.java index 4a4a01bc3087..32ff58ca7a06 100644 --- a/instrumentation/rocketmq/rocketmq-client-5.0/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/rocketmqclient/v5_0/RocketMqConsumerProcessAttributeGetter.java +++ b/instrumentation/rocketmq/rocketmq-client-5.0/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/rocketmqclient/v5_0/RocketMqConsumerProcessAttributeGetter.java @@ -77,6 +77,13 @@ public Long getBatchMessageCount(MessageView messageView, @Nullable ConsumeResul return null; } + @Nullable + @Override + public String getErrorType( + MessageView messageView, @Nullable ConsumeResult consumeResult, @Nullable Throwable error) { + return consumeResult == ConsumeResult.FAILURE ? ConsumeResult.FAILURE.name() : null; + } + @Override public List getMessageHeader(MessageView messageView, String name) { String value = messageView.getProperties().get(name); diff --git a/instrumentation/rocketmq/rocketmq-client-5.0/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/rocketmqclient/v5_0/RocketMqInstrumenterFactory.java b/instrumentation/rocketmq/rocketmq-client-5.0/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/rocketmqclient/v5_0/RocketMqInstrumenterFactory.java index bb6ce5d1d276..7d3409f085a8 100644 --- a/instrumentation/rocketmq/rocketmq-client-5.0/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/rocketmqclient/v5_0/RocketMqInstrumenterFactory.java +++ b/instrumentation/rocketmq/rocketmq-client-5.0/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/rocketmqclient/v5_0/RocketMqInstrumenterFactory.java @@ -12,9 +12,9 @@ import apache.rocketmq.v2.ReceiveMessageRequest; import io.opentelemetry.api.OpenTelemetry; import io.opentelemetry.api.trace.StatusCode; -import io.opentelemetry.instrumentation.api.incubator.semconv.messaging.MessageOperation; import io.opentelemetry.instrumentation.api.incubator.semconv.messaging.MessagingAttributesExtractor; import io.opentelemetry.instrumentation.api.incubator.semconv.messaging.MessagingAttributesGetter; +import io.opentelemetry.instrumentation.api.incubator.semconv.messaging.MessagingOperationType; import io.opentelemetry.instrumentation.api.incubator.semconv.messaging.MessagingSpanNameExtractor; import io.opentelemetry.instrumentation.api.instrumenter.AttributesExtractor; import io.opentelemetry.instrumentation.api.instrumenter.Instrumenter; @@ -37,16 +37,16 @@ private RocketMqInstrumenterFactory() {} public static Instrumenter createProducerInstrumenter( OpenTelemetry openTelemetry, List capturedHeaders) { RocketMqProducerAttributeGetter getter = new RocketMqProducerAttributeGetter(); - MessageOperation operation = MessageOperation.PUBLISH; + MessagingOperationType operationType = MessagingOperationType.SEND; AttributesExtractor attributesExtractor = - buildMessagingAttributesExtractor(getter, operation, capturedHeaders); + buildMessagingAttributesExtractor(getter, operationType, capturedHeaders); InstrumenterBuilder instrumenterBuilder = Instrumenter.builder( openTelemetry, INSTRUMENTATION_NAME, - MessagingSpanNameExtractor.create(getter, operation)) + MessagingSpanNameExtractor.create(getter, operationType)) .addAttributesExtractor(attributesExtractor) .addAttributesExtractor(new RocketMqProducerAttributeExtractor()); setMessagingSendExceptionEventExtractor(instrumenterBuilder); @@ -57,16 +57,16 @@ public static Instrumenter createProduce createConsumerReceiveInstrumenter( OpenTelemetry openTelemetry, List capturedHeaders, boolean enabled) { RocketMqConsumerReceiveAttributeGetter getter = new RocketMqConsumerReceiveAttributeGetter(); - MessageOperation operation = MessageOperation.RECEIVE; + MessagingOperationType operationType = MessagingOperationType.RECEIVE; AttributesExtractor> attributesExtractor = - buildMessagingAttributesExtractor(getter, operation, capturedHeaders); + buildMessagingAttributesExtractor(getter, operationType, capturedHeaders); InstrumenterBuilder> instrumenterBuilder = Instrumenter.>builder( openTelemetry, INSTRUMENTATION_NAME, - MessagingSpanNameExtractor.create(getter, operation)) + MessagingSpanNameExtractor.create(getter, operationType)) .setEnabled(enabled) .addAttributesExtractor(attributesExtractor) .addAttributesExtractor(new RocketMqConsumerReceiveAttributeExtractor()); @@ -79,16 +79,16 @@ public static Instrumenter createConsumerProcessInst List capturedHeaders, boolean receiveInstrumentationEnabled) { RocketMqConsumerProcessAttributeGetter getter = new RocketMqConsumerProcessAttributeGetter(); - MessageOperation operation = MessageOperation.PROCESS; + MessagingOperationType operationType = MessagingOperationType.PROCESS; AttributesExtractor attributesExtractor = - buildMessagingAttributesExtractor(getter, operation, capturedHeaders); + buildMessagingAttributesExtractor(getter, operationType, capturedHeaders); InstrumenterBuilder instrumenterBuilder = Instrumenter.builder( openTelemetry, INSTRUMENTATION_NAME, - MessagingSpanNameExtractor.create(getter, operation)) + MessagingSpanNameExtractor.create(getter, operationType)) .addAttributesExtractor(attributesExtractor) .addAttributesExtractor(new RocketMqConsumerProcessAttributeExtractor()) .setSpanStatusExtractor( @@ -114,9 +114,9 @@ public static Instrumenter createConsumerProcessInst private static AttributesExtractor buildMessagingAttributesExtractor( MessagingAttributesGetter getter, - MessageOperation operation, + MessagingOperationType operationType, List capturedHeaders) { - return MessagingAttributesExtractor.builder(getter, operation) + return MessagingAttributesExtractor.builder(getter, operationType) .setCapturedHeaders(capturedHeaders) .build(); } diff --git a/instrumentation/spring/spring-integration-4.1/library/src/main/java/io/opentelemetry/instrumentation/spring/integration/v4_1/SpringIntegrationTelemetryBuilder.java b/instrumentation/spring/spring-integration-4.1/library/src/main/java/io/opentelemetry/instrumentation/spring/integration/v4_1/SpringIntegrationTelemetryBuilder.java index 20dea3ca31f7..23e0f6186df8 100644 --- a/instrumentation/spring/spring-integration-4.1/library/src/main/java/io/opentelemetry/instrumentation/spring/integration/v4_1/SpringIntegrationTelemetryBuilder.java +++ b/instrumentation/spring/spring-integration-4.1/library/src/main/java/io/opentelemetry/instrumentation/spring/integration/v4_1/SpringIntegrationTelemetryBuilder.java @@ -12,9 +12,9 @@ import com.google.errorprone.annotations.CanIgnoreReturnValue; import io.opentelemetry.api.OpenTelemetry; import io.opentelemetry.api.trace.SpanKind; -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.instrumenter.AttributesExtractor; import io.opentelemetry.instrumentation.api.instrumenter.Instrumenter; import io.opentelemetry.instrumentation.api.instrumenter.InstrumenterBuilder; @@ -84,7 +84,7 @@ public SpringIntegrationTelemetry build() { .addAttributesExtractor( buildMessagingAttributesExtractor( new SpringMessagingAttributesGetter(), - MessageOperation.PROCESS, + MessagingOperationType.PROCESS, capturedHeaders)); setMessagingProcessExceptionEventExtractor(consumerBuilder); Instrumenter consumerInstrumenter = @@ -99,7 +99,7 @@ public SpringIntegrationTelemetry build() { .addAttributesExtractor( buildMessagingAttributesExtractor( new SpringMessagingAttributesGetter(), - MessageOperation.PUBLISH, + MessagingOperationType.SEND, capturedHeaders)); setMessagingSendExceptionEventExtractor(producerBuilder); Instrumenter producerInstrumenter = @@ -121,9 +121,9 @@ private static String producerSpanName(MessageWithChannel messageWithChannel) { private static AttributesExtractor buildMessagingAttributesExtractor( MessagingAttributesGetter getter, - MessageOperation operation, + MessagingOperationType operationType, List capturedHeaders) { - return MessagingAttributesExtractor.builder(getter, operation) + return MessagingAttributesExtractor.builder(getter, operationType) .setCapturedHeaders(capturedHeaders) .build(); } diff --git a/instrumentation/spring/spring-pulsar-1.0/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/spring/pulsar/v1_0/SpringPulsarSingletons.java b/instrumentation/spring/spring-pulsar-1.0/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/spring/pulsar/v1_0/SpringPulsarSingletons.java index 1f9db736d418..7aae59e3f90f 100644 --- a/instrumentation/spring/spring-pulsar-1.0/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/spring/pulsar/v1_0/SpringPulsarSingletons.java +++ b/instrumentation/spring/spring-pulsar-1.0/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/spring/pulsar/v1_0/SpringPulsarSingletons.java @@ -9,8 +9,8 @@ import io.opentelemetry.api.GlobalOpenTelemetry; import io.opentelemetry.api.OpenTelemetry; -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.MessagingOperationType; import io.opentelemetry.instrumentation.api.incubator.semconv.messaging.MessagingSpanNameExtractor; import io.opentelemetry.instrumentation.api.instrumenter.Instrumenter; import io.opentelemetry.instrumentation.api.instrumenter.InstrumenterBuilder; @@ -26,7 +26,7 @@ public class SpringPulsarSingletons { static { OpenTelemetry openTelemetry = GlobalOpenTelemetry.get(); SpringPulsarMessageAttributesGetter getter = new SpringPulsarMessageAttributesGetter(); - MessageOperation operation = MessageOperation.PROCESS; + MessagingOperationType operationType = MessagingOperationType.PROCESS; boolean messagingReceiveInstrumentationEnabled = ExperimentalConfig.get().messagingReceiveInstrumentationEnabled(); @@ -34,9 +34,9 @@ public class SpringPulsarSingletons { Instrumenter., Void>builder( openTelemetry, INSTRUMENTATION_NAME, - MessagingSpanNameExtractor.create(getter, operation)) + MessagingSpanNameExtractor.create(getter, operationType)) .addAttributesExtractor( - MessagingAttributesExtractor.builder(getter, operation) + MessagingAttributesExtractor.builder(getter, operationType) .setCapturedHeaders(ExperimentalConfig.get().getMessagingHeaders()) .build()); setMessagingProcessExceptionEventExtractor(builder); diff --git a/instrumentation/spring/spring-rabbit-1.0/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/spring/rabbit/v1_0/SpringRabbitSingletons.java b/instrumentation/spring/spring-rabbit-1.0/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/spring/rabbit/v1_0/SpringRabbitSingletons.java index 0b1c73f8a742..11d844ed96ba 100644 --- a/instrumentation/spring/spring-rabbit-1.0/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/spring/rabbit/v1_0/SpringRabbitSingletons.java +++ b/instrumentation/spring/spring-rabbit-1.0/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/spring/rabbit/v1_0/SpringRabbitSingletons.java @@ -8,8 +8,8 @@ import static io.opentelemetry.instrumentation.api.incubator.semconv.messaging.internal.MessagingExceptionEventExtractors.setMessagingProcessExceptionEventExtractor; import io.opentelemetry.api.GlobalOpenTelemetry; -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.MessagingOperationType; import io.opentelemetry.instrumentation.api.incubator.semconv.messaging.MessagingSpanNameExtractor; import io.opentelemetry.instrumentation.api.instrumenter.Instrumenter; import io.opentelemetry.instrumentation.api.instrumenter.InstrumenterBuilder; @@ -24,15 +24,15 @@ public class SpringRabbitSingletons { static { SpringRabbitMessageAttributesGetter getter = new SpringRabbitMessageAttributesGetter(); - MessageOperation operation = MessageOperation.PROCESS; + MessagingOperationType operationType = MessagingOperationType.PROCESS; InstrumenterBuilder builder = Instrumenter.builder( GlobalOpenTelemetry.get(), INSTRUMENTATION_NAME, - MessagingSpanNameExtractor.create(getter, operation)) + MessagingSpanNameExtractor.create(getter, operationType)) .addAttributesExtractor( - MessagingAttributesExtractor.builder(getter, operation) + MessagingAttributesExtractor.builder(getter, operationType) .setCapturedHeaders(ExperimentalConfig.get().getMessagingHeaders()) .build()); setMessagingProcessExceptionEventExtractor(builder); From 079681957d54d2b7e67a7bcd99e2953445583a19 Mon Sep 17 00:00:00 2001 From: Trask Stalnaker Date: Wed, 15 Jul 2026 19:47:31 -0700 Subject: [PATCH 4/4] Migrate Kafka messaging telemetry to v1.43 preview --- .../javaagent/build.gradle.kts | 21 +- .../v0_11/KafkaClientDefaultTest.java | 36 +- .../v0_11/internal/KafkaClientBaseTest.java | 35 +- .../library/build.gradle.kts | 10 +- .../v2_6/AbstractInterceptorsTest.java | 140 +++++-- .../InterceptorsSuppressReceiveSpansTest.java | 93 +++-- .../v2_6/WrapperPropagationDisabledTest.java | 12 +- .../v2_6/WrapperSendExceptionTest.java | 4 +- .../v2_6/WrapperSuppressReceiveSpansTest.java | 69 +--- .../kafkaclients/v2_6/WrapperTest.java | 96 ++++- .../KafkaConsumerAttributesExtractor.java | 9 +- .../internal/KafkaInstrumenterFactory.java | 33 +- .../KafkaReceiveAttributesExtractor.java | 12 +- .../v2_6/KafkaConnectSingletons.java | 6 +- .../testing/build.gradle.kts | 10 +- .../v2_6/KafkaConnectSinkTaskBaseTest.java | 75 +++- .../v2_6/MongoKafkaConnectSinkTaskTest.java | 75 ++-- .../PostgresKafkaConnectSinkTaskTest.java | 75 ++-- .../javaagent/build.gradle.kts | 13 + .../v0_11/KafkaStreamsDefaultTest.java | 236 +++++++---- .../javaagent/build.gradle.kts | 12 +- .../kafka/v1_0/AbstractReactorKafkaTest.java | 115 ++++-- .../javaagent/build.gradle.kts | 11 +- .../spring/kafka/v2_7/SpringKafkaTest.java | 371 ++++++++---------- ...cordsNoReceiveTelemetryVertxKafkaTest.java | 18 +- .../AbstractBatchRecordsVertxKafkaTest.java | 30 +- ...ecordNoReceiveTelemetryVertxKafkaTest.java | 11 +- .../AbstractSingleRecordVertxKafkaTest.java | 23 +- .../vertx/kafka/AbstractVertxKafkaTest.java | 114 ++++-- .../build.gradle.kts | 11 +- .../build.gradle.kts | 10 +- .../build.gradle.kts | 10 +- 32 files changed, 1145 insertions(+), 651 deletions(-) diff --git a/instrumentation/kafka/kafka-clients/kafka-clients-0.11/javaagent/build.gradle.kts b/instrumentation/kafka/kafka-clients/kafka-clients-0.11/javaagent/build.gradle.kts index bbae53c120b0..84364a127299 100644 --- a/instrumentation/kafka/kafka-clients/kafka-clients-0.11/javaagent/build.gradle.kts +++ b/instrumentation/kafka/kafka-clients/kafka-clients-0.11/javaagent/build.gradle.kts @@ -67,7 +67,7 @@ tasks { systemProperty("metadataConfig", "otel.instrumentation.kafka.experimental-span-attributes=true") } - val testStableSemconv = register("testStableSemconv") { + val testV3Preview = register("testV3Preview") { testClassesDirs = sourceSets.test.get().output.classesDirs classpath = sourceSets.test.get().runtimeClasspath filter { @@ -79,11 +79,26 @@ tasks { jvmArgs("-Dotel.instrumentation.common.v3-preview=true") // kafka metrics are disabled by default with v3-preview enabled jvmArgs("-Dotel.instrumentation.kafka-clients-metrics.enabled=true") - systemProperty("metadataConfig", "otel.semconv-stability.opt-in=messaging") + systemProperty("metadataConfig", "otel.instrumentation.common.v3-preview=true") + } + + val testBothSemconv = register("testBothSemconv") { + testClassesDirs = sourceSets.test.get().output.classesDirs + classpath = sourceSets.test.get().runtimeClasspath + filter { + excludeTestsMatching("KafkaClientPropagationDisabledTest") + excludeTestsMatching("KafkaClientSuppressReceiveSpansTest") + } + jvmArgs("-Dotel.instrumentation.messaging.experimental.receive-telemetry.enabled=true") + jvmArgs("-Dotel.semconv-stability.preview=messaging/dup") + jvmArgs("-Dotel.instrumentation.common.v3-preview=true") + // kafka metrics are disabled by default with v3-preview enabled + jvmArgs("-Dotel.instrumentation.kafka-clients-metrics.enabled=true") + systemProperty("metadataConfig", "otel.semconv-stability.preview=messaging/dup") } check { - dependsOn(testStableSemconv) + dependsOn(testV3Preview, testBothSemconv) } test { diff --git a/instrumentation/kafka/kafka-clients/kafka-clients-0.11/javaagent/src/test/java/io/opentelemetry/javaagent/instrumentation/kafkaclients/v0_11/KafkaClientDefaultTest.java b/instrumentation/kafka/kafka-clients/kafka-clients-0.11/javaagent/src/test/java/io/opentelemetry/javaagent/instrumentation/kafkaclients/v0_11/KafkaClientDefaultTest.java index ea8055f306e1..7a240656bdf8 100644 --- a/instrumentation/kafka/kafka-clients/kafka-clients-0.11/javaagent/src/test/java/io/opentelemetry/javaagent/instrumentation/kafkaclients/v0_11/KafkaClientDefaultTest.java +++ b/instrumentation/kafka/kafka-clients/kafka-clients-0.11/javaagent/src/test/java/io/opentelemetry/javaagent/instrumentation/kafkaclients/v0_11/KafkaClientDefaultTest.java @@ -78,14 +78,15 @@ void testKafkaProducerAndConsumerSpan(boolean testHeaders) throws Exception { } AtomicReference producerSpan = new AtomicReference<>(); testing.waitAndAssertSortedTraces( - orderByRootSpanKind(SpanKind.INTERNAL, SpanKind.CONSUMER), + orderByRootSpanKind( + SpanKind.INTERNAL, emitStableMessagingSemconv() ? SpanKind.CLIENT : SpanKind.CONSUMER), trace -> { trace.hasSpansSatisfyingExactly( span -> span.hasName("parent").hasKind(SpanKind.INTERNAL).hasNoParent(), span -> span.hasName( emitStableMessagingSemconv() - ? "publish " + SHARED_TOPIC + ? "send " + SHARED_TOPIC : SHARED_TOPIC + " publish") .hasKind(SpanKind.PRODUCER) .hasParent(trace.getSpan(0)) @@ -101,9 +102,9 @@ void testKafkaProducerAndConsumerSpan(boolean testHeaders) throws Exception { span -> span.hasName( emitStableMessagingSemconv() - ? "receive " + SHARED_TOPIC + ? "poll " + SHARED_TOPIC : SHARED_TOPIC + " receive") - .hasKind(SpanKind.CONSUMER) + .hasKind(emitStableMessagingSemconv() ? SpanKind.CLIENT : SpanKind.CONSUMER) .hasNoParent() .hasAttributesSatisfyingExactly(receiveAttributes(testHeaders)), span -> @@ -135,13 +136,14 @@ void testPassThroughTombstone() throws Exception { AtomicReference producerSpan = new AtomicReference<>(); testing.waitAndAssertSortedTraces( - orderByRootSpanKind(SpanKind.INTERNAL, SpanKind.CONSUMER), + orderByRootSpanKind( + SpanKind.INTERNAL, emitStableMessagingSemconv() ? SpanKind.CLIENT : SpanKind.CONSUMER), trace -> { trace.hasSpansSatisfyingExactly( span -> span.hasName( emitStableMessagingSemconv() - ? "publish " + SHARED_TOPIC + ? "send " + SHARED_TOPIC : SHARED_TOPIC + " publish") .hasKind(SpanKind.PRODUCER) .hasNoParent() @@ -153,9 +155,9 @@ void testPassThroughTombstone() throws Exception { span -> span.hasName( emitStableMessagingSemconv() - ? "receive " + SHARED_TOPIC + ? "poll " + SHARED_TOPIC : SHARED_TOPIC + " receive") - .hasKind(SpanKind.CONSUMER) + .hasKind(emitStableMessagingSemconv() ? SpanKind.CLIENT : SpanKind.CONSUMER) .hasNoParent() .hasAttributesSatisfyingExactly(receiveAttributes(false)), span -> @@ -203,13 +205,14 @@ void testRecordsWithTopicPartitionKafkaConsume(boolean testListIterator) throws AtomicReference producerSpan = new AtomicReference<>(); testing.waitAndAssertSortedTraces( - orderByRootSpanKind(SpanKind.INTERNAL, SpanKind.CONSUMER), + orderByRootSpanKind( + SpanKind.INTERNAL, emitStableMessagingSemconv() ? SpanKind.CLIENT : SpanKind.CONSUMER), trace -> { trace.hasSpansSatisfyingExactly( span -> span.hasName( emitStableMessagingSemconv() - ? "publish " + SHARED_TOPIC + ? "send " + SHARED_TOPIC : SHARED_TOPIC + " publish") .hasKind(SpanKind.PRODUCER) .hasNoParent() @@ -221,9 +224,9 @@ void testRecordsWithTopicPartitionKafkaConsume(boolean testListIterator) throws span -> span.hasName( emitStableMessagingSemconv() - ? "receive " + SHARED_TOPIC + ? "poll " + SHARED_TOPIC : SHARED_TOPIC + " receive") - .hasKind(SpanKind.CONSUMER) + .hasKind(emitStableMessagingSemconv() ? SpanKind.CLIENT : SpanKind.CONSUMER) .hasNoParent() .hasAttributesSatisfyingExactly(receiveAttributes(false)), span -> @@ -276,14 +279,15 @@ void testKafkaHeaderNull() throws Exception { } AtomicReference producerSpan = new AtomicReference<>(); testing.waitAndAssertSortedTraces( - orderByRootSpanKind(SpanKind.INTERNAL, SpanKind.CONSUMER), + orderByRootSpanKind( + SpanKind.INTERNAL, emitStableMessagingSemconv() ? SpanKind.CLIENT : SpanKind.CONSUMER), trace -> { trace.hasSpansSatisfyingExactly( span -> span.hasName("parent").hasKind(SpanKind.INTERNAL).hasNoParent(), span -> span.hasName( emitStableMessagingSemconv() - ? "publish " + SHARED_TOPIC + ? "send " + SHARED_TOPIC : SHARED_TOPIC + " publish") .hasKind(SpanKind.PRODUCER) .hasParent(trace.getSpan(0)) @@ -299,9 +303,9 @@ void testKafkaHeaderNull() throws Exception { span -> span.hasName( emitStableMessagingSemconv() - ? "receive " + SHARED_TOPIC + ? "poll " + SHARED_TOPIC : SHARED_TOPIC + " receive") - .hasKind(SpanKind.CONSUMER) + .hasKind(emitStableMessagingSemconv() ? SpanKind.CLIENT : SpanKind.CONSUMER) .hasNoParent() .hasAttributesSatisfyingExactly(receiveAttributes(false)), span -> diff --git a/instrumentation/kafka/kafka-clients/kafka-clients-0.11/testing/src/main/java/io/opentelemetry/instrumentation/kafkaclients/common/v0_11/internal/KafkaClientBaseTest.java b/instrumentation/kafka/kafka-clients/kafka-clients-0.11/testing/src/main/java/io/opentelemetry/instrumentation/kafkaclients/common/v0_11/internal/KafkaClientBaseTest.java index c6a8301f571e..80d7c5fe4534 100644 --- a/instrumentation/kafka/kafka-clients/kafka-clients-0.11/testing/src/main/java/io/opentelemetry/instrumentation/kafkaclients/common/v0_11/internal/KafkaClientBaseTest.java +++ b/instrumentation/kafka/kafka-clients/kafka-clients-0.11/testing/src/main/java/io/opentelemetry/instrumentation/kafkaclients/common/v0_11/internal/KafkaClientBaseTest.java @@ -10,11 +10,11 @@ import static io.opentelemetry.instrumentation.api.internal.SemconvStability.emitOldMessagingSemconv; import static io.opentelemetry.instrumentation.api.internal.SemconvStability.emitStableMessagingSemconv; import static io.opentelemetry.instrumentation.testing.junit.message.MessageHeaderUtil.headerAttributeKey; -import static io.opentelemetry.instrumentation.testing.junit.message.SemconvMessagingStabilityUtil.effectiveKey; import static io.opentelemetry.instrumentation.testing.util.TestLatestDeps.testLatestDeps; import static io.opentelemetry.sdk.testing.assertj.OpenTelemetryAssertions.equalTo; import static io.opentelemetry.sdk.testing.assertj.OpenTelemetryAssertions.satisfies; import static io.opentelemetry.semconv.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_PARTITION_ID; import static io.opentelemetry.semconv.incubating.MessagingIncubatingAttributes.MESSAGING_KAFKA_CONSUMER_GROUP; @@ -77,7 +77,7 @@ public abstract class KafkaClientBaseTest { @RegisterExtension final AutoCleanupExtension cleanup = AutoCleanupExtension.create(); protected static final String SHARED_TOPIC = "shared.topic"; - protected static final AttributeKey MESSAGING_CLIENT_ID = + protected static final AttributeKey MESSAGING_CLIENT_ID_OLD = AttributeKey.stringKey("messaging.client_id"); private KafkaContainer kafka; @@ -185,10 +185,10 @@ protected static List sendAttributes( equalTo(MESSAGING_SYSTEM, "kafka"), equalTo(MESSAGING_DESTINATION_NAME, SHARED_TOPIC), equalTo(MESSAGING_OPERATION, emitOldMessagingSemconv() ? "publish" : null), - equalTo(MESSAGING_OPERATION_NAME, emitStableMessagingSemconv() ? "publish" : null), + equalTo(MESSAGING_OPERATION_NAME, emitStableMessagingSemconv() ? "send" : null), equalTo(MESSAGING_OPERATION_TYPE, emitStableMessagingSemconv() ? "send" : null), - satisfies(effectiveKey(MESSAGING_CLIENT_ID), val -> val.startsWith("producer")), satisfies(MESSAGING_DESTINATION_PARTITION_ID, AbstractStringAssert::isNotEmpty))); + addClientIdAssertions(assertions, "producer"); if (emitOldMessagingSemconv()) { assertions.add(satisfies(MESSAGING_KAFKA_MESSAGE_OFFSET, AbstractLongAssert::isNotNegative)); } @@ -221,13 +221,16 @@ protected static List receiveAttributes(boolean testHeaders) equalTo(MESSAGING_SYSTEM, "kafka"), equalTo(MESSAGING_DESTINATION_NAME, SHARED_TOPIC), equalTo(MESSAGING_OPERATION, emitOldMessagingSemconv() ? "receive" : null), - equalTo(MESSAGING_OPERATION_NAME, emitStableMessagingSemconv() ? "receive" : null), + equalTo(MESSAGING_OPERATION_NAME, emitStableMessagingSemconv() ? "poll" : null), equalTo(MESSAGING_OPERATION_TYPE, emitStableMessagingSemconv() ? "receive" : null), - satisfies(effectiveKey(MESSAGING_CLIENT_ID), val -> val.startsWith("consumer")), satisfies(MESSAGING_BATCH_MESSAGE_COUNT, AbstractLongAssert::isPositive))); + addClientIdAssertions(assertions, "consumer"); // consumer group is not available in version 0.11 if (testLatestDeps()) { - assertions.add(equalTo(MESSAGING_KAFKA_CONSUMER_GROUP, "test")); + assertions.add( + equalTo(MESSAGING_KAFKA_CONSUMER_GROUP, emitOldMessagingSemconv() ? "test" : null)); + assertions.add( + equalTo(MESSAGING_CONSUMER_GROUP_NAME, emitStableMessagingSemconv() ? "test" : null)); } if (testHeaders) { assertions.add(equalTo(headerAttributeKey("Test-Message-Header"), singletonList("test"))); @@ -246,8 +249,8 @@ protected static List processAttributes( equalTo(MESSAGING_OPERATION, emitOldMessagingSemconv() ? "process" : null), equalTo(MESSAGING_OPERATION_NAME, emitStableMessagingSemconv() ? "process" : null), equalTo(MESSAGING_OPERATION_TYPE, emitStableMessagingSemconv() ? "process" : null), - satisfies(effectiveKey(MESSAGING_CLIENT_ID), val -> val.startsWith("consumer")), satisfies(MESSAGING_DESTINATION_PARTITION_ID, AbstractStringAssert::isNotEmpty))); + addClientIdAssertions(assertions, "consumer"); if (EXPERIMENTAL_ATTRIBUTES) { assertions.add( satisfies(longKey("kafka.record.queue_time_ms"), AbstractLongAssert::isNotNegative)); @@ -260,7 +263,10 @@ protected static List processAttributes( } // consumer group is not available in version 0.11 if (testLatestDeps()) { - assertions.add(equalTo(MESSAGING_KAFKA_CONSUMER_GROUP, "test")); + assertions.add( + equalTo(MESSAGING_KAFKA_CONSUMER_GROUP, emitOldMessagingSemconv() ? "test" : null)); + assertions.add( + equalTo(MESSAGING_CONSUMER_GROUP_NAME, emitStableMessagingSemconv() ? "test" : null)); } if (messageKey != null) { assertions.add(equalTo(MESSAGING_KAFKA_MESSAGE_KEY, messageKey)); @@ -280,4 +286,15 @@ protected static List processAttributes( } return assertions; } + + private static void addClientIdAssertions( + List assertions, String clientIdPrefix) { + if (emitOldMessagingSemconv()) { + assertions.add(satisfies(MESSAGING_CLIENT_ID_OLD, val -> val.startsWith(clientIdPrefix))); + } + if (emitStableMessagingSemconv()) { + assertions.add( + satisfies(stringKey("messaging.client.id"), val -> val.startsWith(clientIdPrefix))); + } + } } diff --git a/instrumentation/kafka/kafka-clients/kafka-clients-2.6/library/build.gradle.kts b/instrumentation/kafka/kafka-clients/kafka-clients-2.6/library/build.gradle.kts index 421f6f1aac53..d4689bb594ee 100644 --- a/instrumentation/kafka/kafka-clients/kafka-clients-2.6/library/build.gradle.kts +++ b/instrumentation/kafka/kafka-clients/kafka-clients-2.6/library/build.gradle.kts @@ -34,8 +34,16 @@ tasks { systemProperty("metadataConfig", "otel.semconv.exception.signal.preview=logs") } + val testV3Preview = register("testV3Preview") { + testClassesDirs = sourceSets.test.get().output.classesDirs + classpath = sourceSets.test.get().runtimeClasspath + jvmArgs("-Dotel.instrumentation.common.v3-preview=true") + jvmArgs("-Dotel.semconv-stability.preview=messaging") + systemProperty("metadataConfig", "otel.instrumentation.common.v3-preview=true") + } + check { - dependsOn(testExceptionSignalLogs) + dependsOn(testExceptionSignalLogs, testV3Preview) } } diff --git a/instrumentation/kafka/kafka-clients/kafka-clients-2.6/library/src/test/java/io/opentelemetry/instrumentation/kafkaclients/v2_6/AbstractInterceptorsTest.java b/instrumentation/kafka/kafka-clients/kafka-clients-2.6/library/src/test/java/io/opentelemetry/instrumentation/kafkaclients/v2_6/AbstractInterceptorsTest.java index a62c8e475f19..7658c7fe1b12 100644 --- a/instrumentation/kafka/kafka-clients/kafka-clients-2.6/library/src/test/java/io/opentelemetry/instrumentation/kafkaclients/v2_6/AbstractInterceptorsTest.java +++ b/instrumentation/kafka/kafka-clients/kafka-clients-2.6/library/src/test/java/io/opentelemetry/instrumentation/kafkaclients/v2_6/AbstractInterceptorsTest.java @@ -7,17 +7,23 @@ import static io.opentelemetry.api.common.AttributeKey.longKey; 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.instrumentation.testing.junit.message.MessageHeaderUtil.headerAttributeKey; import static io.opentelemetry.instrumentation.testing.util.TelemetryDataUtil.orderByRootSpanName; import static io.opentelemetry.sdk.testing.assertj.OpenTelemetryAssertions.equalTo; import static io.opentelemetry.sdk.testing.assertj.OpenTelemetryAssertions.satisfies; 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_PARTITION_ID; import static io.opentelemetry.semconv.incubating.MessagingIncubatingAttributes.MESSAGING_KAFKA_CONSUMER_GROUP; import static io.opentelemetry.semconv.incubating.MessagingIncubatingAttributes.MESSAGING_KAFKA_MESSAGE_OFFSET; +import static io.opentelemetry.semconv.incubating.MessagingIncubatingAttributes.MESSAGING_KAFKA_OFFSET; import static io.opentelemetry.semconv.incubating.MessagingIncubatingAttributes.MESSAGING_MESSAGE_BODY_SIZE; 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.nio.charset.StandardCharsets.UTF_8; import static java.util.Arrays.asList; @@ -32,6 +38,7 @@ import io.opentelemetry.sdk.testing.assertj.AttributeAssertion; import io.opentelemetry.sdk.trace.data.LinkData; import java.time.Duration; +import java.util.ArrayList; import java.util.List; import java.util.Map; import java.util.concurrent.atomic.AtomicReference; @@ -113,12 +120,18 @@ void testInterceptors() throws InterruptedException { void assertTraces() { AtomicReference producerSpanContext = new AtomicReference<>(); testing.waitAndAssertSortedTraces( - orderByRootSpanName("parent", SHARED_TOPIC + " receive", "producer callback"), + orderByRootSpanName( + "parent", + emitStableMessagingSemconv() ? "poll " + SHARED_TOPIC : SHARED_TOPIC + " receive", + "producer callback"), trace -> { trace.hasSpansSatisfyingExactly( span -> span.hasName("parent").hasKind(SpanKind.INTERNAL).hasNoParent(), span -> - span.hasName(SHARED_TOPIC + " publish") + span.hasName( + emitStableMessagingSemconv() + ? "send " + SHARED_TOPIC + : SHARED_TOPIC + " publish") .hasKind(SpanKind.PRODUCER) .hasParent(trace.getSpan(0)) .hasAttributesSatisfyingExactly( @@ -134,13 +147,19 @@ void assertTraces() { trace -> trace.hasSpansSatisfyingExactly( span -> - span.hasName(SHARED_TOPIC + " receive") - .hasKind(SpanKind.CONSUMER) + span.hasName( + emitStableMessagingSemconv() + ? "poll " + SHARED_TOPIC + : SHARED_TOPIC + " receive") + .hasKind(emitStableMessagingSemconv() ? SpanKind.CLIENT : SpanKind.CONSUMER) .hasNoParent() .hasLinksSatisfying(links -> assertThat(links).isEmpty()) .hasAttributesSatisfyingExactly(receiveAttributes()), span -> - span.hasName(SHARED_TOPIC + " process") + span.hasName( + emitStableMessagingSemconv() + ? "process " + SHARED_TOPIC + : SHARED_TOPIC + " process") .hasKind(SpanKind.CONSUMER) .hasParent(trace.getSpan(0)) .hasLinks(LinkData.create(producerSpanContext.get())) @@ -159,49 +178,84 @@ void assertTraces() { } private static List publishAttributes(boolean experimental) { - return asList( - equalTo(headerAttributeKey("Test-Message-Header"), singletonList("test")), - equalTo(MESSAGING_SYSTEM, "kafka"), - equalTo(MESSAGING_DESTINATION_NAME, SHARED_TOPIC), - equalTo(MESSAGING_OPERATION, "publish"), - satisfies(MESSAGING_CLIENT_ID, val -> val.startsWith("producer")), - satisfies( - stringKey("messaging.kafka.bootstrap.servers"), - val -> { - if (experimental) { - val.matches("^localhost:\\d+(,localhost:\\d+)*$"); - } - })); + List assertions = + new ArrayList<>( + asList( + equalTo(headerAttributeKey("Test-Message-Header"), singletonList("test")), + equalTo(MESSAGING_SYSTEM, "kafka"), + equalTo(MESSAGING_DESTINATION_NAME, SHARED_TOPIC), + equalTo(MESSAGING_OPERATION, emitOldMessagingSemconv() ? "publish" : null), + equalTo(MESSAGING_OPERATION_NAME, emitStableMessagingSemconv() ? "send" : null), + equalTo(MESSAGING_OPERATION_TYPE, emitStableMessagingSemconv() ? "send" : null), + satisfies( + stringKey("messaging.kafka.bootstrap.servers"), + val -> { + if (experimental) { + val.matches("^localhost:\\d+(,localhost:\\d+)*$"); + } + }))); + addClientIdAssertions(assertions, "producer"); + return assertions; } private static List receiveAttributes() { - return asList( - equalTo(headerAttributeKey("Test-Message-Header"), singletonList("test")), - equalTo(MESSAGING_SYSTEM, "kafka"), - equalTo(MESSAGING_DESTINATION_NAME, SHARED_TOPIC), - equalTo(MESSAGING_OPERATION, "receive"), - equalTo(MESSAGING_KAFKA_CONSUMER_GROUP, "test"), - satisfies(MESSAGING_CLIENT_ID, val -> val.startsWith("consumer")), - equalTo(MESSAGING_BATCH_MESSAGE_COUNT, 1)); + List assertions = + new ArrayList<>( + asList( + equalTo(headerAttributeKey("Test-Message-Header"), singletonList("test")), + equalTo(MESSAGING_SYSTEM, "kafka"), + equalTo(MESSAGING_DESTINATION_NAME, SHARED_TOPIC), + equalTo(MESSAGING_OPERATION, emitOldMessagingSemconv() ? "receive" : null), + equalTo(MESSAGING_OPERATION_NAME, emitStableMessagingSemconv() ? "poll" : null), + equalTo(MESSAGING_OPERATION_TYPE, emitStableMessagingSemconv() ? "receive" : null), + equalTo(MESSAGING_KAFKA_CONSUMER_GROUP, emitOldMessagingSemconv() ? "test" : null), + equalTo( + MESSAGING_CONSUMER_GROUP_NAME, emitStableMessagingSemconv() ? "test" : null), + equalTo(MESSAGING_BATCH_MESSAGE_COUNT, 1))); + addClientIdAssertions(assertions, "consumer"); + return assertions; } private static List processAttributes(boolean experimental) { - return asList( - equalTo(headerAttributeKey("Test-Message-Header"), singletonList("test")), - equalTo(MESSAGING_SYSTEM, "kafka"), - equalTo(MESSAGING_DESTINATION_NAME, SHARED_TOPIC), - equalTo(MESSAGING_OPERATION, "process"), - equalTo(MESSAGING_MESSAGE_BODY_SIZE, greeting.getBytes(UTF_8).length), - satisfies(MESSAGING_DESTINATION_PARTITION_ID, AbstractStringAssert::isNotEmpty), - satisfies(MESSAGING_KAFKA_MESSAGE_OFFSET, AbstractLongAssert::isNotNegative), - equalTo(MESSAGING_KAFKA_CONSUMER_GROUP, "test"), - satisfies(MESSAGING_CLIENT_ID, val -> val.startsWith("consumer")), - satisfies( - longKey("kafka.record.queue_time_ms"), - val -> { - if (experimental) { - val.isNotNegative(); - } - })); + List assertions = + new ArrayList<>( + asList( + equalTo(headerAttributeKey("Test-Message-Header"), singletonList("test")), + equalTo(MESSAGING_SYSTEM, "kafka"), + equalTo(MESSAGING_DESTINATION_NAME, SHARED_TOPIC), + equalTo(MESSAGING_OPERATION, emitOldMessagingSemconv() ? "process" : null), + equalTo(MESSAGING_OPERATION_NAME, emitStableMessagingSemconv() ? "process" : null), + equalTo(MESSAGING_OPERATION_TYPE, emitStableMessagingSemconv() ? "process" : null), + equalTo(MESSAGING_MESSAGE_BODY_SIZE, greeting.getBytes(UTF_8).length), + satisfies(MESSAGING_DESTINATION_PARTITION_ID, AbstractStringAssert::isNotEmpty), + equalTo(MESSAGING_KAFKA_CONSUMER_GROUP, emitOldMessagingSemconv() ? "test" : null), + equalTo( + MESSAGING_CONSUMER_GROUP_NAME, emitStableMessagingSemconv() ? "test" : null), + satisfies( + longKey("kafka.record.queue_time_ms"), + val -> { + if (experimental) { + val.isNotNegative(); + } + }))); + if (emitOldMessagingSemconv()) { + assertions.add(satisfies(MESSAGING_KAFKA_MESSAGE_OFFSET, AbstractLongAssert::isNotNegative)); + } + if (emitStableMessagingSemconv()) { + assertions.add(satisfies(MESSAGING_KAFKA_OFFSET, AbstractLongAssert::isNotNegative)); + } + addClientIdAssertions(assertions, "consumer"); + return assertions; + } + + private static void addClientIdAssertions( + List assertions, String clientIdPrefix) { + if (emitOldMessagingSemconv()) { + assertions.add(satisfies(MESSAGING_CLIENT_ID_OLD, val -> val.startsWith(clientIdPrefix))); + } + if (emitStableMessagingSemconv()) { + assertions.add( + satisfies(stringKey("messaging.client.id"), val -> val.startsWith(clientIdPrefix))); + } } } diff --git a/instrumentation/kafka/kafka-clients/kafka-clients-2.6/library/src/test/java/io/opentelemetry/instrumentation/kafkaclients/v2_6/InterceptorsSuppressReceiveSpansTest.java b/instrumentation/kafka/kafka-clients/kafka-clients-2.6/library/src/test/java/io/opentelemetry/instrumentation/kafkaclients/v2_6/InterceptorsSuppressReceiveSpansTest.java index 8555895bd51c..8a50bc25bebf 100644 --- a/instrumentation/kafka/kafka-clients/kafka-clients-2.6/library/src/test/java/io/opentelemetry/instrumentation/kafkaclients/v2_6/InterceptorsSuppressReceiveSpansTest.java +++ b/instrumentation/kafka/kafka-clients/kafka-clients-2.6/library/src/test/java/io/opentelemetry/instrumentation/kafkaclients/v2_6/InterceptorsSuppressReceiveSpansTest.java @@ -6,21 +6,32 @@ package io.opentelemetry.instrumentation.kafkaclients.v2_6; 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.equalTo; import static io.opentelemetry.sdk.testing.assertj.OpenTelemetryAssertions.satisfies; +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_PARTITION_ID; import static io.opentelemetry.semconv.incubating.MessagingIncubatingAttributes.MESSAGING_KAFKA_CONSUMER_GROUP; import static io.opentelemetry.semconv.incubating.MessagingIncubatingAttributes.MESSAGING_KAFKA_MESSAGE_OFFSET; +import static io.opentelemetry.semconv.incubating.MessagingIncubatingAttributes.MESSAGING_KAFKA_OFFSET; import static io.opentelemetry.semconv.incubating.MessagingIncubatingAttributes.MESSAGING_MESSAGE_BODY_SIZE; 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.nio.charset.StandardCharsets.UTF_8; +import static java.util.Arrays.asList; import io.opentelemetry.api.trace.SpanKind; +import io.opentelemetry.sdk.testing.assertj.AttributeAssertion; +import java.util.ArrayList; +import java.util.List; import org.assertj.core.api.AbstractLongAssert; import org.assertj.core.api.AbstractStringAssert; +@SuppressWarnings("deprecation") // using deprecated semconv class InterceptorsSuppressReceiveSpansTest extends AbstractInterceptorsTest { private static final KafkaTelemetry kafkaTelemetry = @@ -36,7 +47,6 @@ protected boolean captureExperimentalSpanAttributes() { return false; } - @SuppressWarnings("deprecation") // using deprecated semconv @Override void assertTraces() { testing.waitAndAssertTraces( @@ -44,32 +54,21 @@ void assertTraces() { trace.hasSpansSatisfyingExactly( span -> span.hasName("parent").hasKind(SpanKind.INTERNAL).hasNoParent(), span -> - span.hasName(SHARED_TOPIC + " publish") + span.hasName( + emitStableMessagingSemconv() + ? "send " + SHARED_TOPIC + : SHARED_TOPIC + " publish") .hasKind(SpanKind.PRODUCER) .hasParent(trace.getSpan(0)) - .hasAttributesSatisfyingExactly( - equalTo(MESSAGING_SYSTEM, "kafka"), - equalTo(MESSAGING_DESTINATION_NAME, SHARED_TOPIC), - equalTo(MESSAGING_OPERATION, "publish"), - satisfies(MESSAGING_CLIENT_ID, val -> val.startsWith("producer"))), + .hasAttributesSatisfyingExactly(sendAttributes()), span -> - span.hasName(SHARED_TOPIC + " process") + span.hasName( + emitStableMessagingSemconv() + ? "process " + SHARED_TOPIC + : SHARED_TOPIC + " process") .hasKind(SpanKind.CONSUMER) .hasParent(trace.getSpan(1)) - .hasAttributesSatisfyingExactly( - equalTo(MESSAGING_SYSTEM, "kafka"), - equalTo(MESSAGING_DESTINATION_NAME, SHARED_TOPIC), - equalTo(MESSAGING_OPERATION, "process"), - equalTo(MESSAGING_MESSAGE_BODY_SIZE, greeting.getBytes(UTF_8).length), - satisfies( - MESSAGING_DESTINATION_PARTITION_ID, - AbstractStringAssert::isNotEmpty), - satisfies( - MESSAGING_KAFKA_MESSAGE_OFFSET, AbstractLongAssert::isNotNegative), - equalTo(MESSAGING_KAFKA_CONSUMER_GROUP, "test"), - satisfies(MESSAGING_CLIENT_ID, val -> val.startsWith("consumer")), - equalTo(stringKey("test-baggage-key-1"), "test-baggage-value-1"), - equalTo(stringKey("test-baggage-key-2"), "test-baggage-value-2")), + .hasAttributesSatisfyingExactly(processAttributes()), span -> span.hasName("process child") .hasKind(SpanKind.INTERNAL) @@ -81,4 +80,54 @@ void assertTraces() { span -> span.hasName("producer callback").hasKind(SpanKind.INTERNAL).hasNoParent())); } + + private static List sendAttributes() { + List assertions = + new ArrayList<>( + asList( + equalTo(MESSAGING_SYSTEM, "kafka"), + equalTo(MESSAGING_DESTINATION_NAME, SHARED_TOPIC), + equalTo(MESSAGING_OPERATION, emitOldMessagingSemconv() ? "publish" : null), + equalTo(MESSAGING_OPERATION_NAME, emitStableMessagingSemconv() ? "send" : null), + equalTo(MESSAGING_OPERATION_TYPE, emitStableMessagingSemconv() ? "send" : null))); + addClientIdAssertion(assertions, "producer"); + return assertions; + } + + private static List processAttributes() { + List assertions = + new ArrayList<>( + asList( + equalTo(MESSAGING_SYSTEM, "kafka"), + equalTo(MESSAGING_DESTINATION_NAME, SHARED_TOPIC), + equalTo(MESSAGING_OPERATION, emitOldMessagingSemconv() ? "process" : null), + equalTo(MESSAGING_OPERATION_NAME, emitStableMessagingSemconv() ? "process" : null), + equalTo(MESSAGING_OPERATION_TYPE, emitStableMessagingSemconv() ? "process" : null), + equalTo(MESSAGING_MESSAGE_BODY_SIZE, greeting.getBytes(UTF_8).length), + satisfies(MESSAGING_DESTINATION_PARTITION_ID, AbstractStringAssert::isNotEmpty), + equalTo(MESSAGING_KAFKA_CONSUMER_GROUP, emitOldMessagingSemconv() ? "test" : null), + equalTo( + MESSAGING_CONSUMER_GROUP_NAME, emitStableMessagingSemconv() ? "test" : null), + equalTo(stringKey("test-baggage-key-1"), "test-baggage-value-1"), + equalTo(stringKey("test-baggage-key-2"), "test-baggage-value-2"))); + if (emitOldMessagingSemconv()) { + assertions.add(satisfies(MESSAGING_KAFKA_MESSAGE_OFFSET, AbstractLongAssert::isNotNegative)); + } + if (emitStableMessagingSemconv()) { + assertions.add(satisfies(MESSAGING_KAFKA_OFFSET, AbstractLongAssert::isNotNegative)); + } + addClientIdAssertion(assertions, "consumer"); + return assertions; + } + + private static void addClientIdAssertion( + List assertions, String clientIdPrefix) { + if (emitOldMessagingSemconv()) { + assertions.add(satisfies(MESSAGING_CLIENT_ID_OLD, val -> val.startsWith(clientIdPrefix))); + } + if (emitStableMessagingSemconv()) { + assertions.add( + satisfies(stringKey("messaging.client.id"), val -> val.startsWith(clientIdPrefix))); + } + } } diff --git a/instrumentation/kafka/kafka-clients/kafka-clients-2.6/library/src/test/java/io/opentelemetry/instrumentation/kafkaclients/v2_6/WrapperPropagationDisabledTest.java b/instrumentation/kafka/kafka-clients/kafka-clients-2.6/library/src/test/java/io/opentelemetry/instrumentation/kafkaclients/v2_6/WrapperPropagationDisabledTest.java index 542758cde145..a20b4bd8de8b 100644 --- a/instrumentation/kafka/kafka-clients/kafka-clients-2.6/library/src/test/java/io/opentelemetry/instrumentation/kafkaclients/v2_6/WrapperPropagationDisabledTest.java +++ b/instrumentation/kafka/kafka-clients/kafka-clients-2.6/library/src/test/java/io/opentelemetry/instrumentation/kafkaclients/v2_6/WrapperPropagationDisabledTest.java @@ -5,6 +5,8 @@ package io.opentelemetry.instrumentation.kafkaclients.v2_6; +import static io.opentelemetry.instrumentation.api.internal.SemconvStability.emitStableMessagingSemconv; + import io.opentelemetry.api.trace.SpanKind; import io.opentelemetry.sdk.testing.assertj.AttributeAssertion; import java.util.List; @@ -23,7 +25,10 @@ void assertTraces(boolean testHeaders, boolean testExperimental) { trace.hasSpansSatisfyingExactly( span -> span.hasName("parent").hasKind(SpanKind.INTERNAL).hasNoParent(), span -> - span.hasName(SHARED_TOPIC + " publish") + span.hasName( + emitStableMessagingSemconv() + ? "send " + SHARED_TOPIC + : SHARED_TOPIC + " publish") .hasKind(SpanKind.PRODUCER) .hasParent(trace.getSpan(0)) .hasAttributesSatisfyingExactly( @@ -35,7 +40,10 @@ void assertTraces(boolean testHeaders, boolean testExperimental) { trace -> trace.hasSpansSatisfyingExactly( span -> - span.hasName(SHARED_TOPIC + " process") + span.hasName( + emitStableMessagingSemconv() + ? "process " + SHARED_TOPIC + : SHARED_TOPIC + " process") .hasKind(SpanKind.CONSUMER) .hasNoParent() .hasLinks() diff --git a/instrumentation/kafka/kafka-clients/kafka-clients-2.6/library/src/test/java/io/opentelemetry/instrumentation/kafkaclients/v2_6/WrapperSendExceptionTest.java b/instrumentation/kafka/kafka-clients/kafka-clients-2.6/library/src/test/java/io/opentelemetry/instrumentation/kafkaclients/v2_6/WrapperSendExceptionTest.java index 81d232ddeea5..ec2eb0a40581 100644 --- a/instrumentation/kafka/kafka-clients/kafka-clients-2.6/library/src/test/java/io/opentelemetry/instrumentation/kafkaclients/v2_6/WrapperSendExceptionTest.java +++ b/instrumentation/kafka/kafka-clients/kafka-clients-2.6/library/src/test/java/io/opentelemetry/instrumentation/kafkaclients/v2_6/WrapperSendExceptionTest.java @@ -5,6 +5,7 @@ package io.opentelemetry.instrumentation.kafkaclients.v2_6; +import static io.opentelemetry.instrumentation.api.internal.SemconvStability.emitStableMessagingSemconv; import static org.assertj.core.api.Assertions.assertThatThrownBy; import static org.mockito.ArgumentMatchers.any; import static org.mockito.Mockito.mock; @@ -46,7 +47,8 @@ void producerSpanEndedWhenSendThrowsSynchronously() { trace.hasSpansSatisfyingExactly( span -> span.hasName("parent").hasKind(SpanKind.INTERNAL).hasNoParent(), span -> - span.hasName("test-topic publish") + span.hasName( + emitStableMessagingSemconv() ? "send test-topic" : "test-topic publish") .hasKind(SpanKind.PRODUCER) .hasParent(trace.getSpan(0)) .hasStatus(StatusData.error()))); diff --git a/instrumentation/kafka/kafka-clients/kafka-clients-2.6/library/src/test/java/io/opentelemetry/instrumentation/kafkaclients/v2_6/WrapperSuppressReceiveSpansTest.java b/instrumentation/kafka/kafka-clients/kafka-clients-2.6/library/src/test/java/io/opentelemetry/instrumentation/kafkaclients/v2_6/WrapperSuppressReceiveSpansTest.java index a549ce1aa7f4..0355bd13037a 100644 --- a/instrumentation/kafka/kafka-clients/kafka-clients-2.6/library/src/test/java/io/opentelemetry/instrumentation/kafkaclients/v2_6/WrapperSuppressReceiveSpansTest.java +++ b/instrumentation/kafka/kafka-clients/kafka-clients-2.6/library/src/test/java/io/opentelemetry/instrumentation/kafkaclients/v2_6/WrapperSuppressReceiveSpansTest.java @@ -5,28 +5,11 @@ package io.opentelemetry.instrumentation.kafkaclients.v2_6; -import static io.opentelemetry.api.common.AttributeKey.longKey; -import static io.opentelemetry.api.common.AttributeKey.stringKey; -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; -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_KAFKA_CONSUMER_GROUP; -import static io.opentelemetry.semconv.incubating.MessagingIncubatingAttributes.MESSAGING_KAFKA_MESSAGE_OFFSET; -import static io.opentelemetry.semconv.incubating.MessagingIncubatingAttributes.MESSAGING_MESSAGE_BODY_SIZE; -import static io.opentelemetry.semconv.incubating.MessagingIncubatingAttributes.MESSAGING_OPERATION; -import static io.opentelemetry.semconv.incubating.MessagingIncubatingAttributes.MESSAGING_SYSTEM; -import static java.nio.charset.StandardCharsets.UTF_8; -import static java.util.Arrays.asList; -import static java.util.Collections.singletonList; +import static io.opentelemetry.instrumentation.api.internal.SemconvStability.emitStableMessagingSemconv; import io.opentelemetry.api.trace.SpanKind; import io.opentelemetry.sdk.testing.assertj.AttributeAssertion; -import java.util.ArrayList; import java.util.List; -import org.assertj.core.api.AbstractLongAssert; -import org.assertj.core.api.AbstractStringAssert; @SuppressWarnings("deprecation") // using deprecated semconv class WrapperSuppressReceiveSpansTest extends AbstractWrapperTest { @@ -43,13 +26,19 @@ void assertTraces(boolean testHeaders, boolean testExperimental) { trace.hasSpansSatisfyingExactly( span -> span.hasName("parent").hasKind(SpanKind.INTERNAL).hasNoParent(), span -> - span.hasName(SHARED_TOPIC + " publish") + span.hasName( + emitStableMessagingSemconv() + ? "send " + SHARED_TOPIC + : SHARED_TOPIC + " publish") .hasKind(SpanKind.PRODUCER) .hasParent(trace.getSpan(0)) .hasAttributesSatisfyingExactly( sendAttributes(testHeaders, testExperimental)), span -> - span.hasName(SHARED_TOPIC + " process") + span.hasName( + emitStableMessagingSemconv() + ? "process " + SHARED_TOPIC + : SHARED_TOPIC + " process") .hasKind(SpanKind.CONSUMER) .hasParent(trace.getSpan(1)) .hasAttributesSatisfyingExactly( @@ -65,47 +54,11 @@ void assertTraces(boolean testHeaders, boolean testExperimental) { } static List sendAttributes(boolean testHeaders, boolean testExperimental) { - List assertions = - new ArrayList<>( - asList( - equalTo(MESSAGING_SYSTEM, "kafka"), - equalTo(MESSAGING_DESTINATION_NAME, SHARED_TOPIC), - equalTo(MESSAGING_OPERATION, "publish"), - satisfies(MESSAGING_CLIENT_ID, val -> val.startsWith("producer")), - satisfies(MESSAGING_DESTINATION_PARTITION_ID, AbstractStringAssert::isNotEmpty), - satisfies(MESSAGING_KAFKA_MESSAGE_OFFSET, AbstractLongAssert::isNotNegative))); - if (testHeaders) { - assertions.add(equalTo(headerAttributeKey("Test-Message-Header"), singletonList("test"))); - } - if (testExperimental) { - assertions.add( - satisfies( - stringKey("messaging.kafka.bootstrap.servers"), - val -> val.matches("^localhost:\\d+(,localhost:\\d+)*$"))); - } - return assertions; + return WrapperTest.sendAttributes(testHeaders, testExperimental); } static List processAttributes( String greeting, boolean testHeaders, boolean testExperimental) { - List assertions = - new ArrayList<>( - asList( - equalTo(MESSAGING_SYSTEM, "kafka"), - equalTo(MESSAGING_DESTINATION_NAME, SHARED_TOPIC), - equalTo(MESSAGING_OPERATION, "process"), - equalTo(MESSAGING_MESSAGE_BODY_SIZE, greeting.getBytes(UTF_8).length), - satisfies(MESSAGING_DESTINATION_PARTITION_ID, AbstractStringAssert::isNotEmpty), - satisfies(MESSAGING_KAFKA_MESSAGE_OFFSET, AbstractLongAssert::isNotNegative), - equalTo(MESSAGING_KAFKA_CONSUMER_GROUP, "test"), - satisfies(MESSAGING_CLIENT_ID, val -> val.startsWith("consumer")))); - if (testHeaders) { - assertions.add(equalTo(headerAttributeKey("Test-Message-Header"), singletonList("test"))); - } - if (testExperimental) { - assertions.add( - satisfies(longKey("kafka.record.queue_time_ms"), AbstractLongAssert::isNotNegative)); - } - return assertions; + return WrapperTest.processAttributes(greeting, testHeaders, testExperimental); } } diff --git a/instrumentation/kafka/kafka-clients/kafka-clients-2.6/library/src/test/java/io/opentelemetry/instrumentation/kafkaclients/v2_6/WrapperTest.java b/instrumentation/kafka/kafka-clients/kafka-clients-2.6/library/src/test/java/io/opentelemetry/instrumentation/kafkaclients/v2_6/WrapperTest.java index c9f784651554..c6b012c73b01 100644 --- a/instrumentation/kafka/kafka-clients/kafka-clients-2.6/library/src/test/java/io/opentelemetry/instrumentation/kafkaclients/v2_6/WrapperTest.java +++ b/instrumentation/kafka/kafka-clients/kafka-clients-2.6/library/src/test/java/io/opentelemetry/instrumentation/kafkaclients/v2_6/WrapperTest.java @@ -9,16 +9,23 @@ import static io.opentelemetry.api.common.AttributeKey.stringKey; import static io.opentelemetry.instrumentation.api.internal.SemconvExceptionSignal.emitExceptionAsLogs; import static io.opentelemetry.instrumentation.api.internal.SemconvExceptionSignal.emitExceptionAsSpanEvents; +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.sdk.testing.assertj.OpenTelemetryAssertions.satisfies; +import static io.opentelemetry.semconv.ErrorAttributes.ERROR_TYPE; import static io.opentelemetry.semconv.incubating.MessagingIncubatingAttributes.MESSAGING_BATCH_MESSAGE_COUNT; +import static io.opentelemetry.semconv.incubating.MessagingIncubatingAttributes.MESSAGING_CONSUMER_GROUP_NAME; import static io.opentelemetry.semconv.incubating.MessagingIncubatingAttributes.MESSAGING_DESTINATION_NAME; import static io.opentelemetry.semconv.incubating.MessagingIncubatingAttributes.MESSAGING_DESTINATION_PARTITION_ID; import static io.opentelemetry.semconv.incubating.MessagingIncubatingAttributes.MESSAGING_KAFKA_CONSUMER_GROUP; import static io.opentelemetry.semconv.incubating.MessagingIncubatingAttributes.MESSAGING_KAFKA_MESSAGE_OFFSET; +import static io.opentelemetry.semconv.incubating.MessagingIncubatingAttributes.MESSAGING_KAFKA_OFFSET; import static io.opentelemetry.semconv.incubating.MessagingIncubatingAttributes.MESSAGING_MESSAGE_BODY_SIZE; 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.nio.charset.StandardCharsets.UTF_8; import static java.util.Arrays.asList; @@ -60,7 +67,10 @@ void assertTraces(boolean testHeaders, boolean testExperimental) { trace.hasSpansSatisfyingExactly( span -> span.hasName("parent").hasKind(SpanKind.INTERNAL).hasNoParent(), span -> - span.hasName(SHARED_TOPIC + " publish") + span.hasName( + emitStableMessagingSemconv() + ? "send " + SHARED_TOPIC + : SHARED_TOPIC + " publish") .hasKind(SpanKind.PRODUCER) .hasParent(trace.getSpan(0)) .hasAttributesSatisfyingExactly( @@ -80,13 +90,19 @@ void assertTraces(boolean testHeaders, boolean testExperimental) { trace -> trace.hasSpansSatisfyingExactly( span -> - span.hasName(SHARED_TOPIC + " receive") - .hasKind(SpanKind.CONSUMER) + span.hasName( + emitStableMessagingSemconv() + ? "poll " + SHARED_TOPIC + : SHARED_TOPIC + " receive") + .hasKind(emitStableMessagingSemconv() ? SpanKind.CLIENT : SpanKind.CONSUMER) .hasNoParent() .hasLinksSatisfying(links -> assertThat(links).isEmpty()) .hasAttributesSatisfyingExactly(receiveAttributes(testHeaders)), span -> - span.hasName(SHARED_TOPIC + " process") + span.hasName( + emitStableMessagingSemconv() + ? "process " + SHARED_TOPIC + : SHARED_TOPIC + " process") .hasKind(SpanKind.CONSUMER) .hasParent(trace.getSpan(0)) .hasLinks(LinkData.create(producerSpanContext.get())) @@ -105,10 +121,12 @@ protected static List sendAttributes( asList( equalTo(MESSAGING_SYSTEM, "kafka"), equalTo(MESSAGING_DESTINATION_NAME, SHARED_TOPIC), - equalTo(MESSAGING_OPERATION, "publish"), - satisfies(MESSAGING_CLIENT_ID, val -> val.startsWith("producer")), - satisfies(MESSAGING_DESTINATION_PARTITION_ID, AbstractStringAssert::isNotEmpty), - satisfies(MESSAGING_KAFKA_MESSAGE_OFFSET, AbstractLongAssert::isNotNegative))); + equalTo(MESSAGING_OPERATION, emitOldMessagingSemconv() ? "publish" : null), + equalTo(MESSAGING_OPERATION_NAME, emitStableMessagingSemconv() ? "send" : null), + equalTo(MESSAGING_OPERATION_TYPE, emitStableMessagingSemconv() ? "send" : null), + satisfies(MESSAGING_DESTINATION_PARTITION_ID, AbstractStringAssert::isNotEmpty))); + addClientIdAssertions(assertions, "producer"); + addOffsetAssertions(assertions); if (testHeaders) { assertions.add( equalTo( @@ -123,19 +141,23 @@ protected static List sendAttributes( return assertions; } - private static List processAttributes( + static List processAttributes( String greeting, boolean testHeaders, boolean testExperimental) { List assertions = new ArrayList<>( asList( equalTo(MESSAGING_SYSTEM, "kafka"), equalTo(MESSAGING_DESTINATION_NAME, SHARED_TOPIC), - equalTo(MESSAGING_OPERATION, "process"), + equalTo(MESSAGING_OPERATION, emitOldMessagingSemconv() ? "process" : null), + equalTo(MESSAGING_OPERATION_NAME, emitStableMessagingSemconv() ? "process" : null), + equalTo(MESSAGING_OPERATION_TYPE, emitStableMessagingSemconv() ? "process" : null), equalTo(MESSAGING_MESSAGE_BODY_SIZE, greeting.getBytes(UTF_8).length), satisfies(MESSAGING_DESTINATION_PARTITION_ID, AbstractStringAssert::isNotEmpty), - satisfies(MESSAGING_KAFKA_MESSAGE_OFFSET, AbstractLongAssert::isNotNegative), - equalTo(MESSAGING_KAFKA_CONSUMER_GROUP, "test"), - satisfies(MESSAGING_CLIENT_ID, val -> val.startsWith("consumer")))); + equalTo(MESSAGING_KAFKA_CONSUMER_GROUP, emitOldMessagingSemconv() ? "test" : null), + equalTo( + MESSAGING_CONSUMER_GROUP_NAME, emitStableMessagingSemconv() ? "test" : null))); + addClientIdAssertions(assertions, "consumer"); + addOffsetAssertions(assertions); if (testHeaders) { assertions.add( equalTo( @@ -154,10 +176,14 @@ protected static List receiveAttributes(boolean testHeaders) asList( equalTo(MESSAGING_SYSTEM, "kafka"), equalTo(MESSAGING_DESTINATION_NAME, SHARED_TOPIC), - equalTo(MESSAGING_OPERATION, "receive"), - equalTo(MESSAGING_KAFKA_CONSUMER_GROUP, "test"), - satisfies(MESSAGING_CLIENT_ID, val -> val.startsWith("consumer")), + equalTo(MESSAGING_OPERATION, emitOldMessagingSemconv() ? "receive" : null), + equalTo(MESSAGING_OPERATION_NAME, emitStableMessagingSemconv() ? "poll" : null), + equalTo(MESSAGING_OPERATION_TYPE, emitStableMessagingSemconv() ? "receive" : null), + equalTo(MESSAGING_KAFKA_CONSUMER_GROUP, emitOldMessagingSemconv() ? "test" : null), + equalTo( + MESSAGING_CONSUMER_GROUP_NAME, emitStableMessagingSemconv() ? "test" : null), equalTo(MESSAGING_BATCH_MESSAGE_COUNT, 1))); + addClientIdAssertions(assertions, "consumer"); if (testHeaders) { assertions.add( equalTo( @@ -166,6 +192,26 @@ protected static List receiveAttributes(boolean testHeaders) return assertions; } + private static void addClientIdAssertions( + List assertions, String clientIdPrefix) { + if (emitOldMessagingSemconv()) { + assertions.add(satisfies(MESSAGING_CLIENT_ID_OLD, val -> val.startsWith(clientIdPrefix))); + } + if (emitStableMessagingSemconv()) { + assertions.add( + satisfies(stringKey("messaging.client.id"), val -> val.startsWith(clientIdPrefix))); + } + } + + private static void addOffsetAssertions(List assertions) { + if (emitOldMessagingSemconv()) { + assertions.add(satisfies(MESSAGING_KAFKA_MESSAGE_OFFSET, AbstractLongAssert::isNotNegative)); + } + if (emitStableMessagingSemconv()) { + assertions.add(satisfies(MESSAGING_KAFKA_OFFSET, AbstractLongAssert::isNotNegative)); + } + } + @Test void testConsumerError() { KafkaTelemetryBuilder telemetryBuilder = KafkaTelemetry.builder(testing.getOpenTelemetry()); @@ -182,14 +228,26 @@ void testConsumerError() { trace -> trace.hasSpansSatisfyingExactly( span -> - span.hasName("unknown receive") - .hasKind(SpanKind.CONSUMER) + span.hasName(emitStableMessagingSemconv() ? "poll" : "unknown receive") + .hasKind(emitStableMessagingSemconv() ? SpanKind.CLIENT : SpanKind.CONSUMER) .hasNoParent() .hasStatus(StatusData.error()) .hasException(emitExceptionAsSpanEvents() ? error : null) .hasAttributesSatisfyingExactly( equalTo(MESSAGING_SYSTEM, "kafka"), - equalTo(MESSAGING_OPERATION, "receive"), + equalTo( + MESSAGING_OPERATION, emitOldMessagingSemconv() ? "receive" : null), + equalTo( + MESSAGING_OPERATION_NAME, + emitStableMessagingSemconv() ? "poll" : null), + equalTo( + MESSAGING_OPERATION_TYPE, + emitStableMessagingSemconv() ? "receive" : null), + equalTo( + ERROR_TYPE, + emitStableMessagingSemconv() + ? IllegalStateException.class.getName() + : null), equalTo(MESSAGING_BATCH_MESSAGE_COUNT, 0)))); if (emitExceptionAsLogs()) { diff --git a/instrumentation/kafka/kafka-clients/kafka-clients-common-0.11/library/src/main/java/io/opentelemetry/instrumentation/kafkaclients/common/v0_11/internal/KafkaConsumerAttributesExtractor.java b/instrumentation/kafka/kafka-clients/kafka-clients-common-0.11/library/src/main/java/io/opentelemetry/instrumentation/kafkaclients/common/v0_11/internal/KafkaConsumerAttributesExtractor.java index f1c226cfd8b6..a37bf3d1766e 100644 --- a/instrumentation/kafka/kafka-clients/kafka-clients-common-0.11/library/src/main/java/io/opentelemetry/instrumentation/kafkaclients/common/v0_11/internal/KafkaConsumerAttributesExtractor.java +++ b/instrumentation/kafka/kafka-clients/kafka-clients-common-0.11/library/src/main/java/io/opentelemetry/instrumentation/kafkaclients/common/v0_11/internal/KafkaConsumerAttributesExtractor.java @@ -24,6 +24,8 @@ final class KafkaConsumerAttributesExtractor AttributeKey.stringKey("messaging.destination.partition.id"); private static final AttributeKey MESSAGING_KAFKA_CONSUMER_GROUP = AttributeKey.stringKey("messaging.kafka.consumer.group"); + private static final AttributeKey MESSAGING_CONSUMER_GROUP_NAME = + AttributeKey.stringKey("messaging.consumer.group.name"); private static final AttributeKey MESSAGING_KAFKA_MESSAGE_KEY = AttributeKey.stringKey("messaging.kafka.message.key"); private static final AttributeKey MESSAGING_KAFKA_MESSAGE_OFFSET = @@ -54,7 +56,12 @@ public void onStart( attributes.put(MESSAGING_KAFKA_MESSAGE_TOMBSTONE, true); } - attributes.put(MESSAGING_KAFKA_CONSUMER_GROUP, request.getConsumerGroup()); + if (emitOldMessagingSemconv()) { + attributes.put(MESSAGING_KAFKA_CONSUMER_GROUP, request.getConsumerGroup()); + } + if (emitStableMessagingSemconv()) { + attributes.put(MESSAGING_CONSUMER_GROUP_NAME, request.getConsumerGroup()); + } } private static boolean canSerialize(Class keyClass) { diff --git a/instrumentation/kafka/kafka-clients/kafka-clients-common-0.11/library/src/main/java/io/opentelemetry/instrumentation/kafkaclients/common/v0_11/internal/KafkaInstrumenterFactory.java b/instrumentation/kafka/kafka-clients/kafka-clients-common-0.11/library/src/main/java/io/opentelemetry/instrumentation/kafkaclients/common/v0_11/internal/KafkaInstrumenterFactory.java index 977f0ec3140f..dbb0b38745e8 100644 --- a/instrumentation/kafka/kafka-clients/kafka-clients-common-0.11/library/src/main/java/io/opentelemetry/instrumentation/kafkaclients/common/v0_11/internal/KafkaInstrumenterFactory.java +++ b/instrumentation/kafka/kafka-clients/kafka-clients-common-0.11/library/src/main/java/io/opentelemetry/instrumentation/kafkaclients/common/v0_11/internal/KafkaInstrumenterFactory.java @@ -15,6 +15,7 @@ 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.instrumenter.AttributesExtractor; import io.opentelemetry.instrumentation.api.instrumenter.ErrorCauseExtractor; @@ -80,14 +81,18 @@ public Instrumenter createProducerInstrume KafkaProducerAttributesGetter getter = new KafkaProducerAttributesGetter(); MessagingOperationType operationType = MessagingOperationType.SEND; + String operationName = "send"; InstrumenterBuilder builder = Instrumenter.builder( openTelemetry, instrumentationName, - MessagingSpanNameExtractor.create(getter, operationType)) + MessagingSpanNameExtractor.builder(getter, operationType) + .setOperationName(operationName) + .build()) .addAttributesExtractor( - buildMessagingAttributesExtractor(getter, operationType, capturedHeaders)) + buildMessagingAttributesExtractor( + getter, operationType, operationName, capturedHeaders)) .addAttributesExtractors(extractors) .addAttributesExtractor(new KafkaProducerAttributesExtractor()) .setErrorCauseExtractor(errorCauseExtractor); @@ -95,7 +100,7 @@ public Instrumenter createProducerInstrume builder.addAttributesExtractor(new KafkaProducerExperimentalAttributesExtractor()); } setMessagingSendExceptionEventExtractor(builder); - return builder.buildInstrumenter(SpanKindExtractor.alwaysProducer()); + return builder.buildInstrumenter(MessagingSpanKindExtractor.create(operationType)); } public Instrumenter createConsumerReceiveInstrumenter() { @@ -106,20 +111,24 @@ public Instrumenter createConsumerReceiveInstrumenter Iterable> extractors) { KafkaReceiveAttributesGetter getter = new KafkaReceiveAttributesGetter(); MessagingOperationType operationType = MessagingOperationType.RECEIVE; + String operationName = "poll"; InstrumenterBuilder builder = Instrumenter.builder( openTelemetry, instrumentationName, - MessagingSpanNameExtractor.create(getter, operationType)) + MessagingSpanNameExtractor.builder(getter, operationType) + .setOperationName(operationName) + .build()) .addAttributesExtractor( - buildMessagingAttributesExtractor(getter, operationType, capturedHeaders)) + buildMessagingAttributesExtractor( + getter, operationType, operationName, capturedHeaders)) .addAttributesExtractor(new KafkaReceiveAttributesExtractor()) .addAttributesExtractors(extractors) .setErrorCauseExtractor(errorCauseExtractor) .setEnabled(messagingReceiveInstrumentationEnabled); setMessagingReceiveExceptionEventExtractor(builder); - return builder.buildInstrumenter(SpanKindExtractor.alwaysConsumer()); + return builder.buildInstrumenter(MessagingSpanKindExtractor.create(operationType)); } public Instrumenter createConsumerProcessInstrumenter() { @@ -177,6 +186,18 @@ public Instrumenter createBatchProcessInstrumenter() return builder.buildInstrumenter(SpanKindExtractor.alwaysConsumer()); } + private static + AttributesExtractor buildMessagingAttributesExtractor( + MessagingAttributesGetter getter, + MessagingOperationType operationType, + String operationName, + List capturedHeaders) { + return MessagingAttributesExtractor.builder(getter, operationType) + .setOperationName(operationName) + .setCapturedHeaders(capturedHeaders) + .build(); + } + private static AttributesExtractor buildMessagingAttributesExtractor( MessagingAttributesGetter getter, diff --git a/instrumentation/kafka/kafka-clients/kafka-clients-common-0.11/library/src/main/java/io/opentelemetry/instrumentation/kafkaclients/common/v0_11/internal/KafkaReceiveAttributesExtractor.java b/instrumentation/kafka/kafka-clients/kafka-clients-common-0.11/library/src/main/java/io/opentelemetry/instrumentation/kafkaclients/common/v0_11/internal/KafkaReceiveAttributesExtractor.java index e4470ee4f641..adaf62ca27e3 100644 --- a/instrumentation/kafka/kafka-clients/kafka-clients-common-0.11/library/src/main/java/io/opentelemetry/instrumentation/kafkaclients/common/v0_11/internal/KafkaReceiveAttributesExtractor.java +++ b/instrumentation/kafka/kafka-clients/kafka-clients-common-0.11/library/src/main/java/io/opentelemetry/instrumentation/kafkaclients/common/v0_11/internal/KafkaReceiveAttributesExtractor.java @@ -5,6 +5,9 @@ package io.opentelemetry.instrumentation.kafkaclients.common.v0_11.internal; +import static io.opentelemetry.instrumentation.api.internal.SemconvStability.emitOldMessagingSemconv; +import static io.opentelemetry.instrumentation.api.internal.SemconvStability.emitStableMessagingSemconv; + import io.opentelemetry.api.common.AttributeKey; import io.opentelemetry.api.common.AttributesBuilder; import io.opentelemetry.context.Context; @@ -17,11 +20,18 @@ final class KafkaReceiveAttributesExtractor // copied from MessagingIncubatingAttributes private static final AttributeKey MESSAGING_KAFKA_CONSUMER_GROUP = AttributeKey.stringKey("messaging.kafka.consumer.group"); + private static final AttributeKey MESSAGING_CONSUMER_GROUP_NAME = + AttributeKey.stringKey("messaging.consumer.group.name"); @Override public void onStart( AttributesBuilder attributes, Context parentContext, KafkaReceiveRequest request) { - attributes.put(MESSAGING_KAFKA_CONSUMER_GROUP, request.getConsumerGroup()); + if (emitOldMessagingSemconv()) { + attributes.put(MESSAGING_KAFKA_CONSUMER_GROUP, request.getConsumerGroup()); + } + if (emitStableMessagingSemconv()) { + attributes.put(MESSAGING_CONSUMER_GROUP_NAME, request.getConsumerGroup()); + } } @Override diff --git a/instrumentation/kafka/kafka-connect-2.6/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/kafkaconnect/v2_6/KafkaConnectSingletons.java b/instrumentation/kafka/kafka-connect-2.6/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/kafkaconnect/v2_6/KafkaConnectSingletons.java index a594f59bb6bd..f8b8edbc9297 100644 --- a/instrumentation/kafka/kafka-connect-2.6/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/kafkaconnect/v2_6/KafkaConnectSingletons.java +++ b/instrumentation/kafka/kafka-connect-2.6/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/kafkaconnect/v2_6/KafkaConnectSingletons.java @@ -11,10 +11,10 @@ import io.opentelemetry.context.propagation.TextMapPropagator; import io.opentelemetry.instrumentation.api.incubator.semconv.messaging.MessagingAttributesExtractor; 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.instrumenter.Instrumenter; import io.opentelemetry.instrumentation.api.instrumenter.InstrumenterBuilder; -import io.opentelemetry.instrumentation.api.instrumenter.SpanKindExtractor; public class KafkaConnectSingletons { @@ -41,7 +41,9 @@ public class KafkaConnectSingletons { .addSpanLinksExtractor(spanLinksExtractor); setMessagingProcessExceptionEventExtractor(builder); - instrumenter = builder.buildInstrumenter(SpanKindExtractor.alwaysConsumer()); + instrumenter = + builder.buildInstrumenter( + MessagingSpanKindExtractor.create(MessagingOperationType.PROCESS)); } public static Instrumenter instrumenter() { diff --git a/instrumentation/kafka/kafka-connect-2.6/testing/build.gradle.kts b/instrumentation/kafka/kafka-connect-2.6/testing/build.gradle.kts index bf090179c83a..f895686454ad 100644 --- a/instrumentation/kafka/kafka-connect-2.6/testing/build.gradle.kts +++ b/instrumentation/kafka/kafka-connect-2.6/testing/build.gradle.kts @@ -43,7 +43,15 @@ tasks { systemProperty("metadataConfig", "otel.semconv-stability.opt-in=database") } + val testV3Preview = register("testV3Preview") { + testClassesDirs = sourceSets.test.get().output.classesDirs + classpath = sourceSets.test.get().runtimeClasspath + jvmArgs("-Dotel.instrumentation.common.v3-preview=true") + jvmArgs("-Dotel.semconv-stability.preview=messaging") + systemProperty("metadataConfig", "otel.instrumentation.common.v3-preview=true") + } + check { - dependsOn(testStableSemconv) + dependsOn(testStableSemconv, testV3Preview) } } diff --git a/instrumentation/kafka/kafka-connect-2.6/testing/src/test/java/io/opentelemetry/instrumentation/kafkaconnect/v2_6/KafkaConnectSinkTaskBaseTest.java b/instrumentation/kafka/kafka-connect-2.6/testing/src/test/java/io/opentelemetry/instrumentation/kafkaconnect/v2_6/KafkaConnectSinkTaskBaseTest.java index d4eab1656cee..e1b4d39e362a 100644 --- a/instrumentation/kafka/kafka-connect-2.6/testing/src/test/java/io/opentelemetry/instrumentation/kafkaconnect/v2_6/KafkaConnectSinkTaskBaseTest.java +++ b/instrumentation/kafka/kafka-connect-2.6/testing/src/test/java/io/opentelemetry/instrumentation/kafkaconnect/v2_6/KafkaConnectSinkTaskBaseTest.java @@ -5,6 +5,20 @@ package io.opentelemetry.instrumentation.kafkaconnect.v2_6; +import static io.opentelemetry.instrumentation.api.internal.SemconvStability.emitOldMessagingSemconv; +import static io.opentelemetry.instrumentation.api.internal.SemconvStability.emitStableMessagingSemconv; +import static io.opentelemetry.sdk.testing.assertj.OpenTelemetryAssertions.equalTo; +import static io.opentelemetry.sdk.testing.assertj.OpenTelemetryAssertions.satisfies; +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_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.MessagingOperationTypeIncubatingValues.PROCESS; +import static io.opentelemetry.semconv.incubating.MessagingIncubatingAttributes.MessagingSystemIncubatingValues.KAFKA; +import static io.opentelemetry.semconv.incubating.ThreadIncubatingAttributes.THREAD_ID; +import static io.opentelemetry.semconv.incubating.ThreadIncubatingAttributes.THREAD_NAME; import static io.restassured.RestAssured.given; import static java.lang.String.format; import static java.time.temporal.ChronoUnit.MINUTES; @@ -21,6 +35,7 @@ import io.opentelemetry.instrumentation.test.utils.PortUtils; import io.opentelemetry.instrumentation.testing.junit.InstrumentationExtension; import io.opentelemetry.sdk.OpenTelemetrySdk; +import io.opentelemetry.sdk.testing.assertj.AttributeAssertion; import io.opentelemetry.sdk.trace.SdkTracerProvider; import io.opentelemetry.sdk.trace.export.SimpleSpanProcessor; import io.opentelemetry.smoketest.SmokeTestInstrumentationExtension; @@ -263,9 +278,7 @@ private void setupKafkaConnect() { .withCopyFileToContainer( MountableFile.forHostPath(agentPath), "/opentelemetry-javaagent.jar") // Configure the agent to export spans to backend (like smoke tests) - .withEnv( - "JAVA_TOOL_OPTIONS", - "-javaagent:/opentelemetry-javaagent.jar " + "-Dotel.javaagent.debug=true") + .withEnv("JAVA_TOOL_OPTIONS", javaToolOptions()) // Disable test exporter and force OTLP exporter .withEnv("OTEL_TESTING_EXPORTER_ENABLED", "false") .withEnv("OTEL_TRACES_EXPORTER", "otlp") @@ -309,6 +322,62 @@ private void setupKafkaConnect() { + "/etc/confluent/docker/run 2>&1 | tee /var/log/kafka-connect/kafka-connect.log"); } + private static String javaToolOptions() { + StringBuilder options = + new StringBuilder("-javaagent:/opentelemetry-javaagent.jar -Dotel.javaagent.debug=true"); + appendSystemProperty(options, "otel.instrumentation.common.v3-preview"); + appendSystemProperty(options, "otel.semconv-stability.preview"); + return options.toString(); + } + + private static void appendSystemProperty(StringBuilder options, String propertyName) { + String value = System.getProperty(propertyName); + if (value != null) { + options.append(" -D").append(propertyName).append('=').append(value); + } + } + + @SuppressWarnings("deprecation") // using deprecated semconv + protected static AttributeAssertion[] processAttributes(String destination, long batchSize) { + return processAttributes(destination, batchSize, true); + } + + @SuppressWarnings("deprecation") // using deprecated semconv + protected static AttributeAssertion[] processAttributes(long batchSize) { + return processAttributes("", batchSize, false); + } + + private static AttributeAssertion[] processAttributes( + String destination, long batchSize, boolean hasDestination) { + boolean v3Preview = Boolean.getBoolean("otel.instrumentation.common.v3-preview"); + return new AttributeAssertion[] { + equalTo(MESSAGING_BATCH_MESSAGE_COUNT, batchSize), + equalTo(MESSAGING_DESTINATION_NAME, hasDestination ? destination : null), + equalTo(MESSAGING_OPERATION, emitOldMessagingSemconv() ? PROCESS : null), + equalTo(MESSAGING_OPERATION_NAME, emitStableMessagingSemconv() ? PROCESS : null), + equalTo(MESSAGING_OPERATION_TYPE, emitStableMessagingSemconv() ? PROCESS : null), + equalTo(MESSAGING_SYSTEM, KAFKA), + satisfies( + THREAD_ID, + val -> { + if (v3Preview) { + val.isNull(); + } else { + val.isNotZero(); + } + }), + satisfies( + THREAD_NAME, + val -> { + if (v3Preview) { + val.isNull(); + } else { + val.isNotBlank(); + } + }) + }; + } + @BeforeEach void resetBase() throws Exception { deleteConnectorIfExists(); diff --git a/instrumentation/kafka/kafka-connect-2.6/testing/src/test/java/io/opentelemetry/instrumentation/kafkaconnect/v2_6/MongoKafkaConnectSinkTaskTest.java b/instrumentation/kafka/kafka-connect-2.6/testing/src/test/java/io/opentelemetry/instrumentation/kafkaconnect/v2_6/MongoKafkaConnectSinkTaskTest.java index b24171389ce3..c33aaef8ea92 100644 --- a/instrumentation/kafka/kafka-connect-2.6/testing/src/test/java/io/opentelemetry/instrumentation/kafkaconnect/v2_6/MongoKafkaConnectSinkTaskTest.java +++ b/instrumentation/kafka/kafka-connect-2.6/testing/src/test/java/io/opentelemetry/instrumentation/kafkaconnect/v2_6/MongoKafkaConnectSinkTaskTest.java @@ -7,16 +7,7 @@ import static io.opentelemetry.api.trace.SpanKind.CONSUMER; import static io.opentelemetry.instrumentation.api.internal.SemconvStability.emitStableDatabaseSemconv; -import static io.opentelemetry.sdk.testing.assertj.OpenTelemetryAssertions.equalTo; -import static io.opentelemetry.sdk.testing.assertj.OpenTelemetryAssertions.satisfies; -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_OPERATION; -import static io.opentelemetry.semconv.incubating.MessagingIncubatingAttributes.MESSAGING_SYSTEM; -import static io.opentelemetry.semconv.incubating.MessagingIncubatingAttributes.MessagingOperationTypeIncubatingValues.PROCESS; -import static io.opentelemetry.semconv.incubating.MessagingIncubatingAttributes.MessagingSystemIncubatingValues.KAFKA; -import static io.opentelemetry.semconv.incubating.ThreadIncubatingAttributes.THREAD_ID; -import static io.opentelemetry.semconv.incubating.ThreadIncubatingAttributes.THREAD_NAME; +import static io.opentelemetry.instrumentation.api.internal.SemconvStability.emitStableMessagingSemconv; import static io.restassured.RestAssured.given; import static java.lang.String.format; import static org.awaitility.Awaitility.await; @@ -128,35 +119,43 @@ void testSingleMessage() throws IOException { // producer is in a separate trace, linked to consumer with a span link trace.hasSpansSatisfyingExactly( span -> { - span.hasName(testTopicName + " publish").hasKind(SpanKind.PRODUCER).hasNoParent(); + span.hasName( + emitStableMessagingSemconv() + ? "send " + testTopicName + : testTopicName + " publish") + .hasKind(SpanKind.PRODUCER) + .hasNoParent(); producerSpanContext.set(span.actual().getSpanContext()); }), trace -> // kafka connect sends message to status topic while processing our message trace.hasSpansSatisfyingExactly( span -> - span.hasName("kafka-connect-status publish") + span.hasName( + emitStableMessagingSemconv() + ? "send kafka-connect-status" + : "kafka-connect-status publish") .hasKind(SpanKind.PRODUCER) .hasNoParent(), span -> - span.hasName("kafka-connect-status process") + span.hasName( + emitStableMessagingSemconv() + ? "process kafka-connect-status" + : "kafka-connect-status process") .hasKind(SpanKind.CONSUMER) .hasParent(trace.getSpan(0))), trace -> // kafka connect consumer trace, linked to producer span via a span link trace.hasSpansSatisfyingExactly( span -> - span.hasName(testTopicName + " process") + span.hasName( + emitStableMessagingSemconv() + ? "process " + testTopicName + : testTopicName + " process") .hasKind(CONSUMER) .hasNoParent() .hasLinks(LinkData.create(producerSpanContext.get())) - .hasAttributesSatisfyingExactly( - equalTo(MESSAGING_BATCH_MESSAGE_COUNT, 1), - equalTo(MESSAGING_DESTINATION_NAME, testTopicName), - equalTo(MESSAGING_OPERATION, PROCESS), - equalTo(MESSAGING_SYSTEM, KAFKA), - satisfies(THREAD_ID, val -> val.isNotZero()), - satisfies(THREAD_NAME, val -> val.isNotBlank())), + .hasAttributesSatisfyingExactly(processAttributes(testTopicName, 1)), span -> span.hasName( emitStableDatabaseSemconv() @@ -217,11 +216,17 @@ void testMultiTopic() throws IOException { // kafka connect sends message to status topic while processing our message trace.hasSpansSatisfyingExactly( span -> - span.hasName("kafka-connect-status publish") + span.hasName( + emitStableMessagingSemconv() + ? "send kafka-connect-status" + : "kafka-connect-status publish") .hasKind(SpanKind.PRODUCER) .hasNoParent(), span -> - span.hasName("kafka-connect-status process") + span.hasName( + emitStableMessagingSemconv() + ? "process kafka-connect-status" + : "kafka-connect-status process") .hasKind(SpanKind.CONSUMER) .hasParent(trace.getSpan(0))); @@ -234,19 +239,28 @@ void testMultiTopic() throws IOException { trace.hasSpansSatisfyingExactly( span -> span.hasName("parent").hasNoParent(), span -> { - span.hasName(topicName1 + " publish") + span.hasName( + emitStableMessagingSemconv() + ? "send " + topicName1 + : topicName1 + " publish") .hasKind(SpanKind.PRODUCER) .hasParent(trace.getSpan(0)); producerSpanContext1.set(span.actual().getSpanContext()); }, span -> { - span.hasName(topicName2 + " publish") + span.hasName( + emitStableMessagingSemconv() + ? "send " + topicName2 + : topicName2 + " publish") .hasKind(SpanKind.PRODUCER) .hasParent(trace.getSpan(0)); producerSpanContext2.set(span.actual().getSpanContext()); }, span -> { - span.hasName(topicName3 + " publish") + span.hasName( + emitStableMessagingSemconv() + ? "send " + topicName3 + : topicName3 + " publish") .hasKind(SpanKind.PRODUCER) .hasParent(trace.getSpan(0)); producerSpanContext3.set(span.actual().getSpanContext()); @@ -258,19 +272,14 @@ void testMultiTopic() throws IOException { // kafka connect consumer trace, linked to producer span via a span link trace.hasSpansSatisfyingExactly( span -> - span.hasName("unknown process") + span.hasName(emitStableMessagingSemconv() ? "process" : "unknown process") .hasKind(CONSUMER) .hasNoParent() .hasLinks( LinkData.create(producerSpanContext1.get()), LinkData.create(producerSpanContext2.get()), LinkData.create(producerSpanContext3.get())) - .hasAttributesSatisfyingExactly( - equalTo(MESSAGING_BATCH_MESSAGE_COUNT, 3), - equalTo(MESSAGING_OPERATION, PROCESS), - equalTo(MESSAGING_SYSTEM, KAFKA), - satisfies(THREAD_ID, val -> val.isNotZero()), - satisfies(THREAD_NAME, val -> val.isNotBlank())), + .hasAttributesSatisfyingExactly(processAttributes(3)), span -> span.hasName( emitStableDatabaseSemconv() diff --git a/instrumentation/kafka/kafka-connect-2.6/testing/src/test/java/io/opentelemetry/instrumentation/kafkaconnect/v2_6/PostgresKafkaConnectSinkTaskTest.java b/instrumentation/kafka/kafka-connect-2.6/testing/src/test/java/io/opentelemetry/instrumentation/kafkaconnect/v2_6/PostgresKafkaConnectSinkTaskTest.java index e79f0e8720ca..54cb7b609951 100644 --- a/instrumentation/kafka/kafka-connect-2.6/testing/src/test/java/io/opentelemetry/instrumentation/kafkaconnect/v2_6/PostgresKafkaConnectSinkTaskTest.java +++ b/instrumentation/kafka/kafka-connect-2.6/testing/src/test/java/io/opentelemetry/instrumentation/kafkaconnect/v2_6/PostgresKafkaConnectSinkTaskTest.java @@ -7,16 +7,7 @@ import static io.opentelemetry.api.trace.SpanKind.CONSUMER; import static io.opentelemetry.instrumentation.api.internal.SemconvStability.emitStableDatabaseSemconv; -import static io.opentelemetry.sdk.testing.assertj.OpenTelemetryAssertions.equalTo; -import static io.opentelemetry.sdk.testing.assertj.OpenTelemetryAssertions.satisfies; -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_OPERATION; -import static io.opentelemetry.semconv.incubating.MessagingIncubatingAttributes.MESSAGING_SYSTEM; -import static io.opentelemetry.semconv.incubating.MessagingIncubatingAttributes.MessagingOperationTypeIncubatingValues.PROCESS; -import static io.opentelemetry.semconv.incubating.MessagingIncubatingAttributes.MessagingSystemIncubatingValues.KAFKA; -import static io.opentelemetry.semconv.incubating.ThreadIncubatingAttributes.THREAD_ID; -import static io.opentelemetry.semconv.incubating.ThreadIncubatingAttributes.THREAD_NAME; +import static io.opentelemetry.instrumentation.api.internal.SemconvStability.emitStableMessagingSemconv; import static io.restassured.RestAssured.given; import static java.lang.String.format; import static org.assertj.core.api.Assertions.assertThat; @@ -145,18 +136,29 @@ void testSingleMessage() throws IOException { // producer is in a separate trace, linked to consumer with a span link trace.hasSpansSatisfyingExactly( span -> { - span.hasName(testTopicName + " publish").hasKind(SpanKind.PRODUCER).hasNoParent(); + span.hasName( + emitStableMessagingSemconv() + ? "send " + testTopicName + : testTopicName + " publish") + .hasKind(SpanKind.PRODUCER) + .hasNoParent(); producerSpanContext.set(span.actual().getSpanContext()); }), trace -> // kafka connect sends message to status topic while processing our message trace.hasSpansSatisfyingExactly( span -> - span.hasName("kafka-connect-status publish") + span.hasName( + emitStableMessagingSemconv() + ? "send kafka-connect-status" + : "kafka-connect-status publish") .hasKind(SpanKind.PRODUCER) .hasNoParent(), span -> - span.hasName("kafka-connect-status process") + span.hasName( + emitStableMessagingSemconv() + ? "process kafka-connect-status" + : "kafka-connect-status process") .hasKind(SpanKind.CONSUMER) .hasParent(trace.getSpan(0))), trace -> { @@ -173,17 +175,14 @@ void testSingleMessage() throws IOException { trace.hasSpansSatisfyingExactly( span -> - span.hasName(testTopicName + " process") + span.hasName( + emitStableMessagingSemconv() + ? "process " + testTopicName + : testTopicName + " process") .hasKind(CONSUMER) .hasNoParent() .hasLinks(LinkData.create(producerSpanContext.get())) - .hasAttributesSatisfyingExactly( - equalTo(MESSAGING_BATCH_MESSAGE_COUNT, 1), - equalTo(MESSAGING_DESTINATION_NAME, testTopicName), - equalTo(MESSAGING_OPERATION, PROCESS), - equalTo(MESSAGING_SYSTEM, KAFKA), - satisfies(THREAD_ID, val -> val.isNotZero()), - satisfies(THREAD_NAME, val -> val.isNotBlank())), + .hasAttributesSatisfyingExactly(processAttributes(testTopicName, 1)), selectAssertion, selectAssertion, selectAssertion, @@ -256,11 +255,17 @@ void testMultiTopic() throws IOException { // kafka connect sends message to status topic while processing our message trace.hasSpansSatisfyingExactly( span -> - span.hasName("kafka-connect-status publish") + span.hasName( + emitStableMessagingSemconv() + ? "send kafka-connect-status" + : "kafka-connect-status publish") .hasKind(SpanKind.PRODUCER) .hasNoParent(), span -> - span.hasName("kafka-connect-status process") + span.hasName( + emitStableMessagingSemconv() + ? "process kafka-connect-status" + : "kafka-connect-status process") .hasKind(SpanKind.CONSUMER) .hasParent(trace.getSpan(0))); @@ -273,19 +278,28 @@ void testMultiTopic() throws IOException { trace.hasSpansSatisfyingExactly( span -> span.hasName("parent").hasNoParent(), span -> { - span.hasName(topicName1 + " publish") + span.hasName( + emitStableMessagingSemconv() + ? "send " + topicName1 + : topicName1 + " publish") .hasKind(SpanKind.PRODUCER) .hasParent(trace.getSpan(0)); producerSpanContext1.set(span.actual().getSpanContext()); }, span -> { - span.hasName(topicName2 + " publish") + span.hasName( + emitStableMessagingSemconv() + ? "send " + topicName2 + : topicName2 + " publish") .hasKind(SpanKind.PRODUCER) .hasParent(trace.getSpan(0)); producerSpanContext2.set(span.actual().getSpanContext()); }, span -> { - span.hasName(topicName3 + " publish") + span.hasName( + emitStableMessagingSemconv() + ? "send " + topicName3 + : topicName3 + " publish") .hasKind(SpanKind.PRODUCER) .hasParent(trace.getSpan(0)); producerSpanContext3.set(span.actual().getSpanContext()); @@ -307,19 +321,14 @@ void testMultiTopic() throws IOException { trace.hasSpansSatisfyingExactly( span -> - span.hasName("unknown process") + span.hasName(emitStableMessagingSemconv() ? "process" : "unknown process") .hasKind(CONSUMER) .hasNoParent() .hasLinks( LinkData.create(producerSpanContext1.get()), LinkData.create(producerSpanContext2.get()), LinkData.create(producerSpanContext3.get())) - .hasAttributesSatisfyingExactly( - equalTo(MESSAGING_BATCH_MESSAGE_COUNT, 3), - equalTo(MESSAGING_OPERATION, PROCESS), - equalTo(MESSAGING_SYSTEM, KAFKA), - satisfies(THREAD_ID, val -> val.isNotZero()), - satisfies(THREAD_NAME, val -> val.isNotBlank())), + .hasAttributesSatisfyingExactly(processAttributes(3)), selectAssertion, selectAssertion, selectAssertion, diff --git a/instrumentation/kafka/kafka-streams-0.11/javaagent/build.gradle.kts b/instrumentation/kafka/kafka-streams-0.11/javaagent/build.gradle.kts index 0d12cbd8c1eb..84f1a1f6b0d6 100644 --- a/instrumentation/kafka/kafka-streams-0.11/javaagent/build.gradle.kts +++ b/instrumentation/kafka/kafka-streams-0.11/javaagent/build.gradle.kts @@ -54,6 +54,18 @@ tasks { systemProperty("metadataConfig", "otel.instrumentation.kafka.experimental-span-attributes=true") } + val testV3Preview = register("testV3Preview") { + testClassesDirs = sourceSets.test.get().output.classesDirs + classpath = sourceSets.test.get().runtimeClasspath + filter { + excludeTestsMatching("KafkaStreamsSuppressReceiveSpansTest") + } + jvmArgs("-Dotel.instrumentation.messaging.experimental.receive-telemetry.enabled=true") + jvmArgs("-Dotel.instrumentation.common.v3-preview=true") + jvmArgs("-Dotel.semconv-stability.preview=messaging") + systemProperty("metadataConfig", "otel.instrumentation.common.v3-preview=true") + } + test { filter { excludeTestsMatching("KafkaStreamsSuppressReceiveSpansTest") @@ -64,6 +76,7 @@ tasks { check { dependsOn(testReceiveSpansDisabled) dependsOn(testExperimental) + dependsOn(testV3Preview) } } diff --git a/instrumentation/kafka/kafka-streams-0.11/javaagent/src/test/java/io/opentelemetry/javaagent/instrumentation/kafkastreams/v0_11/KafkaStreamsDefaultTest.java b/instrumentation/kafka/kafka-streams-0.11/javaagent/src/test/java/io/opentelemetry/javaagent/instrumentation/kafkastreams/v0_11/KafkaStreamsDefaultTest.java index 73a48787666d..6205796d5195 100644 --- a/instrumentation/kafka/kafka-streams-0.11/javaagent/src/test/java/io/opentelemetry/javaagent/instrumentation/kafkastreams/v0_11/KafkaStreamsDefaultTest.java +++ b/instrumentation/kafka/kafka-streams-0.11/javaagent/src/test/java/io/opentelemetry/javaagent/instrumentation/kafkastreams/v0_11/KafkaStreamsDefaultTest.java @@ -7,17 +7,23 @@ import static io.opentelemetry.api.common.AttributeKey.longKey; 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.instrumentation.testing.util.TestLatestDeps.testLatestDeps; import static io.opentelemetry.sdk.testing.assertj.OpenTelemetryAssertions.equalTo; import static io.opentelemetry.sdk.testing.assertj.OpenTelemetryAssertions.satisfies; import static io.opentelemetry.semconv.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_PARTITION_ID; import static io.opentelemetry.semconv.incubating.MessagingIncubatingAttributes.MESSAGING_KAFKA_CONSUMER_GROUP; import static io.opentelemetry.semconv.incubating.MessagingIncubatingAttributes.MESSAGING_KAFKA_MESSAGE_KEY; import static io.opentelemetry.semconv.incubating.MessagingIncubatingAttributes.MESSAGING_KAFKA_MESSAGE_OFFSET; +import static io.opentelemetry.semconv.incubating.MessagingIncubatingAttributes.MESSAGING_KAFKA_OFFSET; import static io.opentelemetry.semconv.incubating.MessagingIncubatingAttributes.MESSAGING_MESSAGE_BODY_SIZE; 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.KAFKA; import static java.util.Arrays.asList; @@ -47,9 +53,9 @@ import org.junit.jupiter.api.DisplayName; import org.junit.jupiter.api.Test; +@SuppressWarnings("deprecation") // using deprecated semconv class KafkaStreamsDefaultTest extends KafkaStreamsBaseTest { - @SuppressWarnings("deprecation") // using deprecated semconv @DisplayName("test kafka produce and consume with streams in-between") @Test void testKafkaProduceAndConsumeWithStreamsInBetween() throws Exception { @@ -101,30 +107,22 @@ void testKafkaProduceAndConsumeWithStreamsInBetween() throws Exception { // Add your assertTraces logic here testing.waitAndAssertSortedTraces( TelemetryDataUtil.orderByRootSpanName( - STREAM_PENDING + " publish", - STREAM_PENDING + " receive", - STREAM_PROCESSED + " receive"), + emitStableMessagingSemconv() ? "send " + STREAM_PENDING : STREAM_PENDING + " publish", + emitStableMessagingSemconv() ? "poll " + STREAM_PENDING : STREAM_PENDING + " receive", + emitStableMessagingSemconv() + ? "poll " + STREAM_PROCESSED + : STREAM_PROCESSED + " receive"), trace -> { trace.hasSpansSatisfyingExactly( // kafka-clients PRODUCER span -> - span.hasName(STREAM_PENDING + " publish") + span.hasName( + emitStableMessagingSemconv() + ? "send " + STREAM_PENDING + : STREAM_PENDING + " publish") .hasKind(SpanKind.PRODUCER) .hasNoParent() - .hasAttributesSatisfyingExactly( - equalTo(MESSAGING_SYSTEM, KAFKA), - equalTo(MESSAGING_DESTINATION_NAME, STREAM_PENDING), - equalTo(MESSAGING_OPERATION, "publish"), - satisfies( - stringKey("messaging.client_id"), val -> val.startsWith("producer")), - satisfies( - MESSAGING_DESTINATION_PARTITION_ID, - val -> val.isInstanceOf(String.class)), - equalTo(MESSAGING_KAFKA_MESSAGE_OFFSET, 0), - equalTo(MESSAGING_KAFKA_MESSAGE_KEY, "10"), - equalTo( - stringKey("messaging.kafka.bootstrap.servers"), - EXPERIMENTAL_ATTRIBUTES ? kafka.getBootstrapServers() : null))); + .hasAttributesSatisfyingExactly(producerAttributes(STREAM_PENDING, true))); producerPendingRef.set(trace.getSpan(0)); }, trace -> { @@ -133,18 +131,17 @@ void testKafkaProduceAndConsumeWithStreamsInBetween() throws Exception { span -> { List assertions = new ArrayList<>( - asList( - equalTo(MESSAGING_SYSTEM, KAFKA), - equalTo(MESSAGING_DESTINATION_NAME, STREAM_PENDING), - equalTo(MESSAGING_OPERATION, "receive"), - satisfies( - stringKey("messaging.client_id"), val -> val.endsWith("consumer")), - equalTo(MESSAGING_BATCH_MESSAGE_COUNT, 1))); + messagingAttributes( + STREAM_PENDING, "receive", "poll", "receive", "consumer", false)); + assertions.add(equalTo(MESSAGING_BATCH_MESSAGE_COUNT, 1)); if (testLatestDeps()) { - assertions.add(equalTo(MESSAGING_KAFKA_CONSUMER_GROUP, "test-application")); + addGroupAssertions(assertions, "test-application"); } - span.hasName(STREAM_PENDING + " receive") - .hasKind(SpanKind.CONSUMER) + span.hasName( + emitStableMessagingSemconv() + ? "poll " + STREAM_PENDING + : STREAM_PENDING + " receive") + .hasKind(emitStableMessagingSemconv() ? SpanKind.CLIENT : SpanKind.CONSUMER) .hasNoParent() .hasAttributesSatisfyingExactly(assertions); }, @@ -152,20 +149,16 @@ void testKafkaProduceAndConsumeWithStreamsInBetween() throws Exception { span -> { List assertions = new ArrayList<>( - asList( - equalTo(MESSAGING_SYSTEM, KAFKA), - equalTo(MESSAGING_DESTINATION_NAME, STREAM_PENDING), - equalTo(MESSAGING_OPERATION, "process"), - satisfies( - stringKey("messaging.client_id"), val -> val.endsWith("consumer")), - satisfies( - MESSAGING_MESSAGE_BODY_SIZE, val -> val.isInstanceOf(Long.class)), - satisfies( - MESSAGING_DESTINATION_PARTITION_ID, - val -> val.isInstanceOf(String.class)), - equalTo(MESSAGING_KAFKA_MESSAGE_OFFSET, 0), - equalTo(MESSAGING_KAFKA_MESSAGE_KEY, "10"), - equalTo(stringKey("asdf"), "testing"))); + messagingAttributes( + STREAM_PENDING, "process", "process", "process", "consumer", false)); + assertions.add( + satisfies(MESSAGING_MESSAGE_BODY_SIZE, val -> val.isInstanceOf(Long.class))); + assertions.add( + satisfies( + MESSAGING_DESTINATION_PARTITION_ID, val -> val.isInstanceOf(String.class))); + assertions.add(equalTo(MESSAGING_KAFKA_MESSAGE_KEY, "10")); + assertions.add(equalTo(stringKey("asdf"), "testing")); + addOffsetAssertions(assertions, 0); if (EXPERIMENTAL_ATTRIBUTES) { assertions.add( @@ -175,9 +168,12 @@ void testKafkaProduceAndConsumeWithStreamsInBetween() throws Exception { } if (testLatestDeps()) { - assertions.add(equalTo(MESSAGING_KAFKA_CONSUMER_GROUP, "test-application")); + addGroupAssertions(assertions, "test-application"); } - span.hasName(STREAM_PENDING + " process") + span.hasName( + emitStableMessagingSemconv() + ? "process " + STREAM_PENDING + : STREAM_PENDING + " process") .hasKind(SpanKind.CONSUMER) .hasParent(trace.getSpan(0)) .hasLinks(LinkData.create(producerPendingRef.get().getSpanContext())) @@ -185,24 +181,15 @@ void testKafkaProduceAndConsumeWithStreamsInBetween() throws Exception { }, // kafka-clients PRODUCER span -> - span.hasName(STREAM_PROCESSED + " publish") + span.hasName( + emitStableMessagingSemconv() + ? "send " + STREAM_PROCESSED + : STREAM_PROCESSED + " publish") .hasKind(SpanKind.PRODUCER) .hasParent(trace.getSpan(1)) .hasTraceId(receivedContext.getTraceId()) .hasSpanId(receivedContext.getSpanId()) - .hasAttributesSatisfyingExactly( - equalTo(MESSAGING_SYSTEM, KAFKA), - equalTo(MESSAGING_DESTINATION_NAME, STREAM_PROCESSED), - equalTo(MESSAGING_OPERATION, "publish"), - satisfies( - stringKey("messaging.client_id"), val -> val.endsWith("producer")), - satisfies( - MESSAGING_DESTINATION_PARTITION_ID, - val -> val.isInstanceOf(String.class)), - equalTo(MESSAGING_KAFKA_MESSAGE_OFFSET, 0), - equalTo( - stringKey("messaging.kafka.bootstrap.servers"), - EXPERIMENTAL_ATTRIBUTES ? kafka.getBootstrapServers() : null))); + .hasAttributesSatisfyingExactly(producerAttributes(STREAM_PROCESSED, false))); producerProcessedRef.set(trace.getSpan(2)); }, @@ -212,19 +199,17 @@ void testKafkaProduceAndConsumeWithStreamsInBetween() throws Exception { span -> { List assertions = new ArrayList<>( - asList( - equalTo(MESSAGING_SYSTEM, KAFKA), - equalTo(MESSAGING_DESTINATION_NAME, STREAM_PROCESSED), - equalTo(MESSAGING_OPERATION, "receive"), - satisfies( - stringKey("messaging.client_id"), - val -> val.startsWith("consumer")), - equalTo(MESSAGING_BATCH_MESSAGE_COUNT, 1))); + messagingAttributes( + STREAM_PROCESSED, "receive", "poll", "receive", "consumer", true)); + assertions.add(equalTo(MESSAGING_BATCH_MESSAGE_COUNT, 1)); if (testLatestDeps()) { - assertions.add(equalTo(MESSAGING_KAFKA_CONSUMER_GROUP, "test")); + addGroupAssertions(assertions, "test"); } - span.hasName(STREAM_PROCESSED + " receive") - .hasKind(SpanKind.CONSUMER) + span.hasName( + emitStableMessagingSemconv() + ? "poll " + STREAM_PROCESSED + : STREAM_PROCESSED + " receive") + .hasKind(emitStableMessagingSemconv() ? SpanKind.CLIENT : SpanKind.CONSUMER) .hasNoParent() .hasAttributesSatisfyingExactly(assertions); }, @@ -232,21 +217,17 @@ void testKafkaProduceAndConsumeWithStreamsInBetween() throws Exception { span -> { List assertions = new ArrayList<>( - asList( - equalTo(MESSAGING_SYSTEM, KAFKA), - equalTo(MESSAGING_DESTINATION_NAME, STREAM_PROCESSED), - equalTo(MESSAGING_OPERATION, "process"), - satisfies( - stringKey("messaging.client_id"), - val -> val.startsWith("consumer")), - satisfies( - MESSAGING_MESSAGE_BODY_SIZE, val -> val.isInstanceOf(Long.class)), - satisfies( - MESSAGING_DESTINATION_PARTITION_ID, - val -> val.isInstanceOf(String.class)), - equalTo(MESSAGING_KAFKA_MESSAGE_OFFSET, 0), - equalTo(MESSAGING_KAFKA_MESSAGE_KEY, "10"), - equalTo(longKey("testing"), 123))); + messagingAttributes( + STREAM_PROCESSED, "process", "process", "process", "consumer", true)); + assertions.add( + satisfies(MESSAGING_MESSAGE_BODY_SIZE, val -> val.isInstanceOf(Long.class))); + assertions.add( + satisfies( + MESSAGING_DESTINATION_PARTITION_ID, + val -> val.isInstanceOf(String.class))); + assertions.add(equalTo(MESSAGING_KAFKA_MESSAGE_KEY, "10")); + assertions.add(equalTo(longKey("testing"), 123)); + addOffsetAssertions(assertions, 0); if (EXPERIMENTAL_ATTRIBUTES) { assertions.add( satisfies( @@ -255,13 +236,94 @@ void testKafkaProduceAndConsumeWithStreamsInBetween() throws Exception { } if (testLatestDeps()) { - assertions.add(equalTo(MESSAGING_KAFKA_CONSUMER_GROUP, "test")); + addGroupAssertions(assertions, "test"); } - span.hasName(STREAM_PROCESSED + " process") + span.hasName( + emitStableMessagingSemconv() + ? "process " + STREAM_PROCESSED + : STREAM_PROCESSED + " process") .hasKind(SpanKind.CONSUMER) .hasParent(trace.getSpan(0)) .hasLinks(LinkData.create(producerProcessedRef.get().getSpanContext())) .hasAttributesSatisfyingExactly(assertions); })); } + + private static List producerAttributes(String topic, boolean includeKey) { + List assertions = + new ArrayList<>( + messagingAttributes(topic, "publish", "send", "send", "producer", includeKey)); + assertions.add( + satisfies(MESSAGING_DESTINATION_PARTITION_ID, val -> val.isInstanceOf(String.class))); + assertions.add(equalTo(MESSAGING_KAFKA_MESSAGE_KEY, includeKey ? "10" : null)); + assertions.add( + equalTo( + stringKey("messaging.kafka.bootstrap.servers"), + EXPERIMENTAL_ATTRIBUTES ? kafka.getBootstrapServers() : null)); + addOffsetAssertions(assertions, 0); + return assertions; + } + + private static List messagingAttributes( + String topic, + String oldOperation, + String operationName, + String operationType, + String clientIdSuffix, + boolean startsWith) { + List assertions = + new ArrayList<>( + asList( + equalTo(MESSAGING_SYSTEM, KAFKA), + equalTo(MESSAGING_DESTINATION_NAME, topic), + equalTo(MESSAGING_OPERATION, emitOldMessagingSemconv() ? oldOperation : null), + equalTo( + MESSAGING_OPERATION_NAME, emitStableMessagingSemconv() ? operationName : null), + equalTo( + MESSAGING_OPERATION_TYPE, + emitStableMessagingSemconv() ? operationType : null))); + if (emitOldMessagingSemconv()) { + assertions.add( + satisfies( + stringKey("messaging.client_id"), + val -> { + if (startsWith) { + val.startsWith(clientIdSuffix); + } else { + val.endsWith(clientIdSuffix); + } + })); + } + if (emitStableMessagingSemconv()) { + assertions.add( + satisfies( + stringKey("messaging.client.id"), + val -> { + if (startsWith) { + val.startsWith(clientIdSuffix); + } else { + val.endsWith(clientIdSuffix); + } + })); + } + return assertions; + } + + private static void addOffsetAssertions(List assertions, long offset) { + if (emitOldMessagingSemconv()) { + assertions.add(equalTo(MESSAGING_KAFKA_MESSAGE_OFFSET, offset)); + } + if (emitStableMessagingSemconv()) { + assertions.add(equalTo(MESSAGING_KAFKA_OFFSET, offset)); + } + } + + private static void addGroupAssertions(List assertions, String group) { + if (emitOldMessagingSemconv()) { + assertions.add(equalTo(MESSAGING_KAFKA_CONSUMER_GROUP, group)); + } + if (emitStableMessagingSemconv()) { + assertions.add(equalTo(MESSAGING_CONSUMER_GROUP_NAME, group)); + } + } } diff --git a/instrumentation/reactor/reactor-kafka-1.0/javaagent/build.gradle.kts b/instrumentation/reactor/reactor-kafka-1.0/javaagent/build.gradle.kts index 62efce3619ad..636e7c73725d 100644 --- a/instrumentation/reactor/reactor-kafka-1.0/javaagent/build.gradle.kts +++ b/instrumentation/reactor/reactor-kafka-1.0/javaagent/build.gradle.kts @@ -99,6 +99,16 @@ tasks { systemProperty("hasConsumerGroup", otelProps.testLatestDeps) } + val testV3Preview = register("testV3Preview") { + testClassesDirs = sourceSets.test.get().output.classesDirs + classpath = sourceSets.test.get().runtimeClasspath + systemProperty("hasConsumerGroup", otelProps.testLatestDeps) + jvmArgs("-Dotel.instrumentation.messaging.experimental.receive-telemetry.enabled=true") + jvmArgs("-Dotel.instrumentation.common.v3-preview=true") + jvmArgs("-Dotel.semconv-stability.preview=messaging") + systemProperty("metadataConfig", "otel.instrumentation.common.v3-preview=true") + } + test { systemProperty("hasConsumerGroup", otelProps.testLatestDeps) jvmArgs("-Dotel.instrumentation.messaging.experimental.receive-telemetry.enabled=true") @@ -109,6 +119,6 @@ tasks { } check { - dependsOn(testing.suites, testExperimental, testReceiveSpansDisabled) + dependsOn(testing.suites, testExperimental, testReceiveSpansDisabled, testV3Preview) } } diff --git a/instrumentation/reactor/reactor-kafka-1.0/testing/src/main/java/io/opentelemetry/javaagent/instrumentation/reactor/kafka/v1_0/AbstractReactorKafkaTest.java b/instrumentation/reactor/reactor-kafka-1.0/testing/src/main/java/io/opentelemetry/javaagent/instrumentation/reactor/kafka/v1_0/AbstractReactorKafkaTest.java index b8cbe4b47be2..8cb1243fc007 100644 --- a/instrumentation/reactor/reactor-kafka-1.0/testing/src/main/java/io/opentelemetry/javaagent/instrumentation/reactor/kafka/v1_0/AbstractReactorKafkaTest.java +++ b/instrumentation/reactor/reactor-kafka-1.0/testing/src/main/java/io/opentelemetry/javaagent/instrumentation/reactor/kafka/v1_0/AbstractReactorKafkaTest.java @@ -7,17 +7,23 @@ import static io.opentelemetry.api.common.AttributeKey.longKey; 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.instrumentation.testing.util.TelemetryDataUtil.orderByRootSpanKind; import static io.opentelemetry.sdk.testing.assertj.OpenTelemetryAssertions.equalTo; import static io.opentelemetry.sdk.testing.assertj.OpenTelemetryAssertions.satisfies; 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_PARTITION_ID; import static io.opentelemetry.semconv.incubating.MessagingIncubatingAttributes.MESSAGING_KAFKA_CONSUMER_GROUP; import static io.opentelemetry.semconv.incubating.MessagingIncubatingAttributes.MESSAGING_KAFKA_MESSAGE_KEY; import static io.opentelemetry.semconv.incubating.MessagingIncubatingAttributes.MESSAGING_KAFKA_MESSAGE_OFFSET; +import static io.opentelemetry.semconv.incubating.MessagingIncubatingAttributes.MESSAGING_KAFKA_OFFSET; import static io.opentelemetry.semconv.incubating.MessagingIncubatingAttributes.MESSAGING_MESSAGE_BODY_SIZE; 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.nio.charset.StandardCharsets.UTF_8; import static java.util.Arrays.asList; @@ -61,6 +67,7 @@ import reactor.kafka.sender.SenderOptions; import reactor.kafka.sender.SenderRecord; +@SuppressWarnings("deprecation") // using deprecated semconv public abstract class AbstractReactorKafkaTest { private static final Logger logger = LoggerFactory.getLogger(AbstractReactorKafkaTest.class); @@ -163,12 +170,12 @@ private static void assertWithReceiveTelemetry(SenderRecord producerSpan = new AtomicReference<>(); testing.waitAndAssertSortedTraces( - orderByRootSpanKind(SpanKind.INTERNAL, SpanKind.CONSUMER), + orderByRootSpanKind(SpanKind.INTERNAL, receiveKind()), trace -> { trace.hasSpansSatisfyingExactly( span -> span.hasName("producer"), span -> - span.hasName("testTopic publish") + span.hasName(spanName("testTopic", "publish", "send")) .hasKind(SpanKind.PRODUCER) .hasParent(trace.getSpan(0)) .hasAttributesSatisfyingExactly(sendAttributes(record))); @@ -178,12 +185,12 @@ private static void assertWithReceiveTelemetry(SenderRecord trace.hasSpansSatisfyingExactly( span -> - span.hasName("testTopic receive") - .hasKind(SpanKind.CONSUMER) + span.hasName(spanName("testTopic", "receive", "poll")) + .hasKind(receiveKind()) .hasNoParent() .hasAttributesSatisfyingExactly(receiveAttributes("testTopic")), span -> - span.hasName("testTopic process") + span.hasName(spanName("testTopic", "process", "process")) .hasKind(SpanKind.CONSUMER) .hasParent(trace.getSpan(0)) .hasLinks(LinkData.create(producerSpan.get().getSpanContext())) @@ -197,29 +204,23 @@ private static void assertWithoutReceiveTelemetry(SenderRecord span.hasName("producer"), span -> - span.hasName("testTopic publish") + span.hasName(spanName("testTopic", "publish", "send")) .hasKind(SpanKind.PRODUCER) .hasParent(trace.getSpan(0)) .hasAttributesSatisfyingExactly(sendAttributes(record)), span -> - span.hasName("testTopic process") + span.hasName(spanName("testTopic", "process", "process")) .hasKind(SpanKind.CONSUMER) .hasParent(trace.getSpan(1)) .hasAttributesSatisfyingExactly(processAttributes(record)), span -> span.hasName("consumer").hasParent(trace.getSpan(2)))); } - @SuppressWarnings("deprecation") // using deprecated semconv private static List sendAttributes(ProducerRecord record) { List assertions = - new ArrayList<>( - asList( - equalTo(MESSAGING_SYSTEM, "kafka"), - equalTo(MESSAGING_DESTINATION_NAME, record.topic()), - equalTo(MESSAGING_OPERATION, "publish"), - satisfies(stringKey("messaging.client_id"), val -> val.startsWith("producer")), - satisfies(MESSAGING_DESTINATION_PARTITION_ID, AbstractStringAssert::isNotEmpty), - satisfies(MESSAGING_KAFKA_MESSAGE_OFFSET, AbstractLongAssert::isNotNegative))); + messagingAttributes(record.topic(), "publish", "send", "send", "producer"); + assertions.add(satisfies(MESSAGING_DESTINATION_PARTITION_ID, AbstractStringAssert::isNotEmpty)); + addOffsetAssertion(assertions); if (EXPERIMENTAL_ATTRIBUTES) { assertions.add( equalTo(stringKey("messaging.kafka.bootstrap.servers"), kafka.getBootstrapServers())); @@ -231,35 +232,23 @@ private static List sendAttributes(ProducerRecord receiveAttributes(String topic) { - ArrayList assertions = - new ArrayList<>( - asList( - equalTo(MESSAGING_SYSTEM, "kafka"), - equalTo(MESSAGING_DESTINATION_NAME, topic), - equalTo(MESSAGING_OPERATION, "receive"), - satisfies(stringKey("messaging.client_id"), val -> val.startsWith("consumer")), - equalTo(MESSAGING_BATCH_MESSAGE_COUNT, 1))); + List assertions = + messagingAttributes(topic, "receive", "poll", "receive", "consumer"); + assertions.add(equalTo(MESSAGING_BATCH_MESSAGE_COUNT, 1)); if (HAS_CONSUMER_GROUP) { - assertions.add(equalTo(MESSAGING_KAFKA_CONSUMER_GROUP, "test")); + addGroupAssertions(assertions); } return assertions; } - @SuppressWarnings("deprecation") // using deprecated semconv private static List processAttributes(ProducerRecord record) { List assertions = - new ArrayList<>( - asList( - equalTo(MESSAGING_SYSTEM, "kafka"), - equalTo(MESSAGING_DESTINATION_NAME, record.topic()), - equalTo(MESSAGING_OPERATION, "process"), - satisfies(stringKey("messaging.client_id"), val -> val.startsWith("consumer")), - satisfies(MESSAGING_DESTINATION_PARTITION_ID, AbstractStringAssert::isNotEmpty), - satisfies(MESSAGING_KAFKA_MESSAGE_OFFSET, AbstractLongAssert::isNotNegative))); + messagingAttributes(record.topic(), "process", "process", "process", "consumer"); + assertions.add(satisfies(MESSAGING_DESTINATION_PARTITION_ID, AbstractStringAssert::isNotEmpty)); + addOffsetAssertion(assertions); if (HAS_CONSUMER_GROUP) { - assertions.add(equalTo(MESSAGING_KAFKA_CONSUMER_GROUP, "test")); + addGroupAssertions(assertions); } if (EXPERIMENTAL_ATTRIBUTES) { assertions.add( @@ -275,4 +264,58 @@ private static List processAttributes(ProducerRecord messagingAttributes( + String topic, + String oldOperation, + String operationName, + String operationType, + String clientIdPrefix) { + List assertions = + new ArrayList<>( + asList( + equalTo(MESSAGING_SYSTEM, "kafka"), + equalTo(MESSAGING_DESTINATION_NAME, topic), + equalTo(MESSAGING_OPERATION, emitOldMessagingSemconv() ? oldOperation : null), + equalTo( + MESSAGING_OPERATION_NAME, emitStableMessagingSemconv() ? operationName : null), + equalTo( + MESSAGING_OPERATION_TYPE, + emitStableMessagingSemconv() ? operationType : null))); + if (emitOldMessagingSemconv()) { + assertions.add( + satisfies(stringKey("messaging.client_id"), val -> val.startsWith(clientIdPrefix))); + } + if (emitStableMessagingSemconv()) { + assertions.add( + satisfies(stringKey("messaging.client.id"), val -> val.startsWith(clientIdPrefix))); + } + return assertions; + } + + private static void addOffsetAssertion(List assertions) { + if (emitOldMessagingSemconv()) { + assertions.add(satisfies(MESSAGING_KAFKA_MESSAGE_OFFSET, AbstractLongAssert::isNotNegative)); + } + if (emitStableMessagingSemconv()) { + assertions.add(satisfies(MESSAGING_KAFKA_OFFSET, AbstractLongAssert::isNotNegative)); + } + } + + private static void addGroupAssertions(List assertions) { + if (emitOldMessagingSemconv()) { + assertions.add(equalTo(MESSAGING_KAFKA_CONSUMER_GROUP, "test")); + } + if (emitStableMessagingSemconv()) { + assertions.add(equalTo(MESSAGING_CONSUMER_GROUP_NAME, "test")); + } + } + + private static String spanName(String topic, String oldOperation, String operationName) { + return emitStableMessagingSemconv() ? operationName + " " + topic : topic + " " + oldOperation; + } + + private static SpanKind receiveKind() { + return emitStableMessagingSemconv() ? SpanKind.CLIENT : SpanKind.CONSUMER; + } } diff --git a/instrumentation/spring/spring-kafka-2.7/javaagent/build.gradle.kts b/instrumentation/spring/spring-kafka-2.7/javaagent/build.gradle.kts index 8705e49110d5..9f80f668f6ac 100644 --- a/instrumentation/spring/spring-kafka-2.7/javaagent/build.gradle.kts +++ b/instrumentation/spring/spring-kafka-2.7/javaagent/build.gradle.kts @@ -83,6 +83,15 @@ tasks { ) } + val testV3Preview = register("testV3Preview") { + testClassesDirs = sourceSets.test.get().output.classesDirs + classpath = sourceSets.test.get().runtimeClasspath + jvmArgs("-Dotel.instrumentation.messaging.experimental.receive-telemetry.enabled=true") + jvmArgs("-Dotel.instrumentation.common.v3-preview=true") + jvmArgs("-Dotel.semconv-stability.preview=messaging") + systemProperty("metadataConfig", "otel.instrumentation.common.v3-preview=true") + } + test { jvmArgs("-Dotel.instrumentation.messaging.experimental.receive-telemetry.enabled=true") systemProperty( @@ -92,7 +101,7 @@ tasks { } check { - dependsOn(testing.suites, testExperimental) + dependsOn(testing.suites, testExperimental, testV3Preview) } } diff --git a/instrumentation/spring/spring-kafka-2.7/javaagent/src/test/java/io/opentelemetry/javaagent/instrumentation/spring/kafka/v2_7/SpringKafkaTest.java b/instrumentation/spring/spring-kafka-2.7/javaagent/src/test/java/io/opentelemetry/javaagent/instrumentation/spring/kafka/v2_7/SpringKafkaTest.java index ce5644ea1599..136d1c00ead7 100644 --- a/instrumentation/spring/spring-kafka-2.7/javaagent/src/test/java/io/opentelemetry/javaagent/instrumentation/spring/kafka/v2_7/SpringKafkaTest.java +++ b/instrumentation/spring/spring-kafka-2.7/javaagent/src/test/java/io/opentelemetry/javaagent/instrumentation/spring/kafka/v2_7/SpringKafkaTest.java @@ -7,18 +7,25 @@ import static io.opentelemetry.api.common.AttributeKey.longKey; 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.instrumentation.testing.util.TelemetryDataUtil.orderByRootSpanKind; import static io.opentelemetry.instrumentation.testing.util.TestLatestDeps.testLatestDeps; import static io.opentelemetry.sdk.testing.assertj.OpenTelemetryAssertions.equalTo; import static io.opentelemetry.sdk.testing.assertj.OpenTelemetryAssertions.satisfies; +import static io.opentelemetry.semconv.ErrorAttributes.ERROR_TYPE; import static io.opentelemetry.semconv.incubating.MessagingIncubatingAttributes.MESSAGING_BATCH_MESSAGE_COUNT; +import static io.opentelemetry.semconv.incubating.MessagingIncubatingAttributes.MESSAGING_CONSUMER_GROUP_NAME; import static io.opentelemetry.semconv.incubating.MessagingIncubatingAttributes.MESSAGING_DESTINATION_NAME; import static io.opentelemetry.semconv.incubating.MessagingIncubatingAttributes.MESSAGING_DESTINATION_PARTITION_ID; import static io.opentelemetry.semconv.incubating.MessagingIncubatingAttributes.MESSAGING_KAFKA_CONSUMER_GROUP; import static io.opentelemetry.semconv.incubating.MessagingIncubatingAttributes.MESSAGING_KAFKA_MESSAGE_KEY; import static io.opentelemetry.semconv.incubating.MessagingIncubatingAttributes.MESSAGING_KAFKA_MESSAGE_OFFSET; +import static io.opentelemetry.semconv.incubating.MessagingIncubatingAttributes.MESSAGING_KAFKA_OFFSET; import static io.opentelemetry.semconv.incubating.MessagingIncubatingAttributes.MESSAGING_MESSAGE_BODY_SIZE; 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.Arrays.asList; import static java.util.Collections.emptyList; @@ -78,74 +85,33 @@ void shouldCreateSpansForSingleRecordProcess() { AtomicReference producer = new AtomicReference<>(); testing.waitAndAssertSortedTraces( - orderByRootSpanKind(SpanKind.INTERNAL, SpanKind.CONSUMER), + orderByRootSpanKind(SpanKind.INTERNAL, receiveKind()), trace -> { trace.hasSpansSatisfyingExactly( span -> span.hasName("producer"), span -> - span.hasName("testSingleTopic publish") + span.hasName(spanName("testSingleTopic", "publish", "send")) .hasKind(SpanKind.PRODUCER) .hasParent(trace.getSpan(0)) - .hasAttributesSatisfyingExactly( - equalTo(MESSAGING_SYSTEM, "kafka"), - equalTo(MESSAGING_DESTINATION_NAME, "testSingleTopic"), - equalTo(MESSAGING_OPERATION, "publish"), - satisfies( - MESSAGING_DESTINATION_PARTITION_ID, AbstractStringAssert::isNotEmpty), - satisfies( - MESSAGING_KAFKA_MESSAGE_OFFSET, AbstractLongAssert::isNotNegative), - equalTo(MESSAGING_KAFKA_MESSAGE_KEY, "10"), - satisfies( - stringKey("messaging.client_id"), val -> val.startsWith("producer")), - equalTo( - stringKey("messaging.kafka.bootstrap.servers"), - EXPERIMENTAL_ATTRIBUTES ? kafka.getBootstrapServers() : null))); + .hasAttributesSatisfyingExactly(producerAttributes("testSingleTopic", "10"))); producer.set(trace.getSpan(1)); }, trace -> trace.hasSpansSatisfyingExactly( span -> - span.hasName("testSingleTopic receive") - .hasKind(SpanKind.CONSUMER) + span.hasName(spanName("testSingleTopic", "receive", "poll")) + .hasKind(receiveKind()) .hasNoParent() .hasAttributesSatisfyingExactly( - equalTo(MESSAGING_SYSTEM, "kafka"), - equalTo(MESSAGING_DESTINATION_NAME, "testSingleTopic"), - equalTo(MESSAGING_OPERATION, "receive"), - equalTo(MESSAGING_KAFKA_CONSUMER_GROUP, "testSingleListener"), - satisfies( - stringKey("messaging.client_id"), - val -> val.startsWith("consumer")), - equalTo(MESSAGING_BATCH_MESSAGE_COUNT, 1)), + receiveAttributes("testSingleTopic", "testSingleListener", 1)), span -> - span.hasName("testSingleTopic process") + span.hasName(spanName("testSingleTopic", "process", "process")) .hasKind(SpanKind.CONSUMER) .hasParent(trace.getSpan(0)) .hasLinks(LinkData.create(producer.get().getSpanContext())) .hasAttributesSatisfyingExactly( - equalTo(MESSAGING_SYSTEM, "kafka"), - equalTo(MESSAGING_DESTINATION_NAME, "testSingleTopic"), - equalTo(MESSAGING_OPERATION, "process"), - satisfies( - MESSAGING_MESSAGE_BODY_SIZE, AbstractLongAssert::isNotNegative), - satisfies( - MESSAGING_DESTINATION_PARTITION_ID, - AbstractStringAssert::isNotEmpty), - satisfies( - MESSAGING_KAFKA_MESSAGE_OFFSET, AbstractLongAssert::isNotNegative), - equalTo(MESSAGING_KAFKA_MESSAGE_KEY, "10"), - equalTo(MESSAGING_KAFKA_CONSUMER_GROUP, "testSingleListener"), - satisfies( - stringKey("messaging.client_id"), - val -> val.startsWith("consumer")), - satisfies( - longKey("kafka.record.queue_time_ms"), - val -> { - if (EXPERIMENTAL_ATTRIBUTES) { - val.isNotNegative(); - } - })), + singleProcessAttributes("testSingleTopic", "testSingleListener", "10")), span -> span.hasName("consumer").hasParent(trace.getSpan(1)))); } @@ -163,64 +129,29 @@ void shouldHandleFailureInKafkaListener() { Consumer receiveSpanAssert = span -> - span.hasName("testSingleTopic receive") - .hasKind(SpanKind.CONSUMER) + span.hasName(spanName("testSingleTopic", "receive", "poll")) + .hasKind(receiveKind()) .hasNoParent() .hasAttributesSatisfyingExactly( - equalTo(MESSAGING_SYSTEM, "kafka"), - equalTo(MESSAGING_DESTINATION_NAME, "testSingleTopic"), - equalTo(MESSAGING_OPERATION, "receive"), - equalTo(MESSAGING_KAFKA_CONSUMER_GROUP, "testSingleListener"), - satisfies(stringKey("messaging.client_id"), val -> val.startsWith("consumer")), - equalTo(MESSAGING_BATCH_MESSAGE_COUNT, 1)); + receiveAttributes("testSingleTopic", "testSingleListener", 1)); List processAttributes = - asList( - equalTo(MESSAGING_SYSTEM, "kafka"), - equalTo(MESSAGING_DESTINATION_NAME, "testSingleTopic"), - equalTo(MESSAGING_OPERATION, "process"), - satisfies(MESSAGING_MESSAGE_BODY_SIZE, AbstractLongAssert::isNotNegative), - satisfies(MESSAGING_DESTINATION_PARTITION_ID, AbstractStringAssert::isNotEmpty), - satisfies(MESSAGING_KAFKA_MESSAGE_OFFSET, AbstractLongAssert::isNotNegative), - equalTo(MESSAGING_KAFKA_MESSAGE_KEY, "10"), - equalTo(MESSAGING_KAFKA_CONSUMER_GROUP, "testSingleListener"), - satisfies(stringKey("messaging.client_id"), val -> val.startsWith("consumer")), - satisfies( - longKey("kafka.record.queue_time_ms"), - val -> { - if (EXPERIMENTAL_ATTRIBUTES) { - val.isNotNegative(); - } - })); + singleProcessAttributes("testSingleTopic", "testSingleListener", "10"); AtomicReference producer = new AtomicReference<>(); // trace structure differs in latest dep tests because CommonErrorHandler is only set for latest // dep tests if (testLatestDeps()) { testing.waitAndAssertSortedTraces( - orderByRootSpanKind(SpanKind.INTERNAL, SpanKind.CONSUMER), + orderByRootSpanKind(SpanKind.INTERNAL, receiveKind()), trace -> { trace.hasSpansSatisfyingExactly( span -> span.hasName("producer"), span -> - span.hasName("testSingleTopic publish") + span.hasName(spanName("testSingleTopic", "publish", "send")) .hasKind(SpanKind.PRODUCER) .hasParent(trace.getSpan(0)) .hasAttributesSatisfyingExactly( - equalTo(MESSAGING_SYSTEM, "kafka"), - equalTo(MESSAGING_DESTINATION_NAME, "testSingleTopic"), - equalTo(MESSAGING_OPERATION, "publish"), - satisfies( - MESSAGING_DESTINATION_PARTITION_ID, - AbstractStringAssert::isNotEmpty), - satisfies( - MESSAGING_KAFKA_MESSAGE_OFFSET, AbstractLongAssert::isNotNegative), - equalTo(MESSAGING_KAFKA_MESSAGE_KEY, "10"), - satisfies( - stringKey("messaging.client_id"), - val -> val.startsWith("producer")), - equalTo( - stringKey("messaging.kafka.bootstrap.servers"), - EXPERIMENTAL_ATTRIBUTES ? kafka.getBootstrapServers() : null))); + producerAttributes("testSingleTopic", "10"))); producer.set(trace.getSpan(1)); }, @@ -228,59 +159,45 @@ void shouldHandleFailureInKafkaListener() { trace.hasSpansSatisfyingExactly( receiveSpanAssert, span -> - span.hasName("testSingleTopic process") + span.hasName(spanName("testSingleTopic", "process", "process")) .hasKind(SpanKind.CONSUMER) .hasParent(trace.getSpan(0)) .hasLinks(LinkData.create(producer.get().getSpanContext())) .hasStatus(StatusData.error()) .hasException(new IllegalArgumentException("boom")) - .hasAttributesSatisfyingExactly(processAttributes), + .hasAttributesSatisfyingExactly(withErrorType(processAttributes, true)), span -> span.hasName("consumer").hasParent(trace.getSpan(1)), span -> span.hasName("handle exception").hasParent(trace.getSpan(1)), span -> - span.hasName("testSingleTopic process") + span.hasName(spanName("testSingleTopic", "process", "process")) .hasKind(SpanKind.CONSUMER) .hasParent(trace.getSpan(0)) .hasLinks(LinkData.create(producer.get().getSpanContext())) .hasStatus(StatusData.error()) .hasException(new IllegalArgumentException("boom")) - .hasAttributesSatisfyingExactly(processAttributes), + .hasAttributesSatisfyingExactly(withErrorType(processAttributes, true)), span -> span.hasName("consumer").hasParent(trace.getSpan(4)), span -> span.hasName("handle exception").hasParent(trace.getSpan(4)), span -> - span.hasName("testSingleTopic process") + span.hasName(spanName("testSingleTopic", "process", "process")) .hasKind(SpanKind.CONSUMER) .hasParent(trace.getSpan(0)) .hasLinks(LinkData.create(producer.get().getSpanContext())) - .hasAttributesSatisfyingExactly(processAttributes), + .hasAttributesSatisfyingExactly(withErrorType(processAttributes, false)), span -> span.hasName("consumer").hasParent(trace.getSpan(7)))); } else { testing.waitAndAssertSortedTraces( - orderByRootSpanKind(SpanKind.INTERNAL, SpanKind.CONSUMER), + orderByRootSpanKind(SpanKind.INTERNAL, receiveKind()), trace -> { trace.hasSpansSatisfyingExactly( span -> span.hasName("producer"), span -> - span.hasName("testSingleTopic publish") + span.hasName(spanName("testSingleTopic", "publish", "send")) .hasKind(SpanKind.PRODUCER) .hasParent(trace.getSpan(0)) .hasAttributesSatisfyingExactly( - equalTo(MESSAGING_SYSTEM, "kafka"), - equalTo(MESSAGING_DESTINATION_NAME, "testSingleTopic"), - equalTo(MESSAGING_OPERATION, "publish"), - satisfies( - MESSAGING_DESTINATION_PARTITION_ID, - AbstractStringAssert::isNotEmpty), - satisfies( - MESSAGING_KAFKA_MESSAGE_OFFSET, AbstractLongAssert::isNotNegative), - equalTo(MESSAGING_KAFKA_MESSAGE_KEY, "10"), - satisfies( - stringKey("messaging.client_id"), - val -> val.startsWith("producer")), - equalTo( - stringKey("messaging.kafka.bootstrap.servers"), - EXPERIMENTAL_ATTRIBUTES ? kafka.getBootstrapServers() : null))); + producerAttributes("testSingleTopic", "10"))); producer.set(trace.getSpan(1)); }, @@ -288,35 +205,35 @@ void shouldHandleFailureInKafkaListener() { trace.hasSpansSatisfyingExactly( receiveSpanAssert, span -> - span.hasName("testSingleTopic process") + span.hasName(spanName("testSingleTopic", "process", "process")) .hasKind(SpanKind.CONSUMER) .hasParent(trace.getSpan(0)) .hasLinks(LinkData.create(producer.get().getSpanContext())) .hasStatus(StatusData.error()) .hasException(new IllegalArgumentException("boom")) - .hasAttributesSatisfyingExactly(processAttributes), + .hasAttributesSatisfyingExactly(withErrorType(processAttributes, true)), span -> span.hasName("consumer").hasParent(trace.getSpan(1))), trace -> trace.hasSpansSatisfyingExactly( receiveSpanAssert, span -> - span.hasName("testSingleTopic process") + span.hasName(spanName("testSingleTopic", "process", "process")) .hasKind(SpanKind.CONSUMER) .hasParent(trace.getSpan(0)) .hasLinks(LinkData.create(producer.get().getSpanContext())) .hasStatus(StatusData.error()) .hasException(new IllegalArgumentException("boom")) - .hasAttributesSatisfyingExactly(processAttributes), + .hasAttributesSatisfyingExactly(withErrorType(processAttributes, true)), span -> span.hasName("consumer").hasParent(trace.getSpan(1))), trace -> trace.hasSpansSatisfyingExactly( receiveSpanAssert, span -> - span.hasName("testSingleTopic process") + span.hasName(spanName("testSingleTopic", "process", "process")) .hasKind(SpanKind.CONSUMER) .hasParent(trace.getSpan(0)) .hasLinks(LinkData.create(producer.get().getSpanContext())) - .hasAttributesSatisfyingExactly(processAttributes), + .hasAttributesSatisfyingExactly(withErrorType(processAttributes, false)), span -> span.hasName("consumer").hasParent(trace.getSpan(1)))); } } @@ -332,46 +249,20 @@ void shouldCreateSpansForBatchReceiveAndProcess() throws InterruptedException { AtomicReference producer2 = new AtomicReference<>(); testing.waitAndAssertSortedTraces( - orderByRootSpanKind(SpanKind.INTERNAL, SpanKind.CONSUMER), + orderByRootSpanKind(SpanKind.INTERNAL, receiveKind()), trace -> { trace.hasSpansSatisfyingExactlyInAnyOrder( span -> span.hasName("producer"), span -> - span.hasName("testBatchTopic publish") + span.hasName(spanName("testBatchTopic", "publish", "send")) .hasKind(SpanKind.PRODUCER) .hasParent(trace.getSpan(0)) - .hasAttributesSatisfyingExactly( - equalTo(MESSAGING_SYSTEM, "kafka"), - equalTo(MESSAGING_DESTINATION_NAME, "testBatchTopic"), - equalTo(MESSAGING_OPERATION, "publish"), - satisfies( - MESSAGING_DESTINATION_PARTITION_ID, AbstractStringAssert::isNotEmpty), - satisfies( - MESSAGING_KAFKA_MESSAGE_OFFSET, AbstractLongAssert::isNotNegative), - equalTo(MESSAGING_KAFKA_MESSAGE_KEY, "10"), - satisfies( - stringKey("messaging.client_id"), val -> val.startsWith("producer")), - equalTo( - stringKey("messaging.kafka.bootstrap.servers"), - EXPERIMENTAL_ATTRIBUTES ? kafka.getBootstrapServers() : null)), + .hasAttributesSatisfyingExactly(producerAttributes("testBatchTopic", "10")), span -> - span.hasName("testBatchTopic publish") + span.hasName(spanName("testBatchTopic", "publish", "send")) .hasKind(SpanKind.PRODUCER) .hasParent(trace.getSpan(0)) - .hasAttributesSatisfyingExactly( - equalTo(MESSAGING_SYSTEM, "kafka"), - equalTo(MESSAGING_DESTINATION_NAME, "testBatchTopic"), - equalTo(MESSAGING_OPERATION, "publish"), - satisfies( - MESSAGING_DESTINATION_PARTITION_ID, AbstractStringAssert::isNotEmpty), - satisfies( - MESSAGING_KAFKA_MESSAGE_OFFSET, AbstractLongAssert::isNotNegative), - equalTo(MESSAGING_KAFKA_MESSAGE_KEY, "20"), - satisfies( - stringKey("messaging.client_id"), val -> val.startsWith("producer")), - equalTo( - stringKey("messaging.kafka.bootstrap.servers"), - EXPERIMENTAL_ATTRIBUTES ? kafka.getBootstrapServers() : null))); + .hasAttributesSatisfyingExactly(producerAttributes("testBatchTopic", "20"))); producer1.set(trace.getSpan(1)); producer2.set(trace.getSpan(2)); @@ -379,34 +270,20 @@ void shouldCreateSpansForBatchReceiveAndProcess() throws InterruptedException { trace -> trace.hasSpansSatisfyingExactly( span -> - span.hasName("testBatchTopic receive") - .hasKind(SpanKind.CONSUMER) + span.hasName(spanName("testBatchTopic", "receive", "poll")) + .hasKind(receiveKind()) .hasNoParent() .hasAttributesSatisfyingExactly( - equalTo(MESSAGING_SYSTEM, "kafka"), - equalTo(MESSAGING_DESTINATION_NAME, "testBatchTopic"), - equalTo(MESSAGING_OPERATION, "receive"), - equalTo(MESSAGING_KAFKA_CONSUMER_GROUP, "testBatchListener"), - satisfies( - stringKey("messaging.client_id"), - val -> val.startsWith("consumer")), - equalTo(MESSAGING_BATCH_MESSAGE_COUNT, 2)), + receiveAttributes("testBatchTopic", "testBatchListener", 2)), span -> - span.hasName("testBatchTopic process") + span.hasName(spanName("testBatchTopic", "process", "process")) .hasKind(SpanKind.CONSUMER) .hasParent(trace.getSpan(0)) .hasLinks( LinkData.create(producer1.get().getSpanContext()), LinkData.create(producer2.get().getSpanContext())) .hasAttributesSatisfyingExactly( - equalTo(MESSAGING_SYSTEM, "kafka"), - equalTo(MESSAGING_DESTINATION_NAME, "testBatchTopic"), - equalTo(MESSAGING_OPERATION, "process"), - equalTo(MESSAGING_KAFKA_CONSUMER_GROUP, "testBatchListener"), - satisfies( - stringKey("messaging.client_id"), - val -> val.startsWith("consumer")), - equalTo(MESSAGING_BATCH_MESSAGE_COUNT, 2)), + batchProcessAttributes("testBatchTopic", "testBatchListener", 2)), span -> span.hasName("consumer").hasParent(trace.getSpan(1)))); } @@ -430,23 +307,10 @@ void shouldHandleFailureInKafkaBatchListener() { trace.hasSpansSatisfyingExactly( span -> span.hasName("producer"), span -> - span.hasName("testBatchTopic publish") + span.hasName(spanName("testBatchTopic", "publish", "send")) .hasKind(SpanKind.PRODUCER) .hasParent(trace.getSpan(0)) - .hasAttributesSatisfyingExactly( - equalTo(MESSAGING_SYSTEM, "kafka"), - equalTo(MESSAGING_DESTINATION_NAME, "testBatchTopic"), - equalTo(MESSAGING_OPERATION, "publish"), - satisfies( - MESSAGING_DESTINATION_PARTITION_ID, AbstractStringAssert::isNotEmpty), - satisfies( - MESSAGING_KAFKA_MESSAGE_OFFSET, AbstractLongAssert::isNotNegative), - equalTo(MESSAGING_KAFKA_MESSAGE_KEY, "10"), - satisfies( - stringKey("messaging.client_id"), val -> val.startsWith("producer")), - equalTo( - stringKey("messaging.kafka.bootstrap.servers"), - EXPERIMENTAL_ATTRIBUTES ? kafka.getBootstrapServers() : null))); + .hasAttributesSatisfyingExactly(producerAttributes("testBatchTopic", "10"))); producer.set(trace.getSpan(1)); }); @@ -484,37 +348,142 @@ void shouldHandleFailureInKafkaBatchListener() { } testing.waitAndAssertSortedTraces( - orderByRootSpanKind(SpanKind.INTERNAL, SpanKind.CONSUMER), assertions); + orderByRootSpanKind(SpanKind.INTERNAL, receiveKind()), assertions); } private static void assertReceiveSpan(SpanDataAssert span) { - span.hasName("testBatchTopic receive") - .hasKind(SpanKind.CONSUMER) + span.hasName(spanName("testBatchTopic", "receive", "poll")) + .hasKind(receiveKind()) .hasNoParent() .hasAttributesSatisfyingExactly( - equalTo(MESSAGING_SYSTEM, "kafka"), - equalTo(MESSAGING_DESTINATION_NAME, "testBatchTopic"), - equalTo(MESSAGING_OPERATION, "receive"), - equalTo(MESSAGING_KAFKA_CONSUMER_GROUP, "testBatchListener"), - satisfies(stringKey("messaging.client_id"), val -> val.startsWith("consumer")), - equalTo(MESSAGING_BATCH_MESSAGE_COUNT, 1)); + receiveAttributes("testBatchTopic", "testBatchListener", 1)); } private static void assertProcessSpan( SpanDataAssert span, TraceAssert trace, SpanData producer, boolean failed) { - span.hasName("testBatchTopic process") + span.hasName(spanName("testBatchTopic", "process", "process")) .hasKind(SpanKind.CONSUMER) .hasParent(trace.getSpan(0)) .hasLinks(LinkData.create(producer.getSpanContext())) .hasAttributesSatisfyingExactly( - equalTo(MESSAGING_SYSTEM, "kafka"), - equalTo(MESSAGING_DESTINATION_NAME, "testBatchTopic"), - equalTo(MESSAGING_OPERATION, "process"), - equalTo(MESSAGING_KAFKA_CONSUMER_GROUP, "testBatchListener"), - satisfies(stringKey("messaging.client_id"), val -> val.startsWith("consumer")), - equalTo(MESSAGING_BATCH_MESSAGE_COUNT, 1)); + withErrorType( + batchProcessAttributes("testBatchTopic", "testBatchListener", 1), failed)); if (failed) { span.hasStatus(StatusData.error()).hasException(new IllegalArgumentException("boom")); } } + + private static List producerAttributes(String topic, String messageKey) { + List assertions = + messagingAttributes(topic, "publish", "send", "send", "producer"); + assertions.add(satisfies(MESSAGING_DESTINATION_PARTITION_ID, AbstractStringAssert::isNotEmpty)); + addOffsetAssertion(assertions); + assertions.add(equalTo(MESSAGING_KAFKA_MESSAGE_KEY, messageKey)); + assertions.add( + equalTo( + stringKey("messaging.kafka.bootstrap.servers"), + EXPERIMENTAL_ATTRIBUTES ? kafka.getBootstrapServers() : null)); + return assertions; + } + + private static List receiveAttributes( + String topic, String group, int batchSize) { + List assertions = + messagingAttributes(topic, "receive", "poll", "receive", "consumer"); + addGroupAssertions(assertions, group); + assertions.add(equalTo(MESSAGING_BATCH_MESSAGE_COUNT, batchSize)); + return assertions; + } + + private static List singleProcessAttributes( + String topic, String group, String messageKey) { + List assertions = + messagingAttributes(topic, "process", "process", "process", "consumer"); + assertions.add(satisfies(MESSAGING_MESSAGE_BODY_SIZE, AbstractLongAssert::isNotNegative)); + assertions.add(satisfies(MESSAGING_DESTINATION_PARTITION_ID, AbstractStringAssert::isNotEmpty)); + addOffsetAssertion(assertions); + assertions.add(equalTo(MESSAGING_KAFKA_MESSAGE_KEY, messageKey)); + addGroupAssertions(assertions, group); + assertions.add( + satisfies( + longKey("kafka.record.queue_time_ms"), + val -> { + if (EXPERIMENTAL_ATTRIBUTES) { + val.isNotNegative(); + } + })); + return assertions; + } + + private static List batchProcessAttributes( + String topic, String group, int batchSize) { + List assertions = + messagingAttributes(topic, "process", "process", "process", "consumer"); + addGroupAssertions(assertions, group); + assertions.add(equalTo(MESSAGING_BATCH_MESSAGE_COUNT, batchSize)); + return assertions; + } + + private static List messagingAttributes( + String topic, + String oldOperation, + String operationName, + String operationType, + String clientIdPrefix) { + List assertions = + new ArrayList<>( + asList( + equalTo(MESSAGING_SYSTEM, "kafka"), + equalTo(MESSAGING_DESTINATION_NAME, topic), + equalTo(MESSAGING_OPERATION, emitOldMessagingSemconv() ? oldOperation : null), + equalTo( + MESSAGING_OPERATION_NAME, emitStableMessagingSemconv() ? operationName : null), + equalTo( + MESSAGING_OPERATION_TYPE, + emitStableMessagingSemconv() ? operationType : null))); + if (emitOldMessagingSemconv()) { + assertions.add( + satisfies(stringKey("messaging.client_id"), val -> val.startsWith(clientIdPrefix))); + } + if (emitStableMessagingSemconv()) { + assertions.add( + satisfies(stringKey("messaging.client.id"), val -> val.startsWith(clientIdPrefix))); + } + return assertions; + } + + private static void addOffsetAssertion(List assertions) { + if (emitOldMessagingSemconv()) { + assertions.add(satisfies(MESSAGING_KAFKA_MESSAGE_OFFSET, AbstractLongAssert::isNotNegative)); + } + if (emitStableMessagingSemconv()) { + assertions.add(satisfies(MESSAGING_KAFKA_OFFSET, AbstractLongAssert::isNotNegative)); + } + } + + private static void addGroupAssertions(List assertions, String group) { + if (emitOldMessagingSemconv()) { + assertions.add(equalTo(MESSAGING_KAFKA_CONSUMER_GROUP, group)); + } + if (emitStableMessagingSemconv()) { + assertions.add(equalTo(MESSAGING_CONSUMER_GROUP_NAME, group)); + } + } + + private static List withErrorType( + List assertions, boolean failed) { + List result = new ArrayList<>(assertions); + if (emitStableMessagingSemconv() && failed) { + result.add(equalTo(ERROR_TYPE, IllegalArgumentException.class.getName())); + } + return result; + } + + private static String spanName(String topic, String oldOperation, String operationName) { + return emitStableMessagingSemconv() ? operationName + " " + topic : topic + " " + oldOperation; + } + + private static SpanKind receiveKind() { + return emitStableMessagingSemconv() ? SpanKind.CLIENT : SpanKind.CONSUMER; + } } diff --git a/instrumentation/vertx/vertx-kafka-client-3.6/testing/src/main/java/io/opentelemetry/javaagent/instrumentation/vertx/kafka/AbstractBatchRecordsNoReceiveTelemetryVertxKafkaTest.java b/instrumentation/vertx/vertx-kafka-client-3.6/testing/src/main/java/io/opentelemetry/javaagent/instrumentation/vertx/kafka/AbstractBatchRecordsNoReceiveTelemetryVertxKafkaTest.java index 251e610cbbac..530dadbd43a4 100644 --- a/instrumentation/vertx/vertx-kafka-client-3.6/testing/src/main/java/io/opentelemetry/javaagent/instrumentation/vertx/kafka/AbstractBatchRecordsNoReceiveTelemetryVertxKafkaTest.java +++ b/instrumentation/vertx/vertx-kafka-client-3.6/testing/src/main/java/io/opentelemetry/javaagent/instrumentation/vertx/kafka/AbstractBatchRecordsNoReceiveTelemetryVertxKafkaTest.java @@ -64,12 +64,12 @@ void shouldCreateSpansForBatchReceiveAndProcess() throws InterruptedException { // first record span -> - span.hasName("testBatchTopic publish") + span.hasName(spanName("testBatchTopic", "publish", "send")) .hasKind(SpanKind.PRODUCER) .hasParent(trace.getSpan(0)) .hasAttributesSatisfyingExactly(sendAttributes(record1)), span -> - span.hasName("testBatchTopic process") + span.hasName(spanName("testBatchTopic", "process", "process")) .hasKind(SpanKind.CONSUMER) .hasParent(trace.getSpan(1)) .hasAttributesSatisfyingExactly(processAttributes(record1)), @@ -77,12 +77,12 @@ void shouldCreateSpansForBatchReceiveAndProcess() throws InterruptedException { // second record span -> - span.hasName("testBatchTopic publish") + span.hasName(spanName("testBatchTopic", "publish", "send")) .hasKind(SpanKind.PRODUCER) .hasParent(trace.getSpan(0)) .hasAttributesSatisfyingExactly(sendAttributes(record2)), span -> - span.hasName("testBatchTopic process") + span.hasName(spanName("testBatchTopic", "process", "process")) .hasKind(SpanKind.CONSUMER) .hasParent(trace.getSpan(4)) .hasAttributesSatisfyingExactly(processAttributes(record2)), @@ -95,7 +95,7 @@ void shouldCreateSpansForBatchReceiveAndProcess() throws InterruptedException { trace.hasSpansSatisfyingExactly( // batch consumer span -> - span.hasName("testBatchTopic process") + span.hasName(spanName("testBatchTopic", "process", "process")) .hasKind(SpanKind.CONSUMER) .hasNoParent() .hasLinks( @@ -127,12 +127,12 @@ void shouldHandleFailureInKafkaBatchListener() throws InterruptedException { trace.hasSpansSatisfyingExactly( span -> span.hasName("producer"), span -> - span.hasName("testBatchTopic publish") + span.hasName(spanName("testBatchTopic", "publish", "send")) .hasKind(SpanKind.PRODUCER) .hasParent(trace.getSpan(0)) .hasAttributesSatisfyingExactly(sendAttributes(record)), span -> - span.hasName("testBatchTopic process") + span.hasName(spanName("testBatchTopic", "process", "process")) .hasKind(SpanKind.CONSUMER) .hasParent(trace.getSpan(1)) .hasAttributesSatisfyingExactly(processAttributes(record)), @@ -143,14 +143,14 @@ void shouldHandleFailureInKafkaBatchListener() throws InterruptedException { trace -> trace.hasSpansSatisfyingExactly( span -> - span.hasName("testBatchTopic process") + span.hasName(spanName("testBatchTopic", "process", "process")) .hasKind(SpanKind.CONSUMER) .hasNoParent() .hasLinks(LinkData.create(producer.get().getSpanContext())) .hasStatus(StatusData.error()) .hasException(new IllegalArgumentException("boom")) .hasAttributesSatisfyingExactly( - batchProcessAttributes("testBatchTopic")), + withErrorType(batchProcessAttributes("testBatchTopic"))), span -> span.hasName("batch consumer").hasParent(trace.getSpan(0)))); } } diff --git a/instrumentation/vertx/vertx-kafka-client-3.6/testing/src/main/java/io/opentelemetry/javaagent/instrumentation/vertx/kafka/AbstractBatchRecordsVertxKafkaTest.java b/instrumentation/vertx/vertx-kafka-client-3.6/testing/src/main/java/io/opentelemetry/javaagent/instrumentation/vertx/kafka/AbstractBatchRecordsVertxKafkaTest.java index 09109a3dda08..68f13bf6f89d 100644 --- a/instrumentation/vertx/vertx-kafka-client-3.6/testing/src/main/java/io/opentelemetry/javaagent/instrumentation/vertx/kafka/AbstractBatchRecordsVertxKafkaTest.java +++ b/instrumentation/vertx/vertx-kafka-client-3.6/testing/src/main/java/io/opentelemetry/javaagent/instrumentation/vertx/kafka/AbstractBatchRecordsVertxKafkaTest.java @@ -56,17 +56,17 @@ void shouldCreateSpansForBatchReceiveAndProcess() throws InterruptedException { testing() .waitAndAssertSortedTraces( - orderByRootSpanKind(SpanKind.INTERNAL, SpanKind.CONSUMER), + orderByRootSpanKind(SpanKind.INTERNAL, receiveKind()), trace -> { trace.hasSpansSatisfyingExactlyInAnyOrder( span -> span.hasName("producer"), span -> - span.hasName("testBatchTopic publish") + span.hasName(spanName("testBatchTopic", "publish", "send")) .hasKind(SpanKind.PRODUCER) .hasParent(trace.getSpan(0)) .hasAttributesSatisfyingExactly(sendAttributes(record1)), span -> - span.hasName("testBatchTopic publish") + span.hasName(spanName("testBatchTopic", "publish", "send")) .hasKind(SpanKind.PRODUCER) .hasParent(trace.getSpan(0)) .hasAttributesSatisfyingExactly(sendAttributes(record2))); @@ -77,14 +77,14 @@ void shouldCreateSpansForBatchReceiveAndProcess() throws InterruptedException { trace -> trace.hasSpansSatisfyingExactlyInAnyOrder( span -> - span.hasName("testBatchTopic receive") - .hasKind(SpanKind.CONSUMER) + span.hasName(spanName("testBatchTopic", "receive", "poll")) + .hasKind(receiveKind()) .hasNoParent() .hasAttributesSatisfyingExactly(receiveAttributes("testBatchTopic")), // batch consumer span -> - span.hasName("testBatchTopic process") + span.hasName(spanName("testBatchTopic", "process", "process")) .hasKind(SpanKind.CONSUMER) .hasParent(trace.getSpan(0)) .hasLinks( @@ -96,7 +96,7 @@ void shouldCreateSpansForBatchReceiveAndProcess() throws InterruptedException { // single consumer 1 span -> - span.hasName("testBatchTopic process") + span.hasName(spanName("testBatchTopic", "process", "process")) .hasKind(SpanKind.CONSUMER) .hasParent(trace.getSpan(0)) .hasLinks(LinkData.create(producer1.get().getSpanContext())) @@ -105,7 +105,7 @@ void shouldCreateSpansForBatchReceiveAndProcess() throws InterruptedException { // single consumer 2 span -> - span.hasName("testBatchTopic process") + span.hasName(spanName("testBatchTopic", "process", "process")) .hasKind(SpanKind.CONSUMER) .hasParent(trace.getSpan(0)) .hasLinks(LinkData.create(producer2.get().getSpanContext())) @@ -129,12 +129,12 @@ void shouldHandleFailureInKafkaBatchListener() throws InterruptedException { // the regular handler is not being called if the batch one fails testing() .waitAndAssertSortedTraces( - orderByRootSpanKind(SpanKind.INTERNAL, SpanKind.CONSUMER), + orderByRootSpanKind(SpanKind.INTERNAL, receiveKind()), trace -> { trace.hasSpansSatisfyingExactly( span -> span.hasName("producer"), span -> - span.hasName("testBatchTopic publish") + span.hasName(spanName("testBatchTopic", "publish", "send")) .hasKind(SpanKind.PRODUCER) .hasParent(trace.getSpan(0)) .hasAttributesSatisfyingExactly(sendAttributes(record))); @@ -144,26 +144,26 @@ void shouldHandleFailureInKafkaBatchListener() throws InterruptedException { trace -> trace.hasSpansSatisfyingExactly( span -> - span.hasName("testBatchTopic receive") - .hasKind(SpanKind.CONSUMER) + span.hasName(spanName("testBatchTopic", "receive", "poll")) + .hasKind(receiveKind()) .hasNoParent() .hasAttributesSatisfyingExactly(receiveAttributes("testBatchTopic")), // batch consumer span -> - span.hasName("testBatchTopic process") + span.hasName(spanName("testBatchTopic", "process", "process")) .hasKind(SpanKind.CONSUMER) .hasParent(trace.getSpan(0)) .hasLinks(LinkData.create(producer.get().getSpanContext())) .hasStatus(StatusData.error()) .hasException(new IllegalArgumentException("boom")) .hasAttributesSatisfyingExactly( - batchProcessAttributes("testBatchTopic")), + withErrorType(batchProcessAttributes("testBatchTopic"))), span -> span.hasName("batch consumer").hasParent(trace.getSpan(1)), // single consumer span -> - span.hasName("testBatchTopic process") + span.hasName(spanName("testBatchTopic", "process", "process")) .hasKind(SpanKind.CONSUMER) .hasParent(trace.getSpan(0)) .hasAttributesSatisfyingExactly(processAttributes(record)), diff --git a/instrumentation/vertx/vertx-kafka-client-3.6/testing/src/main/java/io/opentelemetry/javaagent/instrumentation/vertx/kafka/AbstractSingleRecordNoReceiveTelemetryVertxKafkaTest.java b/instrumentation/vertx/vertx-kafka-client-3.6/testing/src/main/java/io/opentelemetry/javaagent/instrumentation/vertx/kafka/AbstractSingleRecordNoReceiveTelemetryVertxKafkaTest.java index af6aadb1515a..c8a5479437c3 100644 --- a/instrumentation/vertx/vertx-kafka-client-3.6/testing/src/main/java/io/opentelemetry/javaagent/instrumentation/vertx/kafka/AbstractSingleRecordNoReceiveTelemetryVertxKafkaTest.java +++ b/instrumentation/vertx/vertx-kafka-client-3.6/testing/src/main/java/io/opentelemetry/javaagent/instrumentation/vertx/kafka/AbstractSingleRecordNoReceiveTelemetryVertxKafkaTest.java @@ -50,12 +50,12 @@ void shouldCreateSpansForSingleRecordProcess() throws InterruptedException { trace.hasSpansSatisfyingExactly( span -> span.hasName("producer"), span -> - span.hasName("testSingleTopic publish") + span.hasName(spanName("testSingleTopic", "publish", "send")) .hasKind(SpanKind.PRODUCER) .hasParent(trace.getSpan(0)) .hasAttributesSatisfyingExactly(sendAttributes(record)), span -> - span.hasName("testSingleTopic process") + span.hasName(spanName("testSingleTopic", "process", "process")) .hasKind(SpanKind.CONSUMER) .hasParent(trace.getSpan(1)) .hasAttributesSatisfyingExactly(processAttributes(record)), @@ -78,17 +78,18 @@ void shouldHandleFailureInSingleRecordHandler() throws InterruptedException { trace.hasSpansSatisfyingExactly( span -> span.hasName("producer"), span -> - span.hasName("testSingleTopic publish") + span.hasName(spanName("testSingleTopic", "publish", "send")) .hasKind(SpanKind.PRODUCER) .hasParent(trace.getSpan(0)) .hasAttributesSatisfyingExactly(sendAttributes(record)), span -> - span.hasName("testSingleTopic process") + span.hasName(spanName("testSingleTopic", "process", "process")) .hasKind(SpanKind.CONSUMER) .hasParent(trace.getSpan(1)) .hasStatus(StatusData.error()) .hasException(new IllegalArgumentException("boom")) - .hasAttributesSatisfyingExactly(processAttributes(record)), + .hasAttributesSatisfyingExactly( + withErrorType(processAttributes(record))), span -> span.hasName("consumer").hasParent(trace.getSpan(2)))); } } diff --git a/instrumentation/vertx/vertx-kafka-client-3.6/testing/src/main/java/io/opentelemetry/javaagent/instrumentation/vertx/kafka/AbstractSingleRecordVertxKafkaTest.java b/instrumentation/vertx/vertx-kafka-client-3.6/testing/src/main/java/io/opentelemetry/javaagent/instrumentation/vertx/kafka/AbstractSingleRecordVertxKafkaTest.java index 5f6c61bab0bf..f0b260204ca6 100644 --- a/instrumentation/vertx/vertx-kafka-client-3.6/testing/src/main/java/io/opentelemetry/javaagent/instrumentation/vertx/kafka/AbstractSingleRecordVertxKafkaTest.java +++ b/instrumentation/vertx/vertx-kafka-client-3.6/testing/src/main/java/io/opentelemetry/javaagent/instrumentation/vertx/kafka/AbstractSingleRecordVertxKafkaTest.java @@ -51,12 +51,12 @@ void shouldCreateSpansForSingleRecordProcess() throws InterruptedException { testing() .waitAndAssertSortedTraces( - orderByRootSpanKind(SpanKind.INTERNAL, SpanKind.CONSUMER), + orderByRootSpanKind(SpanKind.INTERNAL, receiveKind()), trace -> { trace.hasSpansSatisfyingExactly( span -> span.hasName("producer"), span -> - span.hasName("testSingleTopic publish") + span.hasName(spanName("testSingleTopic", "publish", "send")) .hasKind(SpanKind.PRODUCER) .hasParent(trace.getSpan(0)) .hasAttributesSatisfyingExactly(sendAttributes(record))); @@ -66,12 +66,12 @@ void shouldCreateSpansForSingleRecordProcess() throws InterruptedException { trace -> trace.hasSpansSatisfyingExactly( span -> - span.hasName("testSingleTopic receive") - .hasKind(SpanKind.CONSUMER) + span.hasName(spanName("testSingleTopic", "receive", "poll")) + .hasKind(receiveKind()) .hasNoParent() .hasAttributesSatisfyingExactly(receiveAttributes("testSingleTopic")), span -> - span.hasName("testSingleTopic process") + span.hasName(spanName("testSingleTopic", "process", "process")) .hasKind(SpanKind.CONSUMER) .hasParent(trace.getSpan(0)) .hasLinks(LinkData.create(producer.get().getSpanContext())) @@ -93,12 +93,12 @@ void shouldHandleFailureInSingleRecordHandler() throws InterruptedException { testing() .waitAndAssertSortedTraces( - orderByRootSpanKind(SpanKind.INTERNAL, SpanKind.CONSUMER), + orderByRootSpanKind(SpanKind.INTERNAL, receiveKind()), trace -> { trace.hasSpansSatisfyingExactly( span -> span.hasName("producer"), span -> - span.hasName("testSingleTopic publish") + span.hasName(spanName("testSingleTopic", "publish", "send")) .hasKind(SpanKind.PRODUCER) .hasParent(trace.getSpan(0)) .hasAttributesSatisfyingExactly(sendAttributes(record))); @@ -108,18 +108,19 @@ void shouldHandleFailureInSingleRecordHandler() throws InterruptedException { trace -> trace.hasSpansSatisfyingExactly( span -> - span.hasName("testSingleTopic receive") - .hasKind(SpanKind.CONSUMER) + span.hasName(spanName("testSingleTopic", "receive", "poll")) + .hasKind(receiveKind()) .hasNoParent() .hasAttributesSatisfyingExactly(receiveAttributes("testSingleTopic")), span -> - span.hasName("testSingleTopic process") + span.hasName(spanName("testSingleTopic", "process", "process")) .hasKind(SpanKind.CONSUMER) .hasParent(trace.getSpan(0)) .hasLinks(LinkData.create(producer.get().getSpanContext())) .hasStatus(StatusData.error()) .hasException(new IllegalArgumentException("boom")) - .hasAttributesSatisfyingExactly(processAttributes(record)), + .hasAttributesSatisfyingExactly( + withErrorType(processAttributes(record))), span -> span.hasName("consumer").hasParent(trace.getSpan(1)))); } } diff --git a/instrumentation/vertx/vertx-kafka-client-3.6/testing/src/main/java/io/opentelemetry/javaagent/instrumentation/vertx/kafka/AbstractVertxKafkaTest.java b/instrumentation/vertx/vertx-kafka-client-3.6/testing/src/main/java/io/opentelemetry/javaagent/instrumentation/vertx/kafka/AbstractVertxKafkaTest.java index 2a8e78be6a62..e7e3835bd457 100644 --- a/instrumentation/vertx/vertx-kafka-client-3.6/testing/src/main/java/io/opentelemetry/javaagent/instrumentation/vertx/kafka/AbstractVertxKafkaTest.java +++ b/instrumentation/vertx/vertx-kafka-client-3.6/testing/src/main/java/io/opentelemetry/javaagent/instrumentation/vertx/kafka/AbstractVertxKafkaTest.java @@ -7,16 +7,23 @@ import static io.opentelemetry.api.common.AttributeKey.longKey; 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.equalTo; import static io.opentelemetry.sdk.testing.assertj.OpenTelemetryAssertions.satisfies; +import static io.opentelemetry.semconv.ErrorAttributes.ERROR_TYPE; import static io.opentelemetry.semconv.incubating.MessagingIncubatingAttributes.MESSAGING_BATCH_MESSAGE_COUNT; +import static io.opentelemetry.semconv.incubating.MessagingIncubatingAttributes.MESSAGING_CONSUMER_GROUP_NAME; import static io.opentelemetry.semconv.incubating.MessagingIncubatingAttributes.MESSAGING_DESTINATION_NAME; import static io.opentelemetry.semconv.incubating.MessagingIncubatingAttributes.MESSAGING_DESTINATION_PARTITION_ID; import static io.opentelemetry.semconv.incubating.MessagingIncubatingAttributes.MESSAGING_KAFKA_CONSUMER_GROUP; import static io.opentelemetry.semconv.incubating.MessagingIncubatingAttributes.MESSAGING_KAFKA_MESSAGE_KEY; import static io.opentelemetry.semconv.incubating.MessagingIncubatingAttributes.MESSAGING_KAFKA_MESSAGE_OFFSET; +import static io.opentelemetry.semconv.incubating.MessagingIncubatingAttributes.MESSAGING_KAFKA_OFFSET; import static io.opentelemetry.semconv.incubating.MessagingIncubatingAttributes.MESSAGING_MESSAGE_BODY_SIZE; 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.KAFKA; import static java.nio.charset.StandardCharsets.UTF_8; @@ -24,6 +31,7 @@ import static java.util.concurrent.TimeUnit.SECONDS; import static org.assertj.core.api.Assertions.assertThat; +import io.opentelemetry.api.trace.SpanKind; import io.opentelemetry.instrumentation.testing.internal.AutoCleanupExtension; import io.opentelemetry.instrumentation.testing.junit.InstrumentationExtension; import io.opentelemetry.sdk.testing.assertj.AttributeAssertion; @@ -53,6 +61,7 @@ import org.testcontainers.kafka.KafkaContainer; import org.testcontainers.utility.DockerImageName; +@SuppressWarnings("deprecation") // using deprecated semconv @TestInstance(TestInstance.Lifecycle.PER_CLASS) public abstract class AbstractVertxKafkaTest { @@ -163,18 +172,12 @@ protected final void sendBatchMessages(KafkaProducerRecord... re protected abstract void sendRecord( KafkaProducerRecord record, Handler> handler); - @SuppressWarnings("deprecation") // using deprecated semconv protected static List sendAttributes( KafkaProducerRecord record) { List assertions = - new ArrayList<>( - asList( - equalTo(MESSAGING_SYSTEM, KAFKA), - equalTo(MESSAGING_DESTINATION_NAME, record.topic()), - equalTo(MESSAGING_OPERATION, "publish"), - satisfies(stringKey("messaging.client_id"), val -> val.startsWith("producer")), - satisfies(MESSAGING_DESTINATION_PARTITION_ID, AbstractStringAssert::isNotEmpty), - satisfies(MESSAGING_KAFKA_MESSAGE_OFFSET, AbstractLongAssert::isNotNegative))); + messagingAttributes(record.topic(), "publish", "send", "send", "producer"); + assertions.add(satisfies(MESSAGING_DESTINATION_PARTITION_ID, AbstractStringAssert::isNotEmpty)); + addOffsetAssertion(assertions); if (EXPERIMENTAL_ATTRIBUTES) { assertions.add( satisfies( @@ -196,40 +199,33 @@ protected List batchProcessAttributes(String topic) { return batchConsumerAttributes(topic, "process"); } - @SuppressWarnings("deprecation") // using deprecated semconv private List batchConsumerAttributes(String topic, String operation) { List assertions = - new ArrayList<>( - asList( - equalTo(MESSAGING_SYSTEM, KAFKA), - equalTo(MESSAGING_DESTINATION_NAME, topic), - equalTo(MESSAGING_OPERATION, operation), - satisfies(stringKey("messaging.client_id"), val -> val.startsWith("consumer")), - satisfies(MESSAGING_BATCH_MESSAGE_COUNT, AbstractLongAssert::isPositive))); + messagingAttributes( + topic, + operation, + operation.equals("receive") ? "poll" : operation, + operation.equals("receive") ? "receive" : "process", + "consumer"); + assertions.add(satisfies(MESSAGING_BATCH_MESSAGE_COUNT, AbstractLongAssert::isPositive)); if (hasConsumerGroup()) { - assertions.add(equalTo(MESSAGING_KAFKA_CONSUMER_GROUP, "test")); + addGroupAssertions(assertions); } return assertions; } - @SuppressWarnings("deprecation") // using deprecated semconv protected List processAttributes(KafkaProducerRecord record) { List assertions = - new ArrayList<>( - asList( - equalTo(MESSAGING_SYSTEM, KAFKA), - equalTo(MESSAGING_DESTINATION_NAME, record.topic()), - equalTo(MESSAGING_OPERATION, "process"), - satisfies(stringKey("messaging.client_id"), val -> val.startsWith("consumer")), - satisfies(MESSAGING_DESTINATION_PARTITION_ID, AbstractStringAssert::isNotEmpty), - satisfies(MESSAGING_KAFKA_MESSAGE_OFFSET, AbstractLongAssert::isNotNegative))); + messagingAttributes(record.topic(), "process", "process", "process", "consumer"); + assertions.add(satisfies(MESSAGING_DESTINATION_PARTITION_ID, AbstractStringAssert::isNotEmpty)); + addOffsetAssertion(assertions); if (EXPERIMENTAL_ATTRIBUTES) { assertions.add( satisfies(longKey("kafka.record.queue_time_ms"), AbstractLongAssert::isNotNegative)); } // consumer group is not available in version 0.11 if (hasConsumerGroup()) { - assertions.add(equalTo(MESSAGING_KAFKA_CONSUMER_GROUP, "test")); + addGroupAssertions(assertions); } String messageKey = record.key(); if (messageKey != null) { @@ -241,4 +237,66 @@ protected List processAttributes(KafkaProducerRecord messagingAttributes( + String topic, + String oldOperation, + String operationName, + String operationType, + String clientIdPrefix) { + List assertions = + new ArrayList<>( + asList( + equalTo(MESSAGING_SYSTEM, KAFKA), + equalTo(MESSAGING_DESTINATION_NAME, topic), + equalTo(MESSAGING_OPERATION, emitOldMessagingSemconv() ? oldOperation : null), + equalTo( + MESSAGING_OPERATION_NAME, emitStableMessagingSemconv() ? operationName : null), + equalTo( + MESSAGING_OPERATION_TYPE, + emitStableMessagingSemconv() ? operationType : null))); + if (emitOldMessagingSemconv()) { + assertions.add( + satisfies(stringKey("messaging.client_id"), val -> val.startsWith(clientIdPrefix))); + } + if (emitStableMessagingSemconv()) { + assertions.add( + satisfies(stringKey("messaging.client.id"), val -> val.startsWith(clientIdPrefix))); + } + return assertions; + } + + private static void addOffsetAssertion(List assertions) { + if (emitOldMessagingSemconv()) { + assertions.add(satisfies(MESSAGING_KAFKA_MESSAGE_OFFSET, AbstractLongAssert::isNotNegative)); + } + if (emitStableMessagingSemconv()) { + assertions.add(satisfies(MESSAGING_KAFKA_OFFSET, AbstractLongAssert::isNotNegative)); + } + } + + private static void addGroupAssertions(List assertions) { + if (emitOldMessagingSemconv()) { + assertions.add(equalTo(MESSAGING_KAFKA_CONSUMER_GROUP, "test")); + } + if (emitStableMessagingSemconv()) { + assertions.add(equalTo(MESSAGING_CONSUMER_GROUP_NAME, "test")); + } + } + + protected static String spanName(String topic, String oldOperation, String operationName) { + return emitStableMessagingSemconv() ? operationName + " " + topic : topic + " " + oldOperation; + } + + protected static SpanKind receiveKind() { + return emitStableMessagingSemconv() ? SpanKind.CLIENT : SpanKind.CONSUMER; + } + + protected static List withErrorType(List assertions) { + List result = new ArrayList<>(assertions); + if (emitStableMessagingSemconv()) { + result.add(equalTo(ERROR_TYPE, IllegalArgumentException.class.getName())); + } + return result; + } } diff --git a/instrumentation/vertx/vertx-kafka-client-3.6/vertx-kafka-client-3.6-testing/build.gradle.kts b/instrumentation/vertx/vertx-kafka-client-3.6/vertx-kafka-client-3.6-testing/build.gradle.kts index b3792e98d550..15eeae967f7a 100644 --- a/instrumentation/vertx/vertx-kafka-client-3.6/vertx-kafka-client-3.6-testing/build.gradle.kts +++ b/instrumentation/vertx/vertx-kafka-client-3.6/vertx-kafka-client-3.6-testing/build.gradle.kts @@ -57,7 +57,16 @@ tasks { ) } + val testV3Preview = register("testV3Preview") { + testClassesDirs = sourceSets.test.get().output.classesDirs + classpath = sourceSets.test.get().runtimeClasspath + jvmArgs("-Dotel.instrumentation.messaging.experimental.receive-telemetry.enabled=true") + jvmArgs("-Dotel.instrumentation.common.v3-preview=true") + jvmArgs("-Dotel.semconv-stability.preview=messaging") + systemProperty("metadataConfig", "otel.instrumentation.common.v3-preview=true") + } + check { - dependsOn(testing.suites, testExperimental) + dependsOn(testing.suites, testExperimental, testV3Preview) } } diff --git a/instrumentation/vertx/vertx-kafka-client-3.6/vertx-kafka-client-4-testing/build.gradle.kts b/instrumentation/vertx/vertx-kafka-client-3.6/vertx-kafka-client-4-testing/build.gradle.kts index 051129f97323..dfc9447e0748 100644 --- a/instrumentation/vertx/vertx-kafka-client-3.6/vertx-kafka-client-4-testing/build.gradle.kts +++ b/instrumentation/vertx/vertx-kafka-client-3.6/vertx-kafka-client-4-testing/build.gradle.kts @@ -57,7 +57,15 @@ tasks { jvmArgs("-Dotel.instrumentation.kafka.experimental-span-attributes=true") } + val testV3Preview = register("testV3Preview") { + testClassesDirs = sourceSets.test.get().output.classesDirs + classpath = sourceSets.test.get().runtimeClasspath + jvmArgs("-Dotel.instrumentation.messaging.experimental.receive-telemetry.enabled=true") + jvmArgs("-Dotel.instrumentation.common.v3-preview=true") + jvmArgs("-Dotel.semconv-stability.preview=messaging") + } + check { - dependsOn(testing.suites, testExperimental) + dependsOn(testing.suites, testExperimental, testV3Preview) } } diff --git a/instrumentation/vertx/vertx-kafka-client-3.6/vertx-kafka-client-5-testing/build.gradle.kts b/instrumentation/vertx/vertx-kafka-client-3.6/vertx-kafka-client-5-testing/build.gradle.kts index f09c01c14f6b..87ae98daf31f 100644 --- a/instrumentation/vertx/vertx-kafka-client-3.6/vertx-kafka-client-5-testing/build.gradle.kts +++ b/instrumentation/vertx/vertx-kafka-client-3.6/vertx-kafka-client-5-testing/build.gradle.kts @@ -57,7 +57,15 @@ tasks { jvmArgs("-Dotel.instrumentation.kafka.experimental-span-attributes=true") } + val testV3Preview = register("testV3Preview") { + testClassesDirs = sourceSets.test.get().output.classesDirs + classpath = sourceSets.test.get().runtimeClasspath + jvmArgs("-Dotel.instrumentation.messaging.experimental.receive-telemetry.enabled=true") + jvmArgs("-Dotel.instrumentation.common.v3-preview=true") + jvmArgs("-Dotel.semconv-stability.preview=messaging") + } + check { - dependsOn(testing.suites, testExperimental) + dependsOn(testing.suites, testExperimental, testV3Preview) } }