semconv stable code #13860

SylvainJuge · 2025-05-15T18:54:41Z

Semconv 1.33.0 brings stable definitions for code.* namespace, which includes the following changes:

code.namespace is removed
code.function is renamed to code.function.name and needs to include fully-qualified name of the class in addition to the function
code.lineno has been renamed code.line.number
code.column has been renamed code.column.number
code.filepath has been renamed code.file.path

~~This PR might have to be updated if merged after the update to semconv 1.33.0 is merged first.~~ EDIT: updated after 1.34.0 semconv update

EDIT: the existing code.* semantic conventions are still produced, the stable ones are opt-in by setting the otel.semconv-stability.opt-in config option to include code (only stable) or code/dup (both stable + old).

laurit · 2025-06-13T13:23:57Z

I have started working on making the switch to stable code semconv opt-in, but it requires a bit of tedious work that I haven't finished and is not ready to be pushed yet. I plan to add something similar to https://github.com/open-telemetry/opentelemetry-java-instrumentation/blob/main/testing-common/src/main/java/io/opentelemetry/instrumentation/testing/junit/db/SemconvStabilityUtil.java#L39 but for the code semantic conventions.

You really don't need to do this, see #13860 (comment). You can convert tests to use the new assertion and enable the opt-in flag for all tests and run only selected tests with both new and old assertions to reduce the amount of work needed.

SylvainJuge · 2025-06-13T14:53:58Z

It's not needed to be able to test everything but I would just sleep better if it is :-).

For example I found that the logging instrumentation would also benefit from being exhaustively tested like the annotations, if I understand it correctly just adding this to the gradle module file should allow to properly test it.

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

  val testBothSemconv by registering(Test::class) {
    jvmArgs("-Dotel.semconv-stability.opt-in=code/dup")
  }

  check {
    dependsOn(testStableSemconv)
    dependsOn(testBothSemconv)
  }

otelbot-java-instrumentation · 2025-06-16T12:43:06Z

🔧 The result from spotlessApply was committed to the PR branch.

…nstrumentation into semconv-stable-code

otelbot-java-instrumentation · 2025-06-17T11:07:46Z

🔧 The result from spotlessApply was committed to the PR branch.

SylvainJuge · 2025-06-17T13:07:19Z

I have updated this PR to only emit the deprecated semantic convention attributes by default.
Most instrumentation remain tested with unstable attributes, but some (like log appenders) are tested with both.

Using otel.semconv-stability.opt-in configuration allows to opt-in for the new stable semantic conventions with code or code/dup like we have for the database attributes, so it means we could merge this PR without altering the current behavior.

Then, we could then later remove the support for the unstable code attributes when preparing for the 3.0 release.

Is there already an issue that contains a list of breaking changes that we are planning to include in this major release to track progress on their respective implementations ? If no, please let me know and I can create one so we don't forget about this (and also the database semconv).

trask · 2025-06-18T01:24:00Z

Is there already an issue that contains a list of breaking changes that we are planning to include in this major release to track progress on their respective implementations ?

https://github.com/open-telemetry/opentelemetry-java-instrumentation/milestone/41

SylvainJuge · 2025-06-18T08:25:52Z

Is there already an issue that contains a list of breaking changes that we are planning to include in this major release to track progress on their respective implementations ?

https://github.com/open-telemetry/opentelemetry-java-instrumentation/milestone/41

Thanks, I've opened #14059.

@trask your review status is still "requested change", do you think there are still things to change before we could merge this ?

stale

…nstrumentation into semconv-stable-code

trask

thanks!

trask · 2025-06-19T20:39:05Z

instrumentation/grails-3.0/javaagent/src/test/java/test/GrailsTest.java

+
+  // using deprecated semconv


Suggested change

// using deprecated semconv

trask · 2025-06-19T20:45:50Z

...esting/src/main/java/io/opentelemetry/instrumentation/jaxrs/AbstractJaxRsHttpServerTest.java

@@ -191,6 +189,13 @@ void shouldHandleAsyncResponse(AsyncResponseTestKind testKind) throws Exception
    assertThat(response.status().code()).isEqualTo(testKind.statusCode);
    testKind.assertBody(response.contentUtf8());

