nightwing 0.0.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 026f5c884e256b1db6ae3dfc0d491ef78355f181
+  data.tar.gz: bd780bd6f1331e749da81c91545ad2a0ef994ac0
+SHA512:
+  metadata.gz: 1f068baec9849f613dce5da7971752904d8f2ebf260264ee36dd95c7a3807a0e0f5f70a583de518ec429dcfe3c0ba63cf7c008a077fbe60c30284d67155b176e
+  data.tar.gz: 4c311cb5de9248e5b5961cf088b6658dcb3207483cc158b6e1d7525d5fcdea7dda5f8a3be171d5e5dd572669689a775abd4e0f2a8c9f1ce9b16f5cef786667d5

data/.gitignore

@@ -0,0 +1,4 @@
+.DS_Store
+robin-*.gem
+nightwing-*.gem
+.idea

data/.rspec

@@ -0,0 +1 @@
+--format documentation

data/.rubocop.yml

@@ -0,0 +1,18 @@
+AllCops:
+  TargetRubyVersion: 2.3
+Documentation:
+  Enabled: false
+Metrics/AbcSize:
+  Max: 35
+Metrics/MethodLength:
+  Enabled: false
+Metrics/LineLength:
+  Max: 120
+StringLiterals:
+  EnforcedStyle: double_quotes
+Style/FrozenStringLiteralComment:
+  Enabled: false
+Style/SignalException:
+  Enabled: false
+Style/GuardClause:
+  Enabled: false

data/.ruby-version

@@ -0,0 +1 @@
+2.3.0

data/CHANGELOG.md

