sidekiq-worker_stats 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dc301892db995ec508d5f9300d46fedece1bad94
-  data.tar.gz: 689357440d58ff1d72a62f3dd59670dfec7f2063
+  metadata.gz: d1543112b4d14962857125dc3f4b1f87696fbf30
+  data.tar.gz: e1f94d3c2cde419a3ac7b0b791cdb78a548f5d71
 SHA512:
-  metadata.gz: 64b8a35dfb4a99dfd7613a5dca0979875b7bb9731e01df922d648af8f6ad739add9c86f73b1f46db11e967f8adda2c8481dde0f1638d9db790daee9b4d17d514
-  data.tar.gz: b7c1f6ae4c030359714f881e718080a315367fa5096aa24b5947e89f1bce609b0a9dedf1d66852e9d1cb4de38d9daa24105eda3e49c304996657314b28a5399b
+  metadata.gz: 29dd66f6095e0f074fa92e17591bde836e2ab2908c95bf0e173e4ba845c8b83fddf10a3f6fd88f8bda462bd5dc2aaad53a1062193f589728789602d4812b7a99
+  data.tar.gz: a49ec725dac939319000624e8eacd1f1522a36af6437ab2dc67d21c3e39c96ba706a1928c183b4a480451f1c3c975a619c4803f782a1dc0d5a13f0de93520748

data/README.md

@@ -1,3 +1,28 @@
 # sidekiq-worker\_stats
+**Statistics for sidekiq workers**
 
-Statistics for sidekiq workers.
+Build status - TODO
+
+The following statistics are saved for analysis:
+
+* Start Time
+* Stop Time
+* Runtime
+* Memory
+
+## Installation
+
+Add `sidekiq-worker_stats` to your Gemfile
+
+```ruby
+gem 'sidekiq-worker_stats'
+```
+
+and install
+
+```bash
+$ bundle install
+```
+
+## Configuration
+We can configure 

data/lib/sidekiq/worker_stats.rb

@@ -1,24 +1,11 @@
 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
 

data/lib/sidekiq/worker_stats/configuration.rb

@@ -1,13 +1,23 @@
 module Sidekiq
   module WorkerStats
     class Configuration
-      attr_accessor :log_file
-      attr_accessor :time
+      DEFAULT_MEM_SLEEP = 5.freeze
+      DEFAULT_ENABLED = false.freeze
 
-      def initialize
-        @log_file = 'log/sidekiq.log'
-        @time = 5
+      attr_reader :klass
+
+      def initialize(klass)
+        @klass = klass
+      end
+
+      def mem_sleep
+        @klass.get_sidekiq_options['worker_stats_mem_sleep'] || Sidekiq::WorkerStats::Configuration::DEFAULT_MEM_SLEEP
+      end
+
+      def enabled
+        @klass.get_sidekiq_options['worker_stats_enabled'] || Sidekiq::WorkerStats::Configuration::DEFAULT_ENABLED
       end
     end
   end
 end
+

data/lib/sidekiq/worker_stats/middleware.rb

@@ -1,53 +1,26 @@
-require 'json'
+require 'sidekiq/worker_stats/configuration'
+require 'sidekiq/worker_stats/stats'
 
 module Sidekiq
   module WorkerStats
     class Middleware
       def call(worker, msg, queue)
-        worker_stats = {}
-        worker_stats[:start] = Time.now.to_i
-        worker_stats[:status] = 'started'
+        c = Sidekiq::WorkerStats::Configuration.new(worker.class)
 
-        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
+        unless c.enabled
+          yield
+          return
         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)
+        begin
+          s = Sidekiq::WorkerStats::Stats.new(worker, msg, queue, c)
+          yield
+          s.stop('completed')
+        rescue => e
+          s.stop('failed')
+          raise e
+        ensure
+          s.save
         end
       end
     end

data/lib/sidekiq/worker_stats/stats.rb

@@ -0,0 +1,86 @@
+require 'sidekiq'
+require 'json'
+
+module Sidekiq
+  module WorkerStats
+    class Stats
+      attr_reader :pid
+      attr_reader :jid
+      attr_reader :queue
+      attr_reader :klass
+
+      attr_reader :start
+      attr_reader :stop
+      attr_reader :walltime
+      attr_reader :status
+      attr_reader :page_size
+      attr_reader :mem
+
+      attr_reader :mem_thr
+      attr_reader :config
+
+      def initialize(worker, msg, queue, config)
+        @config = config
+        @queue = queue
+        @klass = worker.class
+        @pid = Process.pid
+        @jid = worker.jid
+        @page_size = `getconf PAGESIZE`.to_i
+        start
+      end
+
+      def start
+        @status = 'started'
+        @start = Time.now.to_f
+        memory_measurement
+      end
+
+      def stop(status)
+        @stop = Time.now.to_f
+        @walltime = @stop - @start
+        @status = status
+
+        mem_thr.exit if mem_thr != nil
+        @mem[Time.now.to_f] = current_memory
+      end
+
+      def save
+        worker_key = "#{@klass}:#{@start}:#{@jid}"
+        data = {
+          pid: @pid,
+          jid: @jid,
+          queue: @queue,
+          class: @klass,
+          start: @start,
+          stop: @stop,
+          walltime: @walltime,
+          status: @status,
+          page_size: @page_size,
+          mem: @mem
+        }
+
+        Sidekiq.redis do |redis|
+          redis.hset Sidekiq::WorkerStats::REDIS_HASH, worker_key, JSON.generate(data)
+        end
+      end
+
+      private
+
+      def memory_measurement
+        @mem = {}
+        mem_sleep = @config.mem_sleep
+        puts mem_sleep
+        @mem_thr = Thread.new do
+          while true do
+            @mem[Time.now.to_f] = current_memory
+            sleep mem_sleep
+          end
+        end
+      end
+
+      def current_memory
+        `awk '{ print $2 }' /proc/#{@pid}/statm`.strip.to_i * @page_size
+      end
+    end
+  end
+end

