atomic-sidekiq 1.1.0 → 1.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3071f88191cdf61f92a11d1ffde7f5cab21db595
-  data.tar.gz: 850929d672c23bbfdd6ed645467ec2e49c4b4a99
+  metadata.gz: af06b1517443b34e0a8e08127c1d730c81658c73
+  data.tar.gz: 01ad8568be11fa6c4e9c67da7422efe903d2b189
 SHA512:
-  metadata.gz: cd7312265115acc03dd613e0623a74fdbc8ec3996de8177966af68300fad1a6d6e6a0aaf4e21d24a219ad0c189078fea097ce1d9d76550902fd87f0189076ef2
-  data.tar.gz: 5720a6e7b38226ee37cae38df9c94d49fe459d3890da868c3185415c822ff3dce8cb90dfbed4ade9d263b2f0ee418b868973995c85d9e6d232df638b3ad773ed
+  metadata.gz: 4e9aa27c6fd049d84c0a8010ae8a0a636e3bbfe15ee39a5ad194ef5f7193dcca5779ea5bfe80e257ff67f87f0717da967cf8bf0e802bcb1a4ea2e7a8f45dd561
+  data.tar.gz: 340e2d9f8997c905d0e6c0df0c11baff6aa7d1218e447fd3770daacc61d513fabad4662a03b2bd36ec437c96b476fd098d5ed644a1338af64296a8142873d39c

data/Gemfile.lock

@@ -14,8 +14,10 @@ GEM
       url
     concurrent-ruby (1.0.5)
     connection_pool (2.2.1)
+    daemons (1.2.6)
     diff-lcs (1.3)
     docile (1.3.0)
+    eventmachine (1.2.5)
     json (2.1.0)
     parallel (1.12.1)
     parser (2.5.0.5)
@@ -58,6 +60,10 @@ GEM
       json (>= 1.8, < 3)
       simplecov-html (~> 0.10.0)
     simplecov-html (0.10.2)
+    thin (1.7.2)
+      daemons (~> 1.0, >= 1.0.9)
+      eventmachine (~> 1.0, >= 1.0.4)
+      rack (>= 1, < 3)
     timecop (0.9.1)
     unicode-display_width (1.3.0)
     url (0.3.2)
@@ -72,6 +78,7 @@ DEPENDENCIES
   rake (~> 11.3)
   rspec
   rubocop
+  thin
   timecop
 
 BUNDLED WITH

data/README.md

