evil-metrics-sidekiq 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: de3126c7e5682d96325b81bbef7cfb5a432eab92257f557cba134c337cb5cc5d
+  data.tar.gz: 0a1bfcbc03fda0a05cbc5b12d86e3835c67d72b713bde0b3609291fdab94829c
+SHA512:
+  metadata.gz: 0af5fb775ea6fba35ac0ff9302abb445ba843fe5240a425e4a18ab7822f587e204a15a724dc9cde261237063a0192be19ab5a2ff4c81fae6a81bfefe271bb1e3
+  data.tar.gz: e8dba821ab1d688b91150b43fe15987a997e18cc284aa02e8a3d6ec840bd188beb47bfb95e7a29b50ca763dc26ad70de9406fd778a4513fc986334bf9699d058

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+Gemfile.lock
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,46 @@
+---
+require:
+- rubocop-rspec
+
+AllCops:
+  TargetRubyVersion: 2.3
+
+Metrics/BlockLength:
+  Exclude:
+  - "Gemfile"
+  - "spec/**/*"
+
+Style/BracesAroundHashParameters:
+  EnforcedStyle: context_dependent
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+# Allow to use let!
+RSpec/LetSetup:
+  Enabled: false
+
+RSpec/MultipleExpectations:
+  Enabled: false
+
+Bundler/OrderedGems:
+  Enabled: false
+
+Style/TrailingCommaInArguments:
+  Description: 'Checks for trailing comma in argument lists.'
+  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-trailing-params-comma'
+  Enabled: true
+  EnforcedStyleForMultiline: consistent_comma
+
+Style/TrailingCommaInArrayLiteral:
+  Description: 'Checks for trailing comma in array literals.'
+  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-trailing-array-commas'
+  Enabled: true
+  EnforcedStyleForMultiline: consistent_comma
+
+Style/TrailingCommaInHashLiteral:
+  Description: 'Checks for trailing comma in hash literals.'
+  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-trailing-array-commas'
+  Enabled: true
+  EnforcedStyleForMultiline: consistent_comma
+

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.5.1
+before_install: gem install bundler -v 1.16.1

data/Gemfile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in evil-metrics-sidekiq.gemspec
+gemspec
+
+group :development, :test do
+  gem "pry"
+  gem "pry-byebug", platform: :mri
+
+  gem "rubocop"
+  gem "rubocop-rspec"
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Andrey Novikov
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,78 @@
+# Evil::Metrics::[Sidekiq]
+
+Built-in metrics for [Sidekiq] monitoring out of the box!
+
+## Installation
+
+ 1. Add this line to your application's Gemfile:
+
+    ```ruby
+    gem 'evil-metrics-rails'
+    # Then add monitoring system adapter, e.g.:
+    # gem 'evil-metrics-prometheus'
+    ```
+
+    And then execute:
+
+        $ bundle
+
+
+ 2. Add middlewares to your Sidekiq server and client:
+
+    ```ruby
+    # config/initializers/sidekiq or elsewhere
+    Sidekiq.configure_server do |config|
+      config.redis = your_redis_credentials
+      config.server_middleware do |chain|
+        chain.add Evil::Metrics::Sidekiq::ServerMiddleware
+      end
+      # Additional setup may be required depending on adapter. E.g. for prometheus:
+      # Evil::Metrics::Prometheus::Exporter.start_metrics_server!
+    end
+
+    Sidekiq.configure_client do |config|
+      config.redis = your_redis_credentials
+      config.client_middleware do |chain|
+        chain.add Evil::Metrics::Sidekiq::ClientMiddleware
+      end
+    end
+    ```
+
+ 3. You're done!
+
+## Metrics
+
+ - Total number of executed jobs: `sidekiq_jobs_executed_total` -  (segmented by queue and class name)
+ - Number of jobs have been finished successfully: `sidekiq_jobs_success_total` (segmented by queue and class name)
+ - Number of jobs have been failed: `sidekiq_jobs_failed_total` (segmented by queue and class name)
+ - Time of job run: `sidekiq_job_runtime` (seconds per job execution, segmented by queue and class name)
+ - Number of jobs in queues: `sidekiq_jobs_waiting_count` (segmented by queue)
+ - Number of scheduled jobs:`sidekiq_jobs_scheduled_count`
+ - Number of jobs in retry set: `sidekiq_jobs_retry_count`
+ - Number of jobs in dead set (“morgue”): `sidekiq_jobs_dead_count`
+ - Active workers count: `sidekiq_active_processes`
+ - Active processes count: `sidekiq_active_workers_count`
+
+# Roadmap (TODO or Help wanted)
+
+ - Implement optional segmentation of retry/schedule/dead sets
+
+   It should be disabled by default as it requires to iterate over all jobs in sets and may be very slow on large sets.
+
+ - Maybe hooks for ease of plugging in metrics for myriads of Sidekiq plugins?
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/evil-metrics/evil-metrics-sidekiq.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+[Sidekiq]: https://github.com/mperham/sidekiq/ "Simple, efficient background processing for Ruby"

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "evil/metrics/sidekiq"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/evil-metrics-sidekiq.gemspec

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "evil/metrics/sidekiq/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "evil-metrics-sidekiq"
+  spec.version       = Evil::Metrics::Sidekiq::VERSION
+  spec.authors       = ["Andrey Novikov"]
+  spec.email         = ["envek@envek.name"]
+
+  spec.summary       = "Extensible Prometheus exporter for monitoring your Sidekiq"
+  spec.description   = "Prometheus exporter for easy collecting most important of your Sidekiq metrics"
+  spec.homepage      = "https://github.com/evil-metrics/evil-metrics-sidekiq"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "evil-metrics"
+  spec.add_dependency "sidekiq"
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/evil/metrics/sidekiq.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+require "sidekiq"
+require "sidekiq/api"
+
+require "evil/metrics/sidekiq/version"
+require "evil/metrics/sidekiq/client_middleware"
+require "evil/metrics/sidekiq/server_middleware"
+
+module Evil
+  module Metrics
+    module Sidekiq
+      LONG_RUNNING_JOB_RUNTIME_BUCKETS = [
+        0.005, 0.01, 0.025, 0.05, 0.1, 0.25, 0.5, 1, 2.5, 5, 10, # standard (from Prometheus)
+        30, 60, 120, 300, 1800, 3600, 21_600 # Sidekiq tasks may be very long-running
+      ].freeze
+
+      Evil::Metrics.configure do
+        group :sidekiq
+
+        counter :jobs_enqueued_total, comment: "A counter of the total number of jobs sidekiq enqueued."
+
+        next unless ::Sidekiq.server?
+
+        counter   :jobs_executed_total,  comment: "A counter of the total number of jobs sidekiq executed."
+        counter   :jobs_success_total,   comment: "A counter of the total number of jobs successfully processed by sidekiq."
+        counter   :jobs_failed_total,    comment: "A counter of the total number of jobs failed in sidekiq."
+        gauge     :jobs_waiting_count,   comment: "The number of jobs waiting to process in sidekiq."
+        gauge     :active_workers_count, comment: "The number of currently running machines with sidekiq workers."
+        gauge     :jobs_scheduled_count, comment: "The number of jobs scheduled for later execution."
+        gauge     :jobs_retry_count,     comment: "The number of failed jobs waiting to be retried"
+        gauge     :jobs_dead_count,      comment: "The number of jobs exceeded their retry count."
+        gauge     :active_processes,     comment: "The number of active Sidekiq worker processes."
+        histogram :job_runtime, unit: :seconds, per: :job, comment: "A histogram of the job execution time.",
+                                buckets: LONG_RUNNING_JOB_RUNTIME_BUCKETS
+
+        collect do
+          stats = ::Sidekiq::Stats.new
+
+          stats.queues.each do |k, v|
+            sidekiq_jobs_waiting_count.set({ queue: k }, v)
+          end
+          sidekiq_active_workers_count.set({}, stats.workers_size)
+          sidekiq_jobs_scheduled_count.set({}, stats.scheduled_size)
+          sidekiq_jobs_dead_count.set({}, stats.dead_size)
+          sidekiq_active_processes.set({}, stats.processes_size)
+          sidekiq_jobs_retry_count.set({}, stats.retry_size)
+
+          # That is quite slow if your retry set is large
+          # I don't want to enable it by default
+          # retries_by_queues =
+          #     ::Sidekiq::RetrySet.new.each_with_object(Hash.new(0)) do |job, cntr|
+          #       cntr[job["queue"]] += 1
+          #     end
+          # retries_by_queues.each do |queue, count|
+          #   sidekiq_jobs_retry_count.set({ queue: queue }, count)
+          # end
+        end
+      end
+
+      class << self
+        def labelize(worker, _job, queue)
+          { queue: queue, worker: worker_class(worker) }
+        end
+
+        def worker_class(worker)
+          if defined?(ActiveJob::QueueAdapters::SidekiqAdapter::JobWrapper)
+            return job["wrapped"] if worker.is_a?(ActiveJob::QueueAdapters::SidekiqAdapter::JobWrapper)
+          end
+          (worker.is_a?(String) ? worker : worker.class).to_s
+        end
+      end
+    end
+  end
+end

