sidekiq-influxdb 1.0.0 → 1.4.1

data/lib/sidekiq/influxdb.rb

@@ -1,2 +1,4 @@
 require "sidekiq/influxdb/version"
 require "sidekiq/middleware/server/influxdb"
+require "sidekiq/metrics/queues"
+require "sidekiq/metrics/stats"

data/lib/sidekiq/influxdb/version.rb

@@ -1,5 +1,5 @@
 module Sidekiq
   module InfluxDB
-    VERSION = "1.0.0"
+    VERSION = "1.4.1"
   end
 end

data/lib/sidekiq/metrics/queues.rb

@@ -0,0 +1,41 @@
+require 'sidekiq/api'
+
+module Sidekiq
+  module Metrics
+    class Queues
+
+      def initialize(
+        influxdb_client:,
+        series_name: 'sidekiq_queues',
+        retention_policy: nil,
+        tags: {}
+      )
+        @influxdb = influxdb_client
+        @series = series_name
+        @retention = retention_policy
+        @tags = tags
+      end
+
+      def publish
+        queues = Sidekiq::Stats::Queues.new.lengths
+
+        queues.each do |queue, size|
+          save(
+            tags: {queue: queue}.merge(@tags),
+            values: {size: size}
+          )
+        end
+      end
+
+      private
+
+      def save(data)
+        @influxdb.write_point(@series, data, precision, @retention)
+      end
+
+      def precision
+        @influxdb.config.time_precision
+      end
+    end
+  end
+end

data/lib/sidekiq/metrics/stats.rb

@@ -0,0 +1,42 @@
+require 'sidekiq/api'
+
+module Sidekiq
+  module Metrics
+    class Stats
+
+      def initialize(
+        influxdb_client:,
+        series_name: 'sidekiq_stats',
+        retention_policy: nil,
+        tags: {}
+      )
+        @influxdb = influxdb_client
+        @series = series_name
+        @retention = retention_policy
+        @tags = tags
+      end
+
+      def publish
+        stats = Sidekiq::Stats.new.instance_variable_get(:@stats)
+        stats.delete(:default_queue_latency)
+
+        stats.each do |stat, size|
+          save(
+            tags: {stat: stat}.merge(@tags),
+            values: {size: size}
+          )
+        end
+      end
+
+      private
+
+      def save(data)
+        @influxdb.write_point(@series, data, precision, @retention)
+      end
+
+      def precision
+        @influxdb.config.time_precision
+      end
+    end
+  end
+end

data/lib/sidekiq/middleware/server/influxdb.rb

@@ -1,64 +1,74 @@
 require 'set'
-require 'influxdb'
 
 module Sidekiq
   module Middleware
     module Server
       class InfluxDB
 
-        def initialize(
-          influxdb_client:,
-          series_name: 'sidekiq_jobs',
-          retention_policy: nil,
-          start_events: true,
-          tags: {},
-          except: []
-        )
-          @influxdb = influxdb_client
-          @series = series_name
-          @retention = retention_policy
-          @start_events = start_events
-          @tags = tags
-          @secret_agents = Set.new(except)
+        def initialize(options = {})
+          @influxdb = options.fetch(:influxdb_client)
+          @series = options.fetch(:series_name, 'sidekiq_jobs')
+          @retention = options.fetch(:retention_policy, nil)
+          @start_events = options.fetch(:start_events, true)
+          @tags = options.fetch(:tags, {})
+          @secret_agents = class_names(options.fetch(:except, []))
+          @clock = options.fetch(:clock, -> { Time.now.to_f })
         end
 
-        def call(worker, msg, queue)
-          if @secret_agents.include?(worker.class)
+        def call(_worker, msg, _queue)
+          if @secret_agents.include?(job_class_name(msg))
             yield
             return
           end
