prometheus_exporter 0.1.11 → 0.1.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0f8cdad15069a123e796605403a905e67ba6b0310961fecf5e9eb0a96d3f1d9e
-  data.tar.gz: 2b5c3584a871a670dbbb2166e801de402a279164261281a3693769bef705fe37
+  metadata.gz: 2b09dff4a49846230b74243135fcacc1d88b440b04b69e76cf4dce76bd3eaa90
+  data.tar.gz: fb48d9cecb4d0ed600c00c8c8265ec88f4ab8b0e81369adf08eaee478895c337
 SHA512:
-  metadata.gz: ee0180cc0497889ca30f6f9920be065a35cbad7553a6ceddbfbb3647c8fc9e92f9a61b72973671232e07f5326b182460bd7e841c02f4e82cf73e311d451e7903
-  data.tar.gz: 0607ff6aca87265054f28f0a187186bfd55472a8271a7184c81ef82ee4f3febabde16ca354e634a953c31c5d989befb0ed5adaf5e95ed4e68bb7b1ad85d3c7f6
+  metadata.gz: 777e3913f7fd24cd455af42e6ac1d73b98ef6a803189c43443f2d3d517bf4aa540b3be994d99afbb5060bc83ff83ed42be2037217b14522d848918891d64cb1c
+  data.tar.gz: bcbde54a95042c01a80e297ca6096444574d9e8c1d17027759469e51f4ff36b8b23cf574f6111034233805546e7f7a73e8cc8922b96f787191b4bdb345e8dbfa

data/README.md

@@ -155,6 +155,50 @@ Ensure you run the exporter in a monitored background process via
 % bundle exec prometheus_exporter
 ```
 
+### Custom type collectors
+
+In some cases you may have custom metrics you want to ship the collector in a batch, in this case you may still be interested in the base collector behavior but would like to add your own special messages.
+
+```ruby
+# person_collector.rb
+class PersonCollector < PrometheusExporter::Server::TypeCollector
+  def initialize
+    @oldies = PrometheusExporter::Metric::Counter.new("oldies", "old people")
+    @youngies = PrometheusExporter::Metric::Counter.new("youngies", "young people")
+  end
+
+  def type
+    "person"
+  end
+
+  def collect(obj)
+    if obj["age"] > 21
+      @oldies.observe(1)
+    else
+      @youngies.observe(1)
+    end
+  end
+
+  def metrics
+    [@oldies, @youngies]
+  end
+end
+```
+
+Shipping metrics then is done via:
+
+```
+PrometheusExporter::Client.default.send_json(type: "person", age: 40)
+```
+
+To load the custom collector run:
+
+
+```
+bundle exec prometheus_exporter -a person_collector.rb
+
+```
+
 ### Multi process mode with custom collector
 
 You can opt for custom collector logic in a multi process environment.

data/lib/prometheus_exporter/server/collector.rb

@@ -38,7 +38,7 @@ module PrometheusExporter::Server
       obj = JSON.parse(str)
       @mutex.synchronize do
         if collector = @collectors[obj["type"]]
-          collector.observe(obj)
+          collector.collect(obj)
         else
           metric = @metrics[obj["name"]]
           if !metric

data/lib/prometheus_exporter/server/process_collector.rb

@@ -56,7 +56,7 @@ module PrometheusExporter::Server
       metrics.values
     end
 
-    def observe(obj)
+    def collect(obj)
       now = ::Process.clock_gettime(::Process::CLOCK_MONOTONIC)
 
       obj["created_at"] = now

data/lib/prometheus_exporter/server/sidekiq_collector.rb

@@ -5,7 +5,7 @@ module PrometheusExporter::Server
       "sidekiq"
     end
 
-    def observe(obj)
+    def collect(obj)
       ensure_sidekiq_metrics
       @sidekiq_job_duration_seconds.observe(obj["duration"], job_name: obj["name"])
       @sidekiq_job_count.observe(1, job_name: obj["name"])

data/lib/prometheus_exporter/version.rb

@@ -1,3 +1,3 @@
 module PrometheusExporter
-  VERSION = "0.1.11"
+  VERSION = "0.1.12"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: prometheus_exporter
 version: !ruby/object:Gem::Version
-  version: 0.1.11
+  version: 0.1.12
 platform: ruby
 authors:
 - Sam Saffron
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-31 00:00:00.000000000 Z
+date: 2018-02-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler