Add convenience function for setting instance to the IP.

brian-brazil · brian-brazil · commit 6ddc8ade67e5 · 2015-07-09T17:50:22.000+01:00
The new pushgateway url doesn't support setting the instance to the client IP,
so for those who were doing:
pg.push(registry, "job", "");
they can now do:
pg.push(registry, "job", PushGateway.instanceIPGroupingKey());
instead in many cases.
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
@@ -5,6 +5,8 @@
 import io.prometheus.client.exporter.common.TextFormat;
 
 import java.net.HttpURLConnection;
+import java.net.InetAddress;
+import java.net.UnknownHostException;
 import java.net.URL;
 import java.net.URLEncoder;
 import java.util.Map;
@@ -275,4 +277,16 @@ void doRequest(CollectorRegistry registry, String job, Map<String, String> group
     }
   }
 
+  /**
+   * Returns a grouping key with the instance label set to the machine's IP address.
+   * <p>
+   * This is a convenience function, and should only be used where you want to
+   * push per-instance metrics rather than cluster/job level metrics.
+  */
+  public static Map<String, String> instanceIPGroupingKey() throws UnknownHostException {
+    Map<String, String> groupingKey = new HashMap<String, String>();
+    groupingKey.put("instance", InetAddress.getLocalHost().getHostAddress());
+    return groupingKey;
+  }
+
 }
diff --git a/simpleclient_pushgateway/src/test/java/io/prometheus/client/exporter/ExamplePushGateway.java b/simpleclient_pushgateway/src/test/java/io/prometheus/client/exporter/ExamplePushGateway.java
@@ -14,7 +14,7 @@ public class ExamplePushGateway {
   public static void main(String[] args) throws Exception {
     PushGateway pg = new PushGateway(args[0]);
     g.set(42);
-    pg.push(pushRegistry, "job", "instance");
+    pg.push(pushRegistry, "job");
   }
 }
 
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
@@ -9,6 +9,7 @@
 import java.io.IOException;;
 import java.util.TreeMap;
 import java.util.Map;
+import org.junit.Assert;
 import org.junit.Before;
 import org.junit.Rule;
 import org.junit.Test;
@@ -248,4 +249,10 @@ public void testOldDelete() throws IOException {
       ).respond(response().withStatusCode(202));
     pg.delete("j", "i");
   }
+
+  @Test
+  public void testInstanceIPGroupingKey() throws IOException {
+    groupingKey = PushGateway.instanceIPGroupingKey();
+    Assert.assertTrue(!groupingKey.get("instance").equals(""));
+  }
 }

Original file line number	Diff line number	Diff line change
`@@ -14,7 +14,7 @@ public class ExamplePushGateway {`
`14`	`14`	`public static void main(String[] args) throws Exception {`
`15`	`15`	`PushGateway pg = new PushGateway(args[0]);`
`16`	`16`	`g.set(42);`
`17`		`- pg.push(pushRegistry, "job", "instance");`
	`17`	`+ pg.push(pushRegistry, "job");`
`18`	`18`	`}`
`19`	`19`	`}`
`20`	`20`