sidekiq-instrumental 0.2.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b5404945c3248c4f8e1f7ddd324a9c3920bf0589
+  data.tar.gz: 900b31e41aa4b0ec5668a5ff93f4a26502a6abdb
+SHA512:
+  metadata.gz: 95e05cd813fef585d22784a36cd1ab26c814be21848a7bcbd8bcd6cd44fa463cadcad20a28b682072e8f05b0d91d9b2ea741011390e2a5026a632fe17a363719
+  data.tar.gz: 141c86b37cd373c86dc32835906c45521ec7361f74f90863a9e2c3e63715521961dc03b0d3b3baf95bf7c4c0b5fe1e2597fb8dcfc212b73a14728da41011efb0

data/.gitignore

@@ -0,0 +1,12 @@
+/.idea/
+/.bundle/
+/.yardoc
+/.ruby-version
+/.ruby-gemset
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.simplecov

@@ -0,0 +1,7 @@
+SimpleCov.start do
+  if ENV['CIRCLE_ARTIFACTS']
+    dir = File.join(ENV['CIRCLE_ARTIFACTS'], "coverage")
+    coverage_dir(dir)
+  end
+  add_filter "/spec/"
+end

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in sidekiq-instrumental.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Edward Rudd
+
+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,62 @@
+# Sidekiq::Instrumental
+
+sidekiq-instrumental is a simple gem to record Sidekiq queue stats into [Instrumental](https://instrumentalapp.com/).
+
+This gem is inspired by the [librato-sidekiq](https://github.com/StatusPage/librato-sidekiq/) gem.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sidekiq-instrumental'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sidekiq-instrumental
+
+## Usage
+
+After you configue Instrumental simply configure Sidekiq::Instrumental with the reference to your agent object.
+
+```ruby
+I = Instrumental::Agent.new(
+    ENV['INSTRUMENTAL_KEY'],
+    enabled: ENV['INSTRUMENTAL_KEY'].present?
+)
+# now tell Sidekiq::Instrumental what agent connection to use
+Sidekiq::Instrumental.configure do |config|
+  config.instrumental_agent = I
+end
+```
+
+## Configuration
+
+**NOTE** Make all configuration changes through the `.configure` block.
+
+enabled: Boolean, true by default
+
+**instrumental_agent**: the Instrumental::Agent instance to use to submit metrics 
+
+**enabled**: Boolean, true by default
+
+**whitelist_queues**: Array, list of queue names that will be the only ones sent to Instrumental (optional)
+
+**blacklist_queues**: Array, list of queue names that will not be sent to Instrumental (optional)
+
+**whitelist_classes**: Array, list of worker classes that will be the only ones sent to Instrumental (optional)
+
+**blacklist_classes**: Array, list of worker classes that will not be sent to Instrumental (optional)
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/NetsoftHoldings/sidekiq-instrumental.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "sidekiq/instrumental"
+
+# 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

data/bin/setup

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

data/circle.yml

@@ -0,0 +1,17 @@
+machine:
+  ruby:
+    version: 2.1.5
+dependencies:
+  post:
+    - gem install geminabox
+test:
+  post:
+    - gem build sidekiq-instrumental.gemspec
+    - rm -rf pkg
+    - mkdir -p pkg
+    - mv *.gem pkg
+deployment:
+  production:
+    branch: production
+    commands:
+      - gem inabox -g ${HUBSTAFF_GEM_SERVER}

data/lib/sidekiq/instrumental/configuration.rb

@@ -0,0 +1,42 @@
+module Sidekiq
+  module Instrumental
+    class Configuration
+      ARRAY_OPTIONS = [:whitelist_queues, :blacklist_queues, :whitelist_classes, :blacklist_classes]
+
+      attr_accessor :instrumental_agent
+      attr_accessor :enabled, *ARRAY_OPTIONS
+
+      alias_method :I, :instrumental_agent
+
+      def initialize
+        @instrumental_agent = nil
+        self.enabled = true
+        ARRAY_OPTIONS.each {|o| self.send("#{o}=", [])}
+      end
+
+      def enabled?
+        @enabled && !@instrumental_agent.nil?
+      end
+
+      def queue_in_whitelist(queue)
+        whitelist_queues.nil? || whitelist_queues.empty? || whitelist_queues.include?(queue.to_s)
+      end
+
+      def queue_in_blacklist(queue)
+        blacklist_queues.include?(queue.to_s)
+      end
+
+      def class_in_whitelist(worker_instance)
+        whitelist_classes.nil? || whitelist_classes.empty? || whitelist_classes.include?(worker_instance.class.to_s)
+      end
+
+      def class_in_blacklist(worker_instance)
+        blacklist_classes.include?(worker_instance.class.to_s)
+      end
+
+      def allowed_to_submit(queue, worker_instance)
+        class_in_whitelist(worker_instance) && !class_in_blacklist(worker_instance) && queue_in_whitelist(queue) && !queue_in_blacklist(queue)
+      end
+    end
+  end
+end

data/lib/sidekiq/instrumental/middleware/base.rb

@@ -0,0 +1,37 @@
+require 'sidekiq/api'
+
+module Sidekiq
+  module Instrumental
+    module Middleware
+      class Base
+        attr_reader :config
+
+        def initialize(config)
+          @config = config
+        end
+
+        def call(worker_instance, msg, queue, redis_pool = nil)
+          start_time = Time.now
+          result = yield
+          elapsed = (Time.now - start_time).to_f
+
+          return result unless config.enabled?
+
+          track(::Sidekiq::Stats.new, worker_instance, msg, queue, elapsed)
+
+          result
+        end
+
+        protected
+
+        def increment(*args)
+          config.I.increment *args
+        end
+
+        def gauge(*args)
+          config.I.gauge *args
+        end
+      end
+    end
+  end
+end

data/lib/sidekiq/instrumental/middleware/client.rb

@@ -0,0 +1,22 @@
+module Sidekiq
+  module Instrumental
+    module Middleware
+      class Client < Base
+
+        def track(stats, worker_instance, msg, queue, elapsed)
+
+          increment('sidekiq.queued')
+
+          return unless config.allowed_to_submit queue, worker_instance
+
+          base_key = "sidekiq.#{queue.to_s}."
+          increment(base_key + 'queued')
+
+          base_key += msg['class'].underscore.gsub('/', '_') + '.'
+
+          increment(base_key + 'queued')
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,37 @@
+module Sidekiq
+  module Instrumental
+    module Middleware
+      class Server < Base
+        protected
+
+        def track(stats, worker_instance, msg, queue, elapsed)
+          submit_general_stats(stats)
+
+          return unless config.allowed_to_submit queue, worker_instance
+
+          base_key = "sidekiq.#{queue.to_s}."
+
+          increment(base_key + 'processed')
+          gauge(base_key + 'time', elapsed)
+          gauge(base_key + 'enqueued', stats.queues[queue].to_i)
+          guage(base_key + 'latency', Sidekiq::Queue.new(queue.to_s).latency)
+          base_key += msg['class'].underscore.gsub('/', '_') + '.'
+
+          increment(base_key + 'processed')
+          increment(base_key + 'time', elapsed)
+        end
+
+        def submit_general_stats(stats)
+          increment("sidekiq.processed")
+          {
+              enqueued: nil,
+              failed: nil,
+              scheduled_size: 'scheduled'
+          }.each do |method, name|
+            gauge("sidekiq.#{(name || method).to_s}", stats.send(method).to_i)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/sidekiq/instrumental/version.rb

@@ -0,0 +1,5 @@
+module Sidekiq
+  module Instrumental
+    VERSION = "0.2.2"
+  end
+end

data/lib/sidekiq/instrumental.rb

@@ -0,0 +1,43 @@
+require "sidekiq/instrumental/version"
+require 'sidekiq/instrumental/configuration'
+require 'sidekiq/instrumental/middleware/base'
+require 'sidekiq/instrumental/middleware/client'
+require 'sidekiq/instrumental/middleware/server'
+require 'sidekiq'
+
+module Sidekiq
+  module Instrumental
+    def self.config
+      @config ||= Sidekiq::Instrumental::Configuration.new
+    end
+
+    def self.configure
+      yield self.config if block_given?
+      self.register
+    end
+
+    def self.register
+      new_config = self.config.dup
+
+      ::Sidekiq.configure_server do |config|
+        config.server_middleware do |chain|
+          chain.remove Sidekiq::Instrumental::Middleware::Server
+          chain.add Sidekiq::Instrumental::Middleware::Server, new_config
+        end
+        config.client_middleware do |chain|
+          chain.remove Sidekiq::Instrumental::Middleware::Client
+          chain.add Sidekiq::Instrumental::Middleware::Client, new_config
+        end
+      end
+
+      ::Sidekiq.configure_client do |config|
+        config.client_middleware do |chain|
+          chain.remove Sidekiq::Instrumental::Middleware::Client
+          chain.add Sidekiq::Instrumental::Middleware::Client, new_config
+        end
+      end
+    end
+  end
+end
+
+Sidekiq::Instrumental.register

data/sidekiq-instrumental.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sidekiq/instrumental/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "sidekiq-instrumental"
+  spec.version       = Sidekiq::Instrumental::VERSION
+  spec.authors       = ["Edward Rudd"]
+  spec.email         = ["urkle@outoforder.cc"]
+
+  spec.summary       = %q{Send Sidekiq status into Instrumental after every job}
+  spec.homepage      = "https://github.com/NetsoftHoldings/sidekiq-instrumental/"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(spec)/}) }
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+  spec.test_files    = Dir['spec/**/*']
+
+  spec.add_runtime_dependency 'instrumental_agent', ">= 0.13"
+  spec.add_runtime_dependency 'sidekiq', '>= 3.5'
+
+  spec.add_development_dependency "bundler", "~> 1.9"
+  spec.add_development_dependency "simplecov", "~> 0.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.4"
+end

