attentive_sidekiq 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a34e8ef3a9cdeb0c306c2961b32918a49868b459
+  data.tar.gz: 767c629c1d10745291a394f5307c081517c94306
+SHA512:
+  metadata.gz: 31f7ac4e961ac93548d441516198cf00a4977a80595370d514293c2cdd92544716973f1b8d8d8cf0607ef4bd71408bc77de936997e6457ef3e86720073275c20
+  data.tar.gz: 9457a05bc349c0a2cbb1351453464a6f2280f548d42b0da8c7add1c0d11e5e966aa13396f69b0c2e90d5fbf52bb3b874ccf8e0bafe9575ce594e85ddc3e0015b

data/README.md

@@ -0,0 +1,45 @@
+# Attentive Sidekiq
+
+### Motivation
+It's common to face the issues with sidekiq killing jobs in the middle of processing and not putting them back to redis.
+This issue leads to jobs losage, which essentualy means probable loss of critical user data.
+Sidekiq's author, Mike Perham, suggests purchasing Sidekiq Pro which uses another fetch mechanism providing you with a confidence that ensures jobs persist in redis at any time.
+However, it is reported by some users to still to cause the same issue.
+
+
+### About
+Attentive Sidekiq is a sidekiq plugin which monitors the jobs being started but not finished (successfully or badly).
+It saves started jobs info into redis hash and checks whether any job stays there for too long (without being processed or deleted due to job success/failure).
+
+### Installation
+Add this line to your application's Gemfile:
+    
+    gem 'attentive_sidekiq'
+
+And then execute:
+
+    $ bundle
+
+### Usage
+Configure your middleware chains, lookup Middleware usage on Sidekiq wiki for more info.
+
+    Sidekiq.configure_server do |config|
+      config.server_middleware do |chain|
+        chain.add AttentiveSidekiq::Middleware::Server::Attentionist
+      end
+      config.client_middleware do |chain|
+        chain.add AttentiveSidekiq::Middleware::Client::Attentionist
+      end
+    end
+    
+    Sidekiq.configure_client do |config|
+      config.client_middleware do |chain|
+        chain.add AttentiveSidekiq::Middleware::Client::Attentionist
+      end
+    end
+
+After that you can use your jobs as usual.
+
+### Sidekiq Web integration
+Attentive Sidekiq provides an extension to the Sidekiq web interface that adds a Disappeared Jobs page.
+To use it, head to your sidekiq dashboard and click the link at the tabs section.

data/attentive_sidekiq.gemspec

@@ -0,0 +1,13 @@
+Gem::Specification.new do |s|
+  s.name        = 'attentive_sidekiq'
+  s.version     = '0.0.1'
+  s.date        = '2016-10-31'
+  s.summary     = "Make your sidekiq to be attentive to lost jobs"
+  s.description = "This gem allows you to watch the jobs which suddenly dissappeared from redis without being completed by redis worker"
+  s.authors     = ["twonegatives"]
+  s.email       = 'whitewhiteheaven@gmail.com'
+  s.files       = Dir['**/*'].keep_if{ |file| File.file?(file) }
+  s.homepage    =
+    'http://rubygems.org/gems/attentive_sidekiq'
+  s.license       = 'MIT'
+end

data/lib/attentive_sidekiq.rb

@@ -0,0 +1,5 @@
+require 'attentive_sidekiq/middleware'
+require 'attentive_sidekiq/middleware/server/attentionist'
+require 'attentive_sidekiq/middleware/client/attentionist'
+require 'sidekiq/web' unless defined?(Sidekiq::Web)
+require 'attentive_sidekiq/web'

data/lib/attentive_sidekiq/middleware.rb

@@ -0,0 +1,5 @@
+module AttentiveSidekiq
+  module Middleware
+  	REDIS_KEY = "attentive_observed_hash"
+  end
+end

data/lib/attentive_sidekiq/middleware/client/attentionist.rb

@@ -0,0 +1,25 @@
+module AttentiveSidekiq
+  module Middleware
+    module Client
+      class Attentionist
+
+        def call(worker_class, item, queue, redis_pool = nil)
+          yield
+        end
+
+        #def call(worker_class, item, queue, redis_pool = nil)
+        #  yield
+        #  if rerun?(item["jid"])
+        #    mark_as_not_lost(item["jid"])
+        #  else
+        #  add_to_observed_list(item)
+        #  end
+        #end
+
+        #def rerun?(jid)
+        #  Sidekiq.redis{|conn| conn.hexists(AttentiveSidekiq::Middleware::REDIS_KEY, jid) } == 1
+      	#end
+      end
+    end
+  end
+end

data/lib/attentive_sidekiq/middleware/server/attentionist.rb