@@ -0,0 +1,10 @@
+## Unreleased
+
+- Renamed project to "Nightwing"
+- Gem name is now "nightwing"
+
+## 0.0.4
+
+- Changed default namespace from "robin.sidekiq" to "sidekiq"
+- Removed Librato dependency
+- `:client` middleware option is now required

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,70 @@
+PATH
+  remote: .
+  specs:
+    nightwing (0.0.4)
+      activesupport (>= 4.1.0)
+      sidekiq (>= 2.6)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (4.2.5.1)
+      i18n (~> 0.7)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
+    ast (2.2.0)
+    builder (3.2.2)
+    concurrent-ruby (1.0.0)
+    connection_pool (2.2.0)
+    diff-lcs (1.2.5)
+    i18n (0.7.0)
+    json (1.8.3)
+    minitest (5.8.4)
+    parser (2.3.0.2)
+      ast (~> 2.2)
+    powerpack (0.1.1)
+    rainbow (2.1.0)
+    redis (3.2.2)
+    rspec (3.4.0)
+      rspec-core (~> 3.4.0)
+      rspec-expectations (~> 3.4.0)
+      rspec-mocks (~> 3.4.0)
+    rspec-core (3.4.1)
+      rspec-support (~> 3.4.0)
+    rspec-expectations (3.4.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-mocks (3.4.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-support (3.4.1)
+    rspec_junit_formatter (0.2.3)
+      builder (< 4)
+      rspec-core (>= 2, < 4, != 2.12.0)
+    rubocop (0.36.0)
+      parser (>= 2.3.0.0, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 1.99.1, < 3.0)
+      ruby-progressbar (~> 1.7)
+    ruby-progressbar (1.7.5)
+    sidekiq (4.1.0)
+      concurrent-ruby (~> 1.0)
+      connection_pool (~> 2.2, >= 2.2.0)
+      redis (~> 3.2, >= 3.2.1)
+    thread_safe (0.3.5)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  nightwing!
+  rspec (~> 3.4, >= 3.4.0)
+  rspec_junit_formatter (~> 0.2, >= 0.2.3)
+  rubocop (~> 0.36)
+
+BUNDLED WITH
+   1.11.2

data/README.md

@@ -0,0 +1,55 @@
+# Nightwing
+
+Nightwing is a Sidekiq middleware for capturing worker metrics including number processed, number of failures, timing, etc.
+
+## Installation
+
+Inside your Gemfile, add the following line:
+
+```Gemfile
+gem 'nightwing', github: 'teespring/nightwing'
+```
+
+## Configuration
+
+You will need to add the code below to your app. In a typical Rails app, this would go into an initializer.
+
+```ruby
+# config/initializers/sidekiq.rb
+Sidekiq.configure_server do |config|
+  config.server_middleware do |chain|
+    chain.add Nightwing::Sidekiq::Stats, client: Librato
+    chain.add Nightwing::Sidekiq::QueueStats, client: Librato
+    chain.add Nightwing::Sidekiq::WorkerStats, client: Librato
+  end
+end
+```
+
+### Available options
+
+- `client`: Librato or statsd client. Required.
+- `namespace`: the string each metric is prefixed with. Defaults to `"sidekiq"`.
+
+## Metrics
+
+Below are the metrics reported to Librato from the Sidekiq middleware
+
+- `sidekiq.retries`: number of jobs to be retried
+- `sidekiq.scheduled`: number of jobs scheduled to run
+- `sidekiq.processed`: number of times middleware called
+- `sidekiq.failed`: number of jobs that raised an error
+
+### Queue specific
+
+- `sidekiq.<queue>.size`: depth for a given queue
+- `sidekiq.<queue>.latency`: latency for given queue¹
+- `sidekiq.<queue>.processed`: number of times middleware called for given queue
+- `sidekiq.<queue>.failed`: number of jobs in given queue that raised an error
+
+¹: the difference between now and when the oldest job was enqueued (given in seconds)
+
+### Worker specific
+
+- `sidekiq.<queue>.<worker>.processed`: number of times middleware called for given worker
+- `sidekiq.<queue>.<worker>.failed`: number of jobs in given worker that raised an error
+- `sidekiq.<queue>.<worker>.finished`: number of successful worker jobs

data/circle.yml

@@ -0,0 +1,5 @@
+test:
+  pre:
+    - bundle exec rubocop
+  override:
+    - bundle exec rspec -r rspec_junit_formatter --format RspecJunitFormatter -o $CIRCLE_TEST_REPORTS/rspec/junit.xml

data/lib/nightwing.rb

@@ -0,0 +1,4 @@
+require "nightwing/version"
+require "nightwing/sidekiq/stats"
+require "nightwing/sidekiq/queue_stats"
+require "nightwing/sidekiq/worker_stats"

data/lib/nightwing/metric.rb

@@ -0,0 +1,23 @@
+require "active_support/core_ext/string"
+
+module Nightwing
+  class Metric
+    attr_reader :namespace
+
+    def initialize(namespace)
+      @namespace = namespace
+    end
+
+    ##
+    # Generates a metric name
+    #
+    # @param [String] queue
+    # @param [Class]  worker
+    #
+    # returns a String object
+    def for(queue:, worker: nil)
+      worker_name = worker.to_s.underscore.tr("/", "_") if worker
+      [namespace, queue, worker_name].compact.join(".")
+    end
+  end
+end

data/lib/nightwing/nil_client.rb

@@ -0,0 +1,10 @@
+module Nightwing
+  class NilClient
+    def increment(*args)
+    end
+
+    def measure(*args)
+    end
+    alias timing measure
+  end
+end

data/lib/nightwing/sidekiq/base.rb

@@ -0,0 +1,22 @@
+require "sidekiq/api"
+require "nightwing/metric"
+require "nightwing/nil_client"
+
+module Nightwing
+  module Sidekiq
+    class Base
+      attr_reader :namespace, :client
+
+      def initialize(options = {})
+        @namespace = options.fetch(:namespace, "sidekiq")
+        @client = options.fetch(:client, Nightwing::NilClient.new)
+      end
+
+      private
+
+      def metrics
+        @_metrics ||= Nightwing::Metric.new(namespace)
+      end
+    end
+  end
+end

data/lib/nightwing/sidekiq/queue_stats.rb

@@ -0,0 +1,41 @@
+require "nightwing/sidekiq/base"
+
+module Nightwing
+  module Sidekiq
+    ##
+    # Sidekiq server middleware for measuring Sidekiq queues
+    class QueueStats < Base
+      ##
+      # Sends Sidekiq queue metrics to client then yields
+      #
+      # @param [Sidekiq::Worker] _worker
+      #   The worker the job belongs to.
+      #
+      # @param [Hash] _msg
+      #   The job message.
+      #
+      # @param [String] queue
+      #   The current queue.
+      def call(_worker, _msg, queue)
+        exception = nil
+        sidekiq_queue = ::Sidekiq::Queue.new(queue)
+        queue_namespace = metrics.for(queue: queue)
+
+        client.measure "#{queue_namespace}.size", sidekiq_queue.size
+        client.measure "#{queue_namespace}.latency", sidekiq_queue.latency
+        client.increment "#{queue_namespace}.processed"
+
+        begin
+          yield
+        rescue => e
+          exception = e
+        end
+
+        if exception
+          client.increment "#{queue_namespace}.failed"
+          raise exception
+        end
+      end
+    end
+  end
+end

data/lib/nightwing/sidekiq/stats.rb

@@ -0,0 +1,49 @@
+require "nightwing/sidekiq/base"
+
+module Nightwing
+  module Sidekiq
+    ##
+    # Sidekiq server middleware for measuring Sidekiq stats
+    class Stats < Base
+      ##
+      # Sends Sidekiq metrics to statsd client then yields
+      #
+      # @param [Sidekiq::Worker] _worker
+      #   The worker the job belongs to.
+      #
+      # @param [Hash] _msg
+      #   The job message.
+      #
+      # @param [String] _queue
+      #   The current queue.
+      def call(_worker, _msg, _queue)
+        exception = nil
+
+        client.measure "#{namespace}.retries", retries.size
+        client.measure "#{namespace}.scheduled", scheduled.size
+        client.increment "#{namespace}.processed"
+
+        begin
+          yield
+        rescue => e
+          exception = e
+        end
+
+        if exception
+          client.increment "#{namespace}.failed"
+          raise exception
+        end
+      end
+
+      private
+
+      def retries
+        @_retries ||= ::Sidekiq::RetrySet.new
+      end
+
+      def scheduled
+        @_scheduled ||= ::Sidekiq::ScheduledSet.new
+      end
+    end
+  end
+end

data/lib/nightwing/sidekiq/worker_stats.rb

@@ -0,0 +1,27 @@
+require "nightwing/sidekiq/base"
+
+module Nightwing
+  module Sidekiq
+    class WorkerStats < Base
+      def call(worker, _msg, queue)
+        exception = nil
+        worker_namespace = metrics.for(queue: queue, worker: worker.class)
+
+        client.increment "#{worker_namespace}.processed"
+
+        begin
+          yield
+        rescue => e
+          exception = e
+        end
+
+        if exception
+          client.increment "#{worker_namespace}.failed"
+          raise exception
+        end
+
+        client.increment "#{worker_namespace}.finished"
+      end
+    end
+  end
+end

data/lib/nightwing/version.rb

@@ -0,0 +1,3 @@
+module Nightwing
+  VERSION = "0.0.4".freeze
+end

data/nightwing.gemspec

@@ -0,0 +1,21 @@
+require File.expand_path("../lib/nightwing/version", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "nightwing"
+  s.version     = Nightwing::VERSION
+  s.date        = "2016-01-26"
+  s.summary     = "Sidekiq metrics gathering"
+  s.description = "Sidekiq metrics gathering"
+  s.authors     = ["Chris Ledet"]
+  s.email       = "chris.ledet@teespring.com"
+  s.files       = `git ls-files`.split
+  s.homepage    = "https://github.com/teespring/nightwing"
+  s.license     = "MIT"
+
+  s.add_runtime_dependency "sidekiq", ">= 2.6"
+  s.add_runtime_dependency "activesupport", ">= 4.1.0"
+
+  s.add_development_dependency "rubocop", "~> 0.36"
+  s.add_development_dependency "rspec", "~> 3.4", ">= 3.4.0"
+  s.add_development_dependency "rspec_junit_formatter", "~> 0.2", ">= 0.2.3"
+end

data/spec/nightwing/metric_spec.rb

@@ -0,0 +1,20 @@
+require "spec_helper"
+
+describe Nightwing::Metric do
+  subject { described_class.new("sidekiq") }
+
+  it "returns name for queue metric" do
+    metric_name = subject.for(queue: "default")
+    expect(metric_name).to eq("sidekiq.default")
+  end
+
+  it "returns name for worker metric" do
+    metric_name = subject.for(queue: "default", worker: "CoolWorker")
+    expect(metric_name).to eq("sidekiq.default.cool_worker")
+  end
+
+  it "returns name for module worker metric" do
+    metric_name = subject.for(queue: "default", worker: "App::AwesomeWorker")
+    expect(metric_name).to eq("sidekiq.default.app_awesome_worker")
+  end
+end

data/spec/nightwing/sidekiq/queue_stats_spec.rb

@@ -0,0 +1,40 @@
+require "spec_helper"
+
+describe Nightwing::Sidekiq::QueueStats do
+  subject { Nightwing::Sidekiq::QueueStats.new(client: Nightwing::NilClient.new) }
+
+  describe "#call" do
+    let(:fake_queue) { Struct.new(:size, :latency).new(0, 0) }
+
+    before do
+      allow(Sidekiq::Queue).to receive(:new).and_return fake_queue
+    end
+
+    context "when everything just works" do
+      it "increments process count" do
+        expect(subject.client).to receive(:measure).with("sidekiq.default.size", 0)
+        expect(subject.client).to receive(:measure).with("sidekiq.default.latency", 0)
+        expect(subject.client).to receive(:increment).with("sidekiq.default.processed")
+
+        subject.call(nil, nil, "default") do
+          # beep
+        end
+      end
+    end
+
+    context "when something fails" do
+      it "increments process and failure count" do
+        expect(subject.client).to receive(:measure).with("sidekiq.default.size", 0)
+        expect(subject.client).to receive(:measure).with("sidekiq.default.latency", 0)
+        expect(subject.client).to receive(:increment).with("sidekiq.default.processed")
+        expect(subject.client).to receive(:increment).with("sidekiq.default.failed")
+
+        expect do
+          subject.call(nil, nil, "default") do
+            fail "beep"
+          end
+        end.to raise_error RuntimeError
+      end
+    end
+  end
+end

data/spec/nightwing/sidekiq/stats_spec.rb

@@ -0,0 +1,40 @@
+require "spec_helper"
+
+describe Nightwing::Sidekiq::Stats do
+  subject { Nightwing::Sidekiq::Stats.new(client: Nightwing::NilClient.new) }
+
+  before do
+    fake_set = Struct.new(:size).new(1)
+    allow(Sidekiq::RetrySet).to receive(:new).and_return(fake_set)
+    allow(Sidekiq::ScheduledSet).to receive(:new).and_return(fake_set)
+  end
+
+  describe "#call" do
+    context "when everything just works" do
+      it "increments process count" do
+        expect(subject.client).to receive(:measure).with("sidekiq.retries", 1)
+        expect(subject.client).to receive(:measure).with("sidekiq.scheduled", 1)
+        expect(subject.client).to receive(:increment).with("sidekiq.processed")
+
+        subject.call(nil, nil, nil) do
+          # beep
+        end
+      end
+    end
+
+    context "when something fails" do
+      it "increments process and failure count" do
+        expect(subject.client).to receive(:measure).with("sidekiq.retries", 1)
+        expect(subject.client).to receive(:measure).with("sidekiq.scheduled", 1)
+        expect(subject.client).to receive(:increment).with("sidekiq.processed")
+        expect(subject.client).to receive(:increment).with("sidekiq.failed")
+
+        expect do
+          subject.call(nil, nil, nil) do
+            fail "beep"
+          end
+        end.to raise_error RuntimeError
+      end
+    end
+  end
+end

data/spec/nightwing/sidekiq/worker_stats_spec.rb

@@ -0,0 +1,33 @@
+require "spec_helper"
+
+describe Nightwing::Sidekiq::WorkerStats do
+  MyWorker = Class.new
+
+  subject { Nightwing::Sidekiq::WorkerStats.new(client: Nightwing::NilClient.new) }
+
+  describe "#call" do
+    context "when everything just works" do
+      it "increments process count" do
+        expect(subject.client).to receive(:increment).with("sidekiq.default.my_worker.processed")
+        expect(subject.client).to receive(:increment).with("sidekiq.default.my_worker.finished")
+
+        subject.call(MyWorker.new, nil, "default") do
+          # beep
+        end
+      end
+    end
+
+    context "when something fails" do
+      it "increments process and failure count" do
+        expect(subject.client).to receive(:increment).with("sidekiq.default.my_worker.processed")
+        expect(subject.client).to receive(:increment).with("sidekiq.default.my_worker.failed")
+
+        expect do
+          subject.call(MyWorker.new, nil, "default") do
+            fail "beep"
+          end
+        end.to raise_error RuntimeError
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+require "rspec"
+require "nightwing"

metadata

@@ -0,0 +1,148 @@
+--- !ruby/object:Gem::Specification
+name: nightwing
+version: !ruby/object:Gem::Version
+  version: 0.0.4
+platform: ruby
+authors:
+- Chris Ledet
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-01-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sidekiq
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.6'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.1.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.36'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.36'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.4.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.4.0
+- !ruby/object:Gem::Dependency
+  name: rspec_junit_formatter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.3
+description: Sidekiq metrics gathering
+email: chris.ledet@teespring.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- README.md
+- circle.yml
+- lib/nightwing.rb
+- lib/nightwing/metric.rb
+- lib/nightwing/nil_client.rb
+- lib/nightwing/sidekiq/base.rb
+- lib/nightwing/sidekiq/queue_stats.rb
+- lib/nightwing/sidekiq/stats.rb
+- lib/nightwing/sidekiq/worker_stats.rb
+- lib/nightwing/version.rb
+- nightwing.gemspec
+- spec/nightwing/metric_spec.rb
+- spec/nightwing/sidekiq/queue_stats_spec.rb
+- spec/nightwing/sidekiq/stats_spec.rb
+- spec/nightwing/sidekiq/worker_stats_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/teespring/nightwing
+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: Sidekiq metrics gathering
+test_files: []