sidekiq-worker_stats 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: dc301892db995ec508d5f9300d46fedece1bad94
+  data.tar.gz: 689357440d58ff1d72a62f3dd59670dfec7f2063
+SHA512:
+  metadata.gz: 64b8a35dfb4a99dfd7613a5dca0979875b7bb9731e01df922d648af8f6ad739add9c86f73b1f46db11e967f8adda2c8481dde0f1638d9db790daee9b4d17d514
+  data.tar.gz: b7c1f6ae4c030359714f881e718080a315367fa5096aa24b5947e89f1bce609b0a9dedf1d66852e9d1cb4de38d9daa24105eda3e49c304996657314b28a5399b

data/.gitignore

@@ -0,0 +1,85 @@
+
+# Created by https://www.gitignore.io/api/linux,vim,ruby
+
+### Linux ###
+*~
+
+# temporary files which can be created if a process still has a handle open of a deleted file
+.fuse_hidden*
+
+# KDE directory preferences
+.directory
+
+# Linux trash folder which might appear on any partition or disk
+.Trash-*
+
+# .nfs files are created when an open file is removed but is still being accessed
+.nfs*
+
+
+### Vim ###
+# swap
+[._]*.s[a-w][a-z]
+[._]s[a-w][a-z]
+# session
+Session.vim
+# temporary
+.netrwhist
+# auto-generated tag files
+tags
+
+
+### Ruby ###
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+dump.rdb
+config.ru

data/.ruby-version

@@ -0,0 +1 @@
+2.3.1

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/README.md

@@ -0,0 +1,3 @@
+# sidekiq-worker\_stats
+
+Statistics for sidekiq workers.

data/lib/sidekiq-worker_stats.rb

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

data/lib/sidekiq/worker_stats.rb

@@ -0,0 +1,30 @@
+require 'sidekiq'
+
+require 'sidekiq/worker_stats/configuration'
+require 'sidekiq/worker_stats/middleware'
+require 'sidekiq/worker_stats/web' if defined?(Sidekiq::Web)
+
+module Sidekiq
+  module WorkerStats
+    REDIS_HASH = 'sidekiq:worker_stats'.freeze
+
+    class << self
+      attr_writer :configuration
+
+      def configuration
+        @configuration ||= Configuration.new
+      end
+
+      def configure
+        yield(configuration)
+      end
+    end
+  end
+end
+
+Sidekiq.configure_server do |config|
+  config.server_middleware do |chain|
+    chain.add Sidekiq::WorkerStats::Middleware
+  end
+end
+

data/lib/sidekiq/worker_stats/configuration.rb

@@ -0,0 +1,13 @@
+module Sidekiq
+  module WorkerStats
+    class Configuration
+      attr_accessor :log_file
+      attr_accessor :time
+
+      def initialize
+        @log_file = 'log/sidekiq.log'
+        @time = 5
+      end
+    end
+  end
+end

data/lib/sidekiq/worker_stats/middleware.rb

@@ -0,0 +1,55 @@
+require 'json'
+
+module Sidekiq
+  module WorkerStats
+    class Middleware
+      def call(worker, msg, queue)
+        worker_stats = {}
+        worker_stats[:start] = Time.now.to_i
+        worker_stats[:status] = 'started'
+
+        worker_stats[:pid] = Process.pid
+        worker_stats[:jid] = worker.jid
+
+        worker_stats[:page_size] = `getconf PAGESIZE`.to_i
+        worker_stats[:mem] = {}
+        worker_stats[:mem][Time.now.to_i] = `awk '{ print $2 }' /proc/#{worker_stats[:pid]}/statm`.strip.to_i * worker_stats[:page_size]
+
+        thr = Thread.new do
+          while true do
+            sleep Sidekiq::WorkerStats.configuration.time
+            worker_stats[:mem][Time.now.to_i] = `awk '{ print $2 }' /proc/#{worker_stats[:pid]}/statm`.strip.to_i * worker_stats[:page_size]
+          end
+        end
+
+        yield
+
+        worker_stats[:status] = 'completed'
+      rescue => e
+        worker_stats[:status] = 'failed'
+
+        raise e
+      ensure
+        worker_stats[:stop] = Time.now.to_i
+        worker_stats[:runtime] = worker_stats[:stop] - worker_stats[:start]
+
+        worker_stats[:queue] = queue
+        worker_stats[:class] = worker.class.to_s
+       
+        thr.exit if thr != nil
+
+        worker_key = "#{worker_stats[:class]}:#{worker_stats[:start]}:#{worker_stats[:jid]}"
+
+        save_worker_stats worker_key, worker_stats
+      end
+
+      private
+
+      def save_worker_stats(key, worker_stats)
+        Sidekiq.redis do |redis|
+          redis.hset REDIS_HASH, key, JSON.generate(worker_stats)
+        end
+      end
+    end
+  end
+end

