prometheus_exporter 0.3.1 → 0.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ab23e225a84eae5cc41b7c74e5590781cdcfddf15390848df761750c15b38f35
-  data.tar.gz: 193032ba1f46d910ed9d18c3d60c721513d24a952fe1912cc972fe030dcd9676
+  metadata.gz: 884ad6656dc8d2b784711db6e057cf9743cc93a4bb7d9bc978b06e90441978a1
+  data.tar.gz: 34fbcbba98564562c49ea99dcffa95403224d6c85f372686426bed005d5a64e2
 SHA512:
-  metadata.gz: 5b11c5f1c4f989ab529f4d99beec7d60066d656ea59ce7e474939d68de8723e20e7e5ff17ae63d8bb3ba1e74f51703f2f733b2e57fe4b0484badd692f8af8632
-  data.tar.gz: 3086862d65a45a60b71d6e0c4ebd358eac472f8a5d463701f26fad879cd1da0def826ee6867c0153a5adbb7d4c8cf4a3f60ad7a2038b252d8e3d01677d8bc7ef
+  metadata.gz: 243a116fd665dea9bb6b9ed2d350a07a3819b512be4320993caa4b3a1038987c9232b325ff605f9495b75c33626dab2a0ba56d7fd6b0f3119d23156086391c72
+  data.tar.gz: 26630637bbcbfcd92d5c3ec3ccef0ffe9e88b1d8822e2df7c1e76aef9c0ae2bae730e4f6125dd9d169679cb8336f03e6129f0eeb7f2f6ad7e0aa6d3ec886c8aa

data/.travis.yml

@@ -1,5 +1,6 @@
-sudo: false
+sudo: required
 language: ruby
+dist: trusty
 rvm:
   - 2.5.0
 before_install: gem install bundler -v 1.16.1

data/CHANGELOG

@@ -1,3 +1,11 @@
+0.3.3
+
+- Feature: Add more metrics to delayed job collector
+
+0.3.2
+
+- Feature: Add posibility to set custom_labels on multi process mode
+
 0.3.1
 
 - Allow runner to accept a --timeout var

data/README.md

@@ -157,6 +157,17 @@ Sidekiq.configure_server do |config|
 end
 ```
 
+To monitor Sidekiq process info
+
+```ruby
+Sidekiq.configure_server do |config|
+  config.on :startup do
+    require 'prometheus_exporter/instrumentation'
+    PrometheusExporter::Instrumentation::Process.start type: 'sidekiq'
+  end
+end
+```
+
 It also comes with a DelayedJob plugin.
 
 ```ruby
@@ -322,6 +333,12 @@ thing1 122
 thing2 12
 ```
 
+### GraphQL support
+
+GraphQL execution metrics are [supported](https://github.com/rmosolgo/graphql-ruby/blob/master/guides/queries/tracing.md#prometheus) and can be collected via the GraphQL
+collector, included in [graphql-ruby](https://github.com/rmosolgo/graphql-ruby)
+
+
 ### Metrics default prefix / labels
 
 _This only works in single process mode_
@@ -350,6 +367,26 @@ ruby_web_requests{hostname="app-server-01",route="test/route"} 1
 ruby_web_requests{hostname="app-server-01"} 1
 ```
 
+### Client default labels
+
+You can specify a default label for the instrumentation metrics sent by an specific client, for example:
+
+```ruby
+# Specify on intializing PrometheusExporter::Client
+PrometheusExporter::Client.new(custom_labels: { hostname: 'app-server-01', app_name: 'app-01' })
+
+# Specify on an instance of PrometheusExporter::Client
+client = PrometheusExporter::Client.new
+client.custom_labels = { hostname: 'app-server-01', app_name: 'app-01' }
+```
+
+Will result in:
+
+```
+http_requests_total{controller="home","action"="index",service="app-server-01",app_name="app-01"} 2
+http_requests_total{service="app-server-01",app_name="app-01"} 1
+```
+
 ## Transport concerns
 
 Prometheus Exporter handles transport using a simple HTTP protocol. In multi process mode we avoid needing a large number of HTTP request by using chunked encoding to send metrics. This means that a single HTTP channel can deliver 100s or even 1000s of metrics over a single HTTP session to the `/send-metrics` endpoint. All calls to `send` and `send_json` on the PrometheusExporter::Client class are **non-blocking** and batched.

