harness-sidekiq 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f51188a74ffc9aa28a9e4ece8df44b7c324f954c
+  data.tar.gz: bdecc2ce964519c3fdf2b598ee7e08012cf22467
+SHA512:
+  metadata.gz: dcba540980d9e8b3d74f1d5a2a7749dfaaeecf095bb1b64317d99650b9309a232a1baa9a48d928bf43c950fe2fca00d3a68da3d58e094cc0f1bca97b4a4a18c7
+  data.tar.gz: 52e92c5da9c38f314fe279b069bc066c2a930c1af1fe8d24a7269ccf8b035887fa7b2f4a64f5057798a5275a3c9c9833984618306e26d132cc1259845fd970a5

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in harness-varnish.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 ahawkins
+
+MIT License
+
+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.md

@@ -0,0 +1,25 @@
+# Harness::Sidekiq
+
+Log sidekiq related metrics with Harness
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'harness-sidekiq'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install harness-sidekiq
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/*_test.rb'
+end
+
+task :default => :test

data/harness-sidekiq.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'harness/sidekiq/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "harness-sidekiq"
+  spec.version       = Harness::Sidekiq::VERSION
+  spec.authors       = ["ahawkins"]
+  spec.email         = ["adam@hawkins.io"]
+  spec.description   = %q{Log sidekiq metrics to Harness}
+  spec.summary       = %q{}
+  spec.homepage      = "https://github.com/ahawkins/harness-sidekiq"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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.add_dependency "harness"
+  spec.add_dependency "sidekiq"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

data/lib/harness-sidekiq.rb

@@ -0,0 +1 @@
+require 'harness/sidekiq'

data/lib/harness/sidekiq.rb

@@ -0,0 +1,53 @@
+require "harness/sidekiq/version"
+
+require 'sidekiq'
+require 'harness'
+
+module Sidekiq
+  module Middleware
+    module Server
+      class HarnessInstrumentation
+        include Harness::Instrumentation
+
+        def call(worker, item, queue)
+          time "sidekiq.#{worker.class.name.underscore.gsub('/', '.')}" do
+            yield
+          end
+
+          increment "sidekiq.job"
+        end
+      end
+    end
+  end
+end
+
+Sidekiq.configure_server do |config|
+  config.server_middleware do |chain|
+    chain.add Sidekiq::Middleware::Server::HarnessInstrumentation
+  end
+end
+
+module Harness
+  class SidekiqGauge
+    include Instrumentation
+
+    def initialize(namespace = nil)
+      @namespace = namespace
+    end
+
+    def log
+      stats = ::Sidekiq::Stats.new
+
+      gauge namespaced('sidekiq.jobs.processed'), stats.processed
+      gauge namespaced('sidekiq.jobs.enqueued'), stats.enqueued
+      gauge namespaced('sidekiq.jobs.failed'), stats.failed
+      gauge namespaced('sidekiq.jobs.retries'), stats.failed
+      gauge namespaced('sidekiq.jobs.scheduled'), stats.scheduled_size
+    end
+
+    private
+    def namespaced(name)
+      [@namespace, name].compact.join '.'
+    end
+  end
+end

data/lib/harness/sidekiq/version.rb

@@ -0,0 +1,5 @@
+module Harness
+  module Sidekiq
+    VERSION = "0.1.0"
+  end
+end

data/test/gauge_test.rb

@@ -0,0 +1,62 @@
+require_relative 'test_helper'
+require 'logger'
+
+class NullLogger < Logger
+  def initialize(*args)
+
+  end
+
+  def add(*args)
+
+  end
+end
+
+Sidekiq.logger = NullLogger.new
+
+class SidekiqGaugeTest < MiniTest::Unit::TestCase
+  def test_reports_processed_jobs
+    instrumentor = Harness::SidekiqGauge.new
+    instrumentor.log
+
+    assert_gauge 'sidekiq.jobs.processed'
+  end
+
+  def test_reports_enqueued_jobs
+    instrumentor = Harness::SidekiqGauge.new
+    instrumentor.log
+
+    assert_gauge 'sidekiq.jobs.enqueued'
+  end
+
+  def test_reports_failed_jobs
+    instrumentor = Harness::SidekiqGauge.new
+    instrumentor.log
+
+    assert_gauge 'sidekiq.jobs.failed'
+  end
+
+  def test_reports_retries
+    instrumentor = Harness::SidekiqGauge.new
+    instrumentor.log
+
+    assert_gauge 'sidekiq.jobs.retries'
+  end
+
+  def test_reports_scheduled_jobs
+    instrumentor = Harness::SidekiqGauge.new
+    instrumentor.log
+
+    assert_gauge 'sidekiq.jobs.scheduled'
+  end
+
+  def test_logs_all_metrics_in_given_namespace
+    instrumentor = Harness::SidekiqGauge.new 'foo'
+    instrumentor.log
+
+    assert_gauge 'foo.sidekiq.jobs.processed'
+    assert_gauge 'foo.sidekiq.jobs.enqueued'
+    assert_gauge 'foo.sidekiq.jobs.failed'
+    assert_gauge 'foo.sidekiq.jobs.retries'
+    assert_gauge 'foo.sidekiq.jobs.scheduled'
+  end
+end

data/test/sidekiq_test.rb

@@ -0,0 +1,21 @@
+require_relative 'test_helper'
+
+class SidekiqIntegrationTest < MiniTest::Unit::TestCase
+  Report = Class.new
+
+  def middleware
+    Sidekiq::Middleware::Server::HarnessInstrumentation.new
+  end
+
+  def tests_times_the_given_job
+    middleware.call(Report.new, nil, nil) { }
+
+    assert_timer "sidekiq.sidekiq_integration_test.report"
+  end
+
+  def tests_logs_a_counter_of_all_jobs
+    middleware.call(Report.new, nil, nil) { }
+
+    assert_increment "sidekiq.job"
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,63 @@
+require 'bundler/setup'
+require 'harness-sidekiq'
+require 'minitest/unit'
+require 'minitest/autorun'
+
+class MiniTest::Unit::TestCase
+  def setup
+    Harness.config.collector = Harness::FakeCollector.new
+    Harness.config.queue = Harness::SyncQueue.new
+  end
+
+  def assert_timer(name)
+    refute_empty timers
+    timer = timers.find { |t| t.name == name }
+    assert timer, "Timer #{name} not logged!"
+  end
+
+  def assert_increment(name)
+    refute_empty increments
+    increment = increments.find { |i| i.name == name }
+    assert increment, "Increment #{name} not logged!"
+  end
+
+  def assert_decrement(name)
+    refute_empty decrements
+    decrement = decrements.find { |i| i.name == name }
+    assert decrement, "decrement #{name} not logged!"
+  end
+
+  def assert_gauge(name)
+    refute_empty gauges
+    gauge = gauges.find { |g| g.name == name }
+    assert gauge, "gauge #{name} not logged!"
+  end
+
+  def instrument(name, data = {}, &block)
+    ActiveSupport::Notifications.instrument name, data, &block
+  end
+
+  def collector
+    Harness.config.collector
+  end
+
+  def timers
+    collector.timers
+  end
+
+  def increments
+    collector.increments
+  end
+
+  def decrements
+    collector.decrements
+  end
+
+  def counters
+    collector.counters
+  end
+
+  def gauges
+    collector.gauges
+  end
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: harness-sidekiq
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- ahawkins
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: harness
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sidekiq
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Log sidekiq metrics to Harness
+email:
+- adam@hawkins.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- harness-sidekiq.gemspec
+- lib/harness-sidekiq.rb
+- lib/harness/sidekiq.rb
+- lib/harness/sidekiq/version.rb
+- test/gauge_test.rb
+- test/sidekiq_test.rb
+- test/test_helper.rb
+homepage: https://github.com/ahawkins/harness-sidekiq
+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: ''
+test_files:
+- test/gauge_test.rb
+- test/sidekiq_test.rb
+- test/test_helper.rb