data/spec/sidekiq/instrumental/configuration_spec.rb

@@ -0,0 +1,86 @@
+require 'spec_helper'
+
+RSpec.describe Sidekiq::Instrumental::Configuration do
+  describe '#initialize' do
+    it 'should set enabled to true' do
+      expect(subject.enabled).to eq(true)
+    end
+
+    described_class::ARRAY_OPTIONS.each do |o|
+      it "should set #{o} to a blank array" do
+        expect(subject.send(o)).to eq([])
+      end
+    end
+  end
+
+  shared_examples_for 'whitelist checks' do |option, method, list, value|
+    context 'when it is empty' do
+      before do
+        expect(subject.send(option)).to be_empty
+      end
+      it 'should return true' do
+        expect(subject.send(method, value)).to eq(true)
+      end
+    end
+    context 'when it is not empty' do
+      before do
+        subject.send("#{option}=", list)
+      end
+
+      it 'should be true when the list contains the entry' do
+        expect(subject.send(method, value)).to eq(true)
+      end
+
+      it 'should be false when the list does not contain the entry' do
+        expect(subject.send(method, 'other')).to eq(false)
+      end
+    end
+  end
+
+  shared_examples_for 'blacklist checks' do |option, method, list, value|
+    context 'when it is empty' do
+      before do
+        expect(subject.send(option)).to be_empty
+      end
+      it 'should return false' do
+        expect(subject.send(method, value)).to eq(false)
+      end
+    end
+    context 'when it is not empty' do
+      before do
+        subject.send("#{option}=", list)
+      end
+
+      it 'should be false when the list contains the entry' do
+        expect(subject.send(method, value)).to eq(true)
+      end
+
+      it 'should be true when the list does not contain the entry' do
+        expect(subject.send(method, 'other')).to eq(false)
+      end
+    end
+
+  end
+
+  describe '#queue_in_whitelist' do
+    include_examples 'whitelist checks', :whitelist_queues, :queue_in_whitelist, ['default'], 'default'
+  end
+
+  describe '#queue_in_blacklist' do
+    include_examples 'blacklist checks', :blacklist_queues, :queue_in_blacklist, ['default'], 'default'
+  end
+
+  describe '#class_in_whitelist' do
+    include_examples 'whitelist checks', :whitelist_classes, :class_in_whitelist, ['Array'], []
+  end
+
+  describe '#class_in_blacklist' do
+    include_examples 'blacklist checks', :blacklist_classes, :class_in_blacklist, ['Array'], []
+  end
+
+  describe '#allowed_to_submit' do
+    it 'when no lists defined it should always be true' do
+      expect(subject.allowed_to_submit('default', [])).to eq(true)
+    end
+  end
+end

data/spec/sidekiq/instrumental_spec.rb

@@ -0,0 +1,76 @@
+require 'spec_helper'
+
+RSpec.describe Sidekiq::Instrumental do
+  it 'has a version number' do
+    expect(described_class::VERSION).not_to be nil
+  end
+
+  describe '::config' do
+    describe '::config' do
+      it 'should return a Configuration object' do
+        expect(described_class.config).to be_an_instance_of(described_class::Configuration)
+      end
+    end
+  end
+
+  describe '::configure' do
+    before do
+      allow(described_class).to receive(:register)
+    end
+    it 'should yield to the passed block' do
+      expect { |b| described_class.configure(&b) }.to yield_control
+    end
+
+    it 'should yield the configuration object' do
+      expect { |b| described_class.configure(&b) }.to yield_with_args(described_class.config)
+    end
+  end
+
+  describe '::register' do
+    context 'when sidekiq run as a server' do
+      before do
+        allow(Sidekiq).to receive(:server?).and_return(true)
+      end
+
+      it 'should register server middleware' do
+        server_chain = double('Sidekick::MiddlewareChain')
+        config = double('Chain')
+        allow(config).to receive(:server_middleware).and_yield(server_chain)
+        allow(config).to receive(:client_middleware)
+        allow(Sidekiq).to receive(:configure_server).and_yield(config)
+
+        expect(server_chain).to receive(:remove).with(described_class::Middleware::Server)
+        expect(server_chain).to receive(:add).with(described_class::Middleware::Server, an_instance_of(described_class::Configuration))
+
+        described_class.register
+      end
+
+      it 'should register client middleware' do
+        client_chain = double('Sidekick::MiddlewareChain')
+        config = double('Sidekiq')
+        allow(config).to receive(:server_middleware)
+        allow(config).to receive(:client_middleware).and_yield(client_chain)
+        allow(Sidekiq).to receive(:configure_server).and_yield(config)
+
+        expect(client_chain).to receive(:remove).with(described_class::Middleware::Client)
+        expect(client_chain).to receive(:add).with(described_class::Middleware::Client, an_instance_of(described_class::Configuration))
+
+        described_class.register
+      end
+    end
+
+    context 'when sidekiq not run as a server' do
+      it 'should register client middleware' do
+        client_chain = double('Sidekick::MiddlewareChain')
+        config = double('Sidekiq')
+        allow(config).to receive(:client_middleware).and_yield(client_chain)
+        allow(Sidekiq).to receive(:configure_client).and_yield(config)
+
+        expect(client_chain).to receive(:remove).with(described_class::Middleware::Client)
+        expect(client_chain).to receive(:add).with(described_class::Middleware::Client, an_instance_of(described_class::Configuration))
+
+        described_class.register
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,19 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'simplecov'
+require 'sidekiq/instrumental'
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+
+  config.disable_monkey_patching!
+
+  config.order = :random
+
+  Kernel.srand config.seed
+end

