Implementation for the latest Messaging Semantic conventions. #13192

cbos · 2025-02-04T15:22:59Z

Update Messaging span with the latest semantic conventions.
https://github.com/open-telemetry/semantic-conventions/blob/v1.30.0/docs/messaging/messaging-spans.md

By default nothing changes, it adheres to this:

SHOULD introduce an environment variable OTEL_SEMCONV_STABILITY_OPT_IN
in the existing major version which is a comma-separated list of values.
The list of values includes:

messaging - emit the new, stable messaging conventions,
and stop emitting the old experimental messaging conventions
that the instrumentation emitted previously.

messaging/dup - emit both the old and the stable messaging conventions,
allowing for a seamless transition.

The default behavior (in the absence of one of these values) is to continue
emitting whatever version of the old experimental messaging conventions
the instrumentation was emitting previously.

Note: messaging/dup has higher precedence than messaging in case both values are present

…g (v1.29.0)

…xtractor in instrumenters

linux-foundation-easycla · 2025-02-04T15:23:04Z

✅login: cbos / (a086a82)
✅login: cbos / (a086a82, 138cce0)
✅login: cbos / (a086a82, 138cce0, 3ecd05d)
✅login: cbos / (a086a82, 138cce0, 3ecd05d, f9d51fa)
✅login: cbos / (a086a82, 138cce0, 3ecd05d, f9d51fa, 79c0d1e)
✅login: cbos / (a086a82, 138cce0, 3ecd05d, f9d51fa, 79c0d1e, d1594a1)
✅login: cbos / (a086a82, 138cce0, 3ecd05d, f9d51fa, 79c0d1e, d1594a1, 118bf1b)
✅login: cbos / (a086a82, 138cce0, 3ecd05d, f9d51fa, 79c0d1e, d1594a1, 118bf1b, 1cf86e5)
✅login: cbos / (a086a82, 138cce0, 3ecd05d, f9d51fa, 79c0d1e, d1594a1, 118bf1b, 1cf86e5, bacd3d3)
✅login: cbos / (a086a82, 138cce0, 3ecd05d, f9d51fa, 79c0d1e, d1594a1, 118bf1b, 1cf86e5, bacd3d3, 91ae29b)
✅login: cbos / (a086a82, 138cce0, 3ecd05d, f9d51fa, 79c0d1e, d1594a1, 118bf1b, 1cf86e5, bacd3d3, 91ae29b, aa83bad)
✅login: cbos / (a086a82, 138cce0, 3ecd05d, f9d51fa, 79c0d1e, d1594a1, 118bf1b, 1cf86e5, bacd3d3, 91ae29b, aa83bad, fcfd92b)
✅login: cbos / (a086a82, 138cce0, 3ecd05d, f9d51fa, 79c0d1e, d1594a1, 118bf1b, 1cf86e5, bacd3d3, 91ae29b, aa83bad, fcfd92b, 4a3ac25)
✅login: cbos / (a086a82, 138cce0, 3ecd05d, f9d51fa, 79c0d1e, d1594a1, 118bf1b, 1cf86e5, bacd3d3, 91ae29b, aa83bad, fcfd92b, 4a3ac25, b2dd7c5)
✅login: cbos / (a086a82, 138cce0, 3ecd05d, f9d51fa, 79c0d1e, d1594a1, 118bf1b, 1cf86e5, bacd3d3, 91ae29b, aa83bad, fcfd92b, 4a3ac25, b2dd7c5, eab1903)
✅login: cbos / (a086a82, 138cce0, 3ecd05d, f9d51fa, 79c0d1e, d1594a1, 118bf1b, 1cf86e5, bacd3d3, 91ae29b, aa83bad, fcfd92b, 4a3ac25, b2dd7c5, eab1903, 18f46bc)
✅login: cbos / (a086a82, 138cce0, 3ecd05d, f9d51fa, 79c0d1e, d1594a1, 118bf1b, 1cf86e5, bacd3d3, 91ae29b, aa83bad, fcfd92b, 4a3ac25, b2dd7c5, eab1903, 18f46bc, 7d26666)
✅login: cbos / (a086a82, 138cce0, 3ecd05d, f9d51fa, 79c0d1e, d1594a1, 118bf1b, 1cf86e5, bacd3d3, 91ae29b, aa83bad, fcfd92b, 4a3ac25, b2dd7c5, eab1903, 18f46bc, 7d26666, f18f981)

The committers listed above are authorized under a signed CLA.

# Conflicts: # instrumentation-api/src/main/java/io/opentelemetry/instrumentation/api/internal/SemconvStability.java

…ll' and it results in span name with 'null' in the name.

…n where PropagatorBasedSpanLinksExtractor is used

… make the spans correctly connected and hierarchical instead of separeted.

… and new naming conventions