+    List<AttributeAssertion> attributeAssertions =
+        codeFunctionInfixAssertions("test.JaxRsTestResource", "asyncOp");


I think?

Suggested change

codeFunctionInfixAssertions("test.JaxRsTestResource", "asyncOp");

codeFunctionSuffixAssertions("test.JaxRsTestResource", "asyncOp");

trask · 2025-06-19T20:46:11Z

...esting/src/main/java/io/opentelemetry/instrumentation/jaxrs/AbstractJaxRsHttpServerTest.java

-                                  CODE_NAMESPACE,
-                                  "io.opentelemetry.instrumentation.jaxrs.v2_0.test.JaxRsTestResource"),
-                              equalTo(CODE_FUNCTION, "jaxRs21Async"));
+                              codeFunctionInfixAssertions(".JaxRsTestResource", "jaxRs21Async"));


Suggested change

codeFunctionInfixAssertions(".JaxRsTestResource", "jaxRs21Async"));

codeFunctionSuffixAssertions(".JaxRsTestResource", "jaxRs21Async"));

trask · 2025-06-19T20:46:29Z

...esting/src/main/java/io/opentelemetry/instrumentation/jaxrs/AbstractJaxRsHttpServerTest.java

@@ -319,7 +315,6 @@ protected SpanDataAssert assertHandlerSpan(
    return span.hasName("JaxRsTestResource." + methodName)
        .hasKind(SpanKind.INTERNAL)
        .hasAttributesSatisfyingExactly(
-            satisfies(CODE_NAMESPACE, name -> name.endsWith("JaxRsTestResource")),
-            equalTo(CODE_FUNCTION, methodName));
+            codeFunctionInfixAssertions(".JaxRsTestResource", methodName));


Suggested change

codeFunctionInfixAssertions(".JaxRsTestResource", methodName));

codeFunctionSuffixAssertions(".JaxRsTestResource", methodName));

trask · 2025-06-19T20:55:22Z

instrumentation/logback/logback-appender-1.0/library/build.gradle.kts

-    dependsOn(testing.suites)
+    dependsOn(testStableSemconv)
+    dependsOn(testBothSemconv)


I suspect we still need dependsOn(testing.suites)

trask · 2025-06-19T21:04:07Z

instrumentation/rxjava/rxjava-2.0/javaagent/src/test/java/BaseRxJava2WithSpanTest.java

@@ -57,8 +61,7 @@ public void captureSpanForCompletedCompletable() {
                            .hasKind(SpanKind.INTERNAL)
                            .hasNoParent()
                            .hasAttributesSatisfyingExactly(
-                                satisfies(CODE_NAMESPACE, val -> val.endsWith(".TracedWithSpan")),
-                                equalTo(CODE_FUNCTION, "completable"))));
+                                codeFunctionSuffixAssertions("TracedWithSpan", "completable"))));


(and other places below, to stay consistent with other places)

Suggested change

codeFunctionSuffixAssertions("TracedWithSpan", "completable"))));

codeFunctionSuffixAssertions(".TracedWithSpan", "completable"))));

trask · 2025-06-19T21:08:02Z

...in/java/io/opentelemetry/instrumentation/spring/webmvc/boot/AbstractSpringBootBasedTest.java

-                        v ->
-                            assertThat(v)
-                                .isEqualTo(
-                                    "org.springframework.security.web.firewall.FirewalledResponse"),
-                        v ->
-                            assertThat(v)
-                                .isEqualTo("jakarta.servlet.http.HttpServletResponseWrapper"))),


interesting, just confirming these seem no longer needed?

trask · 2025-06-19T21:08:24Z

...in/java/io/opentelemetry/instrumentation/spring/webmvc/filter/AbstractServletFilterTest.java

-                    satisfies(CODE_NAMESPACE, v -> v.endsWith(".BasicErrorController")),
-                    equalTo(CODE_FUNCTION, "error")));
+                    SemconvCodeStabilityUtil.codeFunctionSuffixAssertions(
+                        "BasicErrorController", "error")));


Suggested change

