sidekiq_parameters_logging 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3c00a97157720bf54c57efbe1277aaf0efdc93e1
-  data.tar.gz: 7dc5e35a22ade77a08d71c604817ecbca957de0c
+  metadata.gz: 46b268d15a18076eda823b0cf9bf928745a59429
+  data.tar.gz: dd6a8649a14daf91967eda6fe65b5a1f4f6ff5dd
 SHA512:
-  metadata.gz: e39f667827656f8d8a6884abe78a02742497a18e496a822d39bbe694b91aeeb66202f9249a5480f7e6e0d5760db7b349a4c0e34b0e6a37c17a189e3a5ca470da
-  data.tar.gz: ad3116cd6f699a22e58d71a821060439f85b4b04d65bc0c057c32ac78e93b6b7bcaab8d183a65aad6f57ff1d697d33f5e1eaae89d28c14b39dffd5019b0eca9d
+  metadata.gz: 1facab0c06e536eb5db41dc28e0deb7669cec8f4ac9fd036e4875f3093f051ea4134c30e3198306661eca0d2db7133ce392e3bd6d685f615c230f153f60ffe04
+  data.tar.gz: 363f07c874d7b01bfa8129dfe138e0aee40fdfe3755b09cfae23f695158a29fa5ef3e318d963daf034db5cd63d5b01bafbb5397e4d68933a2bfd1ed666bb9201

data/README.markdown

@@ -6,8 +6,8 @@
 class Worker
   include Sidekiq::Worker
 
-  def perform(*args)
-    # do something 
+  def perform(*params)
+    # do something
   end
 end
 ```
@@ -21,11 +21,40 @@ Worker JID-ae4889cc009b554132fed3a0 INFO: done: 3.363 sec
 
 # with Sidekiq::Parameters::Logging
 Worker JID-ae4889cc009b554132fed3a0 INFO: start
-Worker JID-ae4889cc009b554132fed3a0 INFO: parameters: #{args.inspect}
+Worker JID-ae4889cc009b554132fed3a0 INFO: parameters: #{params.inspect}
 Worker JID-ae4889cc009b554132fed3a0 INFO: done: 3.363 sec
 
 ```
 
+## Installation
+
+Make sure that you already have [sidekiq](http://sidekiq.org/) installed.  In your `Gemfile`:
+
+```ruby
+gem 'sidekiq_parameters_logging'
+```
+
+## Log Filtering
+
+You can also filter the parameters that you want to get logged by the logger:
+
+```ruby
+class Worker
+  include Sidekiq::Worker
+  include Sidekiq::Parameters::Logger
+
+  logger_filter do |params|
+    params[-1] # only print out the last parameter
+  end
+
+  def perform(*params)
+    # do something
+  end
+end
+```
+
+`logger_filter` takes a block with an array of parameters that are being passed to your `perform` method.  Logger will then print out whatever that is returned from this block with `.inspect`.
+
 ## Notes
 
 `Sidekiq::Parameters::Logging` replaces the standard `Sidekiq::Middleware::Server::Logging`.

data/lib/sidekiq/parameters/logger.rb

@@ -0,0 +1,17 @@
+module Sidekiq
+  module Parameters
+    module Logger
+      module ClassMethods
+        attr_reader :filter_block
+
+        def logger_filter(&block)
+          @filter_block = block
+        end
+      end
+
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+    end
+  end
+end

data/lib/sidekiq/parameters/logging.rb

@@ -1,12 +1,22 @@
 module Sidekiq
-  class Parameters
+  module Parameters
     class Logging
       def call(worker, item, queue)
         Sidekiq::Logging.with_context("#{worker.class.to_s} JID-#{item['jid']}") do
           begin
             start = Time.now
             logger.info { "start" }
-            logger.info { "parameters: #{item['args'].inspect}" }
+
+            # see whether filter_block is set
+            worker_class = worker.class
+            if worker_class.respond_to?(:filter_block) && worker_class.filter_block
+              logger.info do
+                "parameters: #{worker_class.filter_block.call(item['args'].clone).inspect}"
+              end
+            else
+              logger.info { "parameters: #{item['args'].inspect}" }
+            end
+
             yield
             logger.info { "done: #{elapsed(start)} sec" }
           rescue Exception

data/lib/sidekiq_parameters_logging.rb

@@ -1,4 +1,5 @@
 require 'sidekiq/parameters/logging'
+require 'sidekiq/parameters/logger'
 
 Sidekiq.configure_server do |config|
   config.server_middleware do |chain|

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq_parameters_logging
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Teng Siong Ong
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-07 00:00:00.000000000 Z
+date: 2013-10-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sidekiq
@@ -32,6 +32,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- lib/sidekiq/parameters/logger.rb
 - lib/sidekiq/parameters/logging.rb
 - lib/sidekiq_parameters_logging.rb
 - MIT-LICENSE