sidekiq-queue-stats 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a2dc2eb1a1491761dcf29003723af76103d87708
+  data.tar.gz: 9ead0cf4014a3fc517b4fa6b5617834831c49f57
+SHA512:
+  metadata.gz: ddd68453e02c0d79bd2fb44f050679f91c5256b62cca537ee8cf6e984e69a5f88a4527dbc4bce272114030ea7725f1ad4fd9b5f052665f88badde4114380ba27
+  data.tar.gz: 1ca1e20ad688623141a35976c3ba5088ae8ded9be46822c8c71946db3fb8866f05e91d446af3f07122d8957644fd9b3ff3d6170397cb6ce8aa6aa17b54e90867

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+services:
+  - redis-server
+rvm:
+  - 2.3.1
+env:
+  matrix:
+    - SIDEKIQ_VERSION="~> 4.2.2"

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## Unreleased
+
+## 0.0.1
+
+  * Initial release (@mikestephens)

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in sidekiq-failures.gemspec
+gemspec
+
+gem 'sidekiq', ENV['SIDEKIQ_VERSION'] if ENV['SIDEKIQ_VERSION']
+gem 'minitest'
+gem 'pry'

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2016 Michael Stephens
+
+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,37 @@
+# Sidekiq::QueueStats [![Build Status](https://travis-ci.org/mikestephens/sidekiq-queue-stats.svg?branch=master)](https://travis-ci.org/mikestephens/sidekiq-queue-stats)
+
+Keeps track of Sidekiq job count and adds a tab to the Web UI to let you view totals.
+
+[WARNING] Large amounts of jobs in queues can cause this gem to slowly load. Use the 'Live Poll' button at your own risk.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sidekiq-queue-stats'
+```
+
+## Usage
+
+Simply having the gem in your Gemfile is enough to get you started. Your
+job count will be visible via a Worker Stats tab in the Web UI.
+
+![Web UI](http://i.imgur.com/eSNVK0O.png)
+## Dependencies
+
+Depends on Sidekiq >= 2.16.0
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## License
+
+Released under the MIT License. See the [LICENSE][license] file for further details.
+
+[license]: https://github.com/mhfs/sidekiq-queue-count/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-queue-stats.rb

@@ -0,0 +1 @@
+require "sidekiq/queue_stats"

data/lib/sidekiq/queue_stats.rb

@@ -0,0 +1,17 @@
+begin
+  require "sidekiq/web"
+rescue LoadError
+  # client-only usage
+end
+
+require "sidekiq/api"
+require "sidekiq/queue_stats/version"
+require "sidekiq/queue_stats/web_extension"
+
+module Sidekiq
+end
+
+if defined?(Sidekiq::Web)
+  Sidekiq::Web.register Sidekiq::QueueStats::WebExtension
+  Sidekiq::Web.tabs["Worker Stats"] = "queue_stats"
+end

data/lib/sidekiq/queue_stats/version.rb

@@ -0,0 +1,5 @@
+module Sidekiq
+  module QueueStats
+    VERSION = "1.0.0"
+  end
+end

data/lib/sidekiq/queue_stats/views/queue_stats.erb

@@ -0,0 +1,63 @@
+<header class="row">
+  <div class="col-sm-5">
+    <h3>Queue Stats</h3>
+  </div>
+</header>
+
+<div class="dropdown pull-right">
+  <button class="btn btn-default dropdown-toggle" type="button" id="dropdownMenu1" data-toggle="dropdown" aria-haspopup="true" aria-expanded="true">
+    Queues
+    <span class="caret"></span>
+  </button>
+  <ul class="dropdown-menu" aria-labelledby="dropdownMenu1">
+    <li><a href="?queue=all">All</a></li>
+    <% @queues.each do |q| %>
+      <li><a href=<%="?queue=#{q.downcase}"%>><%= q.capitalize %></a></li>
+    <% end %>
+  </ul>
+</div>
+
+<%= csrf_tag if respond_to?(:csrf_tag) %>
+<% if params[:queue] == "all" %>
+  <% @queues.each do |q| %>
+    <h4><%= q.capitalize %></h4>
+    <% if @workers[q].empty? %>
+     <div class="alert alert-success">Nothing waiting in queue</div>
+    <% else %>
+     <table class="table table-striped table-bordered table-white">
+       <thead>
+         <tr>
+           <th>Name</th>
+           <th style="width: 150px">Count</th>
+         </tr>
+       </thead>
+       <% @workers[q].each do |worker| %>
+         <tr>
+           <td><%=worker.first%></td>
+           <td><%=worker.last%></td>
+         </tr>
+       <% end %>
+     </table>
+    <% end %>
+  <% end %>
+<% else %>
+  <h4><%= @queue.name.capitalize %></h4>
+  <% if @workers[@queue].nil? %>
+    <div class="alert alert-success">Nothing waiting in queue</div>
+  <% else %>
+    <table class="table table-striped table-bordered table-white">
+      <thead>
+        <tr>
+          <th>Name</th>
+          <th style="width: 150px">Count</th>
+        </tr>
+      </thead>
+      <% @workers[@queue.name].each do |worker| %>
+        <tr>
+          <td><%=worker.first%></td>
+          <td><%=worker.last%></td>
+        </tr>
+      <% end %>
+    </table>
+  <% end %>
+<% end %>

data/lib/sidekiq/queue_stats/web_extension.rb

@@ -0,0 +1,38 @@
+module Sidekiq
+module QueueStats
+    module WebExtension
+
+      def self.registered(app)
+        view_path = File.join(File.expand_path("..", __FILE__), "views")
+
+        app.get "/queue_stats" do
+          @queues = Sidekiq::Queue.all.map(&:name)
+          @workers = {}
+
+          if params[:queue] == "all"
+            Sidekiq::Queue.all.each do |q|
+              @workers[q.name] = {}
+              total = q.map{|cue| cue.klass}
+              klasses = total.uniq
+              klasses.each do |klass|
+                @workers[q.name][klass] = total.count(klass)
+              end
+            end
+          else
+            @queue = params[:queue] ? Sidekiq::Queue.new(params[:queue]) : Sidekiq::Queue.new
+            @workers[@queue.name] = {}
+            total = @queue.map{|cue| cue.klass}
+            klasses = total.uniq
+            if klasses
+              klasses.each do |klass|
+                @workers[@queue.name][klass] = total.count(klass)
+              end
+            end
+          end
+
+          render(:erb, File.read(File.join(view_path, "worker_stats.erb")))
+        end
+      end
+    end
+  end
+end

data/sidekiq-queue-stats.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/sidekiq/queue_stats/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Michael Stephens"]
+  gem.email         = ["michael@stephens.tech"]
+  gem.description   = %q{Keep track of Sidekiq queue stats}
+  gem.summary       = %q{Keeps track of Sidekiq queue stats to see total counts of each job.}
+  gem.homepage      = "https://github.com/mikestephens/sidekiq-queue-stats/"
+
+  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.name          = "sidekiq-queue-stats"
+  gem.require_paths = ["lib"]
+  gem.version       = Sidekiq::QueueStats::VERSION
+
+  gem.add_dependency "sidekiq", ">= 2.16.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/test_helper.rb

@@ -0,0 +1,14 @@
+require "minitest/autorun"
+require "minitest/spec"
+require "minitest/mock"
+require "rack/test"
+
+require "sidekiq"
+require "sidekiq-queue-stats"
+require "sidekiq/processor"
+require "sidekiq/fetch"
+require "sidekiq/cli"
+
+Sidekiq.logger.level = Logger::ERROR
+
+REDIS = Sidekiq::RedisConnection.create(url: "redis://localhost/15")

data/test/web_extension_test.rb

@@ -0,0 +1,31 @@
+require "test_helper"
+require "sidekiq/web"
+
+module Sidekiq
+  describe "WebExtension" do
+    include Rack::Test::Methods
+
+    def app
+      Sidekiq::Web
+    end
+
+    before do
+      Sidekiq.redis = REDIS
+      Sidekiq.redis {|c| c.flushdb }
+    end
+
+    it 'can display home with queue stats tab' do
+      get '/'
+      last_response.status.must_equal 200
+      last_response.body.must_match /Sidekiq/
+      last_response.body.must_match /Queue Stats/
+    end
+
+    it 'can display queue stats page without any failures' do
+      get '/queue_stats'
+      last_response.status.must_equal 200
+      last_response.body.must_match /Queue Stats/
+      last_response.body.must_match /Default/
+    end
+  end
+end

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: sidekiq-queue-stats
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Michael Stephens
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-09-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sidekiq
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.16.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.16.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 Sidekiq queue stats
+email:
+- michael@stephens.tech
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/sidekiq-queue-stats.rb
+- lib/sidekiq/queue_stats.rb
+- lib/sidekiq/queue_stats/version.rb
+- lib/sidekiq/queue_stats/views/queue_stats.erb
+- lib/sidekiq/queue_stats/web_extension.rb
+- sidekiq-queue-stats.gemspec
+- test/test_helper.rb
+- test/web_extension_test.rb
+homepage: https://github.com/mikestephens/sidekiq-queue-stats/
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Keeps track of Sidekiq queue stats to see total counts of each job.
+test_files:
+- test/test_helper.rb
+- test/web_extension_test.rb