Deprecated registerObserver methods that were using the GlobalOpenTel…

…emetry instance.
open-telemetry · Mar 30, 2022 · 013921a · 013921a
1 parent c1d75a6
commit 013921a
Show file tree

Hide file tree

Showing 8 changed files with 40 additions and 16 deletions.
diff --git a/...nt/src/main/java/io/opentelemetry/javaagent/instrumentation/oshi/MetricsRegistration.java b/...nt/src/main/java/io/opentelemetry/javaagent/instrumentation/oshi/MetricsRegistration.java
@@ -5,6 +5,7 @@
 
 package io.opentelemetry.javaagent.instrumentation.oshi;
 
+import io.opentelemetry.api.GlobalOpenTelemetry;
 import io.opentelemetry.instrumentation.api.config.Config;
 import io.opentelemetry.instrumentation.oshi.ProcessMetrics;
 import io.opentelemetry.instrumentation.oshi.SystemMetrics;
@@ -16,15 +17,15 @@ public final class MetricsRegistration {
 
   public static void register() {
     if (registered.compareAndSet(false, true)) {
-      SystemMetrics.registerObservers();
+      SystemMetrics.registerObservers(GlobalOpenTelemetry.get());
 
       // ProcessMetrics don't follow the spec
       if (Config.get()
           .getBoolean("otel.instrumentation.oshi.experimental-metrics.enabled", false)) {
-        ProcessMetrics.registerObservers();
+        ProcessMetrics.registerObservers(GlobalOpenTelemetry.get());
       }
     }
   }
 
   private MetricsRegistration() {}
-}
+}
diff --git a/...tion/oshi/library/src/main/java/io/opentelemetry/instrumentation/oshi/ProcessMetrics.java b/...tion/oshi/library/src/main/java/io/opentelemetry/instrumentation/oshi/ProcessMetrics.java
@@ -20,10 +20,15 @@ public class ProcessMetrics {
 
   private ProcessMetrics() {}
 
-  /** Register observers for java runtime metrics. */
+  /**
+   * Register observers for java runtime metrics.
+   * @deprecated use {@link #registerObservers(OpenTelemetry openTelemetry)}
+   */
+  @Deprecated
   public static void registerObservers() {
     registerObservers(GlobalOpenTelemetry.get());
   }
+
   public static void registerObservers(OpenTelemetry openTelemetry) {
     Meter meter = openTelemetry.getMeterProvider().get("io.opentelemetry.oshi");
     SystemInfo systemInfo = new SystemInfo();

diff --git a/...ation/oshi/library/src/main/java/io/opentelemetry/instrumentation/oshi/SystemMetrics.java b/...ation/oshi/library/src/main/java/io/opentelemetry/instrumentation/oshi/SystemMetrics.java
@@ -28,10 +28,15 @@ public class SystemMetrics {
 
   private SystemMetrics() {}
 
-  /** Register observers for system metrics. */
+  /**
+   * Register observers for system metrics.
+   * @deprecated use {@link #registerObservers(OpenTelemetry openTelemetry)}
+   */
+  @Deprecated
   public static void registerObservers() {
     registerObservers(GlobalOpenTelemetry.get());
   }
+
   public static void registerObservers(OpenTelemetry openTelemetry) {
     Meter meter = openTelemetry.getMeterProvider().get("io.opentelemetry.oshi");
     SystemInfo systemInfo = new SystemInfo();

diff --git a/.../oshi/library/src/test/java/io/opentelemetry/instrumentation/oshi/ProcessMetricsTest.java b/.../oshi/library/src/test/java/io/opentelemetry/instrumentation/oshi/ProcessMetricsTest.java
@@ -5,6 +5,7 @@
 
 package io.opentelemetry.instrumentation.oshi;
 
+import io.opentelemetry.api.GlobalOpenTelemetry;
 import io.opentelemetry.instrumentation.testing.junit.InstrumentationExtension;
 import io.opentelemetry.instrumentation.testing.junit.LibraryInstrumentationExtension;
 import org.junit.jupiter.api.extension.RegisterExtension;
@@ -16,11 +17,11 @@ class ProcessMetricsTest extends AbstractProcessMetricsTest {
 
   @Override
   protected void registerMetrics() {
-    ProcessMetrics.registerObservers();
+    ProcessMetrics.registerObservers(GlobalOpenTelemetry.get());
   }
 
   @Override
   protected InstrumentationExtension testing() {
     return testing;
   }
-}
+}
diff --git a/...n/oshi/library/src/test/java/io/opentelemetry/instrumentation/oshi/SystemMetricsTest.java b/...n/oshi/library/src/test/java/io/opentelemetry/instrumentation/oshi/SystemMetricsTest.java
@@ -5,6 +5,7 @@
 
 package io.opentelemetry.instrumentation.oshi;
 
+import io.opentelemetry.api.GlobalOpenTelemetry;
 import io.opentelemetry.instrumentation.testing.junit.InstrumentationExtension;
 import io.opentelemetry.instrumentation.testing.junit.LibraryInstrumentationExtension;
 import org.junit.jupiter.api.extension.RegisterExtension;
@@ -16,11 +17,11 @@ class SystemMetricsTest extends AbstractSystemMetricsTest {
 
   @Override
   protected void registerMetrics() {
-    SystemMetrics.registerObservers();
+    SystemMetrics.registerObservers(GlobalOpenTelemetry.get());
   }
 
   @Override
   protected InstrumentationExtension testing() {
     return testing;
   }
-}
+}
diff --git a/...va/io/opentelemetry/instrumentation/javaagent/runtimemetrics/RuntimeMetricsInstaller.java b/...va/io/opentelemetry/instrumentation/javaagent/runtimemetrics/RuntimeMetricsInstaller.java
@@ -6,6 +6,7 @@
 package io.opentelemetry.instrumentation.javaagent.runtimemetrics;
 
 import com.google.auto.service.AutoService;
+import io.opentelemetry.api.GlobalOpenTelemetry;
 import io.opentelemetry.instrumentation.api.config.Config;
 import io.opentelemetry.instrumentation.runtimemetrics.GarbageCollector;
 import io.opentelemetry.instrumentation.runtimemetrics.MemoryPools;
@@ -20,8 +21,8 @@ public class RuntimeMetricsInstaller implements AgentListener {
   public void afterAgent(Config config, AutoConfiguredOpenTelemetrySdk unused) {
     if (config.isInstrumentationEnabled(
         Collections.singleton("runtime-metrics"), /* defaultEnabled= */ true)) {
-      GarbageCollector.registerObservers();
-      MemoryPools.registerObservers();
+      GarbageCollector.registerObservers(GlobalOpenTelemetry.get());
+      MemoryPools.registerObservers(GlobalOpenTelemetry.get());
     }
   }
-}
+}
diff --git a/...brary/src/main/java/io/opentelemetry/instrumentation/runtimemetrics/GarbageCollector.java b/...brary/src/main/java/io/opentelemetry/instrumentation/runtimemetrics/GarbageCollector.java
@@ -21,7 +21,7 @@
  * <p>Example usage:
  *
  * <pre>{@code
- * GarbageCollector.registerObservers();
+ * GarbageCollector.registerObservers(GlobalOpenTelemetry.get());
  * }</pre>
  *
  * <p>Example metrics being exported:
@@ -34,7 +34,11 @@
 public final class GarbageCollector {
   private static final AttributeKey<String> GC_KEY = AttributeKey.stringKey("gc");
 
-  /** Register all observers provided by this module. */
+  /**
+   * Register all observers provided by this module.
+   * @deprecated use {@link #registerObservers(OpenTelemetry openTelemetry)}
+   */
+  @Deprecated
   public static void registerObservers() {
     registerObservers(GlobalOpenTelemetry.get());
   }

diff --git a/...cs/library/src/main/java/io/opentelemetry/instrumentation/runtimemetrics/MemoryPools.java b/...cs/library/src/main/java/io/opentelemetry/instrumentation/runtimemetrics/MemoryPools.java
@@ -24,7 +24,7 @@
  * <p>Example usage:
  *
  * <pre>{@code
- * MemoryPools.registerObservers();
+ * MemoryPools.registerObservers(GlobalOpenTelemetry.get());
  * }</pre>
  *
  * <p>Example metrics being exported: Component
@@ -59,6 +59,7 @@ public final class MemoryPools {
   private static final Attributes MAX_NON_HEAP = Attributes.of(TYPE_KEY, MAX, AREA_KEY, NON_HEAP);
 
   /** Register only the "area" measurements. */
+  @Deprecated
   public static void registerMemoryAreaObservers() {
     registerMemoryPoolObservers(GlobalOpenTelemetry.get());
   }
@@ -78,6 +79,7 @@ public static void registerMemoryAreaObservers(OpenTelemetry openTelemetry) {
   }
 
   /** Register only the "pool" measurements. */
+  @Deprecated
   public static void registerMemoryPoolObservers() {
     registerMemoryPoolObservers(GlobalOpenTelemetry.get());
   }
@@ -113,7 +115,11 @@ public static void registerMemoryPoolObservers(OpenTelemetry openTelemetry) {
             });
   }
 
-  /** Register all measurements provided by this module. */
+  /**
+   * Register all measurements provided by this module.
+   * @deprecated use {@link #registerObservers(OpenTelemetry openTelemetry)}
+   */
+  @Deprecated
   public static void registerObservers() {
     registerMemoryAreaObservers();
     registerMemoryPoolObservers();