data/lib/prometheus_exporter/client.rb

@@ -35,7 +35,7 @@ class PrometheusExporter::Client
   MAX_SOCKET_AGE = 25
   MAX_QUEUE_SIZE = 10_000
 
-  def initialize(host: 'localhost', port: PrometheusExporter::DEFAULT_PORT, max_queue_size: nil, thread_sleep: 0.5, json_serializer: nil)
+  def initialize(host: 'localhost', port: PrometheusExporter::DEFAULT_PORT, max_queue_size: nil, thread_sleep: 0.5, json_serializer: nil, custom_labels: nil)
     @metrics = []
 
     @queue = Queue.new
@@ -57,6 +57,12 @@ class PrometheusExporter::Client
     @thread_sleep = thread_sleep
 
     @json_serializer = json_serializer == :oj ? PrometheusExporter::OjCompat : JSON
+
+    @custom_labels = custom_labels
+  end
+
+  def custom_labels=(custom_labels)
+    @custom_labels = custom_labels
   end
 
   def register(type, name, help)
@@ -66,7 +72,8 @@ class PrometheusExporter::Client
   end
 
   def send_json(obj)
-    send(@json_serializer.dump(obj))
+    payload = @custom_labels.nil? ? obj : obj.merge(custom_labels: @custom_labels)
+    send(@json_serializer.dump(payload))
   end
 
   def send(str)

data/lib/prometheus_exporter/instrumentation/delayed_job.rb

@@ -10,7 +10,8 @@ module PrometheusExporter::Instrumentation
         plugin = Class.new(Delayed::Plugin) do
           callbacks do |lifecycle|
             lifecycle.around(:invoke_job) do |job, *args, &block|
-              instrumenter.call(job, *args, &block)
+              max_attempts = Delayed::Worker.max_attempts
+              instrumenter.call(job, max_attempts, *args, &block)
             end
           end
         end
@@ -23,9 +24,10 @@ module PrometheusExporter::Instrumentation
       @client = client || PrometheusExporter::Client.default
     end
 
-    def call(job, *args, &block)
+    def call(job, max_attempts, *args, &block)
       success = false
       start = ::Process.clock_gettime(::Process::CLOCK_MONOTONIC)
+      attempts = job.attempts + 1 # Increment because we're adding the current attempt
       result = block.call(job, *args)
       success = true
       result
@@ -36,7 +38,9 @@ module PrometheusExporter::Instrumentation
         type: "delayed_job",
         name: job.handler.to_s.match(JOB_CLASS_REGEXP).to_a[1].to_s,
         success: success,
-        duration: duration
+        duration: duration,
+        attempts: attempts,
+        max_attempts: max_attempts
       )
     end
   end

data/lib/prometheus_exporter/server/delayed_job_collector.rb

@@ -6,15 +6,25 @@ module PrometheusExporter::Server
     end
 
     def collect(obj)
+      default_labels = { job_name: obj['name'] }
+      custom_labels = obj['custom_labels']
+      labels = custom_labels.nil? ? default_labels : default_labels.merge(custom_labels)
+
       ensure_delayed_job_metrics
