sidekiq-history 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fed6cd482f9bdb31f5290113d1e691a6b14fac9b
+  data.tar.gz: d008a0f65783203548f20a66dba91dffa62c2b03
+SHA512:
+  metadata.gz: c453039f4f8716826b19b001642d04b33372285bfb3aff6e5499284edf919aaeae6cc965b26f8bebcb63b69bd82091b7edb639eaf4539c653ef78ee1cd23475b
+  data.tar.gz: 36cbbcc84b8858ecded10b0faee6ca2b96337275cfa76c96b84f3dbe82fd25a57fdcbfa27c292d318a10ad1a5808b1ebd6b3d1b3ee17d56e4c5186461f7ad0dc

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Russ Smith
+
+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/README.md

@@ -0,0 +1,29 @@
+# Sidekiq::History
+
+A really simple addition to sidekiq web to enable a job history log.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'sidekiq-history'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sidekiq-history
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/sidekiq/history/middleware.rb

@@ -0,0 +1,30 @@
+module Sidekiq
+  module History
+    class Middleware
+      include Sidekiq::Util
+
+      attr_accessor :msg
+
+      def call(worker, msg, queue)
+        self.msg = msg
+
+        data = {
+          started_at: Time.now.utc,
+          payload: msg,
+          worker: msg['class'],
+          processor: "#{hostname}:#{process_id}-#{Thread.current.object_id}",
+          queue: queue
+        }
+
+        Sidekiq.redis do |conn|
+          conn.lpush(LIST_KEY, Sidekiq.dump_json(data))
+          unless Sidekiq.history_max_count == false
+            conn.ltrim(LIST_KEY, 0, Sidekiq.history_max_count - 1)
+          end
+        end
+
+        yield
+      end
+    end
+  end
+end

data/lib/sidekiq/history/version.rb

@@ -0,0 +1,5 @@
+module Sidekiq
+  module History
+    VERSION = "0.0.1"
+  end
+end

data/lib/sidekiq/history/views/history.erb

@@ -0,0 +1,50 @@
+<header class="row">
+  <div class="span5">
+    <h3>History</h3>
+  </div>
+  <div class="span4">
+    <% if @messages.size > 0 %>
+      <%= erb :_paging, :locals => { :url => "#{root_path}history#@name" } %>
+    <% end %>
+  </div>
+</header>
+
+<% if @messages.size > 0 %>
+  <table class="table table-striped table-bordered table-white" style="width: 100%; margin: 0; table-layout:fixed;">
+    <thead>
+      <th style="width: 25%">Worker, Args</th>
+      <th style="width: 10%">Queue</th>
+      <th style="width: 15%">Started At</th>
+      <th style="width: 50%">Processor</th>
+    </thead>
+    <% @messages.each do |msg| %>
+      <tr>
+        <td style="overflow: hidden; text-overflow: ellipsis;">
+          <%= msg['worker'] %>
+          <br />
+          <%= msg['payload']['args'].inspect[0..100] %>
+        </td>
+        <td><%= msg['queue'] %></td>
+        <td>
+          <%= relative_time(Time.parse(msg['started_at'])) %>
+        </td>
+        <td style="overflow: auto; padding: 10px;">
+          Processor: <%= msg['processor'] %>
+        </td>
+      </tr>
+    <% end %>
+  </table>
+  <div class="row">
+    <div class="span5">
+      <form class="form-inline" action="<%= "#{root_path}history/remove" %>" method="post" style="margin: 20px 0">
+        <input class="btn btn-danger btn-small" type="submit" name="delete" value="Clear All" />
+        <label class="checkbox">
+          <input type="checkbox" name="counter" value="true" />
+          reset history counter
+        </label>
+      </form>
+    </div>
+  </div>
+<% else %>
+  <div class="alert alert-success">No jobs found.</div>
+<% end %>

data/lib/sidekiq/history/web_extension.rb

@@ -0,0 +1,22 @@
+module Sidekiq
+  module History
+    module WebExtension
+      def self.registered(app)
+        app.get '/history' do
+          view_path = File.join(File.expand_path('..', __FILE__), 'views')
+
+          @count = (params[:count] || 25).to_i
+          (@current_page, @total_size, @messages) = page('history', params[:page], @count)
+          @messages = @messages.map { |msg| Sidekiq.load_json(msg) }
+
+          render(:erb, File.read(File.join(view_path, 'history.erb')))
+        end
+
+        app.post "/history/remove" do
+          Sidekiq::History.reset_history(counter: params['counter'])
+          redirect("#{root_path}history")
+        end
+      end
+    end
+  end
+end

data/lib/sidekiq/history.rb

@@ -0,0 +1,47 @@
+require 'sidekiq/web'
+require 'sidekiq/history/version'
+require 'sidekiq/history/middleware'
+require 'sidekiq/history/web_extension'
+
+module Sidekiq
+  def self.history_max_count=(value)
+    @history_max_count = value
+  end
+
+  def self.history_max_count
+    return 1000 if @history_max_count.nil?
+    @history_max_count
+  end
+
+  module History
+    LIST_KEY = :history
+
+    def self.reset_history(options = {})
+      Sidekiq.redis { |c|
+        c.multi do
+          c.del(LIST_KEY)
+          c.set('stat:history', 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::History::Middleware
+  end
+end
+
+Sidekiq::Web.register(Sidekiq::History::WebExtension)
+
+if Sidekiq::Web.tabs.is_a?(Array)
+  # For sidekiq < 2.5
+  Sidekiq::Web.tabs << 'history'
+else
+  Sidekiq::Web.tabs['History'] = 'history'
+end

data/sidekiq-history.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/history/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "sidekiq-history"
+  spec.version       = Sidekiq::History::VERSION
+  spec.authors       = ["Russ Smith"]
+  spec.email         = ["russ@bashme.org"]
+  spec.description   = %q{History for sidekiq jobs.}
+  spec.summary       = %q{History for sidekiq jobs.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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", ">= 2.14.0"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rack-test"
+  spec.add_development_dependency "sprockets"
+  spec.add_development_dependency "sinatra"
+end

metadata

@@ -0,0 +1,140 @@
+--- !ruby/object:Gem::Specification
+name: sidekiq-history
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Russ Smith
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sidekiq
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 2.14.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 2.14.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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: History for sidekiq jobs.
+email:
+- russ@bashme.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/sidekiq/history.rb
+- lib/sidekiq/history/middleware.rb
+- lib/sidekiq/history/version.rb
+- lib/sidekiq/history/views/history.erb
+- lib/sidekiq/history/web_extension.rb
+- sidekiq-history.gemspec
+homepage: ''
+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.0.3
+signing_key: 
+specification_version: 4
+summary: History for sidekiq jobs.
+test_files: []
+has_rdoc: