Verify class compatibility before attempting cast (#1435)

* verify class compatibility before attempting cast * specify classloader * rename for consistency
signalfx · Sep 13, 2023 · 8e07921 · 8e07921
1 parent 09c2c80
commit 8e07921
Show file tree

Hide file tree

Showing 6 changed files with 29 additions and 16 deletions.
diff --git a/...main/java/com/splunk/opentelemetry/instrumentation/jvmmetrics/AllocatedMemoryMetrics.java b/...main/java/com/splunk/opentelemetry/instrumentation/jvmmetrics/AllocatedMemoryMetrics.java
@@ -25,19 +25,18 @@
 
 public class AllocatedMemoryMetrics {
   public static final String METRIC_NAME = "process.runtime.jvm.memory.allocated";
-  private static final boolean hasComSunThreadMXBean = hasComSunThreadMXBean();
   private final AllocationTracker allocationTracker = createAllocationTracker();
 
-  public boolean isAvailable() {
-    return allocationTracker != null;
+  public boolean isUnavailable() {
+    return allocationTracker == null;
   }
 
   public long getCumulativeAllocationTotal() {
-    return allocationTracker != null ? allocationTracker.getCumulativeAllocationTotal() : 0;
+    return allocationTracker == null ? 0 : allocationTracker.getCumulativeAllocationTotal();
   }
 
   private AllocationTracker createAllocationTracker() {
-    if (hasComSunThreadMXBean && isThreadAllocatedMemoryEnabled()) {
+    if (hasComSunThreadMXBean() && isThreadAllocatedMemoryEnabled() && mxBeanTypeIsCompatible()) {
       return new AllocationTracker();
     }
     return null;
@@ -53,13 +52,26 @@ private static boolean hasComSunThreadMXBean() {
     }
   }
 
+  private static boolean mxBeanTypeIsCompatible() {
+    try {
+      Class<?> mxBeanClass =
+          Class.forName(
+              "com.sun.management.ThreadMXBean",
+              false,
+              AllocatedMemoryMetrics.class.getClassLoader());
+      return mxBeanClass.isInstance(ManagementFactory.getThreadMXBean());
+    } catch (Exception e) {
+      return false;
+    }
+  }
+
   private static boolean isThreadAllocatedMemoryEnabled() {
-    ThreadMXBean threadBean = (ThreadMXBean) ManagementFactory.getThreadMXBean();
+    ThreadMXBean threadBean = (com.sun.management.ThreadMXBean) ManagementFactory.getThreadMXBean();
 
     try {
-      threadBean.getAllThreadIds();
-      return threadBean.isThreadAllocatedMemorySupported()
-          && threadBean.isThreadAllocatedMemoryEnabled();
+      threadBean.getAllThreadIds(); // java.lang.management.ThreadMXBean
+      return threadBean.isThreadAllocatedMemorySupported() // com.sun.management.ThreadMXBean
+          && threadBean.isThreadAllocatedMemoryEnabled(); // com.sun.management.ThreadMXBean
     } catch (Error error) {
       // An error will be thrown for unsupported operations
       // e.g. SubstrateVM does not support getAllThreadIds

diff --git a/...cs/src/main/java/com/splunk/opentelemetry/instrumentation/jvmmetrics/GcMemoryMetrics.java b/...cs/src/main/java/com/splunk/opentelemetry/instrumentation/jvmmetrics/GcMemoryMetrics.java
@@ -47,8 +47,8 @@ public long getDeltaSum() {
     return deltaSum.get();
   }
 
-  public boolean isAvailable() {
-    return managementExtensionsPresent;
+  public boolean isUnavailable() {
+    return !managementExtensionsPresent;
   }
 
   public void registerListener() {

diff --git a/...opentelemetry/instrumentation/jvmmetrics/micrometer/MicrometerAllocatedMemoryMetrics.java b/...opentelemetry/instrumentation/jvmmetrics/micrometer/MicrometerAllocatedMemoryMetrics.java
@@ -19,6 +19,7 @@
 import static com.splunk.opentelemetry.instrumentation.jvmmetrics.AllocatedMemoryMetrics.METRIC_NAME;
 
 import com.splunk.opentelemetry.instrumentation.jvmmetrics.AllocatedMemoryMetrics;
+import io.micrometer.common.lang.NonNull;
 import io.micrometer.core.instrument.FunctionCounter;
 import io.micrometer.core.instrument.MeterRegistry;
 import io.micrometer.core.instrument.binder.BaseUnits;
@@ -27,9 +28,9 @@
 public class MicrometerAllocatedMemoryMetrics implements MeterBinder {
 
   @Override
-  public void bindTo(MeterRegistry registry) {
+  public void bindTo(@NonNull MeterRegistry registry) {
     AllocatedMemoryMetrics allocatedMemoryMetrics = new AllocatedMemoryMetrics();
-    if (!allocatedMemoryMetrics.isAvailable()) {
+    if (allocatedMemoryMetrics.isUnavailable()) {
       return;
     }
 

diff --git a/...splunk/opentelemetry/instrumentation/jvmmetrics/micrometer/MicrometerGcMemoryMetrics.java b/...splunk/opentelemetry/instrumentation/jvmmetrics/micrometer/MicrometerGcMemoryMetrics.java
@@ -29,7 +29,7 @@ public class MicrometerGcMemoryMetrics implements MeterBinder, AutoCloseable {
 
   @Override
   public void bindTo(MeterRegistry registry) {
-    if (!gcMemoryMetrics.isAvailable()) {
+    if (gcMemoryMetrics.isUnavailable()) {
       return;
     }
 

diff --git a/.../com/splunk/opentelemetry/instrumentation/jvmmetrics/otel/OtelAllocatedMemoryMetrics.java b/.../com/splunk/opentelemetry/instrumentation/jvmmetrics/otel/OtelAllocatedMemoryMetrics.java
@@ -29,7 +29,7 @@ public class OtelAllocatedMemoryMetrics {
 
   public void install() {
     AllocatedMemoryMetrics allocatedMemoryMetrics = new AllocatedMemoryMetrics();
-    if (!allocatedMemoryMetrics.isAvailable()) {
+    if (allocatedMemoryMetrics.isUnavailable()) {
       return;
     }
 

diff --git a/...in/java/com/splunk/opentelemetry/instrumentation/jvmmetrics/otel/OtelGcMemoryMetrics.java b/...in/java/com/splunk/opentelemetry/instrumentation/jvmmetrics/otel/OtelGcMemoryMetrics.java
@@ -25,7 +25,7 @@ public class OtelGcMemoryMetrics {
 
   public void install() {
     GcMemoryMetrics gcMemoryMetrics = new GcMemoryMetrics();
-    if (!gcMemoryMetrics.isAvailable()) {
+    if (gcMemoryMetrics.isUnavailable()) {
       return;
     }