-          t = Time.now.to_f
-          data = {
-            tags: {
-              class: worker.class.name,
-              queue: queue,
-              event: 'start',
-            }.merge(@tags),
-            values: {
-              jid:           msg['jid'],
-              creation_time: msg['created_at'],
-              waited:    t - msg['created_at'],
-            },
-            timestamp: in_correct_precision(t)
-          }
-          save(data) if @start_events
+
+          started_at = @clock.call
+          waited = started_at - msg['created_at']
+          record(started_at, msg, {event: 'start'}, {waited: waited}) if @start_events
+
           begin
             yield
-            data[:tags][:event] = 'finish'
+            tags = {event: 'finish'}
           rescue => e
-            data[:tags][:event] = 'error'
-            data[:tags][:error] = e.class.name
+            tags = {event: 'error', error: e.class.name}
           end
-          tt = Time.now.to_f
-          data[:values][:worked] = tt - t
-          data[:values][:total]  = tt - msg['created_at']
-          data[:timestamp] = in_correct_precision(tt)
-          save(data)
+
+          finished_at = @clock.call
+          worked = finished_at - started_at
+          record(finished_at, msg, tags, {waited: waited, worked: worked, total: waited + worked})
+
           raise e if e
         end
 
         private
 
+        def class_names(except)
+          Set.new([except].flatten.map{|e| class_name(e) })
+        end
+
+        def class_name(class_or_name)
+          class_or_name.name
+        rescue NoMethodError
+          class_or_name
+        end
+
+        def job_class_name(msg)
+          msg['wrapped'] || msg['class']
+        end
+
+        def record(t, msg, tags, values = {})
+          save(
+            tags: {
+              class: job_class_name(msg),
+              queue: msg['queue']
+            }.merge(tags).merge(@tags),
+            values: {
+              jid: msg['jid'],
+              creation_time: msg['created_at']
+            }.merge(values),
+            timestamp: in_correct_precision(t)
+          )
+        end
+
         def save(data)
           @influxdb.write_point(@series, data, precision, @retention)
         end
@@ -70,9 +80,12 @@ module Sidekiq
         def in_correct_precision(t)
           case precision
             # In order of probability in real-world setups
-            when 'ms' then (t * 1000).to_i
+            when 'ms' then (t * 1_000).to_i
             when 's'  then  t.to_i
-            when 'u'  then (t * 1000000).to_i
+            when 'u'  then (t * 1_000_000).to_i
+            when 'ns' then (t * 1_000_000_000).to_i
+            when 'm'  then (t / 60).to_i * 60
+            when 'h'  then (t / 60 / 60).to_i * 60 * 60
           end
         end
 

data/sidekiq-influxdb.gemspec

@@ -21,6 +21,6 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency "influxdb"
   spec.add_runtime_dependency "sidekiq"
 
-  spec.add_development_dependency "bundler", "~> 1.16"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "coveralls"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-influxdb
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.4.1
 platform: ruby
 authors:
 - Ilya Vassilevsky
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2018-08-08 00:00:00.000000000 Z
+date: 2021-04-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: influxdb
@@ -39,55 +39,64 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: coveralls
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
-description: 
+        version: '0'
+description:
 email:
 - vassilevsky@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".coveralls.yml"
 - ".gitignore"
+- ".rspec"
 - ".ruby-version"
+- ".travis.yml"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
+- CONTRIBUTING.md
 - Gemfile
+- LICENSE
 - Makefile
 - README.md
 - Rakefile
+- grafana_dashboard.json
 - lib/sidekiq/influxdb.rb
 - lib/sidekiq/influxdb/version.rb
+- lib/sidekiq/metrics/queues.rb
+- lib/sidekiq/metrics/stats.rb
 - lib/sidekiq/middleware/server/influxdb.rb
 - sidekiq-influxdb.gemspec
 homepage: https://github.com/vassilevsky/sidekiq-influxdb
 licenses: []
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -102,9 +111,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.13
-signing_key: 
+rubygems_version: 3.2.3
+signing_key:
 specification_version: 4
 summary: Writes Sidekiq job metrics to InfluxDB
 test_files: []