Promote ExtendedLogger#isEnabled to stable API

Author: jack-berg

api/all/src/main/java/io/opentelemetry/api/logs/DefaultLogger.java

@@ -23,6 +23,11 @@ static Logger getInstance() {
     return INSTANCE;
   }
 
+  @Override
+  public boolean isEnabled(Severity severity, Context context) {
+    return false;
+  }
+
   @Override
   public LogRecordBuilder logRecordBuilder() {
     return NOOP_LOG_RECORD_BUILDER;

api/all/src/main/java/io/opentelemetry/api/logs/Logger.java

@@ -5,6 +5,7 @@
 
 package io.opentelemetry.api.logs;
 
+import io.opentelemetry.context.Context;
 import javax.annotation.concurrent.ThreadSafe;
 
 /**
@@ -22,6 +23,23 @@
 @ThreadSafe
 public interface Logger {
 
+  /**
+   * Returns {@code true} if the logger is enabled for the given {@code context} and {@code
+   * severity}.
+   *
+   * <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(Severity severity, Context context) {
+    return true;
+  }
+
+  /** Overload of {@link #isEnabled(Severity, Context)} assuming {@link Context#current()}. */
+  default boolean isEnabled(Severity severity) {
+    return isEnabled(severity, Context.current());
+  }
+
   /**
    * Return a {@link LogRecordBuilder} to emit a log record.
    *

api/incubator/src/main/java/io/opentelemetry/api/incubator/logs/ExtendedLogger.java

@@ -6,41 +6,10 @@
 package io.opentelemetry.api.incubator.logs;
 
 import io.opentelemetry.api.logs.Logger;
-import io.opentelemetry.api.logs.Severity;
-import io.opentelemetry.context.Context;
 
 /** Extended {@link Logger} with experimental APIs. */
 public interface ExtendedLogger extends Logger {
 
-  /**
-   * Returns {@code true} if the logger is enabled for the given {@code context} and {@code
-   * severity}.
-   *
-   * <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(Severity severity, Context context) {
-    return true;
-  }
-
-  /** Overload of {@link #isEnabled(Severity, Context)} assuming {@link Context#current()}. */
-  default boolean isEnabled(Severity severity) {
-    return isEnabled(severity, Context.current());
-  }
-
-  /**
-   * Overload of {@link #isEnabled(Severity, Context)} assuming {@link
-   * Severity#UNDEFINED_SEVERITY_NUMBER} and {@link Context#current()}.
-   *
-   * @deprecated for removal after 1.55.0. Use {@link #isEnabled(Severity, Context)} or {@link
-   *     #isEnabled(Severity)} instead.
-   */
-  @Deprecated
-  default boolean isEnabled() {
-    return isEnabled(Severity.UNDEFINED_SEVERITY_NUMBER);
-  }
-
   @Override
   ExtendedLogRecordBuilder logRecordBuilder();
 }

api/incubator/src/test/java/io/opentelemetry/api/incubator/logs/ExtendedDefaultLoggerTest.java

@@ -28,18 +28,13 @@ protected Logger getLogger() {
   }
 
   @Test
-  @SuppressWarnings("deprecation") // testing deprecated code
   void incubatingApiIsLoaded() {
     Logger logger = LoggerProvider.noop().get("test");
+    assertThat(logger.isEnabled(Severity.ERROR, Context.current())).isFalse();
+    assertThat(logger.isEnabled(Severity.ERROR)).isFalse();
 
-    assertThat(logger)
-        .isInstanceOfSatisfying(
-            ExtendedLogger.class,
-            extendedLogger -> {
-              assertThat(extendedLogger.isEnabled(Severity.ERROR, Context.current())).isFalse();
-              assertThat(extendedLogger.isEnabled(Severity.ERROR)).isFalse();
-              assertThat(extendedLogger.isEnabled()).isFalse();
-            });
+    assertThat(logger).isInstanceOf(ExtendedLogger.class);
+    assertThat(logger.isEnabled(Severity.ERROR, Context.current())).isFalse();
     ExtendedLogRecordBuilder builder = (ExtendedLogRecordBuilder) logger.logRecordBuilder();
     assertThat(builder).isInstanceOf(ExtendedLogRecordBuilder.class);
     assertThat(builder.setBody(Value.of(0))).isSameAs(builder);

api/testing-internal/src/main/java/io/opentelemetry/api/testing/internal/AbstractDefaultLoggerTest.java

@@ -45,6 +45,11 @@ void noopLoggerProvider_doesNotThrow() {
         .doesNotThrowAnyException();
   }
 
+  @Test
+  void defaultIsEnabled() {
+    assertThat(getLogger().isEnabled(Severity.ERROR, Context.root())).isFalse();
+  }
+
   @Test
   void buildAndEmit() {
     assertThatCode(

docs/apidiffs/current_vs_latest/opentelemetry-api.txt

@@ -1,4 +1,8 @@
 Comparing source compatibility of opentelemetry-api-1.61.0-SNAPSHOT.jar against opentelemetry-api-1.60.1.jar
+***  MODIFIED INTERFACE: PUBLIC ABSTRACT io.opentelemetry.api.logs.Logger  (not serializable)
+	===  CLASS FILE FORMAT VERSION: 52.0 <- 52.0
+	+++  NEW METHOD: PUBLIC(+) boolean isEnabled(io.opentelemetry.api.logs.Severity, io.opentelemetry.context.Context)
+	+++  NEW METHOD: PUBLIC(+) boolean isEnabled(io.opentelemetry.api.logs.Severity)
 ***  MODIFIED INTERFACE: PUBLIC ABSTRACT io.opentelemetry.api.trace.Tracer  (not serializable)
 	===  CLASS FILE FORMAT VERSION: 52.0 <- 52.0
 	+++  NEW METHOD: PUBLIC(+) boolean isEnabled()

sdk/logs/src/main/java/io/opentelemetry/sdk/logs/ExtendedSdkLogger.java

@@ -7,8 +7,6 @@
 
 import io.opentelemetry.api.incubator.logs.ExtendedLogRecordBuilder;
 import io.opentelemetry.api.incubator.logs.ExtendedLogger;
-import io.opentelemetry.api.logs.Severity;
-import io.opentelemetry.context.Context;
 import io.opentelemetry.sdk.common.InstrumentationScopeInfo;
 import io.opentelemetry.sdk.logs.internal.LoggerConfig;
 
@@ -22,12 +20,6 @@ final class ExtendedSdkLogger extends SdkLogger implements ExtendedLogger {
     super(loggerSharedState, instrumentationScopeInfo, loggerConfig);
   }
 
-  @Override
-  @SuppressWarnings("RedundantOverride")
-  public boolean isEnabled(Severity severity, Context context) {
-    return super.isEnabled(severity, context);
-  }
-
   @Override
   public ExtendedLogRecordBuilder logRecordBuilder() {
     return (ExtendedLogRecordBuilder) super.logRecordBuilder();

sdk/logs/src/main/java/io/opentelemetry/sdk/logs/SdkLogger.java

@@ -60,22 +60,6 @@ static SdkLogger create(
   }
 
   @Override
-  public LogRecordBuilder logRecordBuilder() {
-    if (loggerEnabled) {
-      return INCUBATOR_AVAILABLE
-          ? IncubatingUtil.createExtendedLogRecordBuilder(
-              loggerSharedState, instrumentationScopeInfo, this)
-          : new SdkLogRecordBuilder(loggerSharedState, instrumentationScopeInfo, this);
-    }
-    return NOOP_LOGGER.logRecordBuilder();
-  }
-
-  // VisibleForTesting
-  InstrumentationScopeInfo getInstrumentationScopeInfo() {
-    return instrumentationScopeInfo;
-  }
-
-  // Visible for testing
   public boolean isEnabled(Severity severity, Context context) {
     if (!loggerEnabled) {
       return false;
@@ -96,6 +80,22 @@ public boolean isEnabled(Severity severity, Context context) {
     return true;
   }
 
+  @Override
+  public LogRecordBuilder logRecordBuilder() {
+    if (loggerEnabled) {
+      return INCUBATOR_AVAILABLE
+          ? IncubatingUtil.createExtendedLogRecordBuilder(
+              loggerSharedState, instrumentationScopeInfo, this)
+          : new SdkLogRecordBuilder(loggerSharedState, instrumentationScopeInfo, this);
+    }
+    return NOOP_LOGGER.logRecordBuilder();
+  }
+
+  // VisibleForTesting
+  InstrumentationScopeInfo getInstrumentationScopeInfo() {
+    return instrumentationScopeInfo;
+  }
+
   void updateLoggerConfig(LoggerConfig loggerConfig) {
     loggerEnabled = loggerConfig.isEnabled();
     minimumSeverity = loggerConfig.getMinimumSeverity();