"BasicErrorController", "error")));

".BasicErrorController", "error")));

SylvainJuge added 9 commits May 15, 2025 19:57

migrate code extractor

a89364a

jaxrs-1.0

9950e96

jaxrs-2.0

754c87e

jaxrs-3.0

842deee

jaxrs-common

743d865

methods

64ea006

otel annotations

4336748

otel annotations

688962f

reactor

56dcb38

SylvainJuge self-assigned this May 15, 2025

SylvainJuge added 4 commits May 15, 2025 23:14

rx-java-2.0

dcb8230

rxjava3

8543269

servlet

79f9a4a

spring-boot-autoconfigure

dfca3bc

github-actions bot added the test native This label can be applied to PRs to trigger them to run native tests label May 15, 2025

SylvainJuge added 15 commits May 16, 2025 00:23

spotless

24c2198

fix methods instrumentation

177d3c7

springboot-autoconfigure - chapter 2

c7c110b

spring-scheduling

c423a22

spring-webflux

a708390

fix test for opentelemetry api

ee6e51a

spring-boot-mvc part 1

d6dce61

spring-webmvc part 2

1a944bd

spring-web-mvc part 3

f0b4d29

struts

9dbc742

fix code extractor

350c20a

wip

de19f01

fix typo

eda7917

wip

c204c3f

wip

10dfd18

SylvainJuge added 2 commits June 13, 2025 13:55

wip

0846080

wip

d629917

SylvainJuge added 2 commits June 13, 2025 15:28

wip

3d33231

fix logback

9cd067a

SylvainJuge and others added 5 commits June 16, 2025 13:42

wip

62de4d1

wip

bf47648

log4j test stable and incubating semconv

8411054

fix jaxrs

aeae7e8

./gradlew spotlessApply

2067cbc

SylvainJuge and others added 9 commits June 16, 2025 15:10

fix test

f05ac6f

ignore checkstyle issue

7e8beac

fix stuff

d36b345

Merge branch 'main' of github.com:open-telemetry/opentelemetry-java-i…

e955cc3

…nstrumentation into semconv-stable-code

remove unused imports in scala

35ed6c6

add semconv test for @WithSpan test

72a3db9

fix scala compile error

4db44bd

Merge branch 'main' of github.com:open-telemetry/opentelemetry-java-i…

8cf6f0d

…nstrumentation into semconv-stable-code

./gradlew spotlessApply

572b362

trask requested a review from JonasKunz June 18, 2025 01:24

SylvainJuge mentioned this pull request Jun 18, 2025

Switch to stable code semconv attributes for 3.0 #14059

Open

Merge branch 'main' of github.com:open-telemetry/opentelemetry-java-i…

8e2788d

…nstrumentation into semconv-stable-code

trask approved these changes Jun 19, 2025

View reviewed changes

	codeFunctionInfixAssertions("test.JaxRsTestResource", "asyncOp");
	codeFunctionSuffixAssertions("test.JaxRsTestResource", "asyncOp");

	codeFunctionInfixAssertions(".JaxRsTestResource", "jaxRs21Async"));
	codeFunctionSuffixAssertions(".JaxRsTestResource", "jaxRs21Async"));

	codeFunctionSuffixAssertions("TracedWithSpan", "completable"))));
	codeFunctionSuffixAssertions(".TracedWithSpan", "completable"))));

	"BasicErrorController", "error")));
	".BasicErrorController", "error")));

semconv stable code #13860

Are you sure you want to change the base?

semconv stable code #13860

Uh oh!

Conversation

SylvainJuge commented May 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

laurit commented Jun 13, 2025

Uh oh!

SylvainJuge commented Jun 13, 2025

Uh oh!

otelbot-java-instrumentation bot commented Jun 16, 2025

Uh oh!

otelbot-java-instrumentation bot commented Jun 17, 2025

Uh oh!

SylvainJuge commented Jun 17, 2025

Uh oh!

trask commented Jun 18, 2025

Uh oh!

SylvainJuge commented Jun 18, 2025

Uh oh!

trask left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

SylvainJuge commented May 15, 2025 •

edited

Loading