data/lib/sidekiq/worker_stats/version.rb

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

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

@@ -19,7 +19,7 @@
               <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["walltime"]} s" %></td>
               <td><%= "#{(worker["mem"].values.inject(:+) / worker["mem"].count) / 1024 / 1024} Mb" %></td>
               <td><%= "#{(worker["mem"].values.max / 1024 / 1024)} Mb" %></td>
             </tr>

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

@@ -38,7 +38,7 @@
             </tr>
             <tr>
               <td>Runtime</td>
-              <td><%= @worker["runtime"] %> seconds</td>
+              <td><%= @worker["walltime"] %> seconds</td>
             </tr>
           </tbody>
         </table>
@@ -57,7 +57,7 @@
           <tbody>
             <% @worker["mem"].each do |time, mem| %>
               <tr>
-                <td><%= (time.to_i - @worker["start"]).to_s %> seconds</td>
+                <td><%= (time.to_f - @worker["start"]).round(2).to_s %> seconds</td>
                 <td><%= "#{mem / 1024 / 1024} Mb" %></td>
               </tr>
             <% end %>

data/lib/sidekiq/worker_stats/web.rb

@@ -13,7 +13,8 @@ module Sidekiq
           Sidekiq.redis do |redis|
             keys = redis.hkeys REDIS_HASH
             keys.each do |key|
-              @workers[key] = JSON.parse(redis.hget(REDIS_HASH, key))
+              worker_stats = redis.hget(REDIS_HASH, key)
+              @workers[key] = JSON.parse(worker_stats) if worker_stats != nil
             end
           end
 
@@ -34,5 +35,7 @@ module Sidekiq
   end
 end
 
-Sidekiq::Web.register Sidekiq::WorkerStats::Web
-Sidekiq::Web.tabs['Worker Stats'] = 'worker_stats'
+if defined?(Sidekiq::Web)
+  Sidekiq::Web.register Sidekiq::WorkerStats::Web
+  Sidekiq::Web.tabs['Worker Stats'] = 'worker_stats'
+end

data/test/worker_stats/test_middleware.rb

@@ -6,55 +6,76 @@ require 'sidekiq'
 require 'sidekiq/testing'
 require 'sidekiq/worker_stats'
 
-
-class WorkerHelper
+class BasicWorker
   include Sidekiq::Worker
 
+  sidekiq_options({
+    worker_stats_enabled: true,
+    worker_stats_mem_sleep: 1
+  })
+
   def perform
     # Let's use some memory
     a = []
-    for i in 1..10000000
+    for i in 1..5000000
       a << i.to_s * 10
     end
   end
 end
 
-class ErrorWorkerHelper
+class NoStatsWorker
   include Sidekiq::Worker
 
+  sidekiq_options({
+    worker_stats_enabled: false
+  })
+
   def perform
-    raise StandardError.new("Error")
   end
 end
 
-class TestMiddleware < Minitest::Test
-  include Rack::Test::Methods
+class ErrorWorker
+  include Sidekiq::Worker
+
+  sidekiq_options({
+    worker_stats_enabled: true,
+    worker_stats_mem_sleep: 1
+  })
 
-  def app
-    Sidekiq::Web
+  def perform
+    raise StandardError.new("Error")
   end
+end
 
+class TestMiddleware < Minitest::Test
   def setup
     Sidekiq::Testing.server_middleware do |chain|
       chain.add Sidekiq::WorkerStats::Middleware
     end
   end
 
-  def test_that_middleware_reports_start
+  def test_basic_worker_stats_are_saved
     Sidekiq::Testing.inline! do
-      WorkerHelper.perform_async
+      BasicWorker.perform_async
     end
   end
 
-  def test_that_middleware_reports_end
-    skip 'todo'
+  def test_no_stats_worker
+    Sidekiq::Testing.inline! do
+      NoStatsWorker.perform_async
+    end
   end
 
   def test_that_middleware_raises_error
     Sidekiq::Testing.inline! do
       assert_raises StandardError do
-        ErrorWorkerHelper.perform_async
+        ErrorWorker.perform_async
       end
     end
   end
+  
+  def test_that_middleware_reports_end
+    skip 'todo'
+  end
+
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-worker_stats
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Alexandre Jesus
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-07 00:00:00.000000000 Z
+date: 2016-11-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sidekiq
@@ -99,6 +99,7 @@ files:
 - lib/sidekiq/worker_stats.rb
 - lib/sidekiq/worker_stats/configuration.rb
 - lib/sidekiq/worker_stats/middleware.rb
+- lib/sidekiq/worker_stats/stats.rb
 - lib/sidekiq/worker_stats/version.rb
 - lib/sidekiq/worker_stats/views/worker_stats.erb
 - lib/sidekiq/worker_stats/views/worker_stats_single.erb