sidekiq-prometheus-exporter 0.1.7 → 0.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2b702801b2e941ccc0d6df89caa452b5cacba0d8
-  data.tar.gz: 7cfe65f905c85d73162aedd8d0efcb94968ac56f
+  metadata.gz: 706d6acff0ad51c9b9ef02fe334dd52d0dd07b1c
+  data.tar.gz: abaaa090c2f50dd8f7be85d42c3281f9613a23de
 SHA512:
-  metadata.gz: a41177fe1ff1fd8d051518a8e6786c6f0d581ee2d452625e90e1a3ea408c481d98528d31c1611eb76953c003c5fed044aca6d00ee323e064ec9338f8229cd983
-  data.tar.gz: 11187a29bf07f7f63e6f3d794d9bf44fbfeeeee6cb23151ee920e4ba4c231121ec33a7567d2f9cb4d820726339f7fdd8937804013d8ef0b396a5266f582407a5
+  metadata.gz: '09667bd3b4668aee6453110e5bc3275302294bea3cca1e604afa23aaf3f607d9e96a4122b06809a79bdee7011e74abb070341b4072c07fba8cfe5dcc8ddd6b74'
+  data.tar.gz: d91010ae4fd338f8f0e2649e1533ca998f2778bf7e3a4a7506cd698e2ce4cf10a7e5d3941c6fbb76482dd3f7cf1da8fe9e5b1bbcc53e142bcac62522f09566b7

data/.travis.yml

@@ -2,9 +2,10 @@ sudo: false
 language: ruby
 rvm:
   - 2.2.10
-  - 2.3.7
-  - 2.4.4
-  - 2.5.1
+  - 2.3.8
+  - 2.4.6
+  - 2.5.5
+  - 2.6.2
 gemfile:
   - gemfiles/sidekiq_3.3.1.gemfile
   - gemfiles/sidekiq_3.x.gemfile
@@ -13,6 +14,8 @@ gemfile:
 addons:
   code_climate:
     repo_token: $CODECLIMATE_REPO_TOKEN
+notifications:
+  email: false
 
 cache: bundler
 before_install: gem install bundler -v 1.16.5

data/README.md

@@ -14,22 +14,28 @@ Open [dashboard example file](/examples/sidekiq.json), then open `https://<your
 
 # Available metrics
 
-(starting Sidekiq `v3.3.1`)
-
-```text
-sidekiq_processed_jobs_total               counter  The total number of processed jobs.
-sidekiq_failed_jobs_total                  counter  The total number of failed jobs.
-sidekiq_busy_workers                       gauge    The number of workers performing the job.
-sidekiq_enqueued_jobs                      gauge    The number of enqueued jobs.
-sidekiq_scheduled_jobs                     gauge    The number of jobs scheduled for a future execution.
-sidekiq_retry_jobs                         gauge    The number of jobs scheduled for the next try.
-sidekiq_dead_jobs                          gauge    The number of jobs being dead.
-sidekiq_queue_latency_seconds              gauge    The amount of seconds between oldest job being pushed
-                                                    to the queue and current time (labels: name).
-sidekiq_queue_max_processing_time_seconds  gauge    The amount of seconds between oldest job of the queue
-                                                    being executed and current time (labels: name).
-sidekiq_queue_enqueued_jobs                gauge    The number of enqueued jobs in the queue (labels: name).
-```
+*(starting Sidekiq `v3.3.1`)*
+
+### Standard
+
+| Name                                      | Type    | Description             |
+|-------------------------------------------|---------|-------------------------|
+| sidekiq_processed_jobs_total              | counter | The total number of processed jobs
+| sidekiq_failed_jobs_total                 | counter | The total number of failed jobs
+| sidekiq_busy_workers                      | gauge   | The number of workers performing the job
+| sidekiq_enqueued_jobs                     | gauge   | The number of enqueued jobs
+| sidekiq_scheduled_jobs                    | gauge   | The number of jobs scheduled for a future execution
+| sidekiq_retry_jobs                        | gauge   | The number of jobs scheduled for the next try
+| sidekiq_dead_jobs                         | gauge   | The number of jobs being dead
+| sidekiq_queue_latency_seconds             | gauge   | The amount of seconds between oldest job being pushed to the queue and current time (labels: `name`)
+| sidekiq_queue_max_processing_time_seconds | gauge   | The amount of seconds between oldest job of the queue being executed and current time (labels: `name`)
+| sidekiq_queue_enqueued_jobs               | gauge   | The number of enqueued jobs in the queue (labels: `name`)
+
+### [Cron](https://github.com/ondrejbartas/sidekiq-cron)
+
+| Name                                      | Type    | Description             |
+|-------------------------------------------|---------|-------------------------|
+| sidekiq_cron_jobs                         | gauge   | The number of cron jobs
 
 # Installation
 
@@ -67,9 +73,9 @@ end
 run Sidekiq::Prometheus::Exporter.to_app
 ```
 
