Make it easier to push just one metric.

brian-brazil · brian-brazil · commit fe88c755b59c · 2014-11-28T17:58:49.000Z
diff --git a/README.md b/README.md
@@ -35,7 +35,7 @@ assets:
     * [PushGateway support](http://mvnrepository.com/artifact/io.prometheus.client/simpleclient_pushgateway)
       * groupId: _io.prometheus_
       * artifactId: _simpleclient_pushgateway_
-      * version: _0.0.3_
+      * version: _0.0.4_
 
 ### Getting Started
 There are canonical examples defined in the class definition Javadoc of the client packages.
diff --git a/simpleclient_pushgateway/pom.xml b/simpleclient_pushgateway/pom.xml
@@ -10,7 +10,7 @@
 
     <groupId>io.prometheus</groupId>
     <artifactId>simpleclient_pushgateway</artifactId>
-    <version>0.0.3</version>
+    <version>0.0.4</version>
 
     <name>Prometheus Java Client Metrics</name>
     <description>
diff --git a/simpleclient_pushgateway/src/main/java/io/prometheus/client/exporter/PushGateway.java b/simpleclient_pushgateway/src/main/java/io/prometheus/client/exporter/PushGateway.java
@@ -1,5 +1,6 @@
 package io.prometheus.client.exporter;
 
+import io.prometheus.client.Collector;
 import io.prometheus.client.CollectorRegistry;
 import io.prometheus.client.exporter.common.TextFormat;
 
@@ -45,6 +46,21 @@ public void push(CollectorRegistry registry, String job, String instance) throws
     doRequest(registry, job, instance, "POST");
   }
 
+  /**
+   * Pushes all metrics in a Collector, replacing all those with the same job and instance.
+   * <p>
+   * This is useful for pushing a single Gauge.
+   * <p>
+   * See the Pushgateway documentation for detailed implications of the job and
+   * instance parameter. instance can be left empty. The Pushgateway will then
+   * use the client's IP number instead. This uses the POST HTTP method.
+  */
+  public void push(Collector collector, String job, String instance) throws IOException {
+    CollectorRegistry registry = new CollectorRegistry();
+    collector.register(registry);
+    push(registry, job, instance);
+  }
+
   /**
    * Pushes all metrics in a registry, replacing only previously pushed metrics of the same name.
    * <p>
@@ -56,6 +72,21 @@ public void pushAdd(CollectorRegistry registry, String job, String instance) thr
     doRequest(registry, job, instance, "PUT");
   }
 
+  /**
+   * Pushes all metrics in a Collector, replacing only previously pushed metrics of the same name.
+   * <p>
+   * This is useful for pushing a single Gauge.
+   * <p>
+   * See the Pushgateway documentation for detailed implications of the job and
+   * instance parameter. instance can be left empty. The Pushgateway will then
+   * use the client's IP number instead. This uses the POST HTTP method.
+  */
+  public void pushAdd(Collector collector, String job, String instance) throws IOException {
+    CollectorRegistry registry = new CollectorRegistry();
+    collector.register(registry);
+    pushAdd(registry, job, instance);
+  }
+
   /**
    * Deletes metrics from the Pushgateway.
    * <p>
diff --git a/simpleclient_pushgateway/src/test/java/io/prometheus/client/exporter/PushGatewayTest.java b/simpleclient_pushgateway/src/test/java/io/prometheus/client/exporter/PushGatewayTest.java
@@ -5,6 +5,7 @@
 import static org.mockserver.model.HttpResponse.response;
 
 import io.prometheus.client.CollectorRegistry;
+import io.prometheus.client.Gauge;
 import java.io.IOException;;
 import org.junit.Before;
 import org.junit.Rule;
@@ -19,11 +20,13 @@ public class PushGatewayTest {
   private MockServerClient mockServerClient;
 
   CollectorRegistry registry;
+  Gauge gauge;
   PushGateway pg;
 
   @Before
   public void setUp() {
     registry = new CollectorRegistry();
+    gauge = (Gauge) Gauge.build().name("g").help("help").create();
     pg = new PushGateway("localhost:" + mockServerRule.getHttpPort());
   }
 
@@ -67,6 +70,16 @@ public void testPushWithSlashes() throws IOException {
     pg.push(registry, "a/b", "c/d");
   }
 
+  @Test
+  public void testPushCollector() throws IOException {
+    mockServerClient.when(
+        request()
+          .withMethod("POST")
+          .withPath("/metrics/jobs/j/instances/i")
+      ).respond(response().withStatusCode(202));
+    pg.push(gauge, "j", "i");
+  }
+
   @Test
   public void testPushAdd() throws IOException {
     mockServerClient.when(
@@ -77,6 +90,16 @@ public void testPushAdd() throws IOException {
     pg.pushAdd(registry, "j", "i");
   }
 
+  @Test
+  public void testPushAddCollector() throws IOException {
+    mockServerClient.when(
+        request()
+          .withMethod("PUT")
+          .withPath("/metrics/jobs/j/instances/i")
+      ).respond(response().withStatusCode(202));
+    pg.pushAdd(gauge, "j", "i");
+  }
+
   @Test
   public void testDelete() throws IOException {
     mockServerClient.when(