@@ -0,0 +1,23 @@
+module AttentiveSidekiq
+  module Middleware
+  	module Server
+      class Attentionist
+
+        def call(worker_instance, item, queue)
+          add_to_observed_list(item)
+          yield
+        ensure
+          mark_as_not_lost(item["jid"])
+        end
+
+        def mark_as_not_lost(jid)
+          Sidekiq.redis{|conn| conn.hdel(AttentiveSidekiq::Middleware::REDIS_KEY, jid)}
+        end
+
+        def add_to_observed_list(item)
+          Sidekiq.redis{ |conn| conn.hset(AttentiveSidekiq::Middleware::REDIS_KEY, item['jid'], item.to_json) }
+        end
+      end
+    end
+  end
+end

data/lib/attentive_sidekiq/web.rb

@@ -0,0 +1,24 @@
+module AttentiveSidekiq
+  module Web
+    VIEW_PATH = File.expand_path("../web/views", __FILE__)
+
+  	def self.registered(app)
+  	  app.helpers do
+  		  def jobs_not_finished
+  		    jsoned_jobs = Sidekiq.redis{|conn| conn.hvals(AttentiveSidekiq::Middleware::REDIS_KEY)}
+      	  jsoned_jobs.map!{|i| JSON.parse(i)}
+  	    end
+      end
+
+  	  app.get('/disappeared-jobs') do
+        jobs_active_now   = Set.new(Sidekiq::Workers.new.to_a.map{|i| i[2]["payload"]["jid"]})
+      	@suspicious_jobs  = jobs_not_finished.delete_if{|i| jobs_active_now.include?(i["jid"])}
+      	erb File.read(File.join(VIEW_PATH, 'disappeared-list.erb'))
+  	  end	
+  	end
+  end
+end
+
+Sidekiq::Web.register AttentiveSidekiq::Web
+Sidekiq::Web.locales << File.expand_path(File.dirname(__FILE__) + "/web/locales")
+Sidekiq::Web.tabs['disappeared_jobs'] = 'disappeared-jobs'

data/lib/attentive_sidekiq/web/locales/en.yml

@@ -0,0 +1,7 @@
+en:
+  jid: JID
+  queue: Queue name
+  class: Class name
+  arguments: Arguments
+  disappeared_jobs: Disappeared jobs
+  time: When

data/lib/attentive_sidekiq/web/locales/ru.yml

@@ -0,0 +1,7 @@
+ru:
+  jid: JID
+  queue: Очередь
+  class: Задача
+  arguments: Аргументы
+  disappeared_jobs: Пропавшие задачи
+  time: Время

data/lib/attentive_sidekiq/web/views/disappeared-list.erb

@@ -0,0 +1,27 @@
+<h3><%= t('disappeared_jobs') %></h3>
+
+<div class="table_container">
+  <table class="table table-hover table-bordered table-striped table-white">
+    <thead>
+      <tr>
+        <th><%= t('jid') %></th>
+        <th><%= t('queue') %></th>
+        <th><%= t('class') %></th>
+        <th><%= t('arguments') %></th>
+        <th><%= t('time') %></th>
+      </tr>
+    </thead>
+
+    <tbody>
+      <% @suspicious_jobs.each do |job| %>
+        <tr>
+          <td><%= job['jid'] %></td>
+          <td><%= job['queue'] %></td>
+          <td><%= job['class'] %></td>
+          <td><%= job['args'] %></td>
+          <td><%= Time.at(job['created_at']).strftime("%H:%M:%S %d.%m.%Y %z") %></td>
+        </tr>
+      <% end %>
+    </tbody>
+  </table>
+</div>

metadata

@@ -0,0 +1,54 @@
+--- !ruby/object:Gem::Specification
+name: attentive_sidekiq
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- twonegatives
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-10-31 00:00:00.000000000 Z
+dependencies: []
+description: This gem allows you to watch the jobs which suddenly dissappeared from
+  redis without being completed by redis worker
+email: whitewhiteheaven@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- attentive_sidekiq.gemspec
+- lib/attentive_sidekiq.rb
+- lib/attentive_sidekiq/middleware.rb
+- lib/attentive_sidekiq/middleware/client/attentionist.rb
+- lib/attentive_sidekiq/middleware/server/attentionist.rb
+- lib/attentive_sidekiq/web.rb
+- lib/attentive_sidekiq/web/locales/en.yml
+- lib/attentive_sidekiq/web/locales/ru.yml
+- lib/attentive_sidekiq/web/views/disappeared-list.erb
+homepage: http://rubygems.org/gems/attentive_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.5.1
+signing_key: 
+specification_version: 4
+summary: Make your sidekiq to be attentive to lost jobs
+test_files: []