sidekiq-squelch 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4c82ea2475d5c4a68ed3224c2274ca7c3400fc50
+  data.tar.gz: 8f9ca45149f4784a1f3d3c67f4021e0afcd39222
+SHA512:
+  metadata.gz: 85229dc6cd716020d20d75281085d46d7568d1b8433a8aff444793b6263d466bae6712defa7e1f24cfa6a5029900f1fa1d5f02f5ef678184a6acab7ce7b26c58
+  data.tar.gz: 4ab7f40b6602003f558c0466302b27c393cfeb82c2c59e0fb74dea74d2d5dab3f1097368ec6294c3558e6d7a4b58503d18cb73de125d49b23b588687a33aed1b

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+*.rdb

data/.rspec

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Bob Breznak
+
+MIT License
+
+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/Procfile

@@ -0,0 +1 @@
+redis: redis-server

data/README.md

@@ -0,0 +1,31 @@
+# Sidekiq::Squelch
+
+Turns down the noise when executing Sidekiq jobs. Shit happens, its a fact. Sidekiq is pretty good at dealing with that by requing when an uncaught exception is thrown. And if you're monitoring errors using something like [Sentry](https://getsentry.com/) this can be a bit noisy when executing something that has a regular failures and recovery (i.e. network calls). Squelch allows you to set thresholds for common errors that occur so that you can cut down the noise and see when something is really going wrong.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sidekiq-squelch'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sidekiq-squelch
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/sidekiq-squelch/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,7 @@
+require 'bundler/gem_tasks'
+
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new :spec
+
+task default: :spec

data/example/config.yml

@@ -0,0 +1,2 @@
+:squelch:
+  - ['CaughtError', 10, 60]

data/example/sidekiq.rb

@@ -0,0 +1,26 @@
+require 'sidekiq'
+require 'raven/base'
+require './lib/sidekiq/squelch'
+require 'byebug'
+
+class CaughtError < StandardError; end
+class UncaughtError < StandardError; end
+
+class DerpyWorker
+  include Sidekiq::Worker
+
+  def perform(ex)
+    raise CaughtError if ex == 'caught'
+    raise UncaughtError
+  end
+end
+
+Raven.configure do |config|
+  config.dsn = 'https://7d3e06e5127f4f5e804584b7ab79c0b4:c19b1bb109e7470c9fe029fd6776e925@app.getsentry.com/31722'
+end
+
+handler = Sidekiq::Squelch::ErrorHandler.new Sidekiq::Squelch::Notifiers::Raven.new
+
+Sidekiq.configure_server do |config|
+  config.error_handlers << handler
+end

data/lib/sidekiq/squelch.rb

@@ -0,0 +1,9 @@
+require 'time'
+require 'sidekiq'
+require 'active_support/core_ext/string'
+
+require 'sidekiq/squelch/version'
+require 'sidekiq/squelch/middleware'
+require 'sidekiq/squelch/error_handler'
+
+require 'sidekiq/squelch/notifiers/raven'

data/lib/sidekiq/squelch/error_handler.rb

@@ -0,0 +1,56 @@
+module Sidekiq
+  module Squelch
+    class ErrorHandler
+      attr_accessor :notifier
+
+      def initialize(notifier)
+        @notifier = notifier
+      end
+
+      def call(ex, context)
+        increment_exception_counter ex
+        notifier.notify ex, context unless squelched? ex 
+      end
+
+      private
+
+      def squelched?(ex)
+        config = config_for ex
+        return false unless config
+
+        time = (Time.now - config[:period]).to_f
+        key = key_for ex
+        
+        count = Sidekiq.redis do |redis|
+          redis.zremrangebyscore key, '-inf', time
+          redis.zcount key, '-inf', '+inf'
+        end
+
+        count < config[:threshold]
+      end
+
+      def increment_exception_counter(ex)
+        return unless config_for ex
+
+        time = Time.now.to_f
+        key = key_for ex
+        value = { thrown_at: time, message: ex.message }.to_json
+
+        Sidekiq.redis { |redis| redis.zadd key, time, value }
+      end
+
+      def config_for(ex)
+        return unless Sidekiq.options[:squelch]
+
+        config = Sidekiq.options[:squelch].find { |s| s.first.to_s == ex.to_s }
+        return unless config
+
+        Hash[[:error, :threshold, :period].zip config]
+      end
+
+      def key_for(ex)
+        [:squelch, ex.class.to_s.underscore].join(':')
+      end
+    end
+  end
+end