data/lib/evil/metrics/sidekiq/client_middleware.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Evil
+  module Metrics
+    module Sidekiq
+      # Client middleware to count number of enqueued jobs
+      class ClientMiddleware
+        def call(worker, job, queue, _redis_pool)
+          labels = Evil::Metrics::Sidekiq.labelize(worker, job, queue)
+          Evil::Metrics.sidekiq_jobs_enqueued_total.increment(labels)
+          yield
+        end
+      end
+    end
+  end
+end

data/lib/evil/metrics/sidekiq/server_middleware.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Evil
+  module Metrics
+    module Sidekiq
+      # Sidekiq worker middleware
+      class ServerMiddleware
+        def call(worker, job, queue)
+          labels = Evil::Metrics::Sidekiq.labelize(worker, job, queue)
+          start = Time.now
+          begin
+            yield
+            Evil::Metrics.sidekiq_jobs_success_total.increment(labels)
+          rescue Exception # rubocop: disable Lint/RescueException
+            Evil::Metrics.sidekiq_jobs_failed_total.increment(labels)
+            raise
+          ensure
+            Evil::Metrics.sidekiq_job_runtime.measure(labels, elapsed(start))
+            Evil::Metrics.sidekiq_jobs_executed_total.increment(labels)
+          end
+        end
+
+        private
+
+        def elapsed(start)
+          (Time.now - start).round(3)
+        end
+      end
+    end
+  end
+end

data/lib/evil/metrics/sidekiq/version.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Evil
+  module Metrics
+    module Sidekiq
+      VERSION = "0.1.0"
+    end
+  end
+end

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: evil-metrics-sidekiq
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Andrey Novikov
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-10-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: evil-metrics
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sidekiq
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Prometheus exporter for easy collecting most important of your Sidekiq
+  metrics
+email:
+- envek@envek.name
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- evil-metrics-sidekiq.gemspec
+- lib/evil/metrics/sidekiq.rb
+- lib/evil/metrics/sidekiq/client_middleware.rb
+- lib/evil/metrics/sidekiq/server_middleware.rb
+- lib/evil/metrics/sidekiq/version.rb
+homepage: https://github.com/evil-metrics/evil-metrics-sidekiq
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Extensible Prometheus exporter for monitoring your Sidekiq
+test_files: []