harness-resque 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d0398c5736310d882d84c25479a9ec34578a4228
+  data.tar.gz: 274e4478fe8e9e993f6df59cdaeffab8c9244808
+SHA512:
+  metadata.gz: 8c5c13f8ce2665a310feda099195aa51680bdb9283f8b88d1627468d9316748b0b4da98019d62197305e7581f77a06f9b19be2d028c8926a4c5101af72d8e5ef
+  data.tar.gz: d1945cf2e7bf52df16398ce586e29e10f5c2058093a4d0ae5f219eb88147d892c935cfee64a0e0f4ae79d0ffcecac818183ba9f18fcba56e725731ed348a6f41

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,33 @@
+# Harness::resque
+
+Log resque related metrics with Harness
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'harness-resque'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install harness-resque
+
+## In Jobs
+
+```ruby
+class Worker
+  extend Resque::Plugins::Harness
+end
+```
+
+## 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/lib/resque-harness.rb

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

data/lib/resque/harness.rb

@@ -0,0 +1,51 @@
+require "resque/harness/version"
+require "active_support/core_ext/string"
+
+require 'resque'
+require 'harness'
+
+module Resque
+  module Plugins
+    module Harness
+      def around_perform_send_stats
+        job_name = name.underscore.gsub '/', '.'
+        ::Harness.time "resque.#{job_name}" do
+          yield
+        end
+
+        ::Harness.increment "resque.job"
+      end
+    end
+  end
+end
+
+module Harness
+  class ResqueGauge
+    include Instrumentation
+
+    def initialize(namespace = nil)
+      @namespace = namespace
+    end
+
+    def log
+      info = ::Resque.info
+
+      gauge namespaced('resque.jobs.pending'), info.fetch(:pending)
+      gauge namespaced('resque.jobs.processed'), info.fetch(:processed)
+      gauge namespaced('resque.jobs.failed'), info.fetch(:failed)
+
+      gauge namespaced('resque.queues.total'), info.fetch(:queues)
+      gauge namespaced('resque.workers.total'), info.fetch(:workers)
+      gauge namespaced('resque.workers.working'), info.fetch(:working)
+
+      ::Resque.queues.each do |queue|
+        gauge namespaced("resque.queues.#{queue}.depth"), ::Resque.size(queue)
+      end
+    end
+
+    private
+    def namespaced(name)
+      [@namespace, name].compact.join '.'
+    end
+  end
+end

data/lib/resque/harness/version.rb

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

data/resque-harness.gemspec

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

data/test/gauge_test.rb

@@ -0,0 +1,49 @@
+require_relative 'test_helper'
+
+class ResqueGaugeTest < MiniTest::Unit::TestCase
+  def test_reports_pending_jobs
+    instrumentor = Harness::ResqueGauge.new
+    instrumentor.log
+
+    assert_gauge 'resque.jobs.pending'
+  end
+
+  def test_reports_processed_jobs
+    instrumentor = Harness::ResqueGauge.new
+    instrumentor.log
+
+    assert_gauge 'resque.jobs.processed'
+  end
+
+  def test_reports_failed_jobs
+    instrumentor = Harness::ResqueGauge.new
+    instrumentor.log
+
+    assert_gauge 'resque.jobs.failed'
+  end
+
+  def test_reports_total_workers
+    instrumentor = Harness::ResqueGauge.new
+    instrumentor.log
+
+    assert_gauge 'resque.workers.total'
+  end
+
+  def test_reports_total_workers
+    instrumentor = Harness::ResqueGauge.new
+    instrumentor.log
+
+    assert_gauge 'resque.workers.working'
+  end
+
+  def test_logs_all_metrics_in_given_namespace
+    instrumentor = Harness::ResqueGauge.new 'foo'
+    instrumentor.log
+
+    assert_gauge 'foo.resque.jobs.processed'
+    assert_gauge 'foo.resque.jobs.pending'
+    assert_gauge 'foo.resque.jobs.failed'
+    assert_gauge 'foo.resque.workers.total'
+    assert_gauge 'foo.resque.workers.working'
+  end
+end

data/test/resque_test.rb

@@ -0,0 +1,27 @@
+require_relative 'test_helper'
+
+class ResqueTest < MiniTest::Unit::TestCase
+  class DummyJob
+    extend Resque::Plugins::Harness
+  end
+
+  def tests_times_the_given_job
+    DummyJob.around_perform_send_stats do
+
+    end
+
+    assert_timer "resque.resque_test.dummy_job"
+  end
+
+  def tests_logs_a_counter_of_all_jobs
+    DummyJob.around_perform_send_stats do
+
+    end
+
+    assert_increment "resque.job"
+  end
+
+  def test_lints
+    Resque::Plugin.lint Resque::Plugins::Harness
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,63 @@
+require 'bundler/setup'
+require 'resque-harness'
+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-resque
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- ahawkins
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-28 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: resque
+  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 resque metrics to Harness
+email:
+- adam@hawkins.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/resque-harness.rb
+- lib/resque/harness.rb
+- lib/resque/harness/version.rb
+- resque-harness.gemspec
+- test/gauge_test.rb
+- test/resque_test.rb
+- test/test_helper.rb
+homepage: https://github.com/ahawkins/resque-harness
+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/resque_test.rb
+- test/test_helper.rb