data/lib/sidekiq/worker_stats/version.rb

@@ -0,0 +1,5 @@
+module Sidekiq
+  module WorkerStats
+    VERSION = '0.0.2'.freeze
+  end
+end

data/lib/sidekiq/worker_stats/views/worker_stats.erb

@@ -0,0 +1,31 @@
+<div class="worker_stats">
+  <h2>Worker Stats</h2>
+
+  <div class="worker_stats__container">
+    <div class="worker_stats__table">
+      <table class="table table-hover table-bordered table-striped table-white live-reload">
+        <thead>
+          <th>Worker</th>
+          <th>Started at</th>
+          <th>Finished at</th>
+          <th>Runtime</th>
+          <th>Avg. Memory</th>
+          <th>Peak Memory</th>
+        </thead>
+
+        <tbody>
+          <% @workers.each do |key, worker| %>
+            <tr>
+              <td><a href="<%= root_path %>worker_stats/<%= key.to_s %>"><%= worker["class"].to_s %></a></td>
+              <td><%= Time.at(worker["start"]).strftime "%Y-%m-%d %H:%M:%S" %></td>
+              <td><%= Time.at(worker["stop"]).strftime "%Y-%m-%d %H:%M:%S" %></td>
+              <td><%= "#{worker["runtime"]} s" %></td>
+              <td><%= "#{(worker["mem"].values.inject(:+) / worker["mem"].count) / 1024 / 1024} Mb" %></td>
+              <td><%= "#{(worker["mem"].values.max / 1024 / 1024)} Mb" %></td>
+            </tr>
+          <% end %>
+        </tbody>
+      </table>
+    </div>
+  </div>
+</div>

data/lib/sidekiq/worker_stats/views/worker_stats_single.erb

@@ -0,0 +1,69 @@
+<div class="worker_stats">
+  <h2>Worker Stats for <%= @key.to_s %> </h2>
+
+  <div class="worker_stats__container">
+    <div class="worker_stats__info">
+      <h4>Info</h4>
+      <div class="worker_stats__info_table">
+        <table class="table table-hover table-bordered table-striped table-white">
+          <thead>
+            <th>Field</th>
+            <th>Value</th>
+          </thead>
+
+          <tbody>
+            <tr>
+              <td>Class</td>
+              <td><%= @worker["class"] %></td>
+            </tr>
+            <tr>
+              <td>Queue</td>
+              <td><%= @worker["queue"] %></td>
+            </tr>
+            <tr>
+              <td>Status</td>
+              <td><%= @worker["status"] %></td>
+            </tr>
+            <tr>
+              <td>Job ID</td>
+              <td><%= @worker["jid"] %></td>
+            </tr>
+            <tr>
+              <td>Start</td>
+              <td><%= Time.at(@worker["start"]).strftime "%Y-%m-%d %H:%M:%S" %></td>
+            </tr>
+            <tr>
+              <td>Stop</td>
+              <td><%= Time.at(@worker["stop"]).strftime "%Y-%m-%d %H:%M:%S" %></td>
+            </tr>
+            <tr>
+              <td>Runtime</td>
+              <td><%= @worker["runtime"] %> seconds</td>
+            </tr>
+          </tbody>
+        </table>
+      </div>
+    </div>
+
+    <div class="worker_stats__memory">
+      <h4>Memory</h4>
+      <div class="worker_stats__memory_table">
+        <table class="table table-hover table-bordered table-striped table-white">
+          <thead>
+            <th>Time (after start)</th>
+            <th>Memory</th>
+          </thead>
+
+          <tbody>
+            <% @worker["mem"].each do |time, mem| %>
+              <tr>
+                <td><%= (time.to_i - @worker["start"]).to_s %> seconds</td>
+                <td><%= "#{mem / 1024 / 1024} Mb" %></td>
+              </tr>
+            <% end %>
+          </tbody>
+        </table>
+      </div>
+    </div>
+  </div>
+</div>

data/lib/sidekiq/worker_stats/web.rb

