sidekiq-skylight 0.0.4 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3443a4fe1cb4b12ba1f62189c03689fa9637d94e
-  data.tar.gz: 6e31c081e4403f5a0196e0c7ab77165c15fcb04a
+  metadata.gz: 8e2c60a848b24d3651ca7f79732057f783341c1e
+  data.tar.gz: acf95b402036e11b68a1216f8775fb7018e359c5
 SHA512:
-  metadata.gz: cda709bddcee26addacc9ab156d0520187aa83e37c6bf5b49d95aa55194a1fde31333da4b18fd97b91e7b235e3e371f63e2b639a6c389b754de792409e4dd80b
-  data.tar.gz: 8b635e7e007a502bb24c7f9c554edbf4940aec00b4c049ff0f568040b67618cc42416ce5c49653410afdc9569ffa55fcebee7a1077e0a96ad101e42770ea4a1a
+  metadata.gz: 100a2d39ce801249bfad8327b181e8a23c1ea2ee4a56e6ffcf392364b6a9739420551eb39b0a2d66f6bae225b14aa1132bf0b4d2bbdf365215a0aecf306f9b45
+  data.tar.gz: 34292932066fd99422bb8ad14591481503d0b6a36e74b906a59e3e7d1971d4a6ad709cad15404b15ea17e2927d13e0c06e357e08e7a35106dbc8f1f3a320eb04

data/.rubocop.yml

@@ -0,0 +1,98 @@
+# Common configuration.
+AllCops:
+  # Include gemspec and Rakefile
+  Include:
+    - '**/*.gemspec'
+    - '**/Rakefile'
+    - '**/*.rake'
+    - '**/Gemfile'
+  Exclude:
+    - 'vendor/**'
+    - 'spec/fixtures/**'
+    - 'bin/**'
+  RunRailsCops: true
+
+# Indent private/protected/public as deep as method definitions
+AccessModifierIndentation:
+  EnforcedStyle: outdent
+  SupportedStyles:
+    - outdent
+    - indent
+
+# Indentation of `when`.
+CaseIndentation:
+  IndentWhenRelativeTo: end
+  SupportedStyles:
+    - case
+    - end
+  IndentOneStep: false
+
+ClassLength:
+  CountComments: false  # count full line comments?
+  Max: 200
+
+# Align ends correctly.
+EndAlignment:
+  # The value `keyword` means that `end` should be aligned with the matching
+  # keyword (if, while, etc.).
+  # The value `variable` means that in assignments, `end` should be aligned
+  # with the start of the variable on the left hand side of `=`. In all other
+  # situations, `end` should still be aligned with the keyword.
+  AlignWith: variable
+  SupportedStyles:
+    - keyword
+    - variable
+
+# Built-in global variables are allowed by default.
+GlobalVars:
+  AllowedVariables: ['$1', '$2', '$3', '$4', '$5', '$6']
+
+LineLength:
+  Max: 120
+
+MethodLength:
+  CountComments: false  # count full line comments?
+  Max: 20
+
+NumericLiterals:
+  MinDigits: 10
+
+SignalException:
+  EnforcedStyle: only_raise
+  SupportedStyles:
+    - only_raise
+    - only_fail
+    - semantic
+
+SpaceBeforeBlockBraces:
+  EnforcedStyle: no_space
+  SupportedStyles:
+    - space
+    - no_space
+
+SpaceInsideBlockBraces:
+  EnforcedStyle: no_space
+  SupportedStyles:
+    - space
+    - no_space
+  # Valid values are: space, no_space
+  EnforcedStyleForEmptyBraces: no_space
+  # Space between { and |. Overrides EnforcedStyle if there is a conflict.
+  SpaceBeforeBlockParameters: false
+
+SpaceInsideHashLiteralBraces:
+  EnforcedStyle: no_space
+  EnforcedStyleForEmptyBraces: no_space
+  SupportedStyles:
+    - space
+    - no_space
+
+# Checks whether the source file has a utf-8 encoding comment or not
+Encoding:
+  EnforcedStyle: when_needed
+  SupportedStyles:
+    - when_needed
+    - always
+
+WordArray:
+  MinSize: 0

data/README.md

@@ -20,6 +20,19 @@ Or install it yourself as:
 
     $ gem install sidekiq-skylight
 
+## Blacklisted Jobs
+
+If there's a job that you don't want to be instrumented via Skylight, you can
+use the `blacklisted_workers` config option like so:
+
+```ruby
+Sidekiq::Skylight.configure do |config|
+  config.blacklisted_workers = ['BlacklistedWorker']
+end
+```
+
+Any workers with the class names you specify will be ignored from any Skylight tracing.
+
 ## Usage
 
 Make sure you've setup skylight.io for your project already. Everything else should be automatic.

data/Rakefile

@@ -1,7 +1,6 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
-
+task default: :spec

data/lib/sidekiq/skylight.rb

@@ -2,6 +2,7 @@ require 'sidekiq'
 
 require_relative 'skylight/version'
 require_relative 'skylight/server_middleware'
+require_relative 'skylight/configuration'
 
 Sidekiq.configure_server do |config|
   config.server_middleware do |chain|

