Load OTel SDK config from environment variables and system properties.… #1434

cyrille-leclerc · 2024-08-26T13:50:01Z

Description:

Load OTel SDK config from environment variables and system properties.

Existing Issue(s):

otel.resource.attributes and OTEL_RESOURCE_ATTRIBUTES doesn't work #1416

Testing:

See added unit tests

Documentation:

< Describe the documentation added.
Please be sure to modify relevant existing documentation if needed. >

Outstanding items:

< Anything that these changes are intentionally missing
that will be needed or can be helpful in the future. >

…ix open-telemetry#1416

SylvainJuge · 2024-08-26T15:56:25Z

maven-extension/src/main/java/io/opentelemetry/maven/OpenTelemetrySdkService.java

    AutoConfiguredOpenTelemetrySdk autoConfiguredOpenTelemetrySdk =
        AutoConfiguredOpenTelemetrySdk.builder()
            .setServiceClassLoader(getClass().getClassLoader())
-            .addPropertiesSupplier(() -> properties)
+            .addPropertiesCustomizer(configProperties -> {
+              // Change default of "otel.[traces,metrics,logs].exporter" from "otlp" to "none"


[minor] Could you elaborate a bit in a comment on why we need to override the default here ? For example, if I understand correctly when there is no endpoint configured then we assume the extension should silently skip exporting signals.

Thanks for the review Sylvain, please see updated comment

…Fix open-telemetry#1416

trask · 2024-09-16T15:23:34Z

@cyrille-leclerc just a heads up looks like there's a failing test

cyrille-leclerc · 2024-09-17T08:48:28Z

Thanks @trask , unit test fixed.

trask · 2024-09-27T01:00:51Z

cc @kenfinnigan in case you have a chance to review

cyrille-leclerc · 2024-10-08T14:49:36Z

@SylvainJuge could you by any chance review this PR?

maven-extension/src/main/java/io/opentelemetry/maven/OpenTelemetrySdkService.java

maven-extension/src/test/java/io/opentelemetry/maven/OpenTelemetrySdkServiceTest.java

cyrille-leclerc · 2024-10-14T14:55:34Z

Thanks @SylvainJuge , I'll improve ASAP

maven-extension/src/main/java/io/opentelemetry/maven/OpenTelemetrySdkService.java

SylvainJuge · 2024-11-07T09:59:00Z

maven-extension/src/test/java/io/opentelemetry/maven/OpenTelemetrySdkServiceTest.java

    System.setProperty("otel.service.name", "my-maven");
-    try {
-      testConfiguration("my-maven");
+    System.setProperty("otel.resource.attributes", "key1=val1,key2=val2");


I think it would be a bit better to not rely on global state (here in system properties) as we have to take care of the cleanup here.

What I think could be slightly better is to add an argument to the OpenTelemetrySdkService constructor to control which system properties are present or not if we can. While this slightly alters the design for test purpose it could be worth it here as it allows to get rid of any early cleanup or finally block. Also with such a change there can't be any side effect if system properties are set on the JVM that execute the tests which usually require us to ensure properties are not set in some cases.

The AutoConfiguredOpenTelemetrySdkBuilder.setConfigPropertiesCustomizer allows to override the config properties, but it's package-private so using AutoConfigureUtil.setConfigPropertiesCustomizer is needed. While it's an internal API doing this only for tests should be fine.

Could we postpone this improvement? I lack time to clean this up unfortunately.

Yes, we can definitely postpone that to later improvement. Just to keep it safe once this test class has executed adding an @AfterAll method to ensure there are no side effects on things that execute after.

System.clearProperty("otel.exporter.otlp.endpoint"); System.clearProperty("otel.service.name"); System.clearProperty("otel.resource.attributes");

Great suggestion. Please review below.

SylvainJuge · 2024-12-06T15:09:16Z

maven-extension/src/test/java/io/opentelemetry/maven/OpenTelemetrySdkServiceTest.java

    System.setProperty("otel.service.name", "my-maven");
-    try {
-      testConfiguration("my-maven");
+    System.setProperty("otel.resource.attributes", "key1=val1,key2=val2");


Yes, we can definitely postpone that to later improvement. Just to keep it safe once this test class has executed adding an @AfterAll method to ensure there are no side effects on things that execute after.

System.clearProperty("otel.exporter.otlp.endpoint"); System.clearProperty("otel.service.name"); System.clearProperty("otel.resource.attributes");

SylvainJuge · 2024-12-06T15:11:12Z

maven-extension/src/main/java/io/opentelemetry/maven/AutoConfigureUtil2.java

+   * <p>Inspired by {@link
+   * io.opentelemetry.sdk.autoconfigure.internal.AutoConfigureUtil#getConfig(AutoConfiguredOpenTelemetrySdk)}
+   */
+  public static Resource getResource(


[minor] can you elaborate a bit why do we call this method and what it allows to do here ? In addition, is there a follow-up action to make this method publicly accessible in the SDK if there are other similar use-cases ?

Great catch. Comment added in he code of the OpenTelemetrySdkService. The use cases are:

Debugging & troubleshooting helping find traces if they are missing reporting the service.name and service.namespace

Testing: before this PR, we misconfigured the AutoConfigureOtlSdk and overwriting resource attributes through system properties or env vars failed.

In addition, is there a follow-up action to make this method publicly accessible in the SDK if there are other similar use-cases ?
Valid point, I didn't bring thes us cases to the Java SIG as I did in the past for other SDK config topics. We have the same debugging/troubleshooting use case in the Jenkins OTel plugin.

cyrille-leclerc · 2024-12-06T17:17:20Z

maven-extension/src/main/java/io/opentelemetry/maven/AutoConfigureUtil2.java

+   * <p>Inspired by {@link
+   * io.opentelemetry.sdk.autoconfigure.internal.AutoConfigureUtil#getConfig(AutoConfiguredOpenTelemetrySdk)}
+   */
+  public static Resource getResource(


Great catch. Comment added in he code of the OpenTelemetrySdkService. The use cases are:

Debugging & troubleshooting helping find traces if they are missing reporting the service.name and service.namespace

Testing: before this PR, we misconfigured the AutoConfigureOtlSdk and overwriting resource attributes through system properties or env vars failed.

In addition, is there a follow-up action to make this method publicly accessible in the SDK if there are other similar use-cases ?
Valid point, I didn't bring thes us cases to the Java SIG as I did in the past for other SDK config topics. We have the same debugging/troubleshooting use case in the Jenkins OTel plugin.

cyrille-leclerc · 2024-12-06T17:17:45Z

maven-extension/src/test/java/io/opentelemetry/maven/OpenTelemetrySdkServiceTest.java

-    //      GlobalEventEmitterProvider.resetForTest();
-    //    }
+  @AfterAll
+  static void afterAll() {


@SylvainJuge please review

cyrille-leclerc · 2024-12-06T17:18:08Z

maven-extension/src/test/java/io/opentelemetry/maven/OpenTelemetrySdkServiceTest.java

    System.setProperty("otel.service.name", "my-maven");
-    try {
-      testConfiguration("my-maven");
+    System.setProperty("otel.resource.attributes", "key1=val1,key2=val2");


Great suggestion. Please review below.

SylvainJuge

LGTM, just make sure to open an issue/PR to make the AutoConfiguredOpenTelemetrySdk#getResource publicly accessible, linking to this PR would help provide context why it's needed.

cyrille-leclerc · 2024-12-09T19:01:51Z

@SylvainJuge thanks, FYI I created:

Make AutoConfiguredOpenTelemetrySdk's resource and config readable opentelemetry-java#6935

Load OTelSDK config from environment variables and system properties. F…

ee61c7b

…ix open-telemetry#1416

cyrille-leclerc requested a review from a team August 26, 2024 13:50

github-actions bot assigned cyrille-leclerc and kenfinnigan Aug 26, 2024

github-actions bot requested a review from kenfinnigan August 26, 2024 13:50

cyrille-leclerc mentioned this pull request Aug 26, 2024

otel.resource.attributes and OTEL_RESOURCE_ATTRIBUTES doesn't work #1416

Open

cyrille-leclerc added the component: maven-extension label Aug 26, 2024

SylvainJuge reviewed Aug 26, 2024

View reviewed changes

cyrille-leclerc added 2 commits August 27, 2024 09:55

Load OTel SDK config from environment variables and system properties. …

ecb469b

…Fix open-telemetry#1416

Fix code formatting

a89bd63

Fix unit test

cc3490c

cyrille-leclerc requested a review from SylvainJuge October 8, 2024 14:49

trask added this to the v1.40.0 milestone Oct 8, 2024

SylvainJuge reviewed Oct 9, 2024

View reviewed changes

WIP

139c096

cyrille-leclerc requested a review from a team as a code owner October 18, 2024 10:48

trask removed this from the v1.40.0 milestone Oct 18, 2024

cyrille-leclerc added 2 commits October 28, 2024 11:07

WIP

6846a02

WIP

e3316a5

cyrille-leclerc commented Oct 28, 2024

View reviewed changes

maven-extension/src/main/java/io/opentelemetry/maven/OpenTelemetrySdkService.java Show resolved Hide resolved

cyrille-leclerc commented Oct 28, 2024

View reviewed changes

maven-extension/src/main/java/io/opentelemetry/maven/OpenTelemetrySdkService.java Outdated Show resolved Hide resolved

SylvainJuge reviewed Nov 7, 2024

View reviewed changes

cyrille-leclerc added 3 commits November 8, 2024 23:09

WIP

45f8efe

WIP

4f75414

Merge branch 'main' into source-otel-sdk-confi-from-system-out-and-env

70eef3a

Better tests and javadocs

f5c4825

cyrille-leclerc requested a review from SylvainJuge November 29, 2024 10:20

SylvainJuge reviewed Dec 6, 2024

View reviewed changes

Better tests and docs

e5cb582

cyrille-leclerc commented Dec 6, 2024

View reviewed changes

SylvainJuge approved these changes Dec 9, 2024

View reviewed changes

trask added this to the v1.42.0 milestone Dec 9, 2024

cyrille-leclerc mentioned this pull request Dec 9, 2024

Make AutoConfiguredOpenTelemetrySdk's resource and config readable open-telemetry/opentelemetry-java#6935

Open

trask approved these changes Dec 9, 2024

View reviewed changes

trask merged commit bfd7390 into open-telemetry:main Dec 9, 2024
14 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Load OTel SDK config from environment variables and system properties.… #1434

Load OTel SDK config from environment variables and system properties.… #1434

cyrille-leclerc commented Aug 26, 2024

SylvainJuge Aug 26, 2024

cyrille-leclerc Aug 27, 2024

trask commented Sep 16, 2024

cyrille-leclerc commented Sep 17, 2024

trask commented Sep 27, 2024

cyrille-leclerc commented Oct 8, 2024

cyrille-leclerc commented Oct 14, 2024

SylvainJuge Nov 7, 2024

cyrille-leclerc Nov 29, 2024

SylvainJuge Dec 6, 2024

cyrille-leclerc Dec 6, 2024

SylvainJuge Dec 6, 2024

SylvainJuge Dec 6, 2024

cyrille-leclerc Dec 6, 2024

cyrille-leclerc Dec 6, 2024

cyrille-leclerc Dec 6, 2024

cyrille-leclerc Dec 6, 2024

SylvainJuge left a comment

cyrille-leclerc commented Dec 9, 2024

Load OTel SDK config from environment variables and system properties.… #1434

Load OTel SDK config from environment variables and system properties.… #1434

Conversation

cyrille-leclerc commented Aug 26, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

trask commented Sep 16, 2024

cyrille-leclerc commented Sep 17, 2024

trask commented Sep 27, 2024

cyrille-leclerc commented Oct 8, 2024

cyrille-leclerc commented Oct 14, 2024

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

SylvainJuge left a comment

Choose a reason for hiding this comment

cyrille-leclerc commented Dec 9, 2024