resque-cleaner 0.2.2 → 0.2.3

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 0.2.3 (2011-04-11)
+
+* Exception filter.
+
 ## 0.2.2 (2011-04-07)
 
 * Changed a way to load yajl/json\_gem.

data/README.markdown

@@ -64,10 +64,18 @@ You could also group them by class.
           total:   10
     => {'BadJob' => 3, ...}
 
+Or you could also group them by exception.
+
+    > cleaner.stats_by_exception
+	 RuntimeError:   35
+    SyntaxError:    7
+          total:   42
+    => {'RuntimeError' => 35, ...}
+
 You can get the ones filtered with a block: it targets only jobs which the block
-evaluetes true.
+evaluates true.
 
-e.g. Show stats only of jobs entried with some arguments:
+e.g. Show stats only of jobs entered with some arguments:
 
     > cleaner.stats_by_date {|j| j["payload"]["args"].size > 0}
     2009/03/13:    3
@@ -90,13 +98,13 @@ e.g. Retry only jobs with some arguments:
     > cleaner.requeue {|j| j["payload"]["args"].size > 0}
 
 The job hash is extended with a module which defines some useful methods. You
-can use it in the blcok.
+can use it in the block.
 
-e.g. Retry only jobs entried within a day:
+e.g. Retry only jobs entered within a day:
 
     > cleaner.requeue {|j| j.after?(1.day.ago)}
 
-e.g. Retry EmailJob entried with arguments within 3 days:
+e.g. Retry EmailJob entered with arguments within 3 days:
 
     > cleaner.requeue {|j| j.after?(3.days.ago) && j.klass?(EmailJob) && j["payload"]["args"].size>0}
 
@@ -112,7 +120,7 @@ You can clear all failed jobs with this method:
 
     > cleaner.clear
 
-Like you can do with the retry method, the clear metod takes a block. Here are
+Like you can do with the retry method, the clear method takes a block. Here are
 some examples:
 
     > cleaner.clear {|j| j.retried?}
@@ -121,7 +129,7 @@ some examples:
     > cleaner.clear {|j| j.queue?(:low) && j.before?('2010-10-10')}
     => clears all jobs entried in :low queue before 10th October, 2010.
 
-    > cleaner.clear {|j| j["exception"]=="RuntimeError" && j.queue?(:low)}
+    > cleaner.clear {|j| j.exception?("RuntimeError") && j.queue?(:low)}
     => clears all jobs raised RuntimeError and queued :low queue
 
 **Retry and Clear Jobs**
@@ -136,7 +144,7 @@ e.g. Retry EmailJob and remove from failed jobs:
 **Retry with other queue**
 
 You can requeue failed jobs into other queue. In this way, you can retry failed
-jobs without blocking jobs being entried by your service running in the live.
+jobs without blocking jobs being entered by your service running in the live.
 
 e.g. Retry failed jobs on :retry queue
 
@@ -150,13 +158,13 @@ Don't forget to launch resque worker for the queue.
 
 You can just select the jobs of course. Here are some examples:
 
-    > cleaner.select {|j| j["exception"]=="RuntimeError"}
+    > cleaner.select {|j| j["payload"]["args"][0]=="Johonson"}
     > cleaner.select {|j| j.after?(2.days.ago)}
     > cleaner.select #=> returns all jobs
 
 **Helper Methods**
 
-Here is a list of methods a failed job ratained through ResqueCleaner has:
+Here is a list of methods a failed job retained through ResqueCleaner has:
 
     retried?: returns true if the job has already been retried.
     requeued?: alias of retried?.
@@ -164,6 +172,7 @@ Here is a list of methods a failed job ratained through ResqueCleaner has:
     after?(time): returns true if the job failed after the time.
     klass?(klass_or_name): returns true if the class of job matches.
     queue?(queue_name): returns true if the queue of job matches.
