Stabilize enabled api (#8200)

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/all/src/main/java/io/opentelemetry/api/metrics/DefaultMeter.java

@@ -67,6 +67,11 @@ public BatchCallback batchCallback(
   private DefaultMeter() {}
 
   private static class NoopLongCounter implements LongCounter {
+    @Override
+    public boolean isEnabled() {
+      return false;
+    }
+
     @Override
     public void add(long value, Attributes attributes, Context context) {}
 
@@ -78,6 +83,11 @@ public void add(long value) {}
   }
 
   private static class NoopDoubleCounter implements DoubleCounter {
+    @Override
+    public boolean isEnabled() {
+      return false;
+    }
+
     @Override
     public void add(double value, Attributes attributes, Context context) {}
 
@@ -159,6 +169,11 @@ public ObservableDoubleMeasurement buildObserver() {
   }
 
   private static class NoopLongUpDownCounter implements LongUpDownCounter {
+    @Override
+    public boolean isEnabled() {
+      return false;
+    }
+
     @Override
     public void add(long value, Attributes attributes, Context context) {}
 
@@ -170,6 +185,11 @@ public void add(long value) {}
   }
 
   private static class NoopDoubleUpDownCounter implements DoubleUpDownCounter {
+    @Override
+    public boolean isEnabled() {
+      return false;
+    }
+
     @Override
     public void add(double value, Attributes attributes, Context context) {}
 
@@ -253,6 +273,11 @@ public ObservableDoubleMeasurement buildObserver() {
   }
 
   private static class NoopDoubleHistogram implements DoubleHistogram {
+    @Override
+    public boolean isEnabled() {
+      return false;
+    }
+
     @Override
     public void record(double value, Attributes attributes, Context context) {}
 
@@ -264,6 +289,11 @@ public void record(double value) {}
   }
 
   private static class NoopLongHistogram implements LongHistogram {
+    @Override
+    public boolean isEnabled() {
+      return false;
+    }
+
     @Override
     public void record(long value, Attributes attributes, Context context) {}
 
@@ -357,6 +387,11 @@ public DoubleGauge build() {
   }
 
   private static class NoopDoubleGauge implements DoubleGauge {
+    @Override
+    public boolean isEnabled() {
+      return false;
+    }
+
     @Override
     public void set(double value) {}
 
@@ -398,6 +433,11 @@ public LongGauge build() {
   }
 
   private static class NoopLongGauge implements LongGauge {
+    @Override
+    public boolean isEnabled() {
+      return false;
+    }
+
     @Override
     public void set(long value) {}
 

api/all/src/main/java/io/opentelemetry/api/metrics/DoubleCounter.java

@@ -16,6 +16,19 @@
  */
 @ThreadSafe
 public interface DoubleCounter {
+
+  /**
+   * Returns {@code true} if the counter 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 #add(double)}, {@link #add(double, Attributes)}, or {@link #add(double,
+   * Attributes, Context)}.
+   */
+  default boolean isEnabled() {
+    return true;
+  }
+
   /**
    * Records a value.
    *

api/all/src/main/java/io/opentelemetry/api/metrics/DoubleGauge.java

@@ -16,6 +16,19 @@
  */
 @ThreadSafe
 public interface DoubleGauge {
+
+  /**
+   * Returns {@code true} if the gauge 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 #set(double)}, {@link #set(double, Attributes)}, or {@link #set(double,
+   * Attributes, Context)}.
+   */
+  default boolean isEnabled() {
+    return true;
+  }
+
   /**
    * Set the gauge value.
    *

api/all/src/main/java/io/opentelemetry/api/metrics/DoubleHistogram.java

@@ -17,6 +17,18 @@
 @ThreadSafe
 public interface DoubleHistogram {
 
+  /**
+   * Returns {@code true} if the histogram 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 #record(double)}, {@link #record(double, Attributes)}, or {@link #record(double,
+   * Attributes, Context)}.
+   */
+  default boolean isEnabled() {
+    return true;
+  }
+
   /**
    * Records a value.
    *

api/all/src/main/java/io/opentelemetry/api/metrics/DoubleUpDownCounter.java

@@ -16,6 +16,19 @@
  */
 @ThreadSafe
 public interface DoubleUpDownCounter {
+
+  /**
+   * Returns {@code true} if the up down counter 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 #add(double)}, {@link #add(double, Attributes)}, or {@link #add(double,
+   * Attributes, Context)}.
+   */
+  default boolean isEnabled() {
+    return true;
+  }
+
   /**
    * Records a value.
    *

api/all/src/main/java/io/opentelemetry/api/metrics/LongCounter.java

@@ -17,6 +17,18 @@
 @ThreadSafe
 public interface LongCounter {
 
+  /**
+   * Returns {@code true} if the counter 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 #add(long)}, {@link #add(long, Attributes)}, or {@link #add(long, Attributes,
+   * Context)}.
+   */
+  default boolean isEnabled() {
+    return true;
+  }
+
   /**
    * Records a value.
    *

api/all/src/main/java/io/opentelemetry/api/metrics/LongGauge.java

@@ -16,6 +16,19 @@
  */
 @ThreadSafe
 public interface LongGauge {
+
+  /**
+   * Returns {@code true} if the gauge 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 #set(long)}, {@link #set(long, Attributes)}, or {@link #set(long, Attributes,
+   * Context)}.
+   */
+  default boolean isEnabled() {
+    return true;
+  }
+
   /**
    * Set the gauge value.
    *

api/all/src/main/java/io/opentelemetry/api/metrics/LongHistogram.java

@@ -17,6 +17,18 @@
 @ThreadSafe
 public interface LongHistogram {
 
+  /**
+   * Returns {@code true} if the histogram 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 #record(long)}, {@link #record(long, Attributes)}, or {@link #record(long,
+   * Attributes, Context)}.
+   */
+  default boolean isEnabled() {
+    return true;
+  }
+
   /**
    * Records a value.
    *