laurit · 2025-03-24T12:05:21Z

@cbos are you doing this for fun or do you intend to get this merged?

cbos · 2025-03-31T13:09:50Z

@laurit
Thanks for reaching out.
My intent is to get the merged, but I had difficulties to find out how the CLA should be handled. That took an awful lot of time to get that sorted out in the organisation I am currently active, but that is arranged now. I signed the CLA.

cbos · 2025-03-31T13:09:57Z

@laurit
Thanks for reaching out.
My intent is to get the merged, but I had difficulties to find out how the CLA should be handled. That took an awefull lot of time to get that sorted out in the organisation I am currently active, but that is arranged now. I signed the CLA.

laurit

Eventually it would be nice if we also had tests running with the stable semconvs. For db tests we use

tasks {
  val testStableSemconv by registering(Test::class) {
    jvmArgs("-Dotel.semconv-stability.opt-in=database")
  }

  check {
    dependsOn(testStableSemconv)
  }
}

I guess the tests can be added a bit later once the other parts of the PR are finished.

laurit · 2025-04-03T13:00:29Z

.../java/io/opentelemetry/instrumentation/api/incubator/semconv/messaging/MessageOperation.java

@@ -13,16 +13,33 @@
 * that may be used in a messaging system.
 */
 public enum MessageOperation {


javadoc of the class also links to https://github.com/open-telemetry/semantic-conventions/blob/main/docs/messaging/messaging-spans.md#operation-names that could be replaced with https://github.com/open-telemetry/semantic-conventions/blob/main/docs/messaging/messaging-spans.md#operation-types

laurit · 2025-04-03T13:01:55Z

.../java/io/opentelemetry/instrumentation/api/incubator/semconv/messaging/MessageOperation.java

   */
+  @Deprecated
  String operationName() {


Since this is a package private method it is not part of the public api and can be renamed without preserving the original method. If you wish to keep the original method then it would be better to make the old method class the new one.

laurit · 2025-04-03T13:07:57Z

...ntelemetry/instrumentation/api/incubator/semconv/messaging/MessagingAttributesExtractor.java

+    internalSet(attributes, MESSAGING_MESSAGE_BODY_SIZE, getter.getMessageBodySize(request));
+    internalSet(
+        attributes, MESSAGING_MESSAGE_ENVELOPE_SIZE, getter.getMessageEnvelopeSize(request));


why did you move these from start to end?

laurit · 2025-04-03T13:23:35Z

...opentelemetry/instrumentation/api/incubator/semconv/messaging/MessagingAttributesGetter.java

-  String getDestination(REQUEST request);
+  default Long getBatchMessageCount(REQUEST request, @Nullable RESPONSE response) {
+    return null;
+  }


Rearranging methods like that complicates the review. It is hard to tell what methods have been added and what was just moved.

laurit · 2025-04-03T13:28:28Z

...try/instrumentation/api/incubator/semconv/messaging/MessagingNetworkAttributesExtractor.java

+import io.opentelemetry.instrumentation.api.instrumenter.InstrumenterBuilder;
+import javax.annotation.Nullable;
+
+public final class MessagingNetworkAttributesExtractor<REQUEST, RESPONSE>


We already have ServerAttributesExtractor and NetworkAttributesExtractor are you sure we should add a new messaging specific extractor?

laurit · 2025-04-03T13:44:03Z

...main/java/io/opentelemetry/instrumentation/api/internal/PropagatorBasedBaggageExtractor.java

+ * This class is internal and is hence not for public use. Its APIs are unstable and can change at
+ * any time.
+ */
+public class PropagatorBasedBaggageExtractor<REQUEST> implements ContextCustomizer<REQUEST> {


Is this required by the specification? If I understand correctly what this is supposed to do it seems to have a limited usefulness. Perhaps it would be better to introduce it in a separate PR?

laurit · 2025-04-03T13:45:09Z

...y/src/main/java/io/opentelemetry/instrumentation/awssdk/v1_11/AwsSdkInstrumenterFactory.java

-    MessageOperation operation = MessageOperation.PUBLISH;
+    MessageOperation operation =
+        emitStableMessagingSemconv() ? MessageOperation.SEND : MessageOperation.PUBLISH;
+    ;


this line can be deleted

laurit · 2025-04-03T13:46:20Z

...library/src/main/java/io/opentelemetry/instrumentation/awssdk/v1_11/SqsAttributesGetter.java

+enum SqsAttributesGetter
+    implements
+        MessagingAttributesGetter<Request<?>, Response<?>>,
+        MessagingNetworkAttributesGetter<Request<?>, Response<?>> {


not much point in adding the network attributes interface when no methods are implemented

laurit · 2025-04-03T13:52:51Z

...y/src/main/java/io/opentelemetry/instrumentation/awssdk/v1_11/AwsSdkInstrumenterFactory.java

        SpanKindExtractor.alwaysConsumer(),
        toSqsRequestExtractors(attributesExtractors()),
        singletonList(messagingAttributeExtractor),
-        messagingReceiveInstrumentationEnabled);
+        messagingReceiveInstrumentationEnabled || SemconvStability.emitStableMessagingSemconv());


My advice would be to do the attribute changes in one PR and leave any potential changes to trace structure for followup PRs. Changes to trace structure will most likely require new tests and will make your PR much larger. Also as far as I can tell https://opentelemetry.io/docs/specs/semconv/messaging/messaging-spans/#message-creation-context-as-parent-of-process-span hints that having the process span as child of publish span is still allowed. Having these in one trace seems to be preferred by users.

laurit · 2025-04-03T13:55:23Z

...a/io/opentelemetry/javaagent/instrumentation/jms/v1_1/JmsMessageConsumerInstrumentation.java

-    public static Timer onEnter() {
+    public static Timer onEnter(@Advice.This MessageConsumer consumer) {
+
+      if (JmsConfig.EXPERIMENTAL_CONSUMER_PROCESS_TELEMETRY_ENABLED) {


If this change is not related to the semantic conventions consider submitting it as a separate PR.

cbos · 2025-04-04T10:23:34Z

@laurit
Thanks for the review, next week I will go through all details and update the PR

cbos added 4 commits January 28, 2025 16:31

Initial work for adoption of latest semantic conventions for messagin…

a086a82

…g (v1.29.0)

Update MessagingSpanNameExtractorTest

138cce0

Update MessagingSpanNameExtractor javadoc

3ecd05d

Adapt new MessagingAttributesExtractor and updated MessagingSpanNameE…

f9d51fa

…xtractor in instrumenters

cbos requested a review from a team as a code owner February 4, 2025 15:23

cbos and others added 14 commits February 6, 2025 13:04

Merge branch 'main' into messaging_semconv_update

79c0d1e

# Conflicts: # instrumentation-api/src/main/java/io/opentelemetry/instrumentation/api/internal/SemconvStability.java

Fix NullPointerException which caused spans not to be created

d1594a1

Add operation as get the operation name, otherwise the default is 'nu…

118bf1b

…ll' and it results in span name with 'null' in the name.

Do not use producer span as parent in case of stable conventions

1cf86e5

Make Process messages as link in case of stable messaging

bacd3d3

Add generic Baggage propagator which can be used in the same situatio…

91ae29b

…n where PropagatorBasedSpanLinksExtractor is used

Merge branch 'open-telemetry:main' into messaging_semconv_update

aa83bad

Add optional (experimental) process span on consuming a message. This…

fcfd92b

… make the spans correctly connected and hierarchical instead of separeted.

Fix failing MessagingSpanNameExtractorTest

4a3ac25

Fix failing MessagingSpanNameExtractorTest

b2dd7c5

Merge branch 'open-telemetry:main' into messaging_semconv_update

eab1903

Fix failing AwsSdk instrumented tests

18f46bc

Fix failing AwsSdk instrumented tests

7d26666

Fix failing MessagingSpanNameExtractorTest when running with both old…

f18f981

… and new naming conventions

laurit mentioned this pull request Mar 24, 2025

Update Pulsar semantic #13578

Draft

laurit reviewed Apr 3, 2025

View reviewed changes

trask mentioned this pull request Apr 10, 2025

feat: Implement Pulsar 4.0 monitoring support with messaging.client.sent.messages #13599

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Implementation for the latest Messaging Semantic conventions. #13192

Implementation for the latest Messaging Semantic conventions. #13192

cbos commented Feb 4, 2025

linux-foundation-easycla bot commented Feb 4, 2025 •

edited

Loading

laurit commented Mar 24, 2025

cbos commented Mar 31, 2025

cbos commented Mar 31, 2025

laurit left a comment

laurit Apr 3, 2025

laurit Apr 3, 2025

laurit Apr 3, 2025

laurit Apr 3, 2025

laurit Apr 3, 2025

laurit Apr 3, 2025

laurit Apr 3, 2025

laurit Apr 3, 2025

laurit Apr 3, 2025

laurit Apr 3, 2025

cbos commented Apr 4, 2025

Implementation for the latest Messaging Semantic conventions. #13192

Are you sure you want to change the base?

Implementation for the latest Messaging Semantic conventions. #13192

Conversation

cbos commented Feb 4, 2025

linux-foundation-easycla bot commented Feb 4, 2025 • edited Loading

laurit commented Mar 24, 2025

cbos commented Mar 31, 2025

cbos commented Mar 31, 2025

laurit left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

cbos commented Apr 4, 2025

linux-foundation-easycla bot commented Feb 4, 2025 •

edited

Loading