@@ -73,6 +73,15 @@ The performance test uses the default settings for both fetchers (default and At
 
 The reliability improvements of AtomicSidekiq come at the cost of less throughput. AtomicSidekiq's algorithm is linear instead of constant like Sidekiq's default, meaning that the cost of performance increases linearly as more jobs are added to the queue.
 
+## Web
+AtomicSidekiq provides two different pages for checking stats on the job reliability. One shows which jobs are currently "in-flight" status (even if they might have exited uexpectedly) and how long before they expire. A second page shows how many jobs have been recovered by queue and by worker class.
+
+![In-flight Web UI](https://raw.githubusercontent.com/Colex/atomic-sidekiq/master/images/in_flight_web.png)
+
+_"Estimated Lost"_ shows how many jobs in-flight might have been lost (this is calculated by looking how many jobs are in "Busy" and how many are "In-flight").
+
+![Recovered Stats Web UI](https://raw.githubusercontent.com/Colex/atomic-sidekiq/master/images/recovered_web.png)
+
 ## Tests
 ```sh
 bundle exec rspec

data/atomic-sidekiq.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name          = "atomic-sidekiq"
-  s.version       = "1.1.0"
+  s.version       = "1.1.2"
   s.date          = "2018-04-02"
   s.summary       = "Reliable fetcher for Sidekiq"
   s.description   = "Reliable fetcher for Sidekiq"
@@ -21,6 +21,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency "rubocop", "~> 0.54"
   s.add_development_dependency "timecop", "~> 0.9"
   s.add_development_dependency "codecov", ">= 0.1.10"
+  s.add_development_dependency "thin"
 
   s.add_runtime_dependency "sidekiq", "~> 5.0"
 end

data/config.ru

@@ -0,0 +1,10 @@
+require "sidekiq/web"
+require_relative "lib/atomic-sidekiq"
+
+Sidekiq.configure_client do |config|
+  config.redis = { db: 13 }
+end
+
+map "/sidekiq" do
+  run Sidekiq::Web
+end

data/docker-compose.yml

@@ -8,6 +8,8 @@ services:
       - docker.env
     depends_on:
       - redis
+    ports:
+      - 3000:3000
     volumes:
       - .:/sidekiq-atomic
     image: sidekiq-atomic

data/lib/atomic_sidekiq.rb

@@ -1,10 +1,13 @@
 require "sidekiq"
 require_relative "atomic_sidekiq/sidekiq/sidekiq"
+require_relative "atomic_sidekiq/in_flight_queue"
 require_relative "atomic_sidekiq/in_flight_keymaker"
 require_relative "atomic_sidekiq/unit_of_work"
 require_relative "atomic_sidekiq/atomic_fetch"
 require_relative "atomic_sidekiq/dead_job_collector"
 require_relative "atomic_sidekiq/heartbeat"
+require_relative "atomic_sidekiq/recovered_stats"
+require_relative "atomic_sidekiq/web"
 require_relative "atomic_sidekiq/atomic_operation/base"
 require_relative "atomic_sidekiq/atomic_operation/acknowledge"
 require_relative "atomic_sidekiq/atomic_operation/requeue"

data/lib/atomic_sidekiq/dead_job_collector.rb

@@ -9,6 +9,7 @@ module AtomicSidekiq
     end
 
     def initialize(queue, in_flight_keymaker:)
+      @recovered_stats    = RecoveredStats.new
       @queue              = queue
       @in_flight_keymaker = in_flight_keymaker
       @expire_op          = AtomicOperation::Expire.new
@@ -20,10 +21,14 @@ module AtomicSidekiq
 
     private
 
-    attr_reader :queue, :in_flight_keymaker, :expire_op
+    attr_reader :queue, :in_flight_keymaker, :expire_op, :recovered_stats
 
     def expire!(job_key)
-      expire_op.perform(queue, job_key)
+      recovered = expire_op.perform(queue, job_key)
+      return if recovered.nil?
+      job = JSON.parse(recovered[1])
+      recovered_stats.increment!(job)
+      job
     end
 
     def each_keys

data/lib/atomic_sidekiq/in_flight_keymaker.rb

@@ -4,6 +4,10 @@ module AtomicSidekiq
       @key_prefix = key_prefix
     end
 
+    def matcher
+      "#{key_prefix}:*"
+    end
+
     def queue_prefix(queue)
       normalized_name = queue.gsub(/queue:/, "")
       "#{key_prefix}:#{normalized_name}:"

data/lib/atomic_sidekiq/in_flight_queue.rb

@@ -0,0 +1,35 @@
+module AtomicSidekiq
+  class InFlightQueue
+    def initialize
+      @keymaker = InFlightKeymaker.new(AtomicFetch::IN_FLIGHT_KEY_PREFIX)
+    end
+
+    def list
+      keys = list_keys
+      retrieve_jobs(keys)
+    end
+
+    private
+
+    attr_reader :keymaker
+
+    def list_keys
+      matcher = keymaker.matcher
+      result = []
+      it = 0
+      loop do
+        it, keys = Sidekiq.redis { |conn| conn.scan(it, match: matcher) }
+        result.concat(keys)
+        it = it.to_i
+        break if it.zero?
+      end
+      result
+    end
+
+    def retrieve_jobs(keys)
+      Sidekiq.redis do |conn|
+        keys.map { |key| JSON.parse(conn.get(key)) }
+      end
+    end
+  end
+end

data/lib/atomic_sidekiq/recovered_stats.rb

@@ -0,0 +1,57 @@
+module AtomicSidekiq
+  class RecoveredStats
+    def increment!(job)
+      puts "INCREMENTING"
+      increment_by_job!(job["class"])
+      increment_by_queue!(job["queue"])
+    end
+
+    def stats_by_queue
+      iterate_stats(queue_prefix)
+    end
+
+    def stats_by_job
+      iterate_stats(job_prefix)
+    end
+
+    private
+
+    def iterate_stats(prefix)
+      iterate_keys(prefix).map do |key|
+        value = Sidekiq.redis { |conn| conn.get(key) }
+        [key.gsub(Regexp.new("#{prefix}:"), ""), value]
+      end.to_h
+    end
+
+    def iterate_keys(prefix)
+      it = 0
+      result = []
+      loop do
+        it, keys = Sidekiq.redis { |conn| conn.scan(it, match: "#{prefix}:*") }
+        result.concat(keys)
+        it = it.to_i
+        return result if it.zero?
+      end
+    end
+
+    def increment_by_job!(job_name)
+      Sidekiq.redis { |conn| conn.incr("#{job_prefix}:#{job_name}") }
+    end
+
+    def increment_by_queue!(queue)
+      Sidekiq.redis { |conn| conn.incr("#{queue_prefix}:#{queue}") }
+    end
+
+    def prefix
+      "atomic_sidekiq"
+    end
+
+    def queue_prefix
+      "#{prefix}:queue"
+    end
+
+    def job_prefix
+      "#{prefix}:job"
+    end
+  end
+end

data/lib/atomic_sidekiq/web.rb

@@ -0,0 +1,35 @@
+module AtomicSidekiq
+  module Web
+    VIEW_PATH = File.expand_path("../../web/views", __dir__)
+
+    def self.registered(app)
+      app.get "/in-flight" do
+        Web.render_in_flight
+      end
+
+      app.get "/recovered" do
+        Web.render_recovered
+      end
+    end
+
+    def self.render_in_flight
+      @jobs = AtomicSidekiq::InFlightQueue.new.list
+      @total_size = @jobs.count
+      @count = 25
+      @current_page = (params[:page] || 1).to_i
+      @jobs = @jobs[@current_page..(@current_page + @count)]
+      erb File.read(File.join(VIEW_PATH, "in_flight.erb"))
+    end
+
+    def self.render_recovered
+      @queues = AtomicSidekiq::RecoveredStats.new.stats_by_queue
+      @jobs = AtomicSidekiq::RecoveredStats.new.stats_by_job
+      erb File.read(File.join(VIEW_PATH, "recovered.erb"))
+    end
+  end
+end
+
+require "sidekiq/web" unless defined?(Sidekiq::Web)
+Sidekiq::Web.register(AtomicSidekiq::Web)
+Sidekiq::Web.tabs["In-flight"] = "in-flight"
+Sidekiq::Web.tabs["Recovered"] = "recovered"

data/web/views/_paging.erb

@@ -0,0 +1,23 @@
+<% if @total_size > @count %>
+  <ul class="pagination pull-right flip">
+    <li class="<%= "disabled" if @current_page == 1 %>">
+      <a href="<%= url %>?page=1">&laquo;</a>
+    </li>
+    <% if @current_page > 1 %>
+      <li>
+        <a href="<%= url %>?<%= qparams(page: @current_page - 1) %>"><%= @current_page - 1 %></a>
+      </li>
+    <% end %>
+    <li class="disabled">
+      <a href="<%= url %>?<%= qparams(page: @current_page) %>"><%= @current_page %></a>
+    </li>
+    <% if @total_size > @current_page * @count %>
+      <li>
+        <a href="<%= url %>?<%= qparams(page: @current_page + 1) %>"><%= @current_page + 1 %></a>
+      </li>
+    <% end %>
+    <li class="<%= "disabled" if @total_size <= @current_page * @count %>">
+      <a href="<%= url %>?<%= qparams(page: (@total_size.to_f / @count).ceil) %>">&raquo;</a>
+    </li>
+  </ul>
+<% end %>

data/web/views/in_flight.erb

@@ -0,0 +1,44 @@
+<header class="row">
+  <div class="col-sm-6">
+    <h3><%= t("In-flight") %></h3>
+  </div>
+  <div class="col-sm-4">
+    <%= erb :_paging, locals: { url: "#{root_path}in-flight" } %>
+  </div>
+</header>
+
+<div class="table_container">
+  <table class="inflight table table-hover table-bordered table-striped table-white">
+    <thead>
+      <th><%= t("Total In-flight") %></th>
+      <th><%= t("Estimated Lost") %></th>
+    </thead>
+      <tr>
+        <td><%= number_with_delimiter(@total_size) %> </td>
+        <td><%= number_with_delimiter(@total_size - workers.size) %> </td>
+      </tr>
+  </table>
+</div>
+
+<div class="table_container">
+  <table class="inflight table table-hover table-bordered table-striped table-white">
+    <thead>
+      <th><%= t("Job") %></th>
+      <th><%= t("Args") %></th>
+      <th><%= t("Queue") %></th>
+      <th><%= t("Expires at") %></th>
+    </thead>
+    <% @jobs.each do |job| %>
+      <tr>
+        <td><%= h job["class"] %> </td>
+        <td><%= h job["args"] %> </td>
+        <td>
+          <a href="<%= root_path %>queues/<%= CGI.escape(job["queue"]) %>"><%= h job["queue"] %></a>
+        </td>
+        <td>
+          <%= relative_time(Time.at(job["expire_at"]))  %>
+        </td>
+      </tr>
+    <% end %>
+  </table>
+</div>

data/web/views/recovered.erb

@@ -0,0 +1,35 @@
+<header class="row">
+  <div class="col-sm-12">
+    <h3><%= t("Recovered Jobs") %></h3>
+  </div>
+</header>
+
+<div class="table_container">
+  <table class="recovered table table-hover table-bordered table-striped table-white">
+    <thead>
+      <th><%= t("Queue") %></th>
+      <th><%= t("Count") %></th>
+    </thead>
+    <% @queues.each do |key, count| %>
+      <tr>
+        <td><%= h key %> </td>
+        <td><%= h count %> </td>
+      </tr>
+    <% end %>
+  </table>
+</div>
+
+<div class="table_container">
+  <table class="recovered table table-hover table-bordered table-striped table-white">
+    <thead>
+      <th><%= t("Job Name") %></th>
+      <th><%= t("Count") %></th>
+    </thead>
+    <% @jobs.each do |key, count| %>
+      <tr>
+        <td><%= h key %> </td>
+        <td><%= h count %> </td>
+      </tr>
+    <% end %>
+  </table>
+</div>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: atomic-sidekiq
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.2
 platform: ruby
 authors:
 - Alex Correia Santos
@@ -94,6 +94,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.1.10
+- !ruby/object:Gem::Dependency
+  name: thin
+  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: sidekiq
   requirement: !ruby/object:Gem::Requirement
@@ -129,8 +143,11 @@ files:
 - bin/sidekiqfail
 - bin/sidekiqload
 - bin/test
+- config.ru
 - docker-compose.yml
 - docker.env
+- images/in_flight_web.png
+- images/recovered_web.png
 - lib/atomic-sidekiq.rb
 - lib/atomic_sidekiq.rb
 - lib/atomic_sidekiq/atomic_fetch.rb
@@ -146,8 +163,14 @@ files:
 - lib/atomic_sidekiq/dead_job_collector.rb
 - lib/atomic_sidekiq/heartbeat.rb
 - lib/atomic_sidekiq/in_flight_keymaker.rb
+- lib/atomic_sidekiq/in_flight_queue.rb
+- lib/atomic_sidekiq/recovered_stats.rb
 - lib/atomic_sidekiq/sidekiq/sidekiq.rb
 - lib/atomic_sidekiq/unit_of_work.rb
+- lib/atomic_sidekiq/web.rb
+- web/views/_paging.erb
+- web/views/in_flight.erb
+- web/views/recovered.erb
 homepage: https://github.com/Colex/atomic-sidekiq
 licenses:
 - MIT