+    exception?(exception_name): returns true if the exception matches.
 
 
 Failed Job
@@ -200,7 +209,7 @@ ResqueCleaner supposes recent jobs are more important than old jobs. Therefore
 ResqueCleaner deals with **ONLY LAST X(default=1000) JOBS**. In this way, you
 could avoid slow responses. You can change the number through `limiter` attribute.
 
-Let's see how it works with an follwing example.
+Let's see how it works with an following example.
 
 **Sample Situation**
 
@@ -227,13 +236,13 @@ You can change the maximum number of the limiter with maximum attribute.
     > cleaner.limiter.on?
     => true
 
-With limiter, ResqueClener's filtering targets only the last X(3000 in this
-sampe) failed jobs.
+With limiter, ResqueCleaner's filtering targets only the last X(3000 in this
+sample) failed jobs.
 
     > cleaner.select.size
     => 3,000
 
-The clear\_stale method deletes all jobs entried prior to the last X(3000 in
+The clear\_stale method deletes all jobs entered prior to the last X(3000 in
 this sample) failed jobs. This calls Redis API and no iteration occurs on Ruby
 application; it should be quick even if there are huge number of failed jobs.
 
@@ -245,4 +254,9 @@ application; it should be quick even if there are huge number of failed jobs.
     > cleaner.limiter.on?
     => false
 
+Many Thanks!
+------------
+
+To our [Contributors](https://github.com/ono/resque-cleaner/contributors)
+
 

data/lib/resque_cleaner.rb

@@ -46,7 +46,7 @@ module Resque
         end
 
         print_stats(stats) if print?
-        stats 
+        stats
       end
 
       # Stats by class.
@@ -59,7 +59,20 @@ module Resque
         end
 
         print_stats(stats) if print?
-        stats 
+        stats
+      end
+
+      # Stats by exception.
+      def stats_by_exception(&block)
+        jobs, stats = select(&block), {}
+        jobs.each do |job|
+          exception = job["exception"]
+          stats[exception] ||= 0
+          stats[exception] += 1
+        end
+
+        print_stats(stats) if print?
+        stats
       end
 
       # Print stats
@@ -161,6 +174,11 @@ module Resque
           self["payload"]["class"] == klass_or_name.to_s
         end
 
+        # Returns true if the exception raised by the failed job matches. Otherwise returns false.
+        def exception?(exception)
+          self["exception"] == exception.to_s
+        end
+
         # Returns true if the queue of the job matches. Otherwise returns false.
         def queue?(queue)
           self["queue"] == queue.to_s
@@ -168,7 +186,7 @@ module Resque
       end
 
       # Through the Limiter class, you accesses only the last x(default 1000)
-      # jobs. 
+      # jobs.
       class Limiter
         DEFAULT_MAX_JOBS = 1000
         attr_accessor :maximum

data/lib/resque_cleaner/server.rb

@@ -10,7 +10,7 @@ module ResqueCleaner
       File.join(File.dirname(__FILE__), 'server', 'public', filename)
     end
 
-    # Pagination helpr for list page.
+    # Pagination helper for list page.
     class Paginate
       attr_accessor :page_size, :page, :jobs, :url
       def initialize(jobs, url, page=1, page_size=20)
@@ -87,6 +87,16 @@ module ResqueCleaner
             end
             html += "</select>"
           end
+
+          def exception_filter(id, name, exceptions, value)
+            html = "<select id=\"#{id}\" name=\"#{name}\">"
+            html += "<option value=\"\">-</option>"
+            exceptions.each do |ex|
+              selected = ex == value ? 'selected="selected"' : ''
+              html += "<option #{selected} value=\"#{ex}\">#{ex}</option>"
+            end
+            html += "</select>"
+          end
         end
 
         get "/cleaner" do
@@ -121,10 +131,11 @@ module ResqueCleaner
 
           @failed = cleaner.select(&block).reverse
 
-          url = "cleaner_list?c=#{@klass}&f=#{@from}&t=#{@to}"
+          url = "cleaner_list?c=#{@klass}&ex=#{@exception}f=#{@from}&t=#{@to}"
           @paginate = Paginate.new(@failed, url, params[:p].to_i)
 
           @klasses = cleaner.stats_by_class.keys
+          @exceptions = cleaner.stats_by_exception.keys
           @count = cleaner.select(&block).size
 
           erb File.read(ResqueCleaner::Server.erb_path('cleaner_list.erb'))
@@ -141,14 +152,14 @@ module ResqueCleaner
 
           block = filter_block
 
-          @count = 
+          @count =
             case params[:action]
             when "clear" then cleaner.clear(&block)
             when "retry_and_clear" then cleaner.requeue(true,&block)
             when "retry" then cleaner.requeue(false,{},&block)
             end
 
-          @url = "cleaner_list?c=#{@klass}&f=#{@from}&t=#{@to}"
+          @url = "cleaner_list?c=#{@klass}&ex=#{@exception}&f=#{@from}&t=#{@to}"
           erb File.read(ResqueCleaner::Server.erb_path('cleaner_exec.erb'))
         end
 
@@ -184,13 +195,15 @@ module ResqueCleaner
       @from = params[:f]=="" ? nil : params[:f]
       @to = params[:t]=="" ? nil : params[:t]
       @klass = params[:c]=="" ? nil : params[:c]
+      @exception = params[:ex]=="" ? nil : params[:ex]
     end
 
     def filter_block
       block = lambda{|j|
         (!@from || j.after?(hours_ago(@from))) &&
         (!@to || j.before?(hours_ago(@to))) &&
-        (!@klass || j.klass?(@klass)) && 
+        (!@klass || j.klass?(@klass)) &&
+        (!@exception || j.exception?(@exception)) &&
         (!@sha1 || @sha1[Digest::SHA1.hexdigest(j.to_json)])
       }
     end

data/lib/resque_cleaner/server/views/cleaner_list.erb

@@ -12,6 +12,9 @@
         <span class="class_filter">
           Class: <%= class_filter("filter_class","c",@klasses,@klass)%>
         </span>
+        <span class="exception_filter">
+          Exception: <%= exception_filter("filter_class","ex",@exceptions,@exception)%>
+        </span>
         <span class="time_filter">
           From: <%= time_filter("filter_from","f",@from)%>
         </span>

data/test/resque_cleaner_test.rb

@@ -113,6 +113,10 @@ context "ResqueCleaner" do
     ret = @cleaner.select {|j| j.klass?(BadJobWithSyntaxError)}
     assert_equal 7, ret.size
 
+    # filter by exception
+    ret = @cleaner.select {|j| j.exception?(SyntaxError)}
+    assert_equal 7, ret.size
+
     # filter by queue
     ret = @cleaner.select {|j| j.queue?(:jobs2)}
     assert_equal 20, ret.size
@@ -149,6 +153,12 @@ context "ResqueCleaner" do
     assert_equal 7, ret['BadJobWithSyntaxError']
   end
 
+  test "#stats_by_exception returns stats grouped by exception" do
+    ret = @cleaner.stats_by_exception
+    assert_equal 35, ret['RuntimeError']
+    assert_equal 7, ret['SyntaxError']
+  end
+
   test "#lock ensures that a new failure job doesn't affect in a limit mode" do
     @cleaner.limiter.maximum = 23
     @cleaner.limiter.lock do

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: resque-cleaner
 version: !ruby/object:Gem::Version 
-  hash: 19
+  hash: 17
   prerelease: false
   segments: 
   - 0
   - 2
-  - 2
-  version: 0.2.2
+  - 3
+  version: 0.2.3
 platform: ruby
 authors: 
 - Tatsuya Ono
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-04-07 00:00:00 +01:00
+date: 2011-04-11 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency