sidekiq-history 0.0.7 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dcb4da53bbc80b6383a113ee1d552a4e28d72f1e
-  data.tar.gz: 94b30cd2f275a06c86c09ee3a91adf5efbfcaa8a
+  metadata.gz: a5fc1bfef2bd8600e4c92b2c95e96f6af3868958
+  data.tar.gz: e637f50b96a6fb1069ee608ddc1f874bf6261602
 SHA512:
-  metadata.gz: 0b33902b46397cad8a00aa8f616205049ed0f7bb86463a269b7e683e98527cba23302ef32366c6b085028b10d54ada0302d423c5b1c7ba7f5dfe61f0445c93b8
-  data.tar.gz: 7ef485dc3262f2da74042713a0756e8501e63301fc28a96824506b2ef6bb68b59a35c27e4ffeb68e57f69f84483e83ee13a5dd69be7f504289d078a2fe9b1646
+  metadata.gz: 544c08be81d7a1bfc2d77b1cb055a59fb7426a9e9bbe9f82e2d60c74fa837112db1ac7fd87a1ccee80fb8b2afeff4315ef4446eb704588b68aac974d452569a2
+  data.tar.gz: 64024757374fb345d3fa4686fd2a28efb8593fb7521e507ed75d766f64e1c17050a4ce92c084346a8c19185b7f8c6b34782755002981b10e1f5025c2a15c03c6

data/README.md

@@ -20,6 +20,10 @@ Or install it yourself as:
 
 Nothing left to do. Mount sidekiq, and go to the web interface. You'll see a shiny new History tab!
 
+By default it will keep history on the last 1000 jobs.  To change that set `Sidekiq::History::Middleware::MAX_COUNT = 10000`.  Be careful because the data is persisted in Redis Sorted Set and it WILL take up RAM.  Max possible value is 4294967295 per Redis limit.
+
+If you want to only record history for specific jobs you can set `Sidekiq::History::Middleware::EXCLUDE_JOBS = ['OneJob']` (do not record for specified jobs) and `Sidekiq::History::Middleware::INCLUDE_JOBS = ['AnotherJob']` (record ONLY jobs specified).  INCLUDE will take precedence so if you set it to blank array nothing will be recorded.
+
 ## Screenshot
 
 ![Web UI](https://github.com/russ/sidekiq-history/raw/master/examples/screenshot.png)

data/lib/sidekiq/history/middleware.rb

@@ -9,6 +9,7 @@ module Sidekiq
 
       def call(worker, msg, queue)
         self.msg = msg
+        job_class = msg['args'][0]['job_class']
 
         data = {
           started_at: Time.now.utc,
@@ -26,12 +27,16 @@ module Sidekiq
             conn.del(LIST_KEY)
             list.each do |entry|
               migrated_data = JSON.parse(entry)
-              conn.zadd(LIST_KEY, data[:started_at].to_f, Sidekiq.dump_json(migrated_data))
+              if record_history(job_class) == true
+                conn.zadd(LIST_KEY, data[:started_at].to_f, Sidekiq.dump_json(migrated_data))
+              end
             end
           end
 
           # regular storage of history
-          conn.zadd(LIST_KEY, data[:started_at].to_f, Sidekiq.dump_json(data))
+          if record_history(job_class) == true
+            conn.zadd(LIST_KEY, data[:started_at].to_f, Sidekiq.dump_json(data))
+          end
           unless Sidekiq.history_max_count == false
             conn.zremrangebyrank(LIST_KEY, 0, -(Sidekiq.history_max_count + 1))
           end
@@ -39,6 +44,29 @@ module Sidekiq
 
         yield
       end
+
+      private
+
+      # check if this job should be recorded
+      def record_history job_class
+        # first check inclusion
+        if defined? INCLUDE_JOBS
+          if INCLUDE_JOBS.include? job_class
+            return true
+          else
+            return false
+          end
+        elsif defined? EXCLUDE_JOBS
+          if EXCLUDE_JOBS.include? job_class
+            return false
+          else
+            return true
+          end
+        else
+          return true
+        end
+      end
+
     end
   end
 end

data/lib/sidekiq/history/version.rb

@@ -1,5 +1,5 @@
 module Sidekiq
   module History
-    VERSION = "0.0.7"
+    VERSION = "0.0.8"
   end
 end

data/lib/sidekiq/history.rb

@@ -9,7 +9,13 @@ module Sidekiq
   end
 
   def self.history_max_count
-    return 1000 if @history_max_count.nil?
+    # => use default 1000 unless specified in config.  Max is 4294967295 per Redis Sorted Set limit
+    if defined? MAX_COUNT
+      hmc = [MAX_COUNT, 4294967295].min
+    else
+      hmc = 1000
+    end
+    return hmc if @history_max_count.nil?
     @history_max_count
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-history
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
 platform: ruby
 authors:
 - Russ Smith
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-10-04 00:00:00.000000000 Z
+date: 2017-04-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sidekiq
@@ -135,7 +135,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: History for sidekiq jobs.