-      @delayed_job_duration_seconds.observe(obj["duration"], job_name: obj["name"])
-      @delayed_jobs_total.observe(1, job_name: obj["name"])
-      @delayed_failed_jobs_total.observe(1, job_name: obj["name"]) if !obj["success"]
+      @delayed_job_duration_seconds.observe(obj["duration"], labels)
+      @delayed_jobs_total.observe(1, labels)
+      @delayed_failed_jobs_total.observe(1, labels) if !obj["success"]
+      @delayed_jobs_max_attempts_reached_total.observe(1) if obj["attempts"] >= obj["max_attempts"]
+      @delayed_job_duration_seconds_summary.observe(obj["duration"])
+      @delayed_job_duration_seconds_summary.observe(obj["duration"], status: "success") if obj["success"]
+      @delayed_job_duration_seconds_summary.observe(obj["duration"], status: "failed")  if !obj["success"]
+      @delayed_job_attempts_summary.observe(obj["attempts"]) if obj["success"]
     end
 
     def metrics
       if @delayed_jobs_total
-        [@delayed_job_duration_seconds, @delayed_jobs_total, @delayed_failed_jobs_total]
+        [@delayed_job_duration_seconds, @delayed_jobs_total, @delayed_failed_jobs_total,
+         @delayed_jobs_max_attempts_reached_total, @delayed_job_duration_seconds_summary, @delayed_job_attempts_summary]
       else
         []
       end
@@ -36,6 +46,18 @@ module PrometheusExporter::Server
         @delayed_failed_jobs_total =
         PrometheusExporter::Metric::Counter.new(
           "delayed_failed_jobs_total", "Total number failed delayed jobs executed.")
+
+        @delayed_jobs_max_attempts_reached_total =
+            PrometheusExporter::Metric::Counter.new(
+                "delayed_jobs_max_attempts_reached_total", "Total number of delayed jobs that reached max attempts.")
+
+        @delayed_job_duration_seconds_summary =
+            PrometheusExporter::Metric::Summary.new("delayed_job_duration_seconds_summary",
+                                                    "Summary of the time it takes jobs to execute.")
+
+        @delayed_job_attempts_summary =
+            PrometheusExporter::Metric::Summary.new("delayed_job_attempts_summary",
+                                                    "Summary of the amount of attempts it takes delayed jobs to succeed.")
       end
     end
   end

data/lib/prometheus_exporter/server/sidekiq_collector.rb

@@ -6,10 +6,14 @@ module PrometheusExporter::Server
     end
 
     def collect(obj)
+      default_labels = { job_name: obj['name'] }
+      custom_labels = obj['custom_labels']
+      labels = custom_labels.nil? ? default_labels : default_labels.merge(custom_labels)
+
       ensure_sidekiq_metrics
-      @sidekiq_job_duration_seconds.observe(obj["duration"], job_name: obj["name"])
-      @sidekiq_jobs_total.observe(1, job_name: obj["name"])
-      @sidekiq_failed_jobs_total.observe(1, job_name: obj["name"]) if !obj["success"]
+      @sidekiq_job_duration_seconds.observe(obj["duration"], labels)
+      @sidekiq_jobs_total.observe(1, labels)
+      @sidekiq_failed_jobs_total.observe(1, labels) if !obj["success"]
     end
 
     def metrics

data/lib/prometheus_exporter/server/web_collector.rb

@@ -51,11 +51,12 @@ module PrometheusExporter::Server
     end
 
     def observe(obj)
-
-      labels = {
-        controller: obj["controller"] || "other",
-        action: obj["action"] || "other"
+      default_labels = {
+        controller: obj['controller'] || 'other',
+        action: obj['action'] || 'other'
       }
+      custom_labels = obj['custom_labels']
+      labels = custom_labels.nil? ? default_labels : default_labels.merge(custom_labels)
 
       @http_requests_total.observe(1, labels.merge(status: obj["status"]))
 

data/lib/prometheus_exporter/version.rb

@@ -1,3 +1,3 @@
 module PrometheusExporter
-  VERSION = "0.3.1"
+  VERSION = "0.3.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: prometheus_exporter
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.3
 platform: ruby
 authors:
 - Sam Saffron
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-07-04 00:00:00.000000000 Z
+date: 2018-07-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler