sidekiq-datadog 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5aea86eaa87d26b2fa592d8ca714c4fffec52f3a
+  data.tar.gz: 34498e1f66cc33ac85f6056a803c625ddc7a5524
+SHA512:
+  metadata.gz: 84c2b8fa2b0504fd69b67314b4f55b6ae32678fb07c29db9ba0526bb33bd8302293efe78961e77c7ff67d6587d61c4ec01834a88ea952b5603997328f91225f1
+  data.tar.gz: 8bc0124d01c54c5a76428ec09099e092cc504c964501b65254ad14ede5c7aa74e02d460454e6da08503e526f7c6d8ff9edbae3af7217564342925ebc88be00b9

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/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 2.2.2
+  - 2.1.1
+  - 2.0.0
+  - 1.9.3

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Dimitrij Denissenko
+
+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 @@
+sidekiq-datadog
+=============
+
+Datadog intrumentation for [Sidekiq](https://github.com/mperham/sidekiq), integrated via server middleware.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'sidekiq-datadog'
+
+Or install:
+
+    $ gem install sidekiq-datadog
+
+Configure it in an initializer:
+
+    Sidekiq.configure_server do |config|
+      config.server_middleware do |chain|
+        chain.add Sidekiq::Middleware::Server::Datadog
+      end
+    end
+
+For full configuration options, please see the [Documentation][http://www.rubydoc.info/gems/sidekiq-datadog].
+
+## 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. Make a pull request
+

data/Rakefile

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

data/lib/sidekiq/datadog/version.rb

@@ -0,0 +1,5 @@
+module Sidekiq
+  module Datadog
+    VERSION = "0.3.0"
+  end
+end

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

@@ -0,0 +1,90 @@
+require 'sidekiq'
+require 'sidekiq/datadog/version'
+require 'statsd'
+require 'socket'
+
+module Sidekiq
+  module Middleware
+    module Server
+      class Datadog
+
+        # Configure and install datadog instrumentation. Example:
+        #
+        #   Sidekiq.configure_server do |config|
+        #     config.server_middleware do |chain|
+        #       chain.add Sidekiq::Middleware::Server::Datadog
+        #     end
+        #   end
+        #
+        # Options:
+        # * <tt>:hostname</tt>    - the hostname used for instrumentation, defaults to system hostname, respects +INSTRUMENTATION_HOSTNAME+ env variable
+        # * <tt>:metric_name</tt> - the metric name (prefix) to use, defaults to "sidekiq.job"
+        # * <tt>:tags</tt>        - array of custom tags, these can be plain strings or lambda blocks accepting a rack env instance
+        # * <tt>:statsd_host</tt> - the statsD host, defaults to "localhost", respects +STATSD_HOST+ env variable
+        # * <tt>:statsd_port</tt> - the statsD port, defaults to 8125, respects +STATSD_PORT+ env variable
+        # * <tt>:statsd</tt>      - custom statsd instance
+        def initialize(opts = {})
+          hostname      = opts[:hostname] || ENV['INSTRUMENTATION_HOSTNAME'] || Socket.gethostname
+          statsd_host   = opts[:statsd_host] || ENV['STATSD_HOST'] || "localhost"
+          statsd_port   = (opts[:statsd_port] || ENV['STATSD_PORT'] || 8125).to_i
+
+          @metric_name  = opts[:metric_name] || "sidekiq.job"
+          @statsd       = opts[:statsd] || ::Statsd.new(statsd_host, statsd_port)
+          @tags         = opts[:tags] || []
+
+          if @tags.none? {|t| t =~ /^host\:/ }
+            @tags.push("host:#{hostname}")
+          end
+
+          env = Sidekiq.options[:environment] || ENV['RACK_ENV']
+          if env && @tags.none? {|t| t =~ /^env\:/ }
+            @tags.push("env:#{ENV['RACK_ENV']}")
+          end
+        end
+
+        def call(worker, job, queue, *)
+          start = Time.now
+          begin
+            yield
+            record(worker, job, queue, start)
+          rescue => e
+            record(worker, job, queue, start, e)
+            raise
+          end
+        end
+
+        private
+
+          def record(worker, job, queue, start, error = nil)
+            ms   = ((Time.now - start) * 1000).round
+            name = underscore(job['wrapped'] || worker.class.to_s)
+            tags = @tags.map do |tag|
+              case tag when String then tag when Proc then tag.call(worker, job, queue, error) end
+            end
+
+            tags.push "name:#{name}"
+            tags.push "queue:#{queue}" if queue
+            if error
+              kind = underscore(error.class.name.sub(/Error$/, ''))
+              tags.push "status:error", "error:#{kind}"
+            else
+              tags.push "status:ok"
+            end
+            tags.compact!
+
+            @statsd.increment @metric_name, :tags => tags
+            @statsd.timing "#{@metric_name}.time", ms, :tags => tags
+          end
+
+          def underscore(word)
+            word = word.to_s.gsub(/::/, '/')
+            word.gsub!(/([A-Z\d]+)([A-Z][a-z])/,'\1_\2')
+            word.gsub!(/([a-z\d])([A-Z])/,'\1_\2')
+            word.tr!("-", "_")
+            word.downcase
+          end
+
+      end
+    end
+  end
+end

data/lib/sidekiq-datadog.rb

@@ -0,0 +1 @@
+require "sidekiq/middleware/server/datadog"

data/sidekiq-datadog.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sidekiq/datadog/version'
+
+Gem::Specification.new do |s|
+  s.name          = "sidekiq-datadog"
+  s.version       = Sidekiq::Datadog::VERSION.dup
+  s.authors       = ["Dimitrij Denissenko"]
+  s.email         = ["dimitrij@blacksquaremedia.com"]
+  s.description   = %q{Datadog metrics for sidekiq}
+  s.summary       = %q{Datadog metrics for sidekiq}
+  s.homepage      = "https://github.com/bsm/sidekiq-datadog"
+
+  s.files         = `git ls-files`.split($/)
+  s.executables   = s.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  s.test_files    = s.files.grep(%r{^(spec)/})
+  s.require_paths = ["lib"]
+
+  s.add_runtime_dependency(%q<sidekiq>)
+  s.add_runtime_dependency(%q<dogstatsd-ruby>)
+
+  s.add_development_dependency(%q<rake>)
+  s.add_development_dependency(%q<bundler>)
+  s.add_development_dependency(%q<rspec>, "~> 3.0")
+end

data/spec/sidekiq/datadog/version_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe Sidekiq::Datadog do
+  it "has a version" do
+    expect(Sidekiq::Datadog::VERSION).to be_instance_of(String)
+  end
+end

data/spec/sidekiq/middleware/server/datadog_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+
+describe Sidekiq::Middleware::Server::Datadog do
+
+  let(:statsd) { Mock::Statsd.new(nil, nil, {}, 10000) }
+  let(:worker) { Mock::Worker.new }
+
+  before  { statsd.buffer.clear }
+  subject { described_class.new hostname: "test.host", statsd: statsd, tags: ["custom:tag", lambda{|w, *| "worker:#{w.class.name[1..2]}" }] }
+
+  it 'should send an increment and timing event for each job run' do
+    subject.call(worker, {}, 'default') { "ok" }
+    expect(statsd.buffer).to eq([
+      "sidekiq.job:1|c|#custom:tag,worker:oc,host:test.host,env:test,name:mock/worker,queue:default,status:ok",
+      "sidekiq.job.time:333|ms|#custom:tag,worker:oc,host:test.host,env:test,name:mock/worker,queue:default,status:ok",
+    ])
+  end
+
+  it 'should support wrappers' do
+    subject.call(worker, {'wrapped' => 'wrap'}, nil) { "ok" }
+    expect(statsd.buffer).to eq([
+      "sidekiq.job:1|c|#custom:tag,worker:oc,host:test.host,env:test,name:wrap,status:ok",
+      "sidekiq.job.time:333|ms|#custom:tag,worker:oc,host:test.host,env:test,name:wrap,status:ok",
+    ])
+  end
+
+  it 'should handle errors' do
+    expect(lambda {
+      subject.call(worker, {}, nil) {  raise RuntimeError, "doh!" }
+    }).to raise_error("doh!")
+
+    expect(statsd.buffer).to eq([
+      "sidekiq.job:1|c|#custom:tag,worker:oc,host:test.host,env:test,name:mock/worker,status:error,error:runtime",
+      "sidekiq.job.time:333|ms|#custom:tag,worker:oc,host:test.host,env:test,name:mock/worker,status:error,error:runtime",
+    ])
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+ENV['RACK_ENV'] ||= 'test'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require 'sidekiq-datadog'
+
+module Mock
+  class Worker
+  end
+
+  class Statsd < ::Statsd
+    def timing(stat, ms, opts={}); super(stat, 333, opts); end
+    def flush_buffer; end
+    alias :send_stat :send_to_buffer
+  end
+end

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: sidekiq-datadog
+version: !ruby/object:Gem::Version
+  version: 0.3.0
+platform: ruby
+authors:
+- Dimitrij Denissenko
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-10-08 00:00:00.000000000 Z
+dependencies:
+- !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: dogstatsd-ruby
+  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: 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'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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'
+- !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'
+description: Datadog metrics for sidekiq
+email:
+- dimitrij@blacksquaremedia.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/sidekiq-datadog.rb
+- lib/sidekiq/datadog/version.rb
+- lib/sidekiq/middleware/server/datadog.rb
+- sidekiq-datadog.gemspec
+- spec/sidekiq/datadog/version_spec.rb
+- spec/sidekiq/middleware/server/datadog_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/bsm/sidekiq-datadog
+licenses: []
+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.4.7
+signing_key: 
+specification_version: 4
+summary: Datadog metrics for sidekiq
+test_files:
+- spec/sidekiq/datadog/version_spec.rb
+- spec/sidekiq/middleware/server/datadog_spec.rb
+- spec/spec_helper.rb
+has_rdoc: