Merge branch 'main' of https://github.com/open-telemetry/opentelemetry-java into config-provider

Author: jack-berg

.github/workflows/build.yml

@@ -74,8 +74,8 @@ jobs:
           RUN_JMH_BASED_TESTS: ${{ matrix.jmh-based-tests }}
 
       - name: Check for diff
-        # The jApiCmp diff compares current to latest, which isn't appropriate for release branches
-        if: ${{ !startsWith(github.ref_name, 'release/') && !startsWith(github.base_ref, 'release/') }}
+        # The jApiCmp diff compares current to latest, which isn't appropriate for release branches, or for bot-generated PRs
+        if: ${{ !startsWith(github.ref_name, 'release/') && !startsWith(github.base_ref, 'release/') && (github.actor != 'opentelemetrybot') }}
         run: |
           # need to "git add" in case any generated files did not already exist
           git add docs/apidiffs

.github/workflows/gradle-wrapper-validation.yml

@@ -13,4 +13,4 @@ jobs:
     steps:
       - uses: actions/checkout@v4
 
-      - uses: gradle/actions/wrapper-validation@v3.4.2
+      - uses: gradle/actions/wrapper-validation@v3.5.0

CHANGELOG.md

@@ -2,6 +2,24 @@
 
 ## Unreleased
 
+## Version 1.40.0 (2024-07-05)
+
+### API
+
+#### Incubator
+
+* Narrow ExtendedSpanBuilder return types for chaining
+  ([#6514](https://github.com/open-telemetry/opentelemetry-java/pull/6514))
+* Add APIs to determine if tracer, logger, instruments are enabled
+  ([#6502](https://github.com/open-telemetry/opentelemetry-java/pull/6502))
+
+### SDK
+
+#### Extensions
+
+* Move autoconfigure docs to opentelemetry.io
+  ([#6491](https://github.com/open-telemetry/opentelemetry-java/pull/6491))
+
 ## Version 1.39.0 (2024-06-07)
 
 ### API
@@ -1921,7 +1939,7 @@ should not be many. Thanks for bearing with us on this.
 ### General
 
 * Examples moved
-  to [opentelemetry-java-docs](https://github.com/open-telemetry/opentelemetry-java-docs)
+  to [opentelemetry-java-examples](https://github.com/open-telemetry/opentelemetry-java-examples)
 
 ### SDK
 

CONTRIBUTING.md

@@ -93,7 +93,7 @@ Other repositories in the OpenTelemetry Java ecosystem include:
   contains instrumentation.
 * [opentelemetry-java-contrib](https://github.com/open-telemetry/opentelemetry-java-contrib)
   contains extensions, prototypes, and instrumentation, including vendor specific components.
-* [opentelemetry-java-docs](https://github.com/open-telemetry/opentelemetry-java-docs) contains
+* [opentelemetry-java-examples](https://github.com/open-telemetry/opentelemetry-java-examples) contains
   working code snippets demonstrating various concepts.
 
 ## Style guideline
@@ -250,13 +250,18 @@ Example usage could be as follows:
    }
    ```
 
+   Please confirm whether the local opentelemetry-java version is consistent with the
+   opentelemetry-java version declared in the project that relies on opentelemetry-java.
+   If it is inconsistent, `dependencySubstitution` may not take effect.
+
    See [the Gradle documentation](https://docs.gradle.org/current/userguide/composite_builds.html#included_build_declaring_substitutions)
    for more information.
-
 4. If you now build your project, it will use the included build to supply the opentelemetry-java
    artifacts, ignoring any version declarations. Use the prefix `:DIRECTORY:` to refer to
    tasks/projects within the included build, where DIRECTORY is the name of the directory in the
    included build (only the part after the last `/`).
+5. Here are some issues and solutions ([discussions/6551](https://github.com/open-telemetry/opentelemetry-java/discussions/6551))
+   you may encounter that may be helpful to you.
 
 ### Updating the OTLP protobufs
 

README.md

@@ -27,7 +27,7 @@ configurations.add(signatureJarClasspath)
 configurations.add(generatedSignature)
 
 dependencies {
-  signature("com.toasttab.android:gummy-bears-api-21:0.8.0@signature")
+  signature("com.toasttab.android:gummy-bears-api-21:0.9.0@signature")
   signatureJar("com.android.tools:desugar_jdk_libs")
 }
 

animal-sniffer-signature/build.gradle.kts

@@ -0,0 +1,40 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package io.opentelemetry.api.internal;
+
+import io.opentelemetry.context.Context;
+import io.opentelemetry.context.ContextKey;
+import java.util.Objects;
+
+/**
+ * This class is internal and is hence not for public use. Its APIs are unstable and can change at
+ * any time.
+ */
+public final class InstrumentationUtil {
+  private static final ContextKey<Boolean> SUPPRESS_INSTRUMENTATION_KEY =
+      ContextKey.named("suppress_instrumentation");
+
+  private InstrumentationUtil() {}
+
+  /**
+   * Adds a Context boolean key that will allow to identify HTTP calls coming from OTel exporters.
+   * The key later be checked by an automatic instrumentation to avoid tracing OTel exporter's
+   * calls.
+   */
+  public static void suppressInstrumentation(Runnable runnable) {
+    Context.current().with(SUPPRESS_INSTRUMENTATION_KEY, true).wrap(runnable).run();
+  }
+
+  /**
+   * Checks if an automatic instrumentation should be suppressed with the provided Context.
+   *
+   * @return TRUE to suppress the automatic instrumentation, FALSE to continue with the
+   *     instrumentation.
+   */
+  public static boolean shouldSuppressInstrumentation(Context context) {
+    return Objects.equals(context.get(SUPPRESS_INSTRUMENTATION_KEY), true);
+  }
+}

api/all/src/main/java/io/opentelemetry/api/internal/InstrumentationUtil.java

@@ -0,0 +1,27 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package io.opentelemetry.api.internal;
+
+import static org.junit.jupiter.api.Assertions.assertFalse;
+import static org.junit.jupiter.api.Assertions.assertTrue;
+
+import io.opentelemetry.context.Context;
+import org.junit.jupiter.api.Test;
+
+class InstrumentationUtilTest {
+  @Test
+  void verifySuppressInstrumentation() {
+    // Should be false by default.
+    assertFalse(InstrumentationUtil.shouldSuppressInstrumentation(Context.current()));
+
+    // Should be true inside the Runnable passed to InstrumentationUtil.suppressInstrumentation.
+    InstrumentationUtil.suppressInstrumentation(
+        () -> assertTrue(InstrumentationUtil.shouldSuppressInstrumentation(Context.current())));
+
+    // Should be false after the runnable finishes.
+    assertFalse(InstrumentationUtil.shouldSuppressInstrumentation(Context.current()));
+  }
+}

api/all/src/test/java/io/opentelemetry/api/internal/InstrumentationUtilTest.java

@@ -14,6 +14,7 @@ See [EventApiUsageTest](./src/test/java/io/opentelemetry/api/incubator/events/Ev
 
 Features:
 
+* Check if logger is enabled before emitting logs to avoid uneccessary computation
 * Set AnyValue log record body with arbitrarily complex data
 
 See [ExtendedLogsBridgeApiUsageTest](./src/test/java/io/opentelemetry/api/incubator/logs/ExtendedLogsBridgeApiUsageTest.java).
@@ -30,6 +31,7 @@ See [ExtendedMetricsApiUsageTest](./src/test/java/io/opentelemetry/api/incubator
 
 Features:
 
+* Check if instrument is enabled before recording measurements to avoid uneccessary computation
 * Simplified injection / extraction of context
 
 See [ExtendedContextPropagatorsUsageTest](./src/test/java/io/opentelemetry/api/incubator/propagation/ExtendedContextPropagatorsUsageTest.java).
@@ -38,6 +40,7 @@ See [ExtendedContextPropagatorsUsageTest](./src/test/java/io/opentelemetry/api/i
 
 Features:
 
+* Check if tracer is enabled before starting spans to avoid uneccessary computation
 * Utility methods to reduce boilerplace using span API, including extracting context, and wrapping runnables / callables with spans
 
 See [ExtendedTraceApiUsageTest](./src/test/java/io/opentelemetry/api/incubator/trace/ExtendedTraceApiUsageTest.java).

api/incubator/README.md

@@ -0,0 +1,23 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package io.opentelemetry.api.incubator.logs;
+
+import io.opentelemetry.api.logs.Logger;
+
+/** Extended {@link Logger} with experimental APIs. */
+public interface ExtendedLogger extends Logger {
+
+  /**
+   * Returns {@code true} if the logger is enabled.
+   *
+   * <p>This allows callers to avoid unnecessary compute when nothing is consuming the data. Because
+   * the response is subject to change over the application, callers should call this before each
+   * call to {@link #logRecordBuilder()}.
+   */
+  default boolean isEnabled() {
+    return true;
+  }
+}