prometheus-client-mmap 0.17.0 → 0.19.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 98e93b1f6cdd34ff4621cc7401fa1b02b6e81b069313899aabd28d1a1650cf7d
-  data.tar.gz: d0ceb3c1535fa17e609baef147217593366bd3e0351254d231848ec18653c06d
+  metadata.gz: e26d61ae108baf0e572b98abc69b02b8cccd0895c73b643205cbf478d6e95de4
+  data.tar.gz: 467ee7242543e334b937b9410ac7da68101b948ab7fb5978a28ad4bbb8013ea3
 SHA512:
-  metadata.gz: 7cc06bff586223b764f098d18c213e59f072a3ab906c7f4c2e844bcc419c9b1037d39b564d2a441a8fac50fc913107f2c5864f06fe37b15e54eb1c828cf8f118
-  data.tar.gz: 72c42e4bb89b7b0bfff4f5855ca3b42eff07c5dc1b8317940739fa0304e79eafca131c9909a80588d6ce1362313175c8a21bacb46b2ed2066114a49f8f3fdb31
+  metadata.gz: 519f9ce6487a24573c889951d7d8eac9704f6b5265331dfb2000460c4866162c9442385c9442ba1cc0e06247182f26926a68ed223bf7947f970cd0b249a3e575
+  data.tar.gz: '07282ac2f426f46a84e17dcadf6bfc95655a4b30af829d008eafc91455066812c11ec1c959bdced5b90a6b5a72eaa0ce325bf0ffc6e46dc11f7d6d6f78b50078'

data/README.md

@@ -68,29 +68,41 @@ integrated [example application](examples/rack/README.md).
 The Ruby client can also be used to push its collected metrics to a
 [Pushgateway][8]. This comes in handy with batch jobs or in other scenarios
 where it's not possible or feasible to let a Prometheus server scrape a Ruby
-process.
+process. TLS and HTTP basic authentication are supported.
 
 ```ruby
 require 'prometheus/client'
 require 'prometheus/client/push'
 
-prometheus = Prometheus::Client.registry
+registry = Prometheus::Client.registry
 # ... register some metrics, set/increment/observe/etc. their values
 
 # push the registry state to the default gateway
-Prometheus::Client::Push.new('my-batch-job').add(prometheus)
+Prometheus::Client::Push.new(job: 'my-batch-job').add(registry)
 
-# optional: specify the instance name (instead of IP) and gateway
+# optional: specify a grouping key that uniquely identifies a job instance, and gateway.
+#
+# Note: the labels you use in the grouping key must not conflict with labels set on the
+# metrics being pushed. If they do, an error will be raised.
 Prometheus::Client::Push.new(
-  'my-job', 'instance-name', 'http://example.domain:1234').add(prometheus)
+  job: 'my-batch-job',
+  gateway: 'https://example.domain:1234',
+  grouping_key: { instance: 'some-instance', extra_key: 'foobar' }
+).add(registry)
 
-# If you want to replace any previously pushed metrics for a given instance,
+# If you want to replace any previously pushed metrics for a given grouping key,
 # use the #replace method.
-Prometheus::Client::Push.new('my-batch-job', 'instance').replace(prometheus)
-
-# If you want to delete all previously pushed metrics for a given instance,
+#
+# Unlike #add, this will completely replace the metrics under the specified grouping key
+# (i.e. anything currently present in the pushgateway for the specified grouping key, but
+# not present in the registry for that grouping key will be removed).
+#
+# See https://github.com/prometheus/pushgateway#put-method for a full explanation.
+Prometheus::Client::Push.new(job: 'my-batch-job').replace(registry)
+
+# If you want to delete all previously pushed metrics for a given grouping key,
 # use the #delete method.
-Prometheus::Client::Push.new('my-batch-job', 'instance').delete
+Prometheus::Client::Push.new(job: 'my-batch-job').delete
 ```
 
 ## Metrics