data/lib/sidekiq/squelch/middleware.rb

@@ -0,0 +1,20 @@
+module Sidekiq
+  module Squelch
+    class Middleware
+      def initialize(notifier)
+        @notifier = notifier
+      end
+
+      def call(worker, msg, queue)
+        yield
+      rescue => ex
+        @handler ||= ErrorHandler.new
+        @handler.notifier = @notifier
+
+        @handler.call ex, {}
+
+        raise
+      end
+    end
+  end
+end

data/lib/sidekiq/squelch/notifiers/raven.rb

@@ -0,0 +1,11 @@
+module Sidekiq
+  module Squelch
+    module Notifiers
+      class Raven
+        def notify(exception, context = {})
+          ::Raven.capture_exception exception, extra: { sidekiq: context }
+        end
+      end
+    end
+  end
+end

data/lib/sidekiq/squelch/version.rb

@@ -0,0 +1,5 @@
+module Sidekiq
+  module Squelch
+    VERSION = '0.1.0'
+  end
+end

data/sidekiq-squelch.gemspec

@@ -0,0 +1,34 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sidekiq/squelch/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'sidekiq-squelch'
+  spec.version       = Sidekiq::Squelch::VERSION
+  spec.authors       = ['Bob Breznak']
+  spec.email         = ['bob.breznak@gmail.com']
+  spec.summary       = 'Better error management for Sidekiq'
+  spec.homepage      = 'https://github.com/bobbrez/sidekiq-squelch'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'sidekiq', '>= 3.0.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake', '~> 10.0'
+
+  spec.add_development_dependency 'foreman', '~> 0.74.0'
+
+  spec.add_development_dependency 'pry', '~> 0.10.0'
+  spec.add_development_dependency 'pry-byebug', '~> 1.3.3'
+
+
+  spec.add_development_dependency 'timecop', '~> 0.7.1'
+  spec.add_development_dependency 'rspec', '~> 3.0.0'
+  spec.add_development_dependency 'simplecov', '~> 0.9.0'
+end

data/spec/config.yml

@@ -0,0 +1,2 @@
+:squelch
+  - ['*', 20, 200]

data/spec/lib/sidekiq/squelch/middleware_spec.rb

