prometheus-client-mmap 0.16.2 → 0.18.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 35a2193b5080273f3311b1a3dbaf2fcd854af38f4cc30017da7b91c0879dbaa0
-  data.tar.gz: 503c7bcfbc1acf0ff4a1dfb88e151bd71720c03569f91e4b9b61e16591ad063f
+  metadata.gz: 28745ccfcec4f7f79be0f0d64258aecf66e19e35aaf28681bf7284833fe7adfc
+  data.tar.gz: 04dd8b1fa4c8f769daff34345dbd039940af4fdf3a72d9c948893ea5e1b56835
 SHA512:
-  metadata.gz: a774996689975c51d3d763a6e7d9187ccba7238212db72762df8981b1476559cd6c92b24d20b869f7402fdcf4ee4b9256efdc46f46dc7280d80a4024baf508f5
-  data.tar.gz: a190ed7b811320c9c3f48cf084330e7347cfe173fd09deae795d991c6b3d0a7d8737940de0b50970eb34fcda61092864b4266d74d6220dad90d9c097071459f0
+  metadata.gz: 75188a0202b23b8845a4fd13e315ec0d98eab57034d32528292e886e684208a681579a14f199c9a40eed70fe62452dc83faf661941247cddeed5e9c89b826add
+  data.tar.gz: 7842632f104eadbda9a1c1733d3384aa9743dfda25c20cf98f1d0f59201900b9b3143414bfcf333e9f61c0b18e2fbe1de46be044e7b719dbe2529d57a92d1e72

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