sidekiq-jfails 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d0431db9bb1e77466c89c7e087f817f6c01a2490
+  data.tar.gz: 637abd0c06fae1b2aa8b870a13a812244e479c62
+SHA512:
+  metadata.gz: 131f5841a15dab460aed41bbd04f53431cd9feee60af575494e3613e4b7412a000bc5b9db73f409a182dfaffe16ec287216cb32ae9aa04b02bedec7ed970cdd7
+  data.tar.gz: a3f28cfeb5ac877c450b2f1a5f9fb93fb88ff110e819bb6262ef41097e7cadb324c612c7830a9ceb32b88c8da3e102fdba8da77ea6b47d64f69f87205a8534ec

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/

data/.travis.yml

@@ -0,0 +1,10 @@
+
+language: ruby
+services:
+  - redis-server
+rvm:
+  - 1.9.3
+  - 2.0.0
+addons:
+ code_climate:
+   repo_token: 8bfe64224e9d80206c588a1c70748353f3920efc5e3a3e9113b5e1c465d29327

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+gemspec
+gem "codeclimate-test-reporter", '0.2.0', group: :test

data/Gemfile.lock

@@ -0,0 +1,60 @@
+PATH
+  remote: .
+  specs:
+    sidekiq-jfails (0.0.2)
+      sidekiq (>= 2.17.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    celluloid (0.15.2)
+      timers (~> 1.1.0)
+    codeclimate-test-reporter (0.2.0)
+      simplecov (>= 0.7.1, < 1.0.0)
+    connection_pool (1.2.0)
+    docile (1.1.3)
+    hike (1.2.3)
+    json (1.8.1)
+    multi_json (1.8.4)
+    rack (1.5.2)
+    rack-protection (1.5.2)
+      rack
+    rack-test (0.6.2)
+      rack (>= 1.0)
+    rake (10.1.1)
+    redis (3.0.7)
+    redis-namespace (1.4.1)
+      redis (~> 3.0.4)
+    sidekiq (2.17.6)
+      celluloid (>= 0.15.2)
+      connection_pool (>= 1.0.0)
+      json
+      redis (>= 3.0.6)
+      redis-namespace (>= 1.3.1)
+    simplecov (0.8.2)
+      docile (~> 1.1.0)
+      multi_json
+      simplecov-html (~> 0.8.0)
+    simplecov-html (0.8.0)
+    sinatra (1.4.4)
+      rack (~> 1.4)
+      rack-protection (~> 1.4)
+      tilt (~> 1.3, >= 1.3.4)
+    sprockets (2.11.0)
+      hike (~> 1.2)
+      multi_json (~> 1.0)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    tilt (1.4.1)
+    timers (1.1.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  codeclimate-test-reporter (= 0.2.0)
+  rack-test
+  rake
+  sidekiq-jfails!
+  sinatra
+  sprockets

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Andrei Panamarenka
+
+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,66 @@
+# Sidekiq::Jfails [![Build Status](https://travis-ci.org/sjke/sidekiq-jfails.png?branch=master)](https://travis-ci.org/sjke/sidekiq-jfails) [![Code Climate](https://codeclimate.com/repos/530ee9fde30ba068e0000d31/badges/d041c9480e3db6b2072b/gpa.png)](https://codeclimate.com/repos/530ee9fde30ba068e0000d31/feed)
+
+Keeps track of fails in Sidekiq jobs in web and provides detailed information on the fail
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sidekiq-jfails', git: 'git@github.com:sjke/sidekiq-jfails.git', tag: '0.0.1'
+```
+## Usage
+
+Simply having the gem in your Gemfile is enough to get you started.
+Your failed jobs will be visible via a Job fails tab in the Web.
+
+## Configuring
+
+### Maximum Count Fails
+
+This parameter sets the count of tracking fails.
+Default of 10 000 maximum tracked fails.
+
+To change the maximum count:
+
+```ruby
+Sidekiq.configure_server do |config|
+  config.jfails_max_count = 1590
+end
+```
+To disable the limit entirely:
+
+```ruby
+Sidekiq.configure_server do |config|
+  config.jfails_max_count = 0
+end
+```
+### Fails per page
+
+This parameter sets the count of fails displayed per page.
+Default of 10 fails per page.
+
+To change the per page:
+
+```ruby
+Sidekiq.configure_server do |config|
+  config.fails_per_page = 15
+end
+```
+
+## Dependencies
+
+Depends on Sidekiq >= 2.17
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b feature-desc`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin feature-desc`)
+5. Create new Pull Request
+
+## License
+
+Released under the MIT License. See the [LICENSE][license] file for further details.
+
+[license]: https://github.com/sjke/sidekiq-jfails/blob/master/LICENSE

data/Rakefile

@@ -0,0 +1,12 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+task :default => :test
+
+Rake::TestTask.new do |t|
+  t.libs << "lib"
+  t.libs << "test"
+  t.test_files = FileList["test/**/*_test.rb"]
+  t.verbose = true
+end

data/lib/sidekiq-jfails.rb

@@ -0,0 +1 @@
+require 'sidekiq/sidekiq'

data/lib/sidekiq/jfails/middleware.rb

@@ -0,0 +1,30 @@
+module Sidekiq
+  module Jfails
+    class Middleware
+      include Sidekiq::Util
+      attr_accessor :msg
+
+      def call(worker, msg, queue)
+        self.msg = msg
+        yield
+      rescue Exception => e
+        data = {
+            :date => Time.now.utc,
+            :exception => e.class.to_s,
+            :args => msg['args'],#.join(', '),
+            :error => e.message,
+            :backtrace => e.backtrace,
+            :worker => msg['class'],
+            :queue => queue
+        }
+
+        Sidekiq.redis do |conn|
+          conn.lpush(LIST_KEY, Sidekiq.dump_json(data))
+          conn.ltrim(LIST_KEY, 0, Sidekiq.jfails_max_count - 1) unless Sidekiq.jfails_max_count == 0
+        end
+
+        raise e
+      end
+    end
+  end
+end

data/lib/sidekiq/jfails/version.rb

@@ -0,0 +1,5 @@
+module Sidekiq
+  module Jfails
+    VERSION = '0.0.2'
+  end
+end

data/lib/sidekiq/jfails/web.rb

@@ -0,0 +1,22 @@
+module Sidekiq
+  module Jfails
+    module Web
+
+      def self.registered(app)
+        app.get '/jfails' do
+          view_path = File.expand_path(File.dirname(__FILE__) + '/../../../web/views')
+
+          @count = Sidekiq.fails_per_page
+          (@current_page, @total_size, @fails) = page('failed', params[:page], @count)
+          @fails = @fails.map { |msg| Sidekiq.load_json(msg) }
+          render :erb, File.read(File.join(view_path, 'fails_list.erb'))
+        end
+
+        app.post '/jfails/reset' do
+          Sidekiq::Jfails.reset(counter: params['counter'])
+          redirect back
+        end
+      end
+    end
+  end
+end

data/lib/sidekiq/sidekiq.rb

@@ -0,0 +1,61 @@
+require 'sidekiq/web'
+require 'sidekiq/jfails/middleware'
+require 'sidekiq/jfails/web'
+
+module Sidekiq
+
+  # Sets the maximum number of fails to track
+  #
+  # If the number of failures exceeds this number the list will be trimmed (oldest
+  # failures will be purged).
+  #
+  # Defaults to 10 000
+  # Set to 0 to disable rotation
+  def self.jfails_max_count=(value)
+    @jfails_max_count = value
+  end
+
+  def self.jfails_max_count
+    return 10000 unless @jfails_max_count
+    @jfails_max_count
+  end
+
+  # Sets the maximum fails per page
+  #
+  # Defaults to 10
+  def self.fails_per_page=(value)
+    @fails_per_page = value
+  end
+
+  def self.fails_per_page
+    return 10 unless @fails_per_page
+    @fails_per_page
+  end
+
+  module Jfails
+    LIST_KEY = :failed
+
+    def self.reset(options = {})
+      Sidekiq.redis { |c|
+        c.multi do
+          c.del(LIST_KEY)
+          c.set('stat:failed', 0) if options[:counter] || options['counter']
+        end
+      }
+    end
+    def self.count
+      Sidekiq.redis {|r| r.llen(LIST_KEY) }
+    end
+  end
+end
+
+Sidekiq.configure_server do |config|
+  config.server_middleware do |chain|
+    chain.add Sidekiq::Jfails::Middleware
+  end
+end
+
+if defined?(Sidekiq::Web)
+  Sidekiq::Web.register Sidekiq::Jfails::Web
+  Sidekiq::Web.tabs['Job fails'] = 'jfails'
+end

data/sidekiq-jfails.gemspec

@@ -0,0 +1,28 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sidekiq/jfails/version'
+
+
+Gem::Specification.new do |gem|
+  # Authors
+  gem.authors       = ["Andrei Ponomarenko"]
+  gem.email         = ["biglolko@gmail.com"]
+  # About gem
+  gem.name          = "sidekiq-jfails"
+  gem.version       = Sidekiq::Jfails::VERSION
+  gem.description   = %q{Keep track of fails in Sidekiq jobs}
+  gem.summary       = %q{Keeps track of fails in Sidekiq jobs in web and provides detailed information on the fail}
+  gem.homepage      = "https://github.com/sjke/sidekiq-jfails/"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  # Dependencys
+  gem.add_dependency "sidekiq", ">= 2.17.0"
+  gem.add_development_dependency "rake"
+  gem.add_development_dependency "rack-test"
+  gem.add_development_dependency "sprockets"
+  gem.add_development_dependency "sinatra"
+end

data/test/middleware_test.rb

@@ -0,0 +1,58 @@
+require 'test_helper'
+
+module Sidekiq
+  module Jfails
+    describe Middleware do
+
+	  WorkerException = Class.new(Exception)
+
+	  let(:msg)    { {'class' => 'MockWorker', 'args' => ['custom_argument'], 'retry' => false} }
+      let(:handler){ Sidekiq::Jfails::Middleware.new }
+
+      before do
+	    Sidekiq.redis = REDIS
+	    Sidekiq.redis { |c| c.flushdb }
+	  end
+	  it 'records job fails by default jfails_max_count' do
+	    assert_equal 0, jfails_count
+         
+        10.times do
+	      assert_raises WorkerException do
+	  	    handler.call(MockWorker.new, msg, 'default') do
+	          raise WorkerException.new 'test'
+	        end
+	      end
+	    end
+
+	    assert_equal 10, jfails_count
+	  end
+
+	  it 'removes old job fails when jfails_max_count has been reached' do
+	    assert_equal 0, jfails_count
+	 	Sidekiq.jfails_max_count= 3
+	      
+	    10.times do
+	      assert_raises WorkerException do
+	        handler.call(MockWorker.new, msg, 'default') do
+	          raise WorkerException.new 'test'
+	        end
+	      end
+	    end
+
+	    assert_equal 3, jfails_count
+	    Sidekiq.jfails_max_count= nil
+	  end
+
+	  def jfails_count
+	    Sidekiq.redis { |redis| redis.llen('failed') } || 0
+	  end
+
+	  class MockWorker
+		include Sidekiq::Worker
+          
+        def perform
+		end
+	  end
+	end
+  end
+end

data/test/sodekiq_test.rb

@@ -0,0 +1,35 @@
+
+require 'test_helper'
+
+module Sidekiq
+  describe Jfails do
+
+	it 'defaults jfails_max_count to 10 000' do
+	  assert_equal 10000, Sidekiq.jfails_max_count
+	end
+
+	it 'defaults fails_per_page to 10' do
+	  assert_equal 10, Sidekiq.fails_per_page
+	end
+
+	it 'revert jfails_max_count by default when this set nil' do
+	  assert_equal 10000, Sidekiq.jfails_max_count
+
+	  Sidekiq.jfails_max_count= 10
+	  assert_equal 10, Sidekiq.jfails_max_count
+
+	  Sidekiq.jfails_max_count= nil
+	  assert_equal 10000, Sidekiq.jfails_max_count 
+	end
+
+	it 'revert fails_per_page by default when this set nil' do
+	  assert_equal 10, Sidekiq.fails_per_page
+
+	  Sidekiq.fails_per_page= 1
+	  assert_equal 1, Sidekiq.fails_per_page
+
+	  Sidekiq.fails_per_page= nil
+	  assert_equal 10, Sidekiq.fails_per_page 
+	end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,15 @@
+require "minitest/autorun"
+require "minitest/spec"
+require "minitest/mock"
+
+require "rack/test"
+
+require "sidekiq"
+require "sidekiq-jfails"
+require "codeclimate-test-reporter"
+
+Encoding.default_external = Encoding::UTF_8
+Encoding.default_internal = Encoding::UTF_8
+
+CodeClimate::TestReporter.start
+REDIS = Sidekiq::RedisConnection.create(:url => "redis://localhost/15", :namespace => 'sidekiq_extension_test')

data/test/web_test.rb

@@ -0,0 +1,85 @@
+require "test_helper"
+require "sidekiq/web"
+
+module Sidekiq
+  describe Web do
+    include Rack::Test::Methods
+
+    def app
+      Sidekiq::Web
+    end
+
+    before do
+      Sidekiq.redis = REDIS
+      Sidekiq.redis {|c| c.flushdb }
+    end
+
+    it 'can display Job fails tab' do
+      get '/'
+
+      last_response.status.must_equal 200
+      last_response.body.must_match /Sidekiq/
+      last_response.body.must_match /Job fails/
+    end
+
+    it 'can display Job fails page without fails' do
+      get '/jfails'
+      last_response.status.must_equal 200
+      last_response.body.must_match /Job fails/
+      last_response.body.must_match /No failed jobs found/
+    end
+
+    describe 'when there are fails' do
+      before do
+        create_sample_fail
+        get '/jfails'
+      end
+
+      it 'can display Job fails page with fails listed' do	
+        last_response.body.wont_match /No failed jobs found/
+        last_response.body.must_match /HardWorker/
+        last_response.body.must_match /ArgumentError: Some new message/
+        last_response.body.must_match /default/
+        last_response.body.must_match /bob, 5/
+      end
+
+      it 'can remove all Job fails' do
+        assert_equal failed_count, "1"
+
+        last_response.body.must_match /HardWorker/
+
+        post '/jfails/reset', counter: "true"
+        last_response.status.must_equal 302
+
+        get '/jfails'
+        last_response.status.must_equal 200
+        last_response.body.must_match /No failed jobs found/
+
+        assert_equal failed_count, "0"
+      end
+    end
+
+    def create_sample_fail
+      data = {
+        :date => Time.now.strftime("%Y/%m/%d %H:%M:%S %Z"),
+        :args => ["bob", 5].join(', '),
+        :exception => "ArgumentError",
+        :error => "Some new message",
+        :backtrace => ["path/file1.rb", "path/file2.rb"],
+        :worker => 'HardWorker',
+        :queue => 'default'
+      }
+
+      Sidekiq.redis do |c|
+        c.multi do
+          c.rpush("failed", Sidekiq.dump_json(data))
+          c.set("stat:failed", 1)
+        end
+      end
+    end
+
+    def failed_count
+      Sidekiq.redis { |c| c.get("stat:failed") }
+    end
+  end
+end

data/web/views/fails_list.erb

@@ -0,0 +1,60 @@
+<link rel="stylesheet" href="//ajax.googleapis.com/ajax/libs/jqueryui/1.10.4/themes/blitzer/jquery-ui.css" />
+<script src="//ajax.googleapis.com/ajax/libs/jqueryui/1.10.4/jquery-ui.min.js"></script>
+<header class="row">
+  <div class="col-sm-5">
+    <h3>Job fails</h3>
+  </div>
+</header>
+
+<% if @fails.size > 0 %>
+  <table class="table table-striped table-bordered table-white">
+    <thead>
+      <th style="width: 15%">Date</th>
+      <th style="width: 25%">Worker</th>
+      <th style="width: 30%">Exception</th>
+      <th style="width: 15%">Queue</th>
+      <th style="width: 15%">Args</th>
+      <th style="width: 15%">Details</th>
+    </thead>
+    <% @fails.each do |fail| %>
+      <tr>
+        <td><%= relative_time Time.parse(fail['date']) %></td>
+        <td><%= fail['worker'] %></td>
+        <td><%= h fail['exception'] %>: <%= h fail['error'] %></td>
+        <td><%= fail['queue'] %></td>
+        <td><%= fail['args'] %></td>
+        <td><a class='details' href="javascript:void(0);" data-details="<%= fail['backtrace'].join('</td></tr><tr><td>') %>">Show</a></td>
+      </tr>
+    <% end %>
+  </table>
+  <div id="dialog-modal" title="Fail details">
+    <div id="code" style="max-height: 350px;"></div>
+  </div>
+  <script>
+    $(function() {
+        $('.details').on('click', function() {
+            var dialog = $('#dialog-modal');
+            var table = '<table class="table table-striped table-bordered table-white"><tr><td>'
+                        + $('.details').attr('data-details')
+                        + '</td></tr></table>';
+            dialog.find('#code').html(table);
+            dialog.dialog({ width: '1200px', modal: true });
+        })
+    })
+  </script>
+  <div class="row">
+    <div class="col-sm-8">
+      <form class="form-inline" action="<%= "#{root_path}jfails/reset" %>" method="post" style="margin: 20px 0">
+        <input type="hidden" name="counter" value="true" />
+        <input class="btn btn-danger btn-small" type="submit" name="delete" value="Clear All" />
+      </form>
+    </div>
+    <% if @total_size > @count %>
+        <div class="col-sm-4">
+          <%= erb :_paging, :locals => { :url => "#{root_path}jfails#@name" } %>
+        </div>
+    <% end %>
+  </div>
+<% else %>
+  <div class="alert alert-success">No failed jobs found.</div>
+<% end %>

metadata

@@ -0,0 +1,136 @@
+--- !ruby/object:Gem::Specification
+name: sidekiq-jfails
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Andrei Ponomarenko
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sidekiq
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 2.17.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 2.17.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sprockets
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Keep track of fails in Sidekiq jobs
+email:
+- biglolko@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- lib/sidekiq-jfails.rb
+- lib/sidekiq/jfails/middleware.rb
+- lib/sidekiq/jfails/version.rb
+- lib/sidekiq/jfails/web.rb
+- lib/sidekiq/sidekiq.rb
+- sidekiq-jfails.gemspec
+- test/middleware_test.rb
+- test/sodekiq_test.rb
+- test/test_helper.rb
+- test/web_test.rb
+- web/views/fails_list.erb
+homepage: https://github.com/sjke/sidekiq-jfails/
+licenses: []
+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.1.11
+signing_key: 
+specification_version: 4
+summary: Keeps track of fails in Sidekiq jobs in web and provides detailed information
+  on the fail
+test_files:
+- test/middleware_test.rb
+- test/sodekiq_test.rb
+- test/test_helper.rb
+- test/web_test.rb