@@ -0,0 +1,88 @@
+require 'spec_helper'
+
+module Sidekiq
+  module Squelch
+    describe Middleware do
+      let(:peroid) { 600 }
+      let(:threshold) { 6 }
+      let(:notifier) { BasicNotifier.new }
+      subject { Middleware.new notifier }
+
+      before(:each) { Sidekiq.redis { |redis| redis.flushall } }
+      before(:each) { Sidekiq.options = Sidekiq.options.merge squelch: [ [ 'BasicError', threshold, peroid] ] }
+
+      after(:each) { Sidekiq.options.delete :squelch }
+
+      it 'raises any errors encountered' do
+        expect { 
+          subject.call(nil, nil, nil) { raise BasicError.new }
+        }.to raise_error
+      end
+
+      it 'increments the error count' do
+        expect(basic_error_count).to eq 0
+        expect { subject.call(nil, nil, nil) { raise BasicError.new } }.to raise_error
+        expect(basic_error_count).to eq 1
+      end
+
+      it 'it prunes the error count based on the peroid' do
+        Timecop.travel Time.now do
+          threshold.times {
+            expect { 
+              subject.call(nil, nil, nil) { raise BasicError.new }
+            }.to raise_error
+          }
+        end
+
+        expect(notifier.count).to eq 0        
+
+        Timecop.travel Time.now + peroid * 2 do
+          threshold.times {
+            expect { 
+              subject.call(nil, nil, nil) { raise BasicError.new }
+            }.to raise_error
+          }
+        end
+
+        expect(notifier.count).to eq 0
+      end
+
+      it 'notifies after hitting the threshold' do
+        (threshold + 5).times {
+          expect { 
+            subject.call(nil, nil, nil) { raise BasicError.new }
+          }.to raise_error
+        }
+
+        expect(notifier.count).to eq 5
+      end
+    end
+  end
+end
+
+private
+
+def basic_error_count
+  Sidekiq.redis { |redis| redis.zcount 'squelch:basic_error', '-inf', '+inf' }
+end
+
+class BasicError < StandardError; end
+class DifferentError < StandardError; end
+
+class BasicNotifier
+  attr_reader :exception, :options, :count
+
+  def initialize
+    reset
+  end
+
+  def reset
+    @count = 0
+  end
+
+  def notify(ex, **opts)
+    @count += 1
+    @exception = ex
+    @options = opts
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+$:.unshift File.expand_path('..', __FILE__)
+$:.unshift File.expand_path('../../lib', __FILE__)
+
+require 'pry'
+require 'pry-byebug'
+require 'timecop'
+
+Dir[File.join './spec/support/**/*.rb'].each { |f| require f }
+
+require File.expand_path('../../lib/sidekiq/squelch', __FILE__)
+
+RSpec.configure do |config|
+  config.profile_examples = 10
+
+  Kernel.srand config.seed
+  config.order = :random
+end

data/spec/support/coverage.rb

@@ -0,0 +1,3 @@
+require 'simplecov'
+
+SimpleCov.start

data/spec/support/redis.rb

@@ -0,0 +1,16 @@
+def redis_add_queues(queues)
+  Sidekiq.redis do |redis|
+    queues.each { |q| redis.sadd Dynamiq::QUEUE_LIST, q }
+  end
+end
+
+def redis_queue_job(dynamic_queue, score, args = nil)
+  payload = { retry: true, class: "Foo", jid: SecureRandom.hex, enqueued_at: Time.now.to_f }
+  payload.merge! queue: dynamic_queue, score: score, args: args
+
+  Sidekiq.redis do |redis|
+    redis.zadd [Dynamiq::QUEUE_LIST, dynamic_queue].join(':'), score, payload.to_json
+  end
+
+  payload
+end

data/spec/support/sidekiq.rb

@@ -0,0 +1,4 @@
+require 'sidekiq'
+
+Sidekiq.logger = nil
+Sidekiq.redis = { namespace: 'test' }

metadata

@@ -0,0 +1,198 @@
+--- !ruby/object:Gem::Specification
+name: sidekiq-squelch
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Bob Breznak
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sidekiq
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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: foreman
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.74.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.74.0
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.3
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.1
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+description: 
+email:
+- bob.breznak@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- Procfile
+- README.md
+- Rakefile
+- example/config.yml
+- example/sidekiq.rb
+- lib/sidekiq/squelch.rb
+- lib/sidekiq/squelch/error_handler.rb
+- lib/sidekiq/squelch/middleware.rb
+- lib/sidekiq/squelch/notifiers/raven.rb
+- lib/sidekiq/squelch/version.rb
+- sidekiq-squelch.gemspec
+- spec/config.yml
+- spec/lib/sidekiq/squelch/middleware_spec.rb
+- spec/spec_helper.rb
+- spec/support/coverage.rb
+- spec/support/redis.rb
+- spec/support/sidekiq.rb
+homepage: https://github.com/bobbrez/sidekiq-squelch
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Better error management for Sidekiq
+test_files:
+- spec/config.yml
+- spec/lib/sidekiq/squelch/middleware_spec.rb
+- spec/spec_helper.rb
+- spec/support/coverage.rb
+- spec/support/redis.rb
+- spec/support/sidekiq.rb
+has_rdoc: