Add runtime.jvm.gc.collection.count metric

open-telemetry · Mar 22, 2021 · bcaab02 · bcaab02
1 parent 4168c0b
commit bcaab02
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 0 deletions.
diff --git a/...roovy/io/opentelemetry/instrumentation/javaagent/runtimemetrics/RuntimeMetricsTest.groovy b/...roovy/io/opentelemetry/instrumentation/javaagent/runtimemetrics/RuntimeMetricsTest.groovy
@@ -17,6 +17,7 @@ class RuntimeMetricsTest extends AgentInstrumentationSpecification {
     then:
     conditions.eventually {
       assert getMetrics().any { it.name == "runtime.jvm.gc.collection" }
+      assert getMetrics().any { it.name == "runtime.jvm.gc.collection.count" }
       assert getMetrics().any { it.name == "runtime.jvm.memory.area" }
       assert getMetrics().any { it.name == "runtime.jvm.memory.pool" }
     }

diff --git a/...brary/src/main/java/io/opentelemetry/instrumentation/runtimemetrics/GarbageCollector.java b/...brary/src/main/java/io/opentelemetry/instrumentation/runtimemetrics/GarbageCollector.java
@@ -26,6 +26,7 @@
  *
  * <pre>
  *   runtime.jvm.gc.collection{gc="PS1"} 6.7
+ *   runtime.jvm.gc.collection.count{gc="PS1"} 1
  * </pre>
  */
 public final class GarbageCollector {
@@ -51,6 +52,18 @@ public static void registerObservers() {
               }
             })
         .build();
+    meter
+        .longSumObserverBuilder("runtime.jvm.gc.collection.count")
+        .setDescription("The number of collections that have occurred for a given JVM garbage collector.")
+        .setUnit("collections")
+        .setUpdater(
+            resultLongObserver -> {
+              for (int i = 0; i < garbageCollectors.size(); i++) {
+                resultLongObserver.observe(
+                    garbageCollectors.get(i).getCollectionCount(), labelSets.get(i));
+              }
+            })
+        .build();
   }
 
   private GarbageCollector() {}

diff --git a/smoke-tests/src/test/groovy/io/opentelemetry/smoketest/SpringBootSmokeTest.groovy b/smoke-tests/src/test/groovy/io/opentelemetry/smoketest/SpringBootSmokeTest.groovy
@@ -63,6 +63,7 @@ class SpringBootSmokeTest extends SmokeTest {
     then: "JVM metrics are exported"
     def metrics = new MetricsInspector(waitForMetrics())
     metrics.hasMetricsNamed("runtime.jvm.gc.collection")
+    metrics.hasMetricsNamed("runtime.jvm.gc.collection.count")
     metrics.hasMetricsNamed("runtime.jvm.memory.area")
     metrics.hasMetricsNamed("runtime.jvm.memory.pool")