Merge branch 'main' into assertions-refactoring

Author: robsunday

.github/renovate.json5

@@ -6,15 +6,14 @@
   "packageRules": [
     {
       "matchPackageNames": [
-        "io.opentelemetry.instrumentation:opentelemetry-instrumentation-bom-alpha",
-        "io.opentelemetry.semconv:opentelemetry-semconv",
-        "io.opentelemetry.semconv:opentelemetry-semconv-incubating",
-        "io.opentelemetry.proto:opentelemetry-proto"
+        "io.opentelemetry:**",
+        "io.opentelemetry.instrumentation:**",
+        "io.opentelemetry.semconv:**",
+        "io.opentelemetry.proto:**"
       ],
       // Renovate's default behavior is only to update from unstable -> unstable if it's for the
       // major.minor.patch, under the assumption that you would want to update to the stable version
       // of that release instead of the unstable version for a future release
-      // (TODO remove once the artifacts above release stable versions)
       "ignoreUnstable": false
     },
     {
@@ -25,10 +24,6 @@
       "matchPackagePrefixes": ["io.micrometer:"],
       "groupName": "micrometer packages"
     },
-    {
-      "matchPackagePrefixes": ["com.gradle.enterprise"],
-      "groupName": "gradle enterprise packages"
-    },
     {
       // prevent 3.0.1u2 -> 3.0.1
       "matchPackageNames": ["com.google.code.findbugs:annotations"],

.github/workflows/build.yml

@@ -30,8 +30,6 @@ jobs:
           cache-read-only: ${{ github.event_name == 'pull_request' }}
       - name: Gradle build and test
         run: ./gradlew build -x test
-        env:
-          GRADLE_ENTERPRISE_ACCESS_KEY: ${{ secrets.GRADLE_ENTERPRISE_ACCESS_KEY }}
 
   test:
     name: test (${{ matrix.test-java-version }})
@@ -71,8 +69,6 @@ jobs:
           -PtestJavaVersion=${{ matrix.test-java-version }}
           -Porg.gradle.java.installations.paths=${{ steps.setup-test-java.outputs.path }}
           -Porg.gradle.java.installations.auto-download=false
-        env:
-          GRADLE_ENTERPRISE_ACCESS_KEY: ${{ secrets.GRADLE_ENTERPRISE_ACCESS_KEY }}
 
   integration-test:
     runs-on: ubuntu-latest
@@ -89,10 +85,9 @@ jobs:
         uses: gradle/actions/setup-gradle@v4
         with:
           cache-read-only: ${{ github.event_name == 'pull_request' }}
+
       - name: Integration test
         run: ./gradlew integrationTest
-        env:
-          GRADLE_ENTERPRISE_ACCESS_KEY: ${{ secrets.GRADLE_ENTERPRISE_ACCESS_KEY }}
 
       - name: Save integration test results
         uses: actions/upload-artifact@v4

RELEASING.md

@@ -12,9 +12,9 @@ as the last step, which publishes a snapshot build to
 
 ## Release cadence
 
-This repository roughly targets monthly minor releases from the `main` branch on the Friday after
+This repository roughly targets monthly minor releases from the `main` branch on the Tuesday after
 the second Monday of the month (roughly a couple of days after the monthly minor release of
-[opentelemetry-java-instrumentation](https://github.com/open-telemetry/opentelemetry-java-instrumentation)).
+[opentelemetry-java](https://github.com/open-telemetry/opentelemetry-java)).
 
 ## Preparing a new major or minor release
 

buildSrc/build.gradle.kts

@@ -15,7 +15,6 @@ dependencies {
   implementation("com.diffplug.spotless:spotless-plugin-gradle:6.25.0")
   implementation("net.ltgt.gradle:gradle-errorprone-plugin:4.1.0")
   implementation("net.ltgt.gradle:gradle-nullaway-plugin:2.1.0")
-  implementation("com.gradle.enterprise:com.gradle.enterprise.gradle.plugin:3.18.2")
 }
 
 spotless {

buildSrc/src/main/kotlin/otel.java-conventions.gradle.kts

@@ -71,13 +71,6 @@ tasks {
       showCauses = true
       showStackTraces = true
     }
-
-    develocity.testRetry {
-      // You can see tests that were retried by this mechanism in the collected test reports and build scans.
-      if (System.getenv().containsKey("CI") || rootProject.hasProperty("retryTests")) {
-        maxRetries.set(5)
-      }
-    }
   }
 
   withType<Javadoc>().configureEach {

dependencyManagement/build.gradle.kts

@@ -7,15 +7,13 @@ data class DependencySet(val group: String, val version: String, val modules: Li
 val dependencyVersions = hashMapOf<String, String>()
 rootProject.extra["versions"] = dependencyVersions
 
-val otelInstrumentationVersion = "2.10.0-alpha"
-
 val DEPENDENCY_BOMS = listOf(
   "com.fasterxml.jackson:jackson-bom:2.18.2",
   "com.google.guava:guava-bom:33.3.1-jre",
   "com.linecorp.armeria:armeria-bom:1.31.2",
   "org.junit:junit-bom:5.11.3",
   "io.grpc:grpc-bom:1.68.2",
-  "io.opentelemetry.instrumentation:opentelemetry-instrumentation-bom-alpha:${otelInstrumentationVersion}",
+  "io.opentelemetry:opentelemetry-bom-alpha:1.44.1-alpha",
   "org.testcontainers:testcontainers-bom:1.20.4"
 )
 
@@ -78,12 +76,6 @@ javaPlatform {
 
 dependencies {
   for (bom in DEPENDENCY_BOMS) {
-    // this is needed until io.opentelemetry.instrumentation:opentelemetry-instrumentation-bom-alpha
-    // is updated to contain the latest version of opentelemetry-semconv
-    if (bom.equals("io.opentelemetry.instrumentation:opentelemetry-instrumentation-bom-alpha:${otelInstrumentationVersion}")) {
-      api(platform(bom))
-      continue
-    }
     api(enforcedPlatform(bom))
     val split = bom.split(':')
     dependencyVersions[split[0]] = split[2]

jmx-scraper/build.gradle.kts

@@ -22,7 +22,7 @@ dependencies {
   runtimeOnly("io.opentelemetry:opentelemetry-exporter-otlp")
   runtimeOnly("io.opentelemetry:opentelemetry-exporter-logging")
 
-  implementation("io.opentelemetry.instrumentation:opentelemetry-jmx-metrics")
+  implementation("io.opentelemetry.instrumentation:opentelemetry-jmx-metrics:2.10.0-alpha")
 
   testImplementation("org.junit-pioneer:junit-pioneer")
   testImplementation("io.opentelemetry:opentelemetry-sdk-testing")

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

@@ -0,0 +1,35 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package io.opentelemetry.maven;
+
+import io.opentelemetry.sdk.autoconfigure.AutoConfiguredOpenTelemetrySdk;
+import io.opentelemetry.sdk.resources.Resource;
+import java.lang.reflect.InvocationTargetException;
+import java.lang.reflect.Method;
+
+/** Utility class to use the {@link AutoConfiguredOpenTelemetrySdk}. */
+public class AutoConfigureUtil2 {
+
+  private AutoConfigureUtil2() {}
+
+  /**
+   * Returns the {@link Resource} that was autoconfigured.
+   *
+   * <p>Inspired by {@link
+   * io.opentelemetry.sdk.autoconfigure.internal.AutoConfigureUtil#getConfig(AutoConfiguredOpenTelemetrySdk)}
+   */
+  public static Resource getResource(
+      AutoConfiguredOpenTelemetrySdk autoConfiguredOpenTelemetrySdk) {
+    try {
+      Method method = AutoConfiguredOpenTelemetrySdk.class.getDeclaredMethod("getResource");
+      method.setAccessible(true);
+      return (Resource) method.invoke(autoConfiguredOpenTelemetrySdk);
+    } catch (NoSuchMethodException | InvocationTargetException | IllegalAccessException e) {
+      throw new IllegalStateException(
+          "Error calling getResource on AutoConfiguredOpenTelemetrySdk", e);
+    }
+  }
+}

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

@@ -5,19 +5,24 @@
 
 package io.opentelemetry.maven;
 
+import com.google.common.annotations.VisibleForTesting;
 import io.opentelemetry.api.OpenTelemetry;
 import io.opentelemetry.api.trace.Tracer;
 import io.opentelemetry.context.propagation.ContextPropagators;
 import io.opentelemetry.maven.semconv.MavenOtelSemanticAttributes;
 import io.opentelemetry.sdk.OpenTelemetrySdk;
 import io.opentelemetry.sdk.autoconfigure.AutoConfiguredOpenTelemetrySdk;
+import io.opentelemetry.sdk.autoconfigure.internal.AutoConfigureUtil;
+import io.opentelemetry.sdk.autoconfigure.spi.ConfigProperties;
+import io.opentelemetry.sdk.autoconfigure.spi.internal.DefaultConfigProperties;
 import io.opentelemetry.sdk.common.CompletableResultCode;
+import io.opentelemetry.sdk.resources.Resource;
 import java.io.Closeable;
+import java.util.Collections;
 import java.util.HashMap;
-import java.util.Locale;
 import java.util.Map;
+import java.util.Optional;
 import java.util.concurrent.TimeUnit;
-import javax.annotation.Nullable;
 import javax.annotation.PreDestroy;
 import javax.inject.Named;
 import javax.inject.Singleton;
@@ -36,6 +41,10 @@ public final class OpenTelemetrySdkService implements Closeable {
 
   private final OpenTelemetrySdk openTelemetrySdk;
 
+  @VisibleForTesting final Resource resource;
+
+  private final ConfigProperties configProperties;
+
   private final Tracer tracer;
 
   private final boolean mojosInstrumentationEnabled;
@@ -47,32 +56,68 @@ public OpenTelemetrySdkService() {
         "OpenTelemetry: Initialize OpenTelemetrySdkService v{}...",
         MavenOtelSemanticAttributes.TELEMETRY_DISTRO_VERSION_VALUE);
 
-    // Change default of "otel.[traces,metrics,logs].exporter" from "otlp" to "none"
-    // The impacts are
-    // * If no otel exporter settings are passed, then the Maven extension will not export
-    //   rather than exporting on OTLP GRPC to http://localhost:4317
-    // * If OTEL_EXPORTER_OTLP_ENDPOINT is defined but OTEL_[TRACES,METRICS,LOGS]_EXPORTER,
-    //   is not, then don't export
-    Map<String, String> properties = new HashMap<>();
-    properties.put("otel.traces.exporter", "none");
-    properties.put("otel.metrics.exporter", "none");
-    properties.put("otel.logs.exporter", "none");
-
     AutoConfiguredOpenTelemetrySdk autoConfiguredOpenTelemetrySdk =
         AutoConfiguredOpenTelemetrySdk.builder()
             .setServiceClassLoader(getClass().getClassLoader())
-            .addPropertiesSupplier(() -> properties)
+            .addPropertiesCustomizer(
+                OpenTelemetrySdkService::requireExplicitConfigOfTheOtlpExporter)
             .disableShutdownHook()
             .build();
 
     this.openTelemetrySdk = autoConfiguredOpenTelemetrySdk.getOpenTelemetrySdk();
+    this.configProperties =
+        Optional.ofNullable(AutoConfigureUtil.getConfig(autoConfiguredOpenTelemetrySdk))
+            .orElseGet(() -> DefaultConfigProperties.createFromMap(Collections.emptyMap()));
+
+    this.resource = AutoConfigureUtil2.getResource(autoConfiguredOpenTelemetrySdk);
+    // Display resource attributes in debug logs for troubleshooting when traces are not found in
+    // the observability backend, helping understand `service.name`, `service.namespace`, etc.
+    logger.debug("OpenTelemetry: OpenTelemetrySdkService initialized, resource:{}", resource);
 
-    Boolean mojoSpansEnabled = getBooleanConfig("otel.instrumentation.maven.mojo.enabled");
-    this.mojosInstrumentationEnabled = mojoSpansEnabled == null || mojoSpansEnabled;
+    this.mojosInstrumentationEnabled =
+        configProperties.getBoolean("otel.instrumentation.maven.mojo.enabled", true);
 
     this.tracer = openTelemetrySdk.getTracer("io.opentelemetry.contrib.maven", VERSION);
   }
 
+  /**
+   * The OTel SDK by default sends data to the OTLP gRPC endpoint localhost:4317 if no exporter and
+   * no OTLP exporter endpoint are defined. This is not suited for a build tool for which we want
+   * the OTel SDK to be disabled by default.
+   *
+   * <p>Change the OTel SDL behavior: if none of the exporter and the OTLP exporter endpoint are
+   * defined, explicitly disable the exporter setting "{@code
+   * otel.[traces,metrics,logs].exporter=none}"
+   *
+   * @return The properties to be returned by {@link
+   *     io.opentelemetry.sdk.autoconfigure.AutoConfiguredOpenTelemetrySdkBuilder#addPropertiesCustomizer(java.util.function.Function)}
+   */
+  static Map<String, String> requireExplicitConfigOfTheOtlpExporter(
+      ConfigProperties configProperties) {
+
+    Map<String, String> properties = new HashMap<>();
+    if (configProperties.getString("otel.exporter.otlp.endpoint") != null) {
+      logger.debug("OpenTelemetry: OTLP exporter endpoint is explicitly configured");
+      return properties;
+    }
+    String[] signalTypes = {"traces", "metrics", "logs"};
+    for (String signalType : signalTypes) {
+      boolean isExporterImplicitlyConfiguredToOtlp =
+          configProperties.getString("otel." + signalType + ".exporter") == null;
+      boolean isOtlpExporterEndpointSpecified =
+          configProperties.getString("otel.exporter.otlp." + signalType + ".endpoint") != null;
+
+      if (isExporterImplicitlyConfiguredToOtlp && !isOtlpExporterEndpointSpecified) {
+        logger.debug(
+            "OpenTelemetry: Disabling default OTLP exporter endpoint for signal {} exporter",
+            signalType);
+        properties.put("otel." + signalType + ".exporter", "none");
+      }
+    }
+
+    return properties;
+  }
+
   @PreDestroy
   @Override
   public synchronized void close() {
@@ -97,6 +142,10 @@ public Tracer getTracer() {
     return this.tracer;
   }
 
+  public ConfigProperties getConfigProperties() {
+    return configProperties;
+  }
+
   /** Returns the {@link ContextPropagators} for this {@link OpenTelemetry}. */
   public ContextPropagators getPropagators() {
     return this.openTelemetrySdk.getPropagators();
@@ -105,17 +154,4 @@ public ContextPropagators getPropagators() {
   public boolean isMojosInstrumentationEnabled() {
     return mojosInstrumentationEnabled;
   }
-
-  @Nullable
-  private static Boolean getBooleanConfig(String name) {
-    String value = System.getProperty(name);
-    if (value != null) {
-      return Boolean.parseBoolean(value);
-    }
-    value = System.getenv(name.toUpperCase(Locale.ROOT).replace('.', '_'));
-    if (value != null) {
-      return Boolean.parseBoolean(value);
-    }
-    return null;
-  }
 }

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

@@ -0,0 +1,24 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package io.opentelemetry.maven;
+
+import io.opentelemetry.sdk.autoconfigure.AutoConfiguredOpenTelemetrySdk;
+import java.lang.reflect.Method;
+import org.junit.jupiter.api.Test;
+
+class AutoConfigureUtil2Test {
+
+  /**
+   * Verify the reflection call works with the current version of AutoConfiguredOpenTelemetrySdk.
+   *
+   * @throws NoSuchMethodException if the method does not exist
+   */
+  @Test
+  void test_getResource() throws NoSuchMethodException {
+    Method method = AutoConfiguredOpenTelemetrySdk.class.getDeclaredMethod("getResource");
+    method.setAccessible(true);
+  }
+}