Build upon Michal's work for jvm stats.

brian-brazil · brian-brazil · commit 5638a2a0fca8 · 2015-02-09T15:53:13.000Z
Spaces are okay in label values, no need to switch to hyphens.
Export committed and max separately.
Inline rather than using constants, so it's easier to read.
Use a summary for GC stats.

Add a way to pick up current and future jvm collectors.
diff --git a/AUTHORS.md b/AUTHORS.md
@@ -14,4 +14,5 @@ The following individuals have contributed code to this repository
 * Flavio W. Brasil <fwbrasil@gmail.com>
 * Julius Volz <julius@soundcloud.com>
 * Matt T. Proud <matt.proud@gmail.com>
+* Michal Witkowski <michal@improbable.io>
 * Ursula Kallio <ursula@soundcloud.com>
diff --git a/simpleclient_hotspot/src/main/java/io/prometheus/client/hotspot/DefaultExports.java b/simpleclient_hotspot/src/main/java/io/prometheus/client/hotspot/DefaultExports.java
@@ -0,0 +1,30 @@
+package io.prometheus.client.hotspot;
+
+/**
+ * Registers the default Hotspot collectors.
+ * <p>
+ * This is intended to avoid users having to add in new
+ * registrations every time a new exporter is added.
+ * <p>
+ * Example usage:
+ * <pre>
+ * {@code
+ *   DefaultExports().initialize();
+ * }
+ * </pre>
+ */
+public class DefaultExports {
+  private static boolean initialized = false;
+  /**
+   * Register the default Hotspot collectors.
+   */
+  public static synchronized void initialize() {
+    if (!initialized) {
+      new StandardExports().register();
+      new MemoryPoolsExports().register();
+      new GarbageCollectorExports().register();
+      initialized = true;
+    }
+  }
+
+}
diff --git a/simpleclient_hotspot/src/main/java/io/prometheus/client/hotspot/GarbageCollectorExports.java b/simpleclient_hotspot/src/main/java/io/prometheus/client/hotspot/GarbageCollectorExports.java
@@ -21,19 +21,11 @@
  * </pre>
  * Example metrics being exported:
  * <pre>
