prometheus_exporter 0.1.8 → 0.1.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f90837db285b202f06d0f7360fe0260435a51457361cfbe505e473b573367fc6
-  data.tar.gz: 9ab075f33187b5cc7563e1236572870d8ce98b421fec46d989b7b00d968ef241
+  metadata.gz: 86a92ab30771272b941d1d453d9a48ec06b77f614ec966490702c270b90e369b
+  data.tar.gz: c606f0aacbcd0d79607ae3ea7f4bbe63b2632c4c431a8f9d19a86d8b072a8543
 SHA512:
-  metadata.gz: 3b34b7b622d684ea9b25f4e8b223cd69b11df7686834a72b0e7f899a1b90bc691194a6bf7695ac0778dd88dba860245981977c67f10b214a9b5f9dcfbf0f31c7
-  data.tar.gz: 2ecc3d186fa4de3bce308b87f5cab0b1c95f336efc72819e08e6cd1258f2b5ef5b381d8347d686e85eb1a18ac8890d4230479e3f9234889d0631ec4034beab2a
+  metadata.gz: 58ec62718537d203ebb9cfa2b2f52ce02ffd878c15845d4fba8a5f0e9c505719b5567af123d075f8e88ff6afed7efdff282178a67a552a335255376cf5799ecd
+  data.tar.gz: 2058b506f5485c86033a9534642a8740852dd351dc43a04cb5eb10fb78921bb7dc85a74505d0830b0c4d7b1abcc722ababcc0d3a2c20f6307ed608af9a38f706

data/README.md

@@ -113,8 +113,8 @@ gem 'prometheus_exporter'
 
 unless Rails.env == "test"
   require 'prometheus_exporter/middleware'
-  # insert in position 1
-  # instrument means method profiler will be injected in Redis and PG
+
+  # This reports stats per request like HTTP status and timings
   Rails.application.middleware.unshift PrometheusExporter::Middleware
 end
 ```
@@ -125,9 +125,12 @@ You may also be interested in per-process stats, this collects memory and GC sta
 # in an initializer
 unless Rails.env == "test"
   require 'prometheus_exporter/instrumentation'
+
+  # this reports basic process stats like RSS and GC info
   PrometheusExporter::Instrumentation::Process.start(type: "master")
 end
 
+# in unicorn/puma/passenger be sure to run a new process instrumenter after fork
 after_fork do
   require 'prometheus_exporter/instrumentation'
   PrometheusExporter::Instrumentation::Process.start(type:"web")
@@ -135,7 +138,18 @@ end
 
 ```
 
-Ensure you run the exporter via
+Including Sidekiq metrics (how many jobs ran? how many failed? how long did they take?)
+
+```
+Sidekiq.configure_server do |config|
+   config.server_middleware do |chain|
+      require 'prometheus_exporter/instrumentation'
+      chain.add PrometheusExporter::Instrumentation::Sidekiq
+   end
+end
+```
+
+Ensure you run the exporter in a monitored background process via
 
 ```
 % bundle exec prometheus_exporter

data/lib/prometheus_exporter/instrumentation/sidekiq.rb

@@ -0,0 +1,25 @@
+module PrometheusExporter::Instrumentation
+  class Sidekiq
+
+    def initialize(client: nil)
+      @client = client || PrometheusExporter::Client.default
+    end
+
+    def call(worker, msg, queue)
+      success = false
+      start = ::Process.clock_gettime(::Process::CLOCK_MONOTONIC)
+      result = yield
+      success = true
+      result
+    ensure
+      duration = ::Process.clock_gettime(::Process::CLOCK_MONOTONIC) - start
+
+      @client.send_json(
+        type: "sidekiq",
+        name: worker.class.to_s,
+        success: success,
+        duration: duration
+      )
+    end
+  end
+end

data/lib/prometheus_exporter/instrumentation.rb

@@ -1,2 +1,4 @@
 require_relative "instrumentation/process"
 require_relative "instrumentation/method_profiler"
+require_relative "instrumentation/sidekiq"
+require_relative "instrumentation/global"

data/lib/prometheus_exporter/server/collector.rb

@@ -34,6 +34,8 @@ module PrometheusExporter::Server
           observe_web(obj)
         elsif obj["type"] == "process"
           observe_process(obj)
+        elsif obj["type"] == "sidekiq"
+          observe_sidekiq(obj)
         else
           metric = @metrics[obj["name"]]
           if !metric
@@ -145,6 +147,33 @@ module PrometheusExporter::Server
       @process_metrics << obj
     end
 
+    def observe_sidekiq(obj)
+      ensure_sidekiq_metrics
+      @sidekiq_job_duration_seconds.observe(obj["duration"], job_name: obj["name"])
+      @sidekiq_job_count.observe(1, job_name: obj["name"])
+      @sidekiq_failed_job_count.observe(1, job_name: obj["name"]) if !obj["success"]
+    end
+
+    def ensure_sidekiq_metrics
+      if !@sidekiq_job_count
+
+        @metrics["sidekiq_job_duration_seconds"] =
+          @sidekiq_job_duration_seconds =
+          PrometheusExporter::Metric::Counter.new(
+            "sidekiq_job_duration_seconds", "Total time spent in sidekiq jobs")
+
+        @metrics["sidekiq_job_count"] =
+          @sidekiq_job_count =
+          PrometheusExporter::Metric::Counter.new(
+            "sidekiq_job_count", "Total number of sidekiq jobs executed")
+
+        @metrics["sidekiq_failed_job_count"] =
+          @sidekiq_failed_job_count =
+          PrometheusExporter::Metric::Counter.new(
+            "sidekiq_failed_job_count", "Total number failed sidekiq jobs executed")
+      end
+    end
+
     def register_metric_unsafe(obj)
       name = obj["name"]
       help = obj["help"]

data/lib/prometheus_exporter/version.rb

@@ -1,3 +1,3 @@
 module PrometheusExporter
-  VERSION = "0.1.8"
+  VERSION = "0.1.9"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: prometheus_exporter
 version: !ruby/object:Gem::Version
-  version: 0.1.8
+  version: 0.1.9
 platform: ruby
 authors:
 - Sam Saffron
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-30 00:00:00.000000000 Z
+date: 2018-01-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -117,8 +117,10 @@ files:
 - lib/prometheus_exporter.rb
 - lib/prometheus_exporter/client.rb
 - lib/prometheus_exporter/instrumentation.rb
+- lib/prometheus_exporter/instrumentation/global.rb
 - lib/prometheus_exporter/instrumentation/method_profiler.rb
 - lib/prometheus_exporter/instrumentation/process.rb
+- lib/prometheus_exporter/instrumentation/sidekiq.rb
 - lib/prometheus_exporter/metric.rb
 - lib/prometheus_exporter/metric/base.rb
 - lib/prometheus_exporter/metric/counter.rb