sidekiq_parameters_logging 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3c00a97157720bf54c57efbe1277aaf0efdc93e1
+  data.tar.gz: 7dc5e35a22ade77a08d71c604817ecbca957de0c
+SHA512:
+  metadata.gz: e39f667827656f8d8a6884abe78a02742497a18e496a822d39bbe694b91aeeb66202f9249a5480f7e6e0d5760db7b349a4c0e34b0e6a37c17a189e3a5ca470da
+  data.tar.gz: ad3116cd6f699a22e58d71a821060439f85b4b04d65bc0c057c32ac78e93b6b7bcaab8d183a65aad6f57ff1d697d33f5e1eaae89d28c14b39dffd5019b0eca9d

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2013 Teng Siong Ong
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.markdown

@@ -0,0 +1,43 @@
+# Sidekiq::Parameters::Logging
+
+`Sidekiq::Parameters::Logging` is a middleware for Sidekiq to log all the parameters that you pass to your worker.  For example:
+
+```ruby
+class Worker
+  include Sidekiq::Worker
+
+  def perform(*args)
+    # do something 
+  end
+end
+```
+
+When you run sidekiq, you see this:
+
+```
+# without Sidekiq::Parameters::Logging
+Worker JID-ae4889cc009b554132fed3a0 INFO: start
+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: done: 3.363 sec
+
+```
+
+## Notes
+
+`Sidekiq::Parameters::Logging` replaces the standard `Sidekiq::Middleware::Server::Logging`.
+
+## License
+
+(The MIT License)
+
+Copyright (c) 2013 Teng Siong Ong
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/lib/sidekiq/parameters/logging.rb

@@ -0,0 +1,28 @@
+module Sidekiq
+  class 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}" }
+            yield
+            logger.info { "done: #{elapsed(start)} sec" }
+          rescue Exception
+            logger.info { "fail: #{elapsed(start)} sec" }
+            raise
+          end
+        end
+      end
+
+      def elapsed(start)
+        (Time.now - start).to_f.round(3)
+      end
+
+      def logger
+        Sidekiq.logger
+      end
+    end
+  end
+end

data/lib/sidekiq_parameters_logging.rb

@@ -0,0 +1,8 @@
+require 'sidekiq/parameters/logging'
+
+Sidekiq.configure_server do |config|
+  config.server_middleware do |chain|
+    chain.remove Sidekiq::Middleware::Server::Logging
+    chain.add Sidekiq::Parameters::Logging
+  end
+end

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification
+name: sidekiq_parameters_logging
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Teng Siong Ong
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sidekiq
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+description: Sidekiq::Paramters::Logging middleware to log parameters passsed to each
+  worker.
+email:
+- siong1987@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/sidekiq/parameters/logging.rb
+- lib/sidekiq_parameters_logging.rb
+- MIT-LICENSE
+- README.markdown
+homepage: https://github.com/siong1987/sidekiq_parameters_logging
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Sidekiq::Paramters::Logging middleware to log parameters passsed to each
+  worker.
+test_files: []