Add context and severity params to ExtendedLogger#isEnabled (#7268)

Author: jack-berg

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

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

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

@@ -6,21 +6,41 @@
 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.
+   * 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() {
+  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/main/java/io/opentelemetry/api/incubator/metrics/ExtendedDefaultMeter.java

@@ -94,6 +94,11 @@ public BatchCallback batchCallback(
   private ExtendedDefaultMeter() {}
 
   private static class NoopLongCounter implements ExtendedLongCounter {
+    @Override
+    public boolean isEnabled() {
+      return false;
+    }
+
     @Override
     public void add(long value, Attributes attributes, Context context) {}
 
@@ -105,6 +110,11 @@ public void add(long value) {}
   }
 
   private static class NoopDoubleCounter implements ExtendedDoubleCounter {
+    @Override
+    public boolean isEnabled() {
+      return false;
+    }
+
     @Override
     public void add(double value, Attributes attributes, Context context) {}
 
@@ -186,6 +196,11 @@ public ObservableDoubleMeasurement buildObserver() {
   }
 
   private static class NoopLongUpDownCounter implements ExtendedLongUpDownCounter {
+    @Override
+    public boolean isEnabled() {
+      return false;
+    }
+
     @Override
     public void add(long value, Attributes attributes, Context context) {}
 
@@ -197,6 +212,11 @@ public void add(long value) {}
   }
 
   private static class NoopDoubleUpDownCounter implements ExtendedDoubleUpDownCounter {
+    @Override
+    public boolean isEnabled() {
+      return false;
+    }
+
     @Override
     public void add(double value, Attributes attributes, Context context) {}
 
@@ -281,6 +301,11 @@ public ObservableDoubleMeasurement buildObserver() {
   }
 
   private static class NoopDoubleHistogram implements ExtendedDoubleHistogram {
+    @Override
+    public boolean isEnabled() {
+      return false;
+    }
+
     @Override
     public void record(double value, Attributes attributes, Context context) {}
 
@@ -292,6 +317,11 @@ public void record(double value) {}
   }
 
   private static class NoopLongHistogram implements ExtendedLongHistogram {
+    @Override
+    public boolean isEnabled() {
+      return false;
+    }
+
     @Override
     public void record(long value, Attributes attributes, Context context) {}
 
@@ -385,6 +415,11 @@ public DoubleGauge build() {
   }
 
   private static class NoopDoubleGauge implements ExtendedDoubleGauge {
+    @Override
+    public boolean isEnabled() {
+      return false;
+    }
+
     @Override
     public void set(double value) {}
 
@@ -426,6 +461,11 @@ public LongGauge build() {
   }
 
   private static class NoopLongGauge implements ExtendedLongGauge {
+    @Override
+    public boolean isEnabled() {
+      return false;
+    }
+
     @Override
     public void set(long value) {}
 

api/incubator/src/main/java/io/opentelemetry/api/incubator/trace/ExtendedDefaultTracer.java

@@ -31,6 +31,11 @@ static Tracer getNoop() {
     return INSTANCE;
   }
 
+  @Override
+  public boolean isEnabled() {
+    return false;
+  }
+
   @Override
   public ExtendedSpanBuilder spanBuilder(String spanName) {
     return NoopSpanBuilder.create();

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

@@ -10,7 +10,9 @@
 import io.opentelemetry.api.common.Value;
 import io.opentelemetry.api.logs.Logger;
 import io.opentelemetry.api.logs.LoggerProvider;
+import io.opentelemetry.api.logs.Severity;
 import io.opentelemetry.api.testing.internal.AbstractDefaultLoggerTest;
+import io.opentelemetry.context.Context;
 import org.junit.jupiter.api.Test;
 
 class ExtendedDefaultLoggerTest extends AbstractDefaultLoggerTest {
@@ -26,10 +28,18 @@ protected Logger getLogger() {
   }
 
   @Test
+  @SuppressWarnings("deprecation") // testing deprecated code
   void incubatingApiIsLoaded() {
     Logger logger = LoggerProvider.noop().get("test");
 
-    assertThat(logger).isInstanceOf(ExtendedLogger.class);
+    assertThat(logger)
+        .isInstanceOfSatisfying(
+            ExtendedLogger.class,
+            extendedLogger -> {
+              assertThat(extendedLogger.isEnabled(Severity.ERROR, Context.current())).isFalse();
+              assertThat(extendedLogger.isEnabled(Severity.ERROR)).isFalse();
+              assertThat(extendedLogger.isEnabled()).isFalse();
+            });
     ExtendedLogRecordBuilder builder = (ExtendedLogRecordBuilder) logger.logRecordBuilder();
     assertThat(builder).isInstanceOf(ExtendedLogRecordBuilder.class);
     assertThat(builder.setBody(Value.of(0))).isSameAs(builder);

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

@@ -14,6 +14,7 @@
 import io.opentelemetry.api.incubator.common.ExtendedAttributeKey;
 import io.opentelemetry.api.incubator.common.ExtendedAttributes;
 import io.opentelemetry.api.logs.Logger;
+import io.opentelemetry.api.logs.Severity;
 import io.opentelemetry.internal.testing.slf4j.SuppressLogger;
 import io.opentelemetry.sdk.logs.SdkLoggerProvider;
 import io.opentelemetry.sdk.logs.SdkLoggerProviderBuilder;
@@ -53,24 +54,26 @@ void loggerEnabled() {
     ExtendedLogger loggerB = (ExtendedLogger) loggerProvider.get("loggerB");
 
     // Check if logger is enabled before emitting log and avoid unnecessary computation
-    if (loggerA.isEnabled()) {
+    if (loggerA.isEnabled(Severity.INFO)) {
       loggerA
           .logRecordBuilder()
+          .setSeverity(Severity.INFO)
           .setBody("hello world!")
           .setAllAttributes(Attributes.builder().put("result", flipCoin()).build())
           .emit();
     }
-    if (loggerB.isEnabled()) {
+    if (loggerB.isEnabled(Severity.INFO)) {
       loggerB
           .logRecordBuilder()
+          .setSeverity(Severity.INFO)
           .setBody("hello world!")
           .setAllAttributes(Attributes.builder().put("result", flipCoin()).build())
           .emit();
     }
 
     // loggerA is enabled, loggerB is disabled
-    assertThat(loggerA.isEnabled()).isTrue();
-    assertThat(loggerB.isEnabled()).isFalse();
+    assertThat(loggerA.isEnabled(Severity.INFO)).isTrue();
+    assertThat(loggerB.isEnabled(Severity.INFO)).isFalse();
 
     // Collected data only consists of logs from loggerA. Note, loggerB's logs would be
     // omitted from the results even if logs were emitted. The check if enabled simply avoids

api/incubator/src/test/java/io/opentelemetry/api/incubator/metrics/ExtendedDefaultMeterTest.java

@@ -11,7 +11,6 @@
 import io.opentelemetry.api.metrics.Meter;
 import io.opentelemetry.api.metrics.MeterProvider;
 import io.opentelemetry.api.testing.internal.AbstractDefaultMeterTest;
-import org.assertj.core.api.Assertions;
 import org.junit.jupiter.api.Test;
 
 class ExtendedDefaultMeterTest extends AbstractDefaultMeterTest {
@@ -27,44 +26,53 @@ protected MeterProvider getMeterProvider() {
   }
 
   @Test
-  public void incubatingApiIsLoaded() {
+  void incubatingApiIsLoaded() {
     Meter meter = MeterProvider.noop().get("test");
     assertThat(meter).isSameAs(OpenTelemetry.noop().getMeter("test"));
 
-    Assertions.assertThat(meter.gaugeBuilder("test").ofLongs())
-        .isInstanceOf(ExtendedLongGaugeBuilder.class);
-    Assertions.assertThat(meter.gaugeBuilder("test").ofLongs().build())
-        .isInstanceOf(ExtendedLongGauge.class);
-    Assertions.assertThat(meter.gaugeBuilder("test"))
-        .isInstanceOf(ExtendedDoubleGaugeBuilder.class);
-    Assertions.assertThat(meter.gaugeBuilder("test").build())
-        .isInstanceOf(ExtendedDoubleGauge.class);
+    assertThat(meter.gaugeBuilder("test").ofLongs()).isInstanceOf(ExtendedLongGaugeBuilder.class);
+    assertThat(meter.gaugeBuilder("test").ofLongs().build())
+        .isInstanceOfSatisfying(
+            ExtendedLongGauge.class, instrument -> assertThat(instrument.isEnabled()).isFalse());
+    assertThat(meter.gaugeBuilder("test")).isInstanceOf(ExtendedDoubleGaugeBuilder.class);
+    assertThat(meter.gaugeBuilder("test").build())
+        .isInstanceOfSatisfying(
+            ExtendedDoubleGauge.class, instrument -> assertThat(instrument.isEnabled()).isFalse());
 
-    Assertions.assertThat(meter.histogramBuilder("test").ofLongs())
+    assertThat(meter.histogramBuilder("test").ofLongs())
         .isInstanceOf(ExtendedLongHistogramBuilder.class);
-    Assertions.assertThat(meter.histogramBuilder("test").ofLongs().build())
-        .isInstanceOf(ExtendedLongHistogram.class);
-    Assertions.assertThat(meter.histogramBuilder("test"))
-        .isInstanceOf(ExtendedDoubleHistogramBuilder.class);
-    Assertions.assertThat(meter.histogramBuilder("test").build())
-        .isInstanceOf(ExtendedDoubleHistogram.class);
+    assertThat(meter.histogramBuilder("test").ofLongs().build())
+        .isInstanceOfSatisfying(
+            ExtendedLongHistogram.class,
+            instrument -> assertThat(instrument.isEnabled()).isFalse());
+    assertThat(meter.histogramBuilder("test")).isInstanceOf(ExtendedDoubleHistogramBuilder.class);
+    assertThat(meter.histogramBuilder("test").build())
+        .isInstanceOfSatisfying(
+            ExtendedDoubleHistogram.class,
+            instrument -> assertThat(instrument.isEnabled()).isFalse());
 
-    Assertions.assertThat(meter.counterBuilder("test"))
-        .isInstanceOf(ExtendedLongCounterBuilder.class);
-    Assertions.assertThat(meter.counterBuilder("test").build())
-        .isInstanceOf(ExtendedLongCounter.class);
-    Assertions.assertThat(meter.counterBuilder("test").ofDoubles())
+    assertThat(meter.counterBuilder("test")).isInstanceOf(ExtendedLongCounterBuilder.class);
+    assertThat(meter.counterBuilder("test").build())
+        .isInstanceOfSatisfying(
+            ExtendedLongCounter.class, instrument -> assertThat(instrument.isEnabled()).isFalse());
+    assertThat(meter.counterBuilder("test").ofDoubles())
         .isInstanceOf(ExtendedDoubleCounterBuilder.class);
-    Assertions.assertThat(meter.counterBuilder("test").ofDoubles().build())
-        .isInstanceOf(ExtendedDoubleCounter.class);
+    assertThat(meter.counterBuilder("test").ofDoubles().build())
+        .isInstanceOfSatisfying(
+            ExtendedDoubleCounter.class,
+            instrument -> assertThat(instrument.isEnabled()).isFalse());
 
-    Assertions.assertThat(meter.upDownCounterBuilder("test"))
+    assertThat(meter.upDownCounterBuilder("test"))
         .isInstanceOf(ExtendedLongUpDownCounterBuilder.class);
-    Assertions.assertThat(meter.upDownCounterBuilder("test").build())
-        .isInstanceOf(ExtendedLongUpDownCounter.class);
-    Assertions.assertThat(meter.upDownCounterBuilder("test").ofDoubles())
+    assertThat(meter.upDownCounterBuilder("test").build())
+        .isInstanceOfSatisfying(
+            ExtendedLongUpDownCounter.class,
+            instrument -> assertThat(instrument.isEnabled()).isFalse());
+    assertThat(meter.upDownCounterBuilder("test").ofDoubles())
         .isInstanceOf(ExtendedDoubleUpDownCounterBuilder.class);
-    Assertions.assertThat(meter.upDownCounterBuilder("test").ofDoubles().build())
-        .isInstanceOf(ExtendedDoubleUpDownCounter.class);
+    assertThat(meter.upDownCounterBuilder("test").ofDoubles().build())
+        .isInstanceOfSatisfying(
+            ExtendedDoubleUpDownCounter.class,
+            instrument -> assertThat(instrument.isEnabled()).isFalse());
   }
 }

api/incubator/src/test/java/io/opentelemetry/api/incubator/trace/ExtendedDefaultTracerTest.java

@@ -6,6 +6,8 @@
 package io.opentelemetry.api.incubator.trace;
 
 import static org.assertj.core.api.Assertions.assertThat;
+import static org.mockito.Mockito.reset;
+import static org.mockito.Mockito.verify;
 
 import io.opentelemetry.api.OpenTelemetry;
 import io.opentelemetry.api.testing.internal.AbstractDefaultTracerTest;
@@ -27,39 +29,42 @@ public TracerProvider getTracerProvider() {
   }
 
   @Test
-  public void incubatingApiIsLoaded() {
+  void incubatingApiIsLoaded() {
     Tracer tracer = TracerProvider.noop().get("test");
     assertThat(tracer).isSameAs(OpenTelemetry.noop().getTracer("test"));
 
-    assertThat(tracer).isInstanceOf(ExtendedTracer.class);
+    assertThat(tracer)
+        .isInstanceOfSatisfying(
+            ExtendedTracer.class,
+            extendedTracer -> assertThat(extendedTracer.isEnabled()).isFalse());
     assertThat(tracer.spanBuilder("test")).isInstanceOf(ExtendedSpanBuilder.class);
   }
 
   @SuppressWarnings("unchecked")
   @Test
-  public void incubatingApi() {
+  void incubatingApi() {
     ExtendedSpanBuilder spanBuilder =
         (ExtendedSpanBuilder) ExtendedDefaultTracer.getNoop().spanBuilder("test");
     assertThat(spanBuilder.setParentFrom(null, null)).isSameAs(spanBuilder);
 
     SpanRunnable<RuntimeException> spanRunnable = Mockito.mock(SpanRunnable.class);
 
     spanBuilder.startAndRun(spanRunnable);
-    Mockito.verify(spanRunnable).runInSpan();
-    Mockito.reset(spanRunnable);
+    verify(spanRunnable).runInSpan();
+    reset(spanRunnable);
 
     spanBuilder.startAndRun(spanRunnable, null);
-    Mockito.verify(spanRunnable).runInSpan();
-    Mockito.reset(spanRunnable);
+    verify(spanRunnable).runInSpan();
+    reset(spanRunnable);
 
     SpanCallable<String, RuntimeException> spanCallable = Mockito.mock(SpanCallable.class);
 
     spanBuilder.startAndCall(spanCallable);
-    Mockito.verify(spanCallable).callInSpan();
-    Mockito.reset(spanCallable);
+    verify(spanCallable).callInSpan();
+    reset(spanCallable);
 
     spanBuilder.startAndCall(spanCallable, null);
-    Mockito.verify(spanCallable).callInSpan();
-    Mockito.reset(spanCallable);
+    verify(spanCallable).callInSpan();
+    reset(spanCallable);
   }
 }