-use your favorite server to start it up, like this
+Use your favorite server to start it up, like this
 
-```
+```bash
 $ bundle exec rackup -p9292 -o0.0.0.0
 ```
 
@@ -77,9 +83,9 @@ and then `curl https://0.0.0.0:9292/metrics`
 
 # Sidekiq Web (extream)
 
-If you are fine, that metrics will be exposed via Sidekiq web dashboard because
-you have it inside your private network or only Prometheus scraper will have an
-access to a machine/port/etc, then add a few lines into your web `config.ru`
+If you are ok with metrics being exposed via Sidekiq web dashboard because
+you have it inside your private network or only Prometheus scraper will have access
+to a machine/port/etc, then add a few lines into your web `config.ru`
 
 ```ruby
 require 'sidekiq/web'
@@ -90,10 +96,33 @@ Sidekiq::Web.register(Sidekiq::Prometheus::Exporter)
 
 and then `curl https://<your-sidekiq-web-uri>/metrics`
 
+# Sidekiq Contribs
+
+By default we try to detect as many as possible [sidekiq contribs](https://github.com/mperham/sidekiq/wiki/Related-Projects)
+and add their metrics to the output.
+But you can change this behaviour by configuring exporters setting
+
+```ruby
+require 'sidekiq/prometheus/exporter'
+
+# Keep the default auto-detect behaviour
+Sidekiq::Prometheus::Exporter.configure do |config|
+  config.exporters = :auto_detect
+end
+
+# Keep only standard (by default) and cron metrics
+Sidekiq::Prometheus::Exporter.configure do |config|
+  config.exporters = %i(cron)
+end
+```
+
 ## Contributing
 
 Bug reports and pull requests to support earlier versions of Sidekiq are welcome on GitHub at https://github.com/Strech/sidekiq-prometheus-exporter/issues.
 
+If you are missing your favourite Sidekiq contrib and want to contribute,
+please make sure that you are following naming conventions from [Prometheus](https://prometheus.io/docs/practices/naming/).
+
 # License
 
 Please see [LICENSE](https://github.com/mperham/sidekiq/blob/master/LICENSE) for licensing details.

data/gemfiles/sidekiq_3.3.1.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    sidekiq-prometheus-exporter (0.1.6)
+    sidekiq-prometheus-exporter (0.1.8)
       sidekiq (>= 3.3.1)
 
 GEM

data/gemfiles/sidekiq_3.x.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    sidekiq-prometheus-exporter (0.1.6)
+    sidekiq-prometheus-exporter (0.1.8)
       sidekiq (>= 3.3.1)
 
 GEM

data/gemfiles/sidekiq_4.x.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    sidekiq-prometheus-exporter (0.1.6)
+    sidekiq-prometheus-exporter (0.1.8)
       sidekiq (>= 3.3.1)
 
 GEM

data/gemfiles/sidekiq_5.x.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    sidekiq-prometheus-exporter (0.1.6)
+    sidekiq-prometheus-exporter (0.1.8)
       sidekiq (>= 3.3.1)
 
 GEM

data/lib/sidekiq/prometheus/exporter.rb

@@ -1,41 +1,43 @@
 # frozen_string_literal: true
 
-require 'erb'
 require 'sidekiq/prometheus/exporter/version'
-require 'sidekiq/prometheus/exporter/metrics'
+require 'sidekiq/prometheus/exporter/exporters'
 
 module Sidekiq
   module Prometheus
     # Expose Prometheus metrics via Rack application or Sidekiq::Web application
     module Exporter
-      HTTP_GET = 'GET'.freeze
-      NOT_FOUND_TEXT = 'Not Found'.freeze
+      REQUEST_VERB = 'GET'.freeze
       REQUEST_METHOD = 'REQUEST_METHOD'.freeze
-      HEADERS = {
-        'Content-Type' => 'text/plain; version=0.0.4',
-        'Cache-Control' => 'no-cache'
-      }.freeze
-      TEMPLATE = ERB.new(File.read(File.expand_path('exporter/templates/metrics.erb', __dir__)))
+      NOT_FOUND_TEXT = 'Not Found'.freeze
+      MOUNT_PATH = '/metrics'.freeze
+      HEADERS = {'Content-Type' => 'text/plain; version=0.0.4', 'Cache-Control' => 'no-cache'}.freeze
+      EXPORTERS = Exporters.new
 
-      def self.registered(app)
-        app.get('/metrics') do
-          Sidekiq::Prometheus::Exporter.call(REQUEST_METHOD => HTTP_GET)
+      class << self
+        def configure
+          yield(EXPORTERS)
         end
-      end
 
-      def self.to_app
-        Rack::Builder.app do
-          map('/metrics') do
-            run Sidekiq::Prometheus::Exporter
+        def registered(app)
+          app.get(MOUNT_PATH) do
+            Sidekiq::Prometheus::Exporter.call(REQUEST_METHOD => REQUEST_VERB)
           end
         end
-      end
 
-      def self.call(env)
-        return [404, HEADERS, [NOT_FOUND_TEXT]] if env[REQUEST_METHOD] != HTTP_GET
+        def to_app
+          Rack::Builder.app do
+            map(MOUNT_PATH) do
+              run Sidekiq::Prometheus::Exporter
+            end
+          end
+        end
 
-        body = TEMPLATE.result(Metrics.new.__binding__).chomp!
-        [200, HEADERS, [body]]
+        def call(env)
+          return [404, HEADERS, [NOT_FOUND_TEXT]] if env[REQUEST_METHOD] != REQUEST_VERB
+
+          [200, HEADERS, [EXPORTERS.to_s]]
+        end
       end
     end
   end

data/lib/sidekiq/prometheus/exporter/cron.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require 'erb'
+
+# Exporter for the https://github.com/ondrejbartas/sidekiq-cron
+module Sidekiq
+  module Prometheus
+    module Exporter
+      class Cron
+        TEMPLATE = ERB.new(File.read(File.expand_path('templates/cron.erb', __dir__)))
+
+        def self.available?
+          defined?(Sidekiq::Cron)
+        end
+
+        def initialize
+          @cron_jobs_count = Sidekiq::Cron::Job.count
+        end
+
+        def to_s
+          TEMPLATE.result(binding).chomp!
+        end
+      end
+    end
+  end
+end

data/lib/sidekiq/prometheus/exporter/exporters.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require 'sidekiq/prometheus/exporter/standard'
+require 'sidekiq/prometheus/exporter/cron'
+
+module Sidekiq
+  module Prometheus
+    module Exporter
+      class Exporters
+        AVAILABLE_EXPORTERS = {
+          standard: Sidekiq::Prometheus::Exporter::Standard,
+          cron: Sidekiq::Prometheus::Exporter::Cron
+        }.freeze
+
+        def initialize
+          @enabled = AVAILABLE_EXPORTERS.values.select(&:available?)
+        end
+
+        def exporters=(value)
+          value = Array(value) unless value.respond_to?(:select)
+          potential = AVAILABLE_EXPORTERS
+
+          unless value.include?(:auto_detect)
+            potential = potential.select { |name, _| value.include?(name) }
+          end
+
+          @enabled =
+            %i(standard).concat(potential.keys).uniq
+              .map { |name| AVAILABLE_EXPORTERS.fetch(name) }
+              .select(&:available?)
+        end
+
+        def to_s
+          @enabled.map { |exporter| exporter.new.to_s }.join("\n".freeze)
+        end
+      end
+    end
+  end
+end

data/lib/sidekiq/prometheus/exporter/standard.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require 'erb'
+require 'sidekiq/api'
+
+module Sidekiq
+  module Prometheus
+    module Exporter
+      class Standard
+        TEMPLATE = ERB.new(File.read(File.expand_path('templates/standard.erb', __dir__)))
+
+        QueueStats = Struct.new(:name, :size, :latency)
+
+        def self.available?
+          true
+        end
+
+        def initialize
+          @overview_stats = Sidekiq::Stats.new
+          @queues_stats = queues_stats
+          @max_processing_times = max_processing_times
+        end
+
+        def to_s
+          TEMPLATE.result(binding).chomp!
+        end
+
+        private
+
+        def queues_stats
+          Sidekiq::Queue.all.map do |queue|
+            QueueStats.new(queue.name, queue.size, queue.latency)
+          end
+        end
+
+        def max_processing_times
+          now = Time.now.to_i
+          Sidekiq::Workers.new
+            .map { |_, _, execution| execution }
+            .group_by { |execution| execution['queue'] }
+            .each_with_object({}) do |(queue, executions), memo|
+              oldest_execution = executions.min_by { |execution| execution['run_at'] }
+              memo[queue] = now - oldest_execution['run_at']
+            end
+        end
+      end
+    end
+  end
+end

data/lib/sidekiq/prometheus/exporter/templates/cron.erb

@@ -0,0 +1,3 @@
+# HELP sidekiq_cron_jobs The number of cron jobs.
+# TYPE sidekiq_cron_jobs gauge
+sidekiq_cron_jobs <%= format('%d', @cron_jobs_count) %>

data/lib/sidekiq/prometheus/exporter/version.rb

@@ -3,7 +3,7 @@
 module Sidekiq
   module Prometheus
     module Exporter
-      VERSION = '0.1.7'
+      VERSION = '0.1.8'.freeze
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-prometheus-exporter
 version: !ruby/object:Gem::Version
-  version: 0.1.7
+  version: 0.1.8
 platform: ruby
 authors:
 - Sergey Fedorov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-12-04 00:00:00.000000000 Z
+date: 2019-04-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sidekiq
@@ -201,8 +201,11 @@ files:
 - gemfiles/sidekiq_5.x.gemfile
 - gemfiles/sidekiq_5.x.gemfile.lock
 - lib/sidekiq/prometheus/exporter.rb
-- lib/sidekiq/prometheus/exporter/metrics.rb
-- lib/sidekiq/prometheus/exporter/templates/metrics.erb
+- lib/sidekiq/prometheus/exporter/cron.rb
+- lib/sidekiq/prometheus/exporter/exporters.rb
+- lib/sidekiq/prometheus/exporter/standard.rb
+- lib/sidekiq/prometheus/exporter/templates/cron.erb
+- lib/sidekiq/prometheus/exporter/templates/standard.erb
 - lib/sidekiq/prometheus/exporter/version.rb
 - sidekiq-prometheus-exporter.gemspec
 homepage: https://github.com/Strech/sidekiq-prometheus-exporter

data/lib/sidekiq/prometheus/exporter/metrics.rb

@@ -1,40 +0,0 @@
-# frozen_string_literal: true
-
-require 'sidekiq/api'
-
-module Sidekiq
-  module Prometheus
-    class Metrics
-      QueueStats = Struct.new(:name, :size, :latency)
-
-      def initialize
-        @overview_stats = Sidekiq::Stats.new
-        @queues_stats = queues_stats
-        @max_processing_times = max_processing_times
-      end
-
-      def __binding__
-        binding
-      end
-
-      private
-
-      def queues_stats
-        Sidekiq::Queue.all.map do |queue|
-          QueueStats.new(queue.name, queue.size, queue.latency)
-        end
-      end
-
-      def max_processing_times
-        now = Time.now.to_i
-        Sidekiq::Workers.new
-          .map { |_, _, execution| execution }
-          .group_by { |execution| execution['queue'] }
-          .each_with_object({}) do |(queue, executions), memo|
-            oldest_execution = executions.min_by { |execution| execution['run_at'] }
-            memo[queue] = now - oldest_execution['run_at']
-          end
-      end
-    end
-  end
-end