- *   jvm_gc_collections{gc="PS1} 200
- *   jvm_gc_collections_time{gc="PS1} 6.7
+ *   jvm_gc_collection_seconds_count{gc="PS1"} 200
+ *   jvm_gc_collection_seconds_sum{gc="PS1"} 6.7
  * </pre>
  */
 public class GarbageCollectorExports extends Collector {
-  private static final Pattern WHITESPACE = Pattern.compile("[\\s]+");
-  static final String COLLECTIONS_COUNT_METRIC = "jvm_gc_collections";
-  static final String COLLECTIONS_TIME_METRIC = "jvm_gc_collections_time";
-  static final List<String> LABEL_NAMES = Arrays.asList("gc");
-  private static final List<String> DEFAULT_LABEL = Arrays.asList("unknown");
-
-  private final HashMap<GarbageCollectorMXBean, List<String>> labelValues =
-      new HashMap<GarbageCollectorMXBean, List<String>>();
   private final List<GarbageCollectorMXBean> garbageCollectors;
 
   public GarbageCollectorExports() {
@@ -42,52 +34,30 @@ public GarbageCollectorExports() {
 
   GarbageCollectorExports(List<GarbageCollectorMXBean> garbageCollectors) {
     this.garbageCollectors = garbageCollectors;
-    for (final GarbageCollectorMXBean gc : garbageCollectors) {
-      if (!labelValues.containsKey(gc)) {
-        String gcName = WHITESPACE.matcher(gc.getName()).replaceAll("-");
-        labelValues.put(gc, Arrays.asList(gcName));
-      }
-    }
   }
 
-  MetricFamilySamples collectorCountMetric() {
+  public List<MetricFamilySamples> collect() {
     ArrayList<MetricFamilySamples.Sample> samples = new ArrayList<MetricFamilySamples.Sample>();
     for (final GarbageCollectorMXBean gc : garbageCollectors) {
       samples.add(
           new MetricFamilySamples.Sample(
-              COLLECTIONS_COUNT_METRIC,
-              LABEL_NAMES,
-              labelValues.getOrDefault(gc, DEFAULT_LABEL),
-              gc.getCollectionCount()));
-    }
-    return new MetricFamilySamples(
-        COLLECTIONS_COUNT_METRIC,
-        Type.COUNTER,
-        "Number of collections of a given JVM garbage collector.",
-        samples);
-  }
-
-  MetricFamilySamples collectorTimeMetric() {
-    ArrayList<MetricFamilySamples.Sample> samples = new ArrayList<MetricFamilySamples.Sample>();
-    for (final GarbageCollectorMXBean gc : garbageCollectors) {
+              "jvm_gc_collection_seconds_sum",
+              Arrays.asList("gc"),
+              Arrays.asList(gc.getName()),
+              gc.getCollectionTime() / MILLISECONDS_PER_SECOND));
       samples.add(
           new MetricFamilySamples.Sample(
-              COLLECTIONS_TIME_METRIC,
-              LABEL_NAMES,
-              labelValues.getOrDefault(gc, DEFAULT_LABEL),
-              gc.getCollectionTime() / MILLISECONDS_PER_SECOND));
+              "jvm_gc_collection_seconds_count",
+              Arrays.asList("gc"),
+              Arrays.asList(gc.getName()),
+              gc.getCollectionCount()));
     }
-    return new MetricFamilySamples(
-        COLLECTIONS_TIME_METRIC,
-        Type.COUNTER,
-        "Accumulated time (s) spent in a given JVM garbage collector.",
-        samples);
-  }
-
-  public List<MetricFamilySamples> collect() {
     List<MetricFamilySamples> mfs = new ArrayList<MetricFamilySamples>();
-    mfs.add(collectorCountMetric());
-    mfs.add(collectorTimeMetric());
+    mfs.add(new MetricFamilySamples(
+        "jvm_gc_collection_seconds",
+        Type.SUMMARY,
+        "Time spent in a given JVM garbage collector in seconds.",
+        samples));
 
     return mfs;
   }
diff --git a/simpleclient_hotspot/src/main/java/io/prometheus/client/hotspot/MemoryPoolsExports.java b/simpleclient_hotspot/src/main/java/io/prometheus/client/hotspot/MemoryPoolsExports.java
@@ -23,25 +23,13 @@
  * </pre>
  * Example metrics being exported:
  * <pre>
- *   jvm_memory_used{area="heap} 2000000
- *   jvm_memory_limit{area="nonheap"} 200000
- *   jvm_memory_pool_used{pool="PS-Eden-Space"} 2000
+ *   jvm_memory_bytes_used{area="heap"} 2000000
+ *   jvm_memory_bytes_committed{area="nonheap"} 200000
+ *   jvm_memory_bytes_max{area="nonheap"} 2000000
+ *   jvm_memory_pool_bytes_used{pool="PS Eden Space"} 2000
  * </pre>
  */
 public class MemoryPoolsExports extends Collector {
-  private static final Pattern WHITESPACE = Pattern.compile("[\\s]+");
-  static final String MEMORY_USED_METRIC = "jvm_memory_used";
-  static final String MEMORY_LIMIT_METRIC = "jvm_memory_limit";
-  static final String POOLS_USED_METRIC = "jvm_memory_pool_used";
-  static final String POOLS_LIMIT_METRIC = "jvm_memory_pool_limit";
-
-  private static final List<String> MEMORY_LABEL_NAMES = Arrays.asList("area");
-  private static final List<String> MEMORY_HEAP_LABEL = Arrays.asList("heap");
-  private static final List<String> MEMORY_NONHEAP_LABEL = Arrays.asList("nonheap");
-
-  private static final List<String> POOLS_LABEL_NAMES = Arrays.asList("pool");
-
-  private final HashMap<MemoryPoolMXBean, List<String>> poolLabelValues = new HashMap<MemoryPoolMXBean, List<String>>();
   private final MemoryMXBean memoryBean;
   private final List<MemoryPoolMXBean> poolBeans;
 
@@ -55,12 +43,6 @@ public MemoryPoolsExports(MemoryMXBean memoryBean,
                              List<MemoryPoolMXBean> poolBeans) {
     this.memoryBean = memoryBean;
     this.poolBeans = poolBeans;
-    for (final MemoryPoolMXBean pool : poolBeans) {
-      if (!poolLabelValues.containsKey(pool)) {
-        String gcName = WHITESPACE.matcher(pool.getName()).replaceAll("-");
-        poolLabelValues.put(pool, Arrays.asList(gcName));
-      }
-    }
   }
 
   void addMemoryAreaMetrics(List<MetricFamilySamples> sampleFamilies) {
@@ -69,74 +51,107 @@ void addMemoryAreaMetrics(List<MetricFamilySamples> sampleFamilies) {
     ArrayList<MetricFamilySamples.Sample> usedSamples = new ArrayList<MetricFamilySamples.Sample>();
     usedSamples.add(
         new MetricFamilySamples.Sample(
-            MEMORY_USED_METRIC,
-            MEMORY_LABEL_NAMES,
-            MEMORY_HEAP_LABEL,
+            "jvm_memory_bytes_used",
+            Arrays.asList("area"),
+            Arrays.asList("heap"),
             heapUsage.getUsed()));
     usedSamples.add(
         new MetricFamilySamples.Sample(
-            MEMORY_USED_METRIC,
-            MEMORY_LABEL_NAMES,
-            MEMORY_NONHEAP_LABEL,
+            "jvm_memory_bytes_used",
+            Arrays.asList("area"),
+            Arrays.asList("nonheap"),
             nonHeapUsage.getUsed()));
     sampleFamilies.add(
         new MetricFamilySamples(
-            MEMORY_USED_METRIC,
+            "jvm_memory_bytes_used",
             Type.GAUGE,
-            "Used bytes of a given JVM memory area (heap, nonheap).",
+            "Used bytes of a given JVM memory area.",
             usedSamples));
-    ArrayList<MetricFamilySamples.Sample> limitSamples = new ArrayList<MetricFamilySamples.Sample>();
-    limitSamples.add(
+    ArrayList<MetricFamilySamples.Sample> committedSamples = new ArrayList<MetricFamilySamples.Sample>();
+    committedSamples.add(
         new MetricFamilySamples.Sample(
-            MEMORY_LIMIT_METRIC,
-            MEMORY_LABEL_NAMES,
-            MEMORY_HEAP_LABEL,
-            heapUsage.getMax() == -1 ? heapUsage.getMax() : heapUsage.getCommitted()));
-    limitSamples.add(
+            "jvm_memory_bytes_committed",
+            Arrays.asList("area"),
+            Arrays.asList("heap"),
+            heapUsage.getCommitted()));
+    committedSamples.add(
         new MetricFamilySamples.Sample(
-            MEMORY_LIMIT_METRIC,
-            MEMORY_LABEL_NAMES,
-            MEMORY_NONHEAP_LABEL,
-            nonHeapUsage.getMax() == -1 ? nonHeapUsage.getMax() : nonHeapUsage.getCommitted()));
+            "jvm_memory_bytes_committed",
+            Arrays.asList("area"),
+            Arrays.asList("nonheap"),
+            nonHeapUsage.getCommitted()));
     sampleFamilies.add(
         new MetricFamilySamples(
-            MEMORY_LIMIT_METRIC,
+            "jvm_memory_bytes_committed",
             Type.GAUGE,
-            "Limit (bytes) of a given JVM memory area (heap, nonheap).",
-            limitSamples));
+            "Committed (bytes) of a given JVM memory area.",
+            committedSamples));
+    ArrayList<MetricFamilySamples.Sample> maxSamples = new ArrayList<MetricFamilySamples.Sample>();
+    maxSamples.add(
+        new MetricFamilySamples.Sample(
+            "jvm_memory_bytes_max",
+            Arrays.asList("area"),
+            Arrays.asList("heap"),
+            heapUsage.getMax()));
+    maxSamples.add(
+        new MetricFamilySamples.Sample(
+            "jvm_memory_bytes_max",
+            Arrays.asList("area"),
+            Arrays.asList("nonheap"),
+            nonHeapUsage.getMax()));
+    sampleFamilies.add(
+        new MetricFamilySamples(
+            "jvm_memory_bytes_max",
+            Type.GAUGE,
+            "Maximum (bytes) of a given JVM memory area.",
+            maxSamples));
   }
 
   void addMemoryPoolMetrics(List<MetricFamilySamples> sampleFamilies) {
     ArrayList<MetricFamilySamples.Sample> usedSamples = new ArrayList<MetricFamilySamples.Sample>();
-    ArrayList<MetricFamilySamples.Sample> limitSamples = new ArrayList<MetricFamilySamples.Sample>();
+    ArrayList<MetricFamilySamples.Sample> committedSamples = new ArrayList<MetricFamilySamples.Sample>();
+    ArrayList<MetricFamilySamples.Sample> maxSamples = new ArrayList<MetricFamilySamples.Sample>();
     for (final MemoryPoolMXBean pool : poolBeans) {
       MemoryUsage poolUsage = pool.getUsage();
       usedSamples.add(
           new MetricFamilySamples.Sample(
-              POOLS_USED_METRIC,
-              POOLS_LABEL_NAMES,
-              poolLabelValues.get(pool),
+              "jvm_memory_pool_bytes_used",
+              Arrays.asList("pool"),
+              Arrays.asList(pool.getName()),
               poolUsage.getUsed()));
-      limitSamples.add(
+      committedSamples.add(
           new MetricFamilySamples.Sample(
-              POOLS_LIMIT_METRIC,
-              POOLS_LABEL_NAMES,
-              poolLabelValues.get(pool),
-              poolUsage.getMax() != -1 ? poolUsage.getMax() : poolUsage.getCommitted()));
+              "jvm_memory_pool_bytes_committed",
+              Arrays.asList("pool"),
+              Arrays.asList(pool.getName()),
+              poolUsage.getCommitted()));
+      maxSamples.add(
+          new MetricFamilySamples.Sample(
+              "jvm_memory_pool_bytes_max",
+              Arrays.asList("pool"),
+              Arrays.asList(pool.getName()),
+              poolUsage.getMax()));
     }
     sampleFamilies.add(
         new MetricFamilySamples(
-            POOLS_USED_METRIC,
+            "jvm_memory_pool_bytes_used",
             Type.GAUGE,
             "Used bytes of a given JVM memory pool.",
             usedSamples));
 
     sampleFamilies.add(
         new MetricFamilySamples(
-            POOLS_LIMIT_METRIC,
+            "jvm_memory_pool_bytes_committed",
             Type.GAUGE,
             "Limit (bytes) of a given JVM memory pool.",
-            limitSamples));
+            committedSamples));
+
+    sampleFamilies.add(
+        new MetricFamilySamples(
+            "jvm_memory_pool_bytes_max",
+            Type.GAUGE,
+            "Max (bytes) of a given JVM memory pool.",
+            maxSamples));
   }
 
 