data/lib/sidekiq/skylight/configuration.rb

@@ -0,0 +1,19 @@
+module Sidekiq
+  module Skylight
+    class Configuration
+      attr_accessor :blacklisted_workers
+
+      def blacklisted_workers
+        @blacklisted_workers ||= []
+      end
+    end
+
+    def self.config
+      @configuration ||= Configuration.new
+    end
+
+    def self.configure
+      yield config
+    end
+  end
+end

data/lib/sidekiq/skylight/server_middleware.rb

@@ -3,11 +3,17 @@ require 'skylight'
 module Sidekiq
   module Skylight
     class ServerMiddleware
-      def call(worker, job, queue)
-        ::Skylight.trace("#{worker.class.to_s}#perform", 'app.sidekiq.worker', 'process') do
+      def call(worker, _job, _queue)
+        if config.blacklisted_workers.include?(worker.class.name)
           yield
+        else
+          ::Skylight.trace("#{worker.class}#perform", 'app.sidekiq.worker', 'process', &Proc.new)
         end
       end
+
+      def config
+        Sidekiq::Skylight.config
+      end
     end
   end
 end

data/lib/sidekiq/skylight/version.rb

@@ -1,5 +1,5 @@
 module Sidekiq
   module Skylight
-    VERSION = "0.0.4"
+    VERSION = '0.1.0'
   end
 end

data/sidekiq-skylight.gemspec

@@ -4,23 +4,23 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'sidekiq/skylight/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "sidekiq-skylight"
+  spec.name          = 'sidekiq-skylight'
   spec.version       = Sidekiq::Skylight::VERSION
-  spec.authors       = ["Allen Madsen"]
-  spec.email         = ["blatyo@gmail.com"]
-  spec.summary       = %q{Middleware for instrumenting Sidekiq with Skylight.io}
-  spec.description   = %q{Middleware for instrumenting Sidekiq with Skylight.io. Automatically configured when required.}
-  spec.homepage      = "https://github.com/lintci/sidekiq-skylight"
-  spec.license       = "MIT"
+  spec.authors       = ['Allen Madsen']
+  spec.email         = ['blatyo@gmail.com']
+  spec.summary       = 'Middleware for instrumenting Sidekiq with Skylight.io'
+  spec.description   = 'Middleware for instrumenting Sidekiq with Skylight.io. Automatically configured when required.'
+  spec.homepage      = 'https://github.com/lintci/sidekiq-skylight'
+  spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0")
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.executables   = spec.files.grep(%r{^bin/}){|f| File.basename(f)}
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
   spec.add_runtime_dependency 'sidekiq', '>= 3.3.0'
   spec.add_runtime_dependency 'skylight', '>= 0.5.2'
-  spec.add_development_dependency "bundler", "~> 1.7"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec"
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec'
 end

data/spec/sidekiq/skylight/server_middleware_spec.rb

@@ -4,10 +4,38 @@ describe Sidekiq::Skylight::ServerMiddleware do
   subject(:middleware){described_class.new}
 
   FakeWorker = Class.new
+  BlacklistedWorker = Class.new
 
   it 'wraps block in skylight instrument' do
-    expect(::Skylight).to receive(:trace).with('FakeWorker#perform', 'app.sidekiq.worker', 'process'){|&block| block.call}
+    expect(::Skylight).to receive(:trace).with('FakeWorker#perform', 'app.sidekiq.worker', 'process') do |&block|
+      block.call
+    end
 
     expect{|probe| middleware.call(FakeWorker.new, double(:job), double(:queue), &probe)}.to yield_control
   end
+
+  context 'with blacklisted workers' do
+    around(:each) do |example|
+      previous_blacklisted = Sidekiq::Skylight.config.blacklisted_workers
+      Sidekiq::Skylight.config.blacklisted_workers = %w(BlacklistedWorker)
+
+      example.run
+
+      Sidekiq::Skylight.config.blacklisted_workers = previous_blacklisted
+    end
+
+    it 'does not instrument a blacklisted worker' do
+      expect(::Skylight).to_not receive(:trace)
+
+      expect{|probe| middleware.call(BlacklistedWorker.new, double(:job), double(:queue), &probe)}.to yield_control
+    end
+
+    it 'still instruments non-blacklisted workers' do
+      expect(::Skylight).to receive(:trace).with('FakeWorker#perform', 'app.sidekiq.worker', 'process') do |&block|
+        block.call
+      end
+
+      expect{|probe| middleware.call(FakeWorker.new, double(:job), double(:queue), &probe)}.to yield_control
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-skylight
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.1.0
 platform: ruby
 authors:
 - Allen Madsen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-15 00:00:00.000000000 Z
+date: 2015-07-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sidekiq
@@ -90,6 +90,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -97,6 +98,7 @@ files:
 - circle.yml
 - lib/sidekiq-skylight.rb
 - lib/sidekiq/skylight.rb
+- lib/sidekiq/skylight/configuration.rb
 - lib/sidekiq/skylight/server_middleware.rb
 - lib/sidekiq/skylight/version.rb
 - sidekiq-skylight.gemspec
@@ -123,7 +125,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: Middleware for instrumenting Sidekiq with Skylight.io