resque-analytics 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7de5a9dd7d1aec1589887da6071dc7b988f71c3a
-  data.tar.gz: 22e1b5663baa1e2eeac7c2e858291899a59e26bf
+  metadata.gz: ee6adecc8664d4c813d51b0d276a09f3805eef5a
+  data.tar.gz: b3f61c77bfea5cc51b7bd9d1db1d2cdfcc5b786c
 SHA512:
-  metadata.gz: 87b121b68b72695be1cc095cfaa7d3a7b0854c5f793d42bab36f2e3453833c9101d7e11684dde7ec368bf1f2c210a0ab11f70e85bae348b0fdc9002c27bb1032
-  data.tar.gz: 6c81ccd7035efa82023b90befea4e927239b758bff7e4779298a9d3b4baecbfb83b02b1428419bbc31d607d23c1342b7c4fb28492488c9a45e62b24bdf3a254e
+  metadata.gz: d514eba2882be8a2625773e4d4411fafc7a044159fdeaecae0b516ff43d73722bd79502fef94056a2dda4b8ad2dce5f5cd25106b3420c370cfa2e63569756620
+  data.tar.gz: 72db95f784fe75998f2bb4714c8e110fe453126d05b305c40840503b98336884555c8a6ad29562abf0f4cd754b518f5a5a6c98936f8407031e32361a08850508

data/Changelog

@@ -0,0 +1,8 @@
+## 0.6.0 (June 9, 2014)
+
+* Add queue wait time
+
+
+## 0.5.0 (June 8, 2014)
+
+* Initial release

data/README.rdoc

@@ -7,6 +7,11 @@ For each worker, the gem keeps the following key performance indicators:
 * Number of times it executed successfuly per day
 * Number of times is failed per day
 * Total run time per day
+* Total wait time per day, which is the amount of time items for this worker were waiting in the queue
+
+Wait is somewhat tricky, as Resque doesn't provide the proper hooks to calculate this value. To handle that, I had to
+replace Resque's push method, and Job initialization method. These methods now add a timestamp when items are added
+to queues, and use the timestamp to calculate the total wait time, when an item is taken out of the queue.
 
 == Installation
 
@@ -35,7 +40,6 @@ On the Resque screens, you will find a new tab called "Analytics".
 == TODO
 
 * Add tests
-* Add queued time to total run time analytics
 
 == Contributing to resque-analytics
 

data/VERSION

@@ -1 +1 @@
-0.5.0
+0.6.0

data/lib/resque-analytics/server.rb

@@ -32,6 +32,21 @@ module Resque
           def chart_data(data, job, kpi)
             legend_keys.map { |key| @data[job][kpi][key].to_i || 0 }
           end
+
+          def chart_it(title, legend, data)
+            Gchart.bar(
+              data: data,
+              title: title,
+              format: "image_tag",
+              size: "1000x300",
+              axis_with_labels: ['x,y'],
+              bar_width_and_spacing: '6',
+              axis_range: [[-90,0,-5], [0, data.map(&:max).sum ]],
+              legend: legend,
+              legend_position: 'top',
+              bar_colors: ['000000', '0088FF']
+            )
+          end
         end
 
         class << self
@@ -39,7 +54,7 @@ module Resque
             app.get '/analytics' do
               @data = measured_jobs.inject({}) { |res, job|
                 res[job] = {}
-                [PERFORMED, FAILED, TOTAL_TIME].each { |kpi| res[job][kpi] = counters_for(job, kpi) }
+                [PERFORMED, FAILED, TOTAL_TIME, WAIT_TIME].each { |kpi| res[job][kpi] = counters_for(job, kpi) }
                 res
               }
               erb(File.read(File.join(VIEW_PATH, 'analytics.erb')))

data/lib/resque-analytics/server/views/analytics.erb

@@ -8,30 +8,9 @@
   <h2><%= job %></h2>
   <% performed = chart_data(@data, job, Resque::Plugins::Analytics::PERFORMED) %>
   <% failed = chart_data(@data, job, Resque::Plugins::Analytics::FAILED) %>
-  <%= Gchart.bar(
-    data: [performed, failed],
-    title: "Number of jobs",
-    format: "image_tag",
-    size: "1000x300",
-    axis_with_labels: ['x,y'],
-    bar_width_and_spacing: '6',
-    axis_range: [[-90,0,-5], [0, performed.max + failed.max ]],
-    legend: [Resque::Plugins::Analytics::PERFORMED, Resque::Plugins::Analytics::FAILED],
-    legend_position: 'top',
-    bar_colors: ['000000', '0088FF']
-  ) %>
+  <%= chart_it("Number of jobs", [Resque::Plugins::Analytics::PERFORMED, Resque::Plugins::Analytics::FAILED], [performed, failed]) %>
 
   <% run_time = chart_data(@data, job, Resque::Plugins::Analytics::TOTAL_TIME) %>
