sidekiq-instrument 0.4.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 55f5707e3e987499dee665c604a5d7453a643f91573fd0f1bec37287bef38309
-  data.tar.gz: '095f5c3bb1dff919143ba4a7a798a00f9a3ed78e467a3165a7942267d75864f4'
+  metadata.gz: dec762f020453b49d17551ce8dba6146fad0b4fdb5c06fbc5ce17ad57bdafae5
+  data.tar.gz: 98e6f98439a8a886a8ec4adc0b8daa83d181629ebe7f2e4020861dc66379c533
 SHA512:
-  metadata.gz: 55f8eab12d63ce0d4dc37ec3323f3126d6026aa1be42c101cd300195275ca94625b706b9beefada7a8764860b1a8c7ab0a02c7ced1d4bd2b02a9ccc5932181e1
-  data.tar.gz: 9ba846d4af8f326c83157fa605b1982068baac4ed4cf07b05fa31cf06cafd5d95a484c60e29e9860462762ab401b041034272b5d87aedb187a3788d17d410dde
+  metadata.gz: 123de131fd9d2aa45d1256c2b4c53c25e1cdc1181b02ab16e230ca6e2cbdeda2785c8b2b58a20b27a5056a8dc2bfc48dfaff8ad26c887e60addb4684acb20162
+  data.tar.gz: 56b1cb9ac84cb8ee016da9ab99fabe7e000b59c46b1c0b23a107798193f8ab979c9e782f3525b4ff8041455533ebe8837e375803e3313478e670e9137b203852

data/.github/workflows/ci.yml

@@ -0,0 +1,36 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+
+permissions:
+  contents: read
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: [2.6, 2.7, 3.0]
+        redis-version: [4, 5, 6]
+
+    steps:
+      - name: Checkout project
+        uses: actions/checkout@v3
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+          bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+
+      - name: Start Redis
+        uses: supercharge/redis-github-action@1.4.0
+        with:
+          redis-version: ${{ matrix.redis-version }}
+
+      - name: Run tests
+        run: bundle exec rake

data/.simplecov

@@ -1,8 +1,11 @@
-require 'coveralls'
+require 'simplecov'
+require 'simplecov-cobertura'
 
 SimpleCov.formatters = [
   SimpleCov::Formatter::HTMLFormatter,
-  Coveralls::SimpleCov::Formatter
+  SimpleCov::Formatter::CoberturaFormatter
 ]
 
-SimpleCov.start
+SimpleCov.start do
+  add_filter "/spec/"
+end

data/README.md

@@ -1,30 +1,33 @@
 # 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.
