sidekiq-instrument 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b91f56b76bb74cae296dabe8f002fd50a22eed0e
+  data.tar.gz: 648a7a5fd46007137612630b37782574e38441ee
+SHA512:
+  metadata.gz: 42284f2bbb7ed52d15dd7271ef428cce8e8b891dffb6c4ed8698f9f1f8c1757260aea3fd4edcd61b0a0f2b67ce8c7ada6d3583cb15f54de710d0d714da760ab5
+  data.tar.gz: 9f5a83e2f9f77812345aec2f60dceb2ca8421615a34c1354edf89cb6db0e9a592e9e5cf7942f2f7465a58b39a00f11eeb28ce3410e62c0440339c3ce5e9fd3e2

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,3 @@
+--require spec_helper
+--format documentation
+--color

data/.simplecov

@@ -0,0 +1,8 @@
+require 'coveralls'
+
+SimpleCov.formatters = [
+  SimpleCov::Formatter::HTMLFormatter,
+  Coveralls::SimpleCov::Formatter
+]
+
+SimpleCov.start

data/.travis.yml

@@ -0,0 +1,9 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.0
+
+services:
+  - redis-server
+
+before_install: gem install bundler -v 1.12.1

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Matt Larraz
+
+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,112 @@
+# Sidekiq::Instrument
+[![Build Status](https://travis-ci.org/enova/sidekiq-instrument.svg?branch=master)](https://travis-ci.org/enova/sidekiq-instrument)
+[![Coverage Status](https://coveralls.io/repos/github/enova/sidekiq-instrument/badge.svg?branch=master)](https://coveralls.io/github/enova/sidekiq-instrument?branch=master)
+
+Reports job metrics using Shopify's [statsd-instrument][statsd-instrument] library, incrementing a counter for each enqueue and dequeue per job type, and timing the full runtime of your perform method.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sidekiq-instrument'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sidekiq-instrument
+
+## Usage
+
+For now, this library assumes you have already initialized `StatsD` on your own;
+the `statsd-instrument` gem may have chosen reasonable defaults for you already. If not,
+a typical Rails app would just use an initializer:
+
+```ruby
+# config/initializers/statsd.rb
+require 'statsd-instrument'
+StatsD.prefix  = 'my-app'
+StatsD.backend = StatsD::Instrument::Backends::UDPBackend.new('some-server:8125')
+```
+
+Then add the client and server middlewares in your Sidekiq initializer:
+
+```ruby
+require 'sidekiq/instrument'
+
+Sidekiq.configure_server do |config|
+  config.server_middleware do |chain|
+    chain.add Sidekiq::Instrument::ServerMiddleware
+  end
+
+  config.client_middleware do |chain|
+    chain.add Sidekiq::Instrument::ClientMiddleware
+  end
+end
+
+Sidekiq.configure_client do |config|
+  config.client_middleware do |chain|
+    chain.add Sidekiq::Instrument::ClientMiddleware
+  end
+end
+```
+
+## StatsD Keys
+For each job, the following metrics will be reported:
+
+1. **shared.sidekiq._queue_._job_.enqueue**: counter incremented each time a
+   job is pushed onto the queue.
+2. **shared.sidekiq._queue_._job_.dequeue**: counter incremented just before
+   worker begins performing a job.
+3. **shared.sidekiq._queue_._job_.runtime**: timer of the total time spent
+   in `perform`, in milliseconds.
+3. **shared.sidekiq._queue_._job_.error**: counter incremented each time a
+   job fails.
+
+The metric names can be changed by overriding the `statsd_metric_name`
+method in your worker classes.
+
+## Worker
+There is a worker, `Sidekiq::Instrument::Worker`, that submits gauges
+for various interesting statistics; namely, the bulk of the information in `Sidekiq::Stats`
+and the sizes of each individual queue. While the worker class is a fully valid Sidekiq worker,
+you should inherit from it your own job implementation instead of using it directly:
+
+```ruby
+# app/jobs/sidekiq_stats_job.rb
+class SidekiqStatsJob < Sidekiq::Instrument::Worker
+  METRIC_NAMES = %w[
+    processed
+    failed
+  ]
+
+  sidekiq_options queue: :stats
+end
+```
+
+In this example, we override the default stats with the ones we want reported by defining `METRIC_NAMES`.
+This can be either an Array or a Hash (if you also want to map a stat to a different metric name).
+
+You can schedule this however you see fit. A simple way is to use [sidekiq-scheduler][sidekiq-scheduler] to run it every N minutes.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/enova/sidekiq-instrument.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+[statsd-instrument]: https://github.com/Shopify/statsd-instrument
+[sidekiq-scheduler]: https://github.com/moove-it/sidekiq-scheduler

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "sidekiq/instrument"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/sidekiq/instrument/middleware/client.rb

@@ -0,0 +1,14 @@
+require 'sidekiq/instrument/mixin'
+
+module Sidekiq::Instrument
+  class ClientMiddleware
+    include Sidekiq::Instrument::MetricNames
+
+    def call(worker_class, job, queue, redis_pool)
+      klass = Object.const_get(worker_class)
+      StatsD.increment metric_name(klass.new, 'enqueue')
+
+      yield
+    end
+  end
+end

data/lib/sidekiq/instrument/middleware/server.rb

@@ -0,0 +1,16 @@
+require 'sidekiq/instrument/mixin'
+
+module Sidekiq::Instrument
+  class ServerMiddleware
+    include Sidekiq::Instrument::MetricNames
+
+    def call(worker, job, queue, &block)
+      StatsD.increment(metric_name(worker, 'dequeue'))
+
+      StatsD.measure(metric_name(worker,'runtime'), &block)
+    rescue StandardError => e
+      StatsD.increment(metric_name(worker, 'error'))
+      raise e
+    end
+  end
+end

data/lib/sidekiq/instrument/mixin.rb

@@ -0,0 +1,14 @@
+module Sidekiq::Instrument
+  module MetricNames
+    def metric_name(worker, event)
+      if worker.respond_to?(:statsd_metric_name)
+        worker.send(:statsd_metric_name, event)
+      else
+        queue = worker.sidekiq_options_hash['queue']
+        name = worker.class.name
+
+        "shared.sidekiq.#{queue}.#{name}.#{event}"
+      end
+    end
+  end
+end

data/lib/sidekiq/instrument/version.rb

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

data/lib/sidekiq/instrument/worker.rb

@@ -0,0 +1,32 @@
+require 'sidekiq'
+require 'sidekiq/api'
+
+module Sidekiq::Instrument
+  class Worker
+    include Sidekiq::Worker
+
+    # These defaults are for compatibility with Resque's stats names
+    # (i.e. the metrics will reported as :processed, :workers, :pending, and :failed).
+    # Feel free to override.
+    METRIC_NAMES = {
+      processed:    nil,
+      workers_size: :workers,
+      enqueued:     :pending,
+      failed:       nil
+    }
+
+    def perform
+      info = Sidekiq::Stats.new
+
+      self.class::METRIC_NAMES.each do |method, stat|
+        stat ||= method
+
+        StatsD.gauge "shared.sidekiq.stats.#{stat}", info.send(method)
+      end
+
+      working = Sidekiq::ProcessSet.new.select { |p| p[:busy] == 1 }.count
+
+      StatsD.gauge "shared.sidekiq.stats.working", working
+    end
+  end
+end

data/lib/sidekiq/instrument.rb

@@ -0,0 +1,7 @@
+require "sidekiq/instrument/version"
+
+module Sidekiq
+  module Instrument
+    # Your code goes here...
+  end
+end

data/sidekiq-instrument.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sidekiq/instrument/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'sidekiq-instrument'
+  spec.version       = Sidekiq::Instrument::VERSION
+  spec.authors       = ['Matt Larraz']
+  spec.email         = ['mlarraz@enova.com']
+
+  spec.summary       = 'StatsD instrumentation for Sidekiq'
+  spec.homepage      = 'https://github.com/enova/sidekiq-instrument'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'sidekiq', '~> 4.0'
+  spec.add_dependency 'statsd-instrument', '~> 2.0', '>= 2.0.4'
+
+  spec.add_development_dependency 'bundler', '~> 1.12'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'pry-byebug', '~> 3.4'
+  spec.add_development_dependency 'coveralls', '~> 0.8'
+end

metadata

@@ -0,0 +1,165 @@
+--- !ruby/object:Gem::Specification
+name: sidekiq-instrument
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Matt Larraz
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-09-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sidekiq
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: statsd-instrument
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.4
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+description: 
+email:
+- mlarraz@enova.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".simplecov"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/sidekiq/instrument.rb
+- lib/sidekiq/instrument/middleware/client.rb
+- lib/sidekiq/instrument/middleware/server.rb
+- lib/sidekiq/instrument/mixin.rb
+- lib/sidekiq/instrument/version.rb
+- lib/sidekiq/instrument/worker.rb
+- sidekiq-instrument.gemspec
+homepage: https://github.com/enova/sidekiq-instrument
+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.5.1
+signing_key: 
+specification_version: 4
+summary: StatsD instrumentation for Sidekiq
+test_files: []