metadata

@@ -0,0 +1,151 @@
+--- !ruby/object:Gem::Specification
+name: sidekiq-instrumental
+version: !ruby/object:Gem::Version
+  version: 0.2.2
+platform: ruby
+authors:
+- Edward Rudd
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-09-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: instrumental_agent
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.13'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.13'
+- !ruby/object:Gem::Dependency
+  name: sidekiq
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+- !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.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+description: 
+email:
+- urkle@outoforder.cc
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".simplecov"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- circle.yml
+- lib/sidekiq/instrumental.rb
+- lib/sidekiq/instrumental/configuration.rb
+- lib/sidekiq/instrumental/middleware/base.rb
+- lib/sidekiq/instrumental/middleware/client.rb
+- lib/sidekiq/instrumental/middleware/server.rb
+- lib/sidekiq/instrumental/version.rb
+- sidekiq-instrumental.gemspec
+- spec/sidekiq/instrumental/configuration_spec.rb
+- spec/sidekiq/instrumental_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/NetsoftHoldings/sidekiq-instrumental/
+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.4.3
+signing_key: 
+specification_version: 4
+summary: Send Sidekiq status into Instrumental after every job
+test_files:
+- spec/sidekiq/instrumental/configuration_spec.rb
+- spec/sidekiq/instrumental_spec.rb
+- spec/spec_helper.rb