+Reports job metrics using Shopify's [statsd-instrument][statsd-instrument] library and \[optionally\] DataDog's [dogstatsd-ruby](https://github.com/DataDog/dogstatsd-ruby), 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:
+Add the following to your application's Gemfile:
 
 ```ruby
 gem 'sidekiq-instrument'
+gem 'dogstatsd-ruby' # optional
 ```
 
 And then execute:
 
     $ bundle
 
-Or install it yourself as:
+Or install the gem(s) yourself as:
 
     $ gem install sidekiq-instrument
+    $ gem install dogstatsd-ruby # again, optional
 
 ## 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:
+a typical Rails app would just use an initializer and set the `StatsD` and optional `DogStatsD`
+clients via this gem's `Statter` class:
+
+### StatsD
 
 ```ruby
 # config/initializers/statsd.rb
@@ -33,11 +36,22 @@ StatsD.prefix  = 'my-app'
 StatsD.backend = StatsD::Instrument::Backends::UDPBackend.new('some-server:8125')
 ```
 
+### DogStatsD
+
+```ruby
+# config/initializers/dogstatsd.rb
+require 'datadog/statsd'
+DogStatsD = Datadog::Statsd.new('localhost', 8125, tags: {app_name: 'my_app', env: 'production'})
+```
+
 Then add the client and server middlewares in your Sidekiq initializer:
 
 ```ruby
 require 'sidekiq/instrument'
 
+Sidekiq::Instrument::Statter.statsd = StatsD # optional, Statter will fall back to a global StatsD
+Sidekiq::Instrument::Statter.dogstatsd = DogStatsD # optional, dogstatsd can be nil if not desired
+
 Sidekiq.configure_server do |config|
   config.server_middleware do |chain|
     chain.add Sidekiq::Instrument::ServerMiddleware
@@ -74,6 +88,22 @@ For each queue, the following metrics will be reported:
 1. **shared.sidekiq._queue_.size**: gauge of how many jobs are in the queue
 1. **shared.sidekiq._queue_.latency**: gauge of how long the oldest job has been in the queue
 
+## DogStatsD Keys
+For each job, the following metrics and tags will be reported:
+
+1. **sidekiq.enqueue (tags: {queue: _queue_, worker: _job_})**: counter incremented each time a
+   job is pushed onto the queue.
+2. **sidekiq.dequeue (tags: {queue: _queue_, worker: _job_})**: counter incremented just before
+   worker begins performing a job.
+3. **sidekiq.runtime (tags: {queue: _queue_, worker: _job_})**: timer of the total time spent
+   in `perform`, in milliseconds.
+3. **sidekiq.error (tags: {queue: _queue_, worker: _job_})**: counter incremented each time a
+   job fails.
+
+For each queue, the following metrics and tags will be reported:
+1. **sidekiq.queue_size (tags: {queue: _queue_})**: gauge of how many jobs are in the queue
+1. **sidekiq.queue_latency (tags: {queue: _queue_})**: gauge of how long the oldest job has been in the queue
+
 ## Worker
 There is a worker, `Sidekiq::Instrument::Worker`, that submits gauges
 for various interesting statistics; namely, the bulk of the information in `Sidekiq::Stats`

data/bin/console

@@ -1,14 +1,15 @@
 #!/usr/bin/env ruby
 
-require "bundler/setup"
-require "sidekiq/instrument"
+require 'bundler/setup'
+require 'sidekiq/instrument'
+require 'datadog/statsd'
 
 # 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"
+# require 'pry'
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start

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

@@ -7,7 +7,9 @@ module Sidekiq::Instrument
     def call(worker_class, job, queue, redis_pool)
       # worker_class is a const in sidekiq >= 6.x
       klass = Object.const_get(worker_class.to_s)
-      StatsD.increment metric_name(klass.new, 'enqueue')
+      class_instance = klass.new
+      Statter.statsd.increment(metric_name(class_instance, 'enqueue'))
+      Statter.dogstatsd&.increment('sidekiq.enqueue', worker_dog_options(class_instance))
 
       yield
     end

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

@@ -5,12 +5,19 @@ module Sidekiq::Instrument
     include Sidekiq::Instrument::MetricNames
 
     def call(worker, job, queue, &block)
-      StatsD.increment(metric_name(worker, 'dequeue'))
+      Statter.statsd.increment(metric_name(worker, 'dequeue'))
+      Statter.dogstatsd&.increment('sidekiq.dequeue', worker_dog_options(worker))
 
-      StatsD.measure(metric_name(worker,'runtime'), &block)
+      start_time = Time.now
+      yield block
+      execution_time_ms = (Time.now - start_time) * 1000
+      Statter.statsd.measure(metric_name(worker, 'runtime'), execution_time_ms)
+      Statter.dogstatsd&.timing('sidekiq.runtime', execution_time_ms, worker_dog_options(worker))
     rescue StandardError => e
-      StatsD.increment(metric_name(worker, 'error'))
+      Statter.statsd.increment(metric_name(worker, 'error'))
+      Statter.dogstatsd&.increment('sidekiq.error', worker_dog_options(worker))
       raise e
     end
   end
 end
+

data/lib/sidekiq/instrument/mixin.rb

@@ -4,11 +4,22 @@ module Sidekiq::Instrument
       if worker.respond_to?(:statsd_metric_name)
         worker.send(:statsd_metric_name, event)
       else
-        queue = worker.class.get_sidekiq_options['queue']
-        name = worker.class.name.gsub('::', '_')
-
-        "shared.sidekiq.#{queue}.#{name}.#{event}"
+        "shared.sidekiq.#{queue_name(worker)}.#{class_name(worker)}.#{event}"
       end
     end
+
+    def worker_dog_options(worker)
+      { tags: ["queue:#{queue_name(worker)}", "worker:#{class_name(worker)}"] }
+    end
+
+    private
+
+    def queue_name(worker)
+      worker.class.get_sidekiq_options['queue']
+    end
+
+    def class_name(worker)
+      worker.class.name.gsub('::', '_')
+    end
   end
 end

data/lib/sidekiq/instrument/statter.rb

@@ -0,0 +1,15 @@
+module Sidekiq::Instrument
+  class Statter
+    # @!scope class
+    # @!attribute [rw]
+    # StatsD client for emitting metrics related to Sidekiq queue operations.
+    class_attribute :statsd
+
+    # @!scope class
+    # @!attribute [rw]
+    # Optional DogStatsD client for emitting metrics related to Sidekiq queue operations.
+    class_attribute :dogstatsd
+
+    self.statsd ||= StatsD
+  end
+end

data/lib/sidekiq/instrument/version.rb

@@ -1,5 +1,5 @@
 module Sidekiq
   module Instrument
-    VERSION = "0.4.1"
+    VERSION = "0.5.0"
   end
 end

data/lib/sidekiq/instrument/worker.rb

@@ -21,18 +21,22 @@ module Sidekiq::Instrument
       self.class::METRIC_NAMES.each do |method, stat|
         stat ||= method
 
-        StatsD.gauge "shared.sidekiq.stats.#{stat}", info.send(method)
+        Statter.statsd.gauge("shared.sidekiq.stats.#{stat}", info.send(method))
+        Statter.dogstatsd&.gauge("sidekiq.#{stat}", info.send(method))
       end
 
       working = Sidekiq::ProcessSet.new.select { |p| p[:busy] == 1 }.count
-      StatsD.gauge "shared.sidekiq.stats.working", working
+      Statter.statsd.gauge('shared.sidekiq.stats.working', working)
+      Statter.dogstatsd&.gauge('sidekiq.working', working)
 
       info.queues.each do |name, size|
-        StatsD.gauge "shared.sidekiq.#{name}.size", size
+        Statter.statsd.gauge("shared.sidekiq.#{name}.size", size)
+        Statter.dogstatsd&.gauge('sidekiq.queue.size', size, tags: ["queue:#{name}"])
       end
 
       Sidekiq::Queue.all.each do |queue|
-        StatsD.gauge "shared.sidekiq.#{queue.name}.latency", queue.latency
+        Statter.statsd.gauge("shared.sidekiq.#{queue.name}.latency", queue.latency)
+        Statter.dogstatsd&.gauge('sidekiq.queue.latency', queue.latency, tags: ["queue:#{queue.name}"])
       end
     end
   end

data/lib/sidekiq/instrument.rb

@@ -1,3 +1,6 @@
+require 'active_support/core_ext/class/attribute'
+
+require "sidekiq/instrument/statter"
 require "sidekiq/instrument/version"
 require "sidekiq/instrument/worker"
 require "sidekiq/instrument/middleware/client"

data/sidekiq-instrument.gemspec

@@ -6,10 +6,10 @@ 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.authors       = ['Loan Application Services']
+  spec.email         = ['application_services@enova.com']
 
-  spec.summary       = 'StatsD instrumentation for Sidekiq'
+  spec.summary       = 'StatsD & DogStatsD Instrumentation for Sidekiq'
   spec.homepage      = 'https://github.com/enova/sidekiq-instrument'
   spec.license       = 'MIT'
 
@@ -18,10 +18,13 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'sidekiq', '>= 4.2', '< 7'
   spec.add_dependency 'statsd-instrument', '>= 2.0.4'
+  spec.add_dependency 'dogstatsd-ruby', '~> 5.5.0'
+  spec.add_dependency 'activesupport', '>= 5.1', '< 7'
 
   spec.add_development_dependency 'bundler', '~> 2.0', '>= 2.0.2'
   spec.add_development_dependency 'rake', '~> 12.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'pry-byebug', '~> 3.4'
-  spec.add_development_dependency 'coveralls', '~> 0.8'
+  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'simplecov-cobertura'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-instrument
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.5.0
 platform: ruby
 authors:
-- Matt Larraz
+- Loan Application Services
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-07-28 00:00:00.000000000 Z
+date: 2022-11-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sidekiq
@@ -44,6 +44,40 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 2.0.4
+- !ruby/object:Gem::Dependency
+  name: dogstatsd-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.5.0
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -107,30 +141,44 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.4'
 - !ruby/object:Gem::Dependency
-  name: coveralls
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov-cobertura
+  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.8'
+        version: '0'
 description:
 email:
-- mlarraz@enova.com
+- application_services@enova.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - ".rspec"
 - ".simplecov"
-- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -141,6 +189,7 @@ files:
 - lib/sidekiq/instrument/middleware/client.rb
 - lib/sidekiq/instrument/middleware/server.rb
 - lib/sidekiq/instrument/mixin.rb
+- lib/sidekiq/instrument/statter.rb
 - lib/sidekiq/instrument/version.rb
 - lib/sidekiq/instrument/worker.rb
 - sidekiq-instrument.gemspec
@@ -166,5 +215,5 @@ requirements: []
 rubygems_version: 3.1.6
 signing_key:
 specification_version: 4
-summary: StatsD instrumentation for Sidekiq
+summary: StatsD & DogStatsD Instrumentation for Sidekiq
 test_files: []

data/.travis.yml

@@ -1,20 +0,0 @@
-sudo: false
-language: ruby
-rvm:
-  - 2.5.8
-  - 2.6.6
-  - 2.7.2
-
-services:
-  - redis-server
-
-before_install: gem install bundler -v 2.0.2
-
-deploy:
-  provider: rubygems
-  api_key:
-    secure: T0S2ipyvGkY2qL6oxcgZgBl+krGR3qFlL4vNyzy+rvaZAV8YNijQiM7YyggTLhnKai3SxuHjzN1ZiT7vzlklJn9k2qRhU1uVq4xW+YX6yVNBBbugJGqNuyw3p2BUOga83ES2jA/Kby9mLAJEebS5LmupapSCeElsmhYzXIlV9SYH1mZV4CHQ06Luv3r1DQ8z1cwrB+5N+Y9TNV1wXa/LbuxJPl6jgxN0oJ+RFU7lTHtovMwyL+wRXLiRpZc2k6dH0IUo03QxYVCUDIvShdX26WfzF+fpSPRgOHnbJeaBTbeuxntFzEDy6Td2hpRQWP31i+/8BzPWGCLqUfS55uQqFM06UI/vnZnbe8NlI57gzw6yJHPsFoyg8Cw/3TABhw+SEOoMyBdued4RGKF6EgYsx3hW+KUhEvncnBg6F7jRdZgtHmk6s8iU+/d39pgQh4AiCJQOhINErAnnH2P5hM3TDoZYQlkUjw0FQ0F8bTmRKJq4JhMyvtwMutvMuSIN+8q7utNTxzFquvYcmAcNYafsmuC7Qtvpqi0iVzQ3f3c+SCljcvEnUEf66+xufkn79eSAYcCrL/FdZOdBEiXpaY2wdtJO7Kr66BMhzGCjlO8YQoDw0pgsES9Uy5H1JtfphjWzHWYdiYDBoofFURE1jO/pJ9V9dp9ezzOcvW4faZhL8ho=
-  gem: sidekiq-instrument
-  on:
-    tags: true
-    repo: enova/sidekiq-instrument