@@ -0,0 +1,38 @@
+require 'json'
+
+require 'sidekiq/web' unless defined?(Sidekiq::Web)
+
+module Sidekiq
+  module WorkerStats
+    module Web
+      def self.registered(app)
+        view_path = File.join(File.expand_path('..', __FILE__), 'views')
+
+        app.get '/worker_stats' do
+          @workers = {}
+          Sidekiq.redis do |redis|
+            keys = redis.hkeys REDIS_HASH
+            keys.each do |key|
+              @workers[key] = JSON.parse(redis.hget(REDIS_HASH, key))
+            end
+          end
+
+          render(:erb, File.read(File.join(view_path, 'worker_stats.erb')))
+        end
+
+        app.get '/worker_stats/:key' do
+          @key = params[:key]
+          @worker = {}
+          Sidekiq.redis do |redis|
+            @worker = JSON.parse(redis.hget(REDIS_HASH, @key))
+          end
+
+          render(:erb, File.read(File.join(view_path, 'worker_stats_single.erb')))
+        end
+      end
+    end
+  end
+end
+
+Sidekiq::Web.register Sidekiq::WorkerStats::Web
+Sidekiq::Web.tabs['Worker Stats'] = 'worker_stats'

data/sidekiq-worker_stats.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sidekiq/worker_stats/version'
+
+Gem::Specification.new do |s|
+  s.name          = 'sidekiq-worker_stats'
+  s.version       = Sidekiq::WorkerStats::VERSION
+  s.license       = 'MIT'
+  s.summary       = 'System statistics for your sidekiq workers'
+  s.description   = 'Save and see on the sidekiq dashboard your workers statistics'
+  
+  s.authors       = ['Alexandre Jesus']
+  s.email         = ['adbjesus@gmail.com']
+  s.homepage      = 'https://github.com/whitesmith/sidekiq-worker_stats'
+
+  s.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.require_paths = ['lib']
+  
+  s.add_dependency 'sidekiq', '~> 4.1', '>= 4.1.4', '< 5'
+  s.add_dependency 'redis', '~> 3.3', '>= 3.3.0'
+
+  s.add_development_dependency 'minitest', '~> 5.0'
+  s.add_development_dependency 'rack-test', '~> 0.6'
+end

data/test/worker_stats/test_middleware.rb

@@ -0,0 +1,60 @@
+require 'minitest/autorun'
+
+require 'rack/test'
+
+require 'sidekiq'
+require 'sidekiq/testing'
+require 'sidekiq/worker_stats'
+
+
+class WorkerHelper
+  include Sidekiq::Worker
+
+  def perform
+    # Let's use some memory
+    a = []
+    for i in 1..10000000
+      a << i.to_s * 10
+    end
+  end
+end
+
+class ErrorWorkerHelper
+  include Sidekiq::Worker
+
+  def perform
+    raise StandardError.new("Error")
+  end
+end
+
+class TestMiddleware < Minitest::Test
+  include Rack::Test::Methods
+
+  def app
+    Sidekiq::Web
+  end
+
+  def setup
+    Sidekiq::Testing.server_middleware do |chain|
+      chain.add Sidekiq::WorkerStats::Middleware
+    end
+  end
+
+  def test_that_middleware_reports_start
+    Sidekiq::Testing.inline! do
+      WorkerHelper.perform_async
+    end
+  end
+
+  def test_that_middleware_reports_end
+    skip 'todo'
+  end
+
+  def test_that_middleware_raises_error
+    Sidekiq::Testing.inline! do
+      assert_raises StandardError do
+        ErrorWorkerHelper.perform_async
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification
+name: sidekiq-worker_stats
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Alexandre Jesus
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-11-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sidekiq
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.1.4
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.1.4
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5'
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+description: Save and see on the sidekiq dashboard your workers statistics
+email:
+- adbjesus@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-version"
+- Gemfile
+- README.md
+- lib/sidekiq-worker_stats.rb
+- lib/sidekiq/worker_stats.rb
+- lib/sidekiq/worker_stats/configuration.rb
+- lib/sidekiq/worker_stats/middleware.rb
+- lib/sidekiq/worker_stats/version.rb
+- lib/sidekiq/worker_stats/views/worker_stats.erb
+- lib/sidekiq/worker_stats/views/worker_stats_single.erb
+- lib/sidekiq/worker_stats/web.rb
+- sidekiq-worker_stats.gemspec
+- test/worker_stats/test_middleware.rb
+homepage: https://github.com/whitesmith/sidekiq-worker_stats
+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: System statistics for your sidekiq workers
+test_files:
+- test/worker_stats/test_middleware.rb