Enable oshi ProcessMetrics in javaagent (and refactor oshi instrumentation) (#5281)

* Enable oshi ProcessMetrics in javaagent (and refactor oshi instrumentation)

* Get rid of double async instrument registration logs

* spotless

Author: Mateusz Rzeszutek

instrumentation/oshi/javaagent/build.gradle.kts

@@ -17,5 +17,11 @@ dependencies {
 
   library("com.github.oshi:oshi-core:5.3.1")
 
-  testImplementation("com.google.guava:guava")
+  testImplementation(project(":instrumentation:oshi:testing"))
+}
+
+tasks {
+  withType<Test>().configureEach {
+    jvmArgs("-Dotel.instrumentation.oshi.experimental-metrics.enabled=true")
+  }
 }

instrumentation/oshi/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/oshi/MetricsRegistration.java

@@ -0,0 +1,30 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package io.opentelemetry.javaagent.instrumentation.oshi;
+
+import io.opentelemetry.instrumentation.api.config.Config;
+import io.opentelemetry.instrumentation.oshi.ProcessMetrics;
+import io.opentelemetry.instrumentation.oshi.SystemMetrics;
+import java.util.concurrent.atomic.AtomicBoolean;
+
+public final class MetricsRegistration {
+
+  private static final AtomicBoolean registered = new AtomicBoolean();
+
+  public static void register() {
+    if (registered.compareAndSet(false, true)) {
+      SystemMetrics.registerObservers();
+
+      // ProcessMetrics don't follow the spec
+      if (Config.get()
+          .getBoolean("otel.instrumentation.oshi.experimental-metrics.enabled", false)) {
+        ProcessMetrics.registerObservers();
+      }
+    }
+  }
+
+  private MetricsRegistration() {}
+}

instrumentation/oshi/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/oshi/SystemInfoInstrumentation.java

@@ -11,7 +11,6 @@
 import static net.bytebuddy.matcher.ElementMatchers.isStatic;
 import static net.bytebuddy.matcher.ElementMatchers.named;
 
-import io.opentelemetry.instrumentation.oshi.SystemMetrics;
 import io.opentelemetry.javaagent.extension.instrumentation.TypeInstrumentation;
 import io.opentelemetry.javaagent.extension.instrumentation.TypeTransformer;
 import net.bytebuddy.asm.Advice;
@@ -44,7 +43,7 @@ public static class GetCurrentPlatformEnumAdvice {
 
     @Advice.OnMethodEnter(suppress = Throwable.class)
     public static void onEnter() {
-      SystemMetrics.registerObservers();
+      MetricsRegistration.register();
     }
   }
 }

instrumentation/oshi/javaagent/src/test/groovy/io/opentelemetry/javaagent/instrumentation/oshi/OshiTest.groovy

@@ -0,0 +1,25 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package io.opentelemetry.javaagent.instrumentation.oshi;
+
+import io.opentelemetry.instrumentation.oshi.AbstractProcessMetricsTest;
+import io.opentelemetry.instrumentation.testing.junit.AgentInstrumentationExtension;
+import io.opentelemetry.instrumentation.testing.junit.InstrumentationExtension;
+import org.junit.jupiter.api.extension.RegisterExtension;
+
+class ProcessMetricsTest extends AbstractProcessMetricsTest {
+
+  @RegisterExtension
+  public static final InstrumentationExtension testing = AgentInstrumentationExtension.create();
+
+  @Override
+  protected void registerMetrics() {}
+
+  @Override
+  protected InstrumentationExtension testing() {
+    return testing;
+  }
+}

instrumentation/oshi/javaagent/src/test/java/io/opentelemetry/javaagent/instrumentation/oshi/ProcessMetricsTest.java

@@ -0,0 +1,25 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package io.opentelemetry.javaagent.instrumentation.oshi;
+
+import io.opentelemetry.instrumentation.oshi.AbstractSystemMetricsTest;
+import io.opentelemetry.instrumentation.testing.junit.AgentInstrumentationExtension;
+import io.opentelemetry.instrumentation.testing.junit.InstrumentationExtension;
+import org.junit.jupiter.api.extension.RegisterExtension;
+
+class SystemMetricsTest extends AbstractSystemMetricsTest {
+
+  @RegisterExtension
+  public static final InstrumentationExtension testing = AgentInstrumentationExtension.create();
+
+  @Override
+  protected void registerMetrics() {}
+
+  @Override
+  protected InstrumentationExtension testing() {
+    return testing;
+  }
+}

instrumentation/oshi/javaagent/src/test/java/io/opentelemetry/javaagent/instrumentation/oshi/SystemMetricsTest.java

@@ -5,7 +5,5 @@ plugins {
 dependencies {
   library("com.github.oshi:oshi-core:5.3.1")
 
-  testImplementation("io.opentelemetry:opentelemetry-sdk-metrics")
-  testImplementation(project(":testing-common"))
-  testImplementation("org.assertj:assertj-core")
+  testImplementation(project(":instrumentation:oshi:testing"))
 }

instrumentation/oshi/library/build.gradle.kts

@@ -22,15 +22,15 @@ private ProcessMetrics() {}
   /** Register observers for java runtime metrics. */
   public static void registerObservers() {
     // TODO(anuraaga): registerObservers should accept an OpenTelemetry instance
-    Meter meter = GlobalOpenTelemetry.get().getMeterProvider().get(ProcessMetrics.class.getName());
+    Meter meter = GlobalOpenTelemetry.get().getMeterProvider().get("io.opentelemetry.oshi");
     SystemInfo systemInfo = new SystemInfo();
     OperatingSystem osInfo = systemInfo.getOperatingSystem();
     OSProcess processInfo = osInfo.getProcess(osInfo.getProcessId());
 
     meter
         .upDownCounterBuilder("runtime.java.memory")
         .setDescription("Runtime Java memory")
-        .setUnit("bytes")
+        .setUnit("By")
         .buildWithCallback(
             r -> {
               processInfo.updateAttributes();
@@ -41,12 +41,12 @@ public static void registerObservers() {
     meter
         .gaugeBuilder("runtime.java.cpu_time")
         .setDescription("Runtime Java CPU time")
-        .setUnit("seconds")
+        .setUnit("ms")
         .buildWithCallback(
             r -> {
               processInfo.updateAttributes();
-              r.record(processInfo.getUserTime() * 1000, Attributes.of(TYPE_KEY, "user"));
-              r.record(processInfo.getKernelTime() * 1000, Attributes.of(TYPE_KEY, "system"));
+              r.record(processInfo.getUserTime(), Attributes.of(TYPE_KEY, "user"));
+              r.record(processInfo.getKernelTime(), Attributes.of(TYPE_KEY, "system"));
             });
   }
 }

instrumentation/oshi/library/src/main/java/io/opentelemetry/instrumentation/oshi/ProcessMetrics.java

@@ -30,8 +30,7 @@ private SystemMetrics() {}
   /** Register observers for system metrics. */
   public static void registerObservers() {
     // TODO(anuraaga): registerObservers should accept an OpenTelemetry instance
-    Meter meter =
-        GlobalOpenTelemetry.get().getMeterProvider().get("io.opentelemetry.instrumentation.oshi");
+    Meter meter = GlobalOpenTelemetry.get().getMeterProvider().get("io.opentelemetry.oshi");
     SystemInfo systemInfo = new SystemInfo();
     HardwareAbstractionLayer hal = systemInfo.getHardware();