-  <%= Gchart.bar(
-    data: [run_time],
-    title: "Run time",
-    format: "image_tag",
-    size: "1000x300",
-    axis_with_labels: ['x,y'],
-    bar_width_and_spacing: '6',
-    axis_range: [[-90,0,-5], [0, run_time.max ]],
-    legend: [Resque::Plugins::Analytics::TOTAL_TIME],
-    legend_position: 'top'
-  ) %>
-
+  <% wait_time = chart_data(@data, job, Resque::Plugins::Analytics::WAIT_TIME) %>
+  <%= chart_it("Wait and Run times", [Resque::Plugins::Analytics::WAIT_TIME, Resque::Plugins::Analytics::TOTAL_TIME], [wait_time, run_time]) %>
 <% end %>

data/lib/resque/plugins/analytics.rb

@@ -1,13 +1,35 @@
 require 'resque'
 
 module Resque
+  # Override Resque's push method to add a timestemp to each enqueued item
+  def push(queue, item)
+    item['analytics_timestamp'] = Time.now if item.is_a?(Hash)
+    redis.pipelined do
+      watch_queue(queue)
+      redis.rpush "queue:#{queue}", encode(item)
+    end
+  end
+
+  class Job
+    # Override Job initialization to extract the timestamp
+    def initialize(queue, payload)
+      timestamp = payload.delete('analytics_timestamp')
+      @queue = queue
+      @payload = payload
+      @failure_hooks_ran = false
+      payload_class.send(:analytics_timestamp, timestamp) if payload_class.respond_to?(:analytics_timestamp)
+    end
+  end
+
   module Plugins
     module Analytics
 
       FAILED = "failed"
       PERFORMED = "performed"
       TOTAL_TIME = "total_time"
-      # WAIT_TIME = "wait_time"
+      WAIT_TIME = "wait_time"
+
+      EXPIRE = 90 * 24 * 60
 
       def key(kpi)
         date = Time.now.strftime("%y_%m_%d")
@@ -20,19 +42,24 @@ module Resque
         total_time = Time.now - start
 
         Resque.redis.lpush(key(TOTAL_TIME), total_time)
-        Resque.redis.expire(key(TOTAL_TIME), 90 * 24 * 60)
+        Resque.redis.expire(key(WAIT_TIME), EXPIRE)
       end
 
       def after_perform_analytics(*args)
         Resque.redis.incr(key(PERFORMED))
-        Resque.redis.expire(key(PERFORMED), 90 * 24 * 60)
+        Resque.redis.expire(key(WAIT_TIME), EXPIRE)
       end
 
-      def on_failure_analytics(e,*args)
+      def on_failure_analytics(error, *args)
         Resque.redis.incr(key(FAILED))
-        Resque.redis.expire(key(FAILED), 90 * 24 * 60)
+        Resque.redis.expire(key(WAIT_TIME), EXPIRE)
+      end
+
+      def analytics_timestamp(timestamp)
+        Resque.redis.lpush(key(WAIT_TIME), Time.now - Time.parse(timestamp))
+        Resque.redis.expire(key(WAIT_TIME), EXPIRE)
       end
 
     end
   end
-end
+end

data/resque-analytics.gemspec

@@ -2,16 +2,15 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: resque-analytics 0.5.0 ruby lib
+# stub: resque-analytics 0.6.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "resque-analytics"
-  s.version = "0.5.0"
+  s.version = "0.6.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.require_paths = ["lib"]
   s.authors = ["Nir Tzur"]
-  s.date = "2014-06-08"
+  s.date = "2014-06-09"
   s.description = "Shows Resque jobs key performance indciators over time"
   s.email = "nir.tzur@samanage.com"
   s.extra_rdoc_files = [
@@ -20,9 +19,11 @@ Gem::Specification.new do |s|
   ]
   s.files = [
     ".document",
+    "Changelog",
     "Gemfile",
     "Gemfile.lock",
     "LICENSE",
+    "README.rdoc",
     "Rakefile",
     "VERSION",
     "lib/resque-analytics.rb",
@@ -33,7 +34,8 @@ Gem::Specification.new do |s|
   ]
   s.homepage = "http://github.com/nirtzur/resque-analytics"
   s.licenses = ["MIT"]
-  s.rubygems_version = "2.2.2"
+  s.require_paths = ["lib"]
+  s.rubygems_version = "2.1.11"
   s.summary = "Resque Job Analytics"
 
   if s.respond_to? :specification_version then

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: resque-analytics
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Nir Tzur
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-08 00:00:00.000000000 Z
+date: 2014-06-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: resque
@@ -89,9 +89,11 @@ extra_rdoc_files:
 - README.rdoc
 files:
 - .document
+- Changelog
 - Gemfile
 - Gemfile.lock
 - LICENSE
+- README.rdoc
 - Rakefile
 - VERSION
 - lib/resque-analytics.rb
@@ -99,7 +101,6 @@ files:
 - lib/resque-analytics/server/views/analytics.erb
 - lib/resque/plugins/analytics.rb
 - resque-analytics.gemspec
-- README.rdoc
 homepage: http://github.com/nirtzur/resque-analytics
 licenses:
 - MIT