diff --git a/simpleclient_hotspot/src/test/java/io/prometheus/client/hotspot/ExampleExporter.java b/simpleclient_hotspot/src/test/java/io/prometheus/client/hotspot/ExampleExporter.java
@@ -6,18 +6,18 @@
 import org.eclipse.jetty.servlet.ServletContextHandler;
 import org.eclipse.jetty.servlet.ServletHolder;
 
+
 public class ExampleExporter {
 
   public static void main(String[] args) throws Exception {
-    new StandardExports().register();
+    DefaultExports.initialize();
     Server server = new Server(1234);
     ServletContextHandler context = new ServletContextHandler();
     context.setContextPath("/");
     server.setHandler(context);
     context.addServlet(new ServletHolder(new MetricsServlet()), "/metrics");
     server.start();
-    while(true) {
-    }
+    server.join();
   }
 
 }
diff --git a/simpleclient_hotspot/src/test/java/io/prometheus/client/hotspot/GarbageCollectorExportsTest.java b/simpleclient_hotspot/src/test/java/io/prometheus/client/hotspot/GarbageCollectorExportsTest.java
@@ -11,6 +11,7 @@
 import java.util.concurrent.TimeUnit;
 
 import static org.junit.Assert.assertEquals;
+import static org.mockito.Mockito.when;
 
 
 public class GarbageCollectorExportsTest {
@@ -23,12 +24,12 @@ public class GarbageCollectorExportsTest {
 
   @Before
   public void setUp() {
-    Mockito.when(mockGcBean1.getName()).thenReturn("MyGC1");
-    Mockito.when(mockGcBean1.getCollectionCount()).thenReturn(100L);
-    Mockito.when(mockGcBean1.getCollectionTime()).thenReturn(TimeUnit.SECONDS.toMillis(10));
-    Mockito.when(mockGcBean2.getName()).thenReturn("MyGC2");
-    Mockito.when(mockGcBean2.getCollectionCount()).thenReturn(200L);
-    Mockito.when(mockGcBean2.getCollectionTime()).thenReturn(TimeUnit.SECONDS.toMillis(20));
+    when(mockGcBean1.getName()).thenReturn("MyGC1");
+    when(mockGcBean1.getCollectionCount()).thenReturn(100L);
+    when(mockGcBean1.getCollectionTime()).thenReturn(TimeUnit.SECONDS.toMillis(10));
+    when(mockGcBean2.getName()).thenReturn("MyGC2");
+    when(mockGcBean2.getCollectionCount()).thenReturn(200L);
+    when(mockGcBean2.getCollectionTime()).thenReturn(TimeUnit.SECONDS.toMillis(20));
     collectorUnderTest = new GarbageCollectorExports(mockList).register(registry);
   }
 
@@ -37,28 +38,28 @@ public void testGarbageCollectorExports() {
     assertEquals(
         100L,
         registry.getSampleValue(
-            GarbageCollectorExports.COLLECTIONS_COUNT_METRIC,
+            "jvm_gc_collection_seconds_count",
             new String[]{"gc"},
             new String[]{"MyGC1"}),
         .0000001);
     assertEquals(
         10d,
         registry.getSampleValue(
-            GarbageCollectorExports.COLLECTIONS_TIME_METRIC,
+            "jvm_gc_collection_seconds_sum",
             new String[]{"gc"},
             new String[]{"MyGC1"}),
         .0000001);
     assertEquals(
         200L,
         registry.getSampleValue(
-            GarbageCollectorExports.COLLECTIONS_COUNT_METRIC,
+            "jvm_gc_collection_seconds_count",
             new String[]{"gc"},
             new String[]{"MyGC2"}),
         .0000001);
     assertEquals(
         20d,
         registry.getSampleValue(
-            GarbageCollectorExports.COLLECTIONS_TIME_METRIC,
+            "jvm_gc_collection_seconds_sum",
             new String[]{"gc"},
             new String[]{"MyGC2"}),
         .0000001);
diff --git a/simpleclient_hotspot/src/test/java/io/prometheus/client/hotspot/MemoryPoolsExportsTest.java b/simpleclient_hotspot/src/test/java/io/prometheus/client/hotspot/MemoryPoolsExportsTest.java
diff --git a/simpleclient_hotspot/src/test/java/io/prometheus/client/hotspot/StandardExportsTest.java b/simpleclient_hotspot/src/test/java/io/prometheus/client/hotspot/StandardExportsTest.java

-Original file line number
+Diff line change
 * Flavio W. Brasil <[email protected]>
 * Julius Volz <[email protected]>
 * Matt T. Proud <[email protected]>
 +* Michal Witkowski <[email protected]>
 * Ursula Kallio <[email protected]>