sidekiq-datadog 0.4.1 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 587cd9c94eb2d0018ddc31e367990f2f0121c40061e8437e6ed0d1491f16a499
-  data.tar.gz: b9e3cf7e254ecb3f26c1df1969f5d40cd20113fed85d69de13792001ec02be87
+  metadata.gz: ee5e44db186a926cdca3e3eae1a8c89c3665c67e067aa079b9a24bf8ae70fbd1
+  data.tar.gz: f0044e25b254c0e663e13a8f31e71f6f60a3d9048521e3592906377f787eba92
 SHA512:
-  metadata.gz: 3abe152091c7c6cce17d943b830f37cf1954a0151c9662fd562d5d4f64fc5d7df87118bcdd8d4e211e1398a2fa9b9af24f0f9f7644c3f20135c93a7825778c54
-  data.tar.gz: f0eb0e04d485c4d915d7c9a1198946725ed9e99be82b2130f4fb39fa19fb04a205a64576f5353f0a907f5ddc608f1baeb643dd21046554ce192e5ebe76b76936
+  metadata.gz: 35f1c25f0c901dc4bbf3fcd15c29c98d0bb6b2be7a39dc33ab61802bd3ee30fe4cb4c460a2858b76db75ce708b8f77130bb97df6fe82c1057d165a4de246726d
+  data.tar.gz: 7415541240b7aed33ae3a22af5661f58e48275733f048f041a69e538aeba5567f2d0066681d0c205ff069d360da5e3c1a8ba4ac7fa946f6a3229311f2cc289d3

data/.github/workflows/test.yml

@@ -0,0 +1,24 @@
+name: Test
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  ruby:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ["2.5", "2.6", "2.7", "3.0"]
+        gemfile: [ Gemfile, Gemfile_dogstats_v4 ]
+    env: # $BUNDLE_GEMFILE must be set at the job level, so it is set for all steps
+      BUNDLE_GEMFILE: ${{ matrix.gemfile }}
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+          bundler-cache: true
+      - run: bundle exec rake

data/.gitignore

@@ -4,3 +4,5 @@
 .config
 .yardoc
 pkg
+.rubocop-*
+.rake*

data/.rubocop.yml

@@ -0,0 +1,17 @@
+inherit_gem:
+  rubocop-bsm:
+    - default.yml
+inherit_mode:
+  merge:
+    - Exclude
+
+AllCops:
+  TargetRubyVersion: "2.5"
+
+Metrics/ParameterLists:
+  Max: 8
+Naming/FileName:
+  Exclude:
+    - lib/sidekiq-datadog.rb
+RSpec/MultipleMemoizedHelpers:
+  Enabled: false

data/Gemfile.lock

@@ -1,38 +1,70 @@
 PATH
   remote: .
   specs:
-    sidekiq-datadog (0.4.1)
-      dogstatsd-ruby (>= 3.3.0)
+    sidekiq-datadog (0.6.0)
+      dogstatsd-ruby (>= 4.2.0)
       sidekiq
 
 GEM
   remote: https://rubygems.org/
   specs:
-    connection_pool (2.2.2)
-    diff-lcs (1.3)
-    dogstatsd-ruby (4.0.0)
-    rack (2.0.5)
-    rack-protection (2.0.3)
-      rack
-    rake (12.3.1)
-    redis (4.0.2)
-    rspec (3.8.0)
-      rspec-core (~> 3.8.0)
-      rspec-expectations (~> 3.8.0)
-      rspec-mocks (~> 3.8.0)
-    rspec-core (3.8.0)
-      rspec-support (~> 3.8.0)
-    rspec-expectations (3.8.1)
+    ast (2.4.2)
+    connection_pool (2.2.5)
+    diff-lcs (1.4.4)
+    dogstatsd-ruby (5.1.0)
+    parallel (1.20.1)
+    parser (3.0.1.1)
+      ast (~> 2.4.1)
+    rack (2.2.3)
+    rainbow (3.0.0)
+    rake (13.0.3)
+    redis (4.3.1)
+    regexp_parser (2.1.1)
+    rexml (3.2.5)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-mocks (3.8.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-support (3.8.0)
-    sidekiq (5.2.1)
-      connection_pool (~> 2.2, >= 2.2.2)
-      rack-protection (>= 1.5.0)
-      redis (>= 3.3.5, < 5)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    rubocop (1.17.0)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.7.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.7.0)
+      parser (>= 3.0.1.1)
+    rubocop-bsm (0.6.0)
+      rubocop (~> 1.0)
+      rubocop-performance
+      rubocop-rake
+      rubocop-rspec
+    rubocop-performance (1.11.3)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    rubocop-rake (0.5.1)
+      rubocop
+    rubocop-rspec (2.4.0)
+      rubocop (~> 1.0)
+      rubocop-ast (>= 1.1.0)
+    ruby-progressbar (1.11.0)
+    sidekiq (6.2.1)
+      connection_pool (>= 2.2.2)
+      rack (~> 2.0)
+      redis (>= 4.2.0)
+    timecop (0.9.4)
+    unicode-display_width (2.0.0)
 
 PLATFORMS
   ruby
@@ -40,8 +72,11 @@ PLATFORMS
 DEPENDENCIES
   bundler
   rake
-  rspec (~> 3.0)
+  rspec
+  rubocop-bsm
+  rubocop-performance
   sidekiq-datadog!
+  timecop
 
 BUNDLED WITH
-   1.16.4
+   2.2.19

data/Gemfile_dogstats_v4

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'dogstatsd-ruby', '~> 4.8'               # A statsd wrapper for reporting DataDog custom metrics

data/Gemfile_dogstats_v4.lock

@@ -0,0 +1,83 @@
+PATH
+  remote: .
+  specs:
+    sidekiq-datadog (0.6.0)
+      dogstatsd-ruby (>= 4.2.0)
+      sidekiq
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    connection_pool (2.2.5)
+    diff-lcs (1.4.4)
+    dogstatsd-ruby (4.8.3)
+    parallel (1.20.1)
+    parser (3.0.1.1)
+      ast (~> 2.4.1)
+    rack (2.2.3)
+    rainbow (3.0.0)
+    rake (13.0.3)
+    redis (4.3.1)
+    regexp_parser (2.1.1)
+    rexml (3.2.5)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    rubocop (1.17.0)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.7.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.7.0)
+      parser (>= 3.0.1.1)
+    rubocop-bsm (0.6.0)
+      rubocop (~> 1.0)
+      rubocop-performance
+      rubocop-rake
+      rubocop-rspec
+    rubocop-performance (1.11.3)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    rubocop-rake (0.5.1)
+      rubocop
+    rubocop-rspec (2.4.0)
+      rubocop (~> 1.0)
+      rubocop-ast (>= 1.1.0)
+    ruby-progressbar (1.11.0)
+    sidekiq (6.2.1)
+      connection_pool (>= 2.2.2)
+      rack (~> 2.0)
+      redis (>= 4.2.0)
+    timecop (0.9.4)
+    unicode-display_width (2.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler
+  dogstatsd-ruby (~> 4.8)
+  rake
+  rspec
+  rubocop-bsm
+  rubocop-performance
+  sidekiq-datadog!
+  timecop
+
+BUNDLED WITH
+   2.2.19

data/README.md

@@ -1,7 +1,7 @@
 sidekiq-datadog
 =============
 
-Datadog intrumentation for [Sidekiq](https://github.com/mperham/sidekiq), integrated via server middleware.
+Datadog instrumentation for [Sidekiq](https://github.com/mperham/sidekiq), integrated via server middleware.
 
 ## Installation
 
@@ -15,7 +15,17 @@ Or install:
 
 Configure it in an initializer:
 
+    Sidekiq.configure_client do |config|
+      config.client_middleware do |chain|
+        chain.add Sidekiq::Middleware::Client::Datadog
+      end
+    end
+
     Sidekiq.configure_server do |config|
+      config.client_middleware do |chain|
+        chain.add Sidekiq::Middleware::Client::Datadog
+      end
+
       config.server_middleware do |chain|
         chain.add Sidekiq::Middleware::Server::Datadog
       end
@@ -45,22 +55,62 @@ executed at runtime when the job is processed
 
     Sidekiq.configure_server do |config|
       config.server_middleware do |chain|
-        chain.add(Sidekiq::Middleware::Server::Datadog, tags: [->(worker, job, queue, error){
+        chain.add(Sidekiq::Middleware::Server::Datadog, tags: [->(worker_or_worker_class, job, queue, error){
           "source:#{job['source']}"
         }])
       end
     end
 
+    # NOTE: Your lambda will either receive a `Worker` object for the Server middleware, 
+    # or a String with the `worker_class` for the Client middleware. 
+    # If you are using that argument, your lambda should be able to handle both cases.
+
+You can supress some of the default tags from being emitted by passing in `skip_tags`. 
+This is also useful if you would like to change one of the default tags, you can define
+a custom lambda **and** define it as `skip_tags`
+
+
+    Sidekiq.configure_server do |config|
+      config.server_middleware do |chain|
+        chain.add(Sidekiq::Middleware::Server::Datadog,
+            skip_tags: ["name"], 
+            tags: [->(worker_or_worker_class, job, queue, error){
+                "name:#{ my_logic_for_name }"
+            }])
+      end
+    end
+
+
 #### supported options
+
+Both Client and Server middlewares support the same options:
+
  - *hostname* - the hostname used for instrumentation, defaults to system hostname. Can also be set with the `INSTRUMENTATION_HOSTNAME` env var.
  - *metric_name* - the metric name (prefix) to use, defaults to "sidekiq.job".
- - *tags* - array of custom tags. These can be plain strings or lambda blocks
+ - *tags* - array of custom tags. These can be plain strings or lambda blocks.
+ - *skip_tags* - array of tag names that shouldn't be emitted.
  - *statsd_host* - the statsD host, defaults to "localhost". Can also be set with the `STATSD_HOST` env var
  - *statsd_port* - the statsD port, defaults to 8125. Can also be set with the `STATSD_PORT` env var
  - *statsd* - custom statsd instance
 
 For more detailed configuration options, please see the [Documentation](http://www.rubydoc.info/gems/sidekiq-datadog).
 
+## Metrics exposed
+
+The client middleware will expose:
+- `sidekiq.job_enqueued` counter, with tags: `host`, `env`, `name` (the job name) and `queue`
+
+The server middleware will expose:
+- `sidekiq.job` counter, with tags: `host`, `env`, `name` (the job name), `queue`, 
+    and `status` (`ok` or `error`). If `status` is `error`, there will be an additional
+    `error` tag with the exception class.
+- `sidekiq.job.time` timing (`ms`) metric with the same tags, specifying the job runtime.
+- `sidekiq.job.queued_time` timing (`ms`) metric with the same tags, specifying how long
+    the job was waiting in the queue before starting.
+
+The base metric names `sidekiq.job` and `sidekiq.job_enqueued` can be overriden using the
+`metric_name` option.
+
 ## Contributing
 
 1. Fork it
@@ -69,3 +119,18 @@ For more detailed configuration options, please see the [Documentation](http://w
 4. Push to the branch (`git push origin my-new-feature`)
 5. Make a pull request
 
+
+**`dogstatsd-ruby` Version note:** `dogstatsd-ruby` has major backwards incompatibilities 
+between v4.8.3 and 5.0.0. This gem is compatible with both, and CI tests both versions.
+
+In order to test through both, we have 2 Gemfiles (and their respective `.lock` files):
+- `Gemfile`
+- `Gemfile_dogstats_v4`
+
+By default, everything runs against `dogstatsd-ruby` >= 5.0.
+
+To update `Gemfile_dogstats_v4.lock`, or run tests with c4.8:
+
+`BUNDLE_GEMFILE=Gemfile_dogstats_v4 bundle update`
+
+`BUNDLE_GEMFILE=Gemfile_dogstats_v4 bundle exec rspec`

data/Rakefile

@@ -1,7 +1,23 @@
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'
+
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  warn e.message
+  warn 'Run `bundle install` to install missing gems'
+  exit e.status_code
+end
+
 require 'rake'
+
 require 'rspec/core'
 require 'rspec/core/rake_task'
 
-RSpec::Core::RakeTask.new(:spec)
-task :default => :spec
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+require 'rubocop/rake_task'
+RuboCop::RakeTask.new(:rubocop)
+
+task default: %i[rubocop spec]

data/lib/sidekiq-datadog.rb

@@ -1 +1 @@
-require "sidekiq/middleware/server/datadog"
+require 'sidekiq/datadog'

data/lib/sidekiq/datadog.rb

@@ -0,0 +1,3 @@
+require 'sidekiq/datadog/version'
+require 'sidekiq/middleware/client/datadog'
+require 'sidekiq/middleware/server/datadog'

data/lib/sidekiq/datadog/tag_builder.rb

@@ -0,0 +1,75 @@
+module Sidekiq
+  module Datadog
+    class TagBuilder
+      def initialize(custom_tags = [], skip_tags = [], custom_hostname = nil)
+        @tags = Array(custom_tags)
+        @skip_tags = Array(skip_tags).map(&:to_s)
+
+        env  = Sidekiq.options[:environment] || ENV['RACK_ENV']
+        host = custom_hostname || ENV['INSTRUMENTATION_HOSTNAME'] || Socket.gethostname
+        setup_defaults(host: host, env: env)
+      end
+
+      def build_tags(worker_or_worker_class, job, queue = nil, error = nil)
+        tags = @tags.flat_map do |tag|
+          case tag
+          when String then tag
+          when Proc then tag.call(worker_or_worker_class, job, queue, error)
+          end
+        end
+        tags.compact!
+
+        tags.push "name:#{job_name(worker_or_worker_class, job)}" if include_tag?('name')
+        tags.push "queue:#{queue}" if queue && include_tag?('queue')
+
+        if error.nil?
+          tags.push 'status:ok' if include_tag?('status')
+        else
+          kind = underscore(error.class.name.sub(/Error$/, ''))
+          tags.push 'status:error' if include_tag?('status')
+          tags.push "error:#{kind}" if include_tag?('error')
+        end
+
+        tags
+      end
+
+      private
+
+      def job_name(worker_or_worker_class, job)
+        # Client middleware sends a `worker_class` String,
+        # whereas Server middleware send a Worker object
+        worker_class = if worker_or_worker_class.is_a?(String)
+                         worker_or_worker_class
+                       else
+                         worker_or_worker_class.class.to_s
+                       end
+
+        underscore(job['wrapped'] || worker_class)
+      end
+
+      def setup_defaults(hash)
+        hash.each do |key, val|
+          key = key.to_s
+          next unless val && include_tag?(key)
+
+          prefix = "#{key}:"
+          next if @tags.any? {|t| t.is_a?(String) && t.start_with?(prefix) }
+
+          @tags.push [key, val].join(':')
+        end
+      end
+
+      def include_tag?(tag)
+        !@skip_tags.include?(tag)
+      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

data/lib/sidekiq/datadog/version.rb

@@ -1,5 +1,5 @@
 module Sidekiq
   module Datadog
-    VERSION = "0.4.1"
+    VERSION = '0.6.0'.freeze
   end
 end

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

@@ -0,0 +1,67 @@
+require 'sidekiq'
+require 'sidekiq/datadog/version'
+require 'sidekiq/datadog/tag_builder'
+require 'datadog/statsd'
+require 'socket'
+
+module Sidekiq
+  module Middleware
+    module Client
+      class Datadog
+        # Configure and install datadog instrumentation. Example:
+        #
+        #   Sidekiq.configure_client do |config|
+        #     config.client_middleware do |chain|
+        #       chain.add Sidekiq::Middleware::Client::Datadog
+        #     end
+        #   end
+        #
+        # You might want to also call `client_middleware` in your `configure_server` call,
+        # since enqueued jobs can enqueue other jobs.
+        #
+        # If you have other client middleware that can stop jobs from getting pushed,
+        # you might want to ensure this middleware is added last, to avoid reporting
+        # enqueues that later get stopped.
+        #
+        # 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_enqueued"
+        # * <tt>:tags</tt>        - array of custom tags, these can be plain strings or lambda blocks accepting a rack env instance
+        # * <tt>:skip_tags</tt>   - array of tag names that shouldn't be emitted
+        # * <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 = {})
+          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_enqueued'
+          @statsd       = opts[:statsd] || ::Datadog::Statsd.new(statsd_host, statsd_port)
+
+          # `status` is meaningless when enqueueing
+          skip_tags = Array(opts[:skip_tags]) + ['status']
+
+          @tag_builder = Sidekiq::Datadog::TagBuilder.new(
+            opts[:tags],
+            skip_tags,
+            opts[:hostname],
+          )
+        end
+
+        def call(worker_class, job, queue, _redis_pool, *)
+          record(worker_class, job, queue)
+          yield
+        end
+
+        private
+
+        def record(worker_class, job, queue)
+          tags = @tag_builder.build_tags(worker_class, job, queue)
+          @statsd.increment @metric_name, tags: tags
+
+          @statsd.flush if @statsd.respond_to?(:flush) # dogstatsd-ruby >= 5.0.0
+        end
+      end
+    end
+  end
+end

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

@@ -1,5 +1,6 @@
 require 'sidekiq'
 require 'sidekiq/datadog/version'
+require 'sidekiq/datadog/tag_builder'
 require 'datadog/statsd'
 require 'socket'
 
@@ -7,7 +8,6 @@ module Sidekiq
   module Middleware
     module Server
       class Datadog
-
         # Configure and install datadog instrumentation. Example:
         #
         #   Sidekiq.configure_server do |config|
@@ -20,76 +20,52 @@ module Sidekiq
         # * <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>:skip_tags</tt>   - array of tag names that shouldn't be emitted
         # * <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
+          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"
+          @metric_name  = opts[:metric_name] || 'sidekiq.job'
           @statsd       = opts[:statsd] || ::Datadog::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
+          @tag_builder  = Sidekiq::Datadog::TagBuilder.new(
+            opts[:tags],
+            opts[:skip_tags],
+            opts[:hostname],
+          )
         end
 
         def call(worker, job, queue, *)
           start = Time.now
+          clock = ::Process.clock_gettime(::Process::CLOCK_MONOTONIC, :millisecond)
+
           begin
             yield
-            record(worker, job, queue, start)
-          rescue => e
-            record(worker, job, queue, start, e)
+            record(worker, job, queue, start, clock)
+          rescue StandardError => e
+            record(worker, job, queue, start, clock, e)
             raise
           end
         end
 
         private
 
-          def record(worker, job, queue, start, error = nil)
-            ms   = ((Time.now - start) * 1000).round
-            if job["enqueued_at"]
-              queued_ms = ((start - Time.at(job["enqueued_at"])) * 1000).round
-            end
-            name = underscore(job['wrapped'] || worker.class.to_s)
-            tags = @tags.flat_map do |tag|
-              case tag when String then tag when Proc then tag.call(worker, job, queue, error) end
-            end
+        def record(worker, job, queue, start, clock, error = nil)
+          msec = ::Process.clock_gettime(::Process::CLOCK_MONOTONIC, :millisecond) - clock
+          tags = @tag_builder.build_tags(worker, job, queue, error)
 
-            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", msec, tags: tags
 
-            @statsd.increment @metric_name, :tags => tags
-            @statsd.timing "#{@metric_name}.time", ms, :tags => tags
-            if queued_ms
-              @statsd.timing "#{@metric_name}.queued_time", queued_ms, :tags => tags
-            end
-          end
+          return unless job['enqueued_at']
 
-          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
+          queued_ms = ((start - Time.at(job['enqueued_at'])) * 1000).round
+          @statsd.timing "#{@metric_name}.queued_time", queued_ms, tags: tags
 
+          @statsd.flush if @statsd.respond_to?(:flush) # dogstatsd-ruby >= 5.0.0
+        end
       end
     end
   end

data/sidekiq-datadog.gemspec

@@ -1,26 +1,29 @@
-# -*- encoding: utf-8 -*-
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'sidekiq/datadog/version'
 
 Gem::Specification.new do |s|
-  s.name          = "sidekiq-datadog"
+  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.authors       = ['Dimitrij Denissenko']
+  s.email         = ['dimitrij@blacksquaremedia.com']
+  s.description   = 'Datadog metrics for sidekiq'
+  s.summary       = '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.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
+  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.require_paths = ['lib']
+  s.required_ruby_version = '>= 2.5'
 
-  s.add_runtime_dependency(%q<sidekiq>)
-  s.add_runtime_dependency(%q<dogstatsd-ruby>, ">= 3.3.0")
+  s.add_runtime_dependency('dogstatsd-ruby', '>= 4.2.0')
+  s.add_runtime_dependency('sidekiq')
 
-  s.add_development_dependency(%q<rake>)
-  s.add_development_dependency(%q<bundler>)
-  s.add_development_dependency(%q<rspec>, "~> 3.0")
+  s.add_development_dependency('bundler')
+  s.add_development_dependency('rake')
+  s.add_development_dependency('rspec')
+  s.add_development_dependency('rubocop-bsm')
+  s.add_development_dependency('rubocop-performance')
+  s.add_development_dependency('timecop')
 end

data/spec/sidekiq/datadog/tag_builder_spec.rb

@@ -0,0 +1,84 @@
+require 'spec_helper'
+
+describe Sidekiq::Datadog::TagBuilder do
+  subject { described_class.new(custom_tags, skip_tags, custom_hostname) }
+
+  let(:custom_tags) { nil }
+  let(:worker) { Mock::Worker.new }
+  let(:job) { { 'enqueued_at' => 1461881794 } }
+  let(:queue) { 'queue_name' }
+  let(:error) { nil }
+  let(:skip_tags) { nil }
+  let(:custom_hostname) { nil }
+
+  it 'builds basic default tags without any parameters' do
+    result = subject.build_tags(worker, job, queue, error)
+
+    expect(result).to eql([
+      "host:#{Socket.gethostname}",
+      'env:test',
+      'name:mock/worker',
+      'queue:queue_name',
+      'status:ok',
+    ])
+  end
+
+  context 'with custom hostname' do
+    let(:custom_hostname) { 'myhostname' }
+
+    it 'reports the custom hostname' do
+      result = subject.build_tags(worker, job, queue, error)
+      expect(result).to include('host:myhostname')
+    end
+  end
+
+  context 'with custom tags' do
+    let(:custom_tags) { ['custom:tag', ->(w, *) { "worker:#{w.class.name[1..2]}" }] }
+
+    it 'reports the custom tags, fixed and Procs' do
+      result = subject.build_tags(worker, job, queue, error)
+      expect(result).to include('custom:tag')
+      expect(result).to include('worker:oc')
+    end
+  end
+
+  context 'with skipped tags' do
+    let(:skip_tags) { %w[name env] }
+
+    it "doesn't output the skipped tags" do
+      result = subject.build_tags(worker, job, queue, error)
+      result_keys = result.map {|t| t.split(':').first }
+
+      expect(result_keys).not_to include('name')
+      expect(result_keys).not_to include('env')
+    end
+  end
+
+  context 'with a wrapped job' do
+    let(:job) { { 'wrapped' => 'Module::WrappedJobName' } }
+
+    it 'reports the wrapped job name' do
+      result = subject.build_tags(worker, job, queue, error)
+      expect(result).to include('name:module/wrapped_job_name')
+    end
+  end
+
+  context 'with an error' do
+    let(:error) { ArgumentError.new }
+
+    it 'reports the error class, and status' do
+      result = subject.build_tags(worker, job, queue, error)
+      expect(result).to include('error:argument')
+      expect(result).to include('status:error')
+    end
+  end
+
+  context 'with a worker_class instead of a Worker object' do
+    let(:worker_class) { 'Module::Worker' }
+
+    it 'reports the error class, and status' do
+      result = subject.build_tags(worker_class, job, queue, error)
+      expect(result).to include('name:module/worker')
+    end
+  end
+end

data/spec/sidekiq/datadog_spec.rb

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

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

@@ -0,0 +1,71 @@
+require 'spec_helper'
+
+describe Sidekiq::Middleware::Client::Datadog do
+  subject { described_class.new(hostname: 'test.host', statsd: statsd, tags: tags, **options) }
+
+  let(:statsd) { Mock::Statsd.new('localhost', 55555) }
+  let(:worker_class) { 'Mock::Worker' }
+  let(:tags) do
+    ['custom:tag', ->(worker_class, *) { "worker:#{worker_class[1..2]}" }]
+  end
+  let(:options) { {} }
+
+  before do
+    statsd.messages.clear
+  end
+
+  it 'sends an increment event for each job enqueued' do
+    subject.call(worker_class, {}, 'default', nil) { 'ok' }
+    expect(statsd.messages).to eq([
+      'sidekiq.job_enqueued:1|c|#custom:tag,worker:oc,host:test.host,env:test,name:mock/worker,'\
+        'queue:default',
+    ])
+  end
+
+  it 'supports wrappers' do
+    subject.call(worker_class, { 'wrapped' => 'wrap' }, nil, nil) { 'ok' }
+    expect(statsd.messages).to eq([
+      'sidekiq.job_enqueued:1|c|#custom:tag,worker:oc,host:test.host,env:test,name:wrap',
+    ])
+  end
+
+  context 'with a dynamic tag list' do
+    let(:tags) do
+      ['custom:tag', ->(_w, j, *) { j['args'].map {|n| "arg:#{n}" } }]
+    end
+
+    it 'generates the correct tags' do
+      subject.call(worker_class, { 'args' => [1, 2] }, 'default', nil) { 'ok' }
+
+      expect(statsd.messages).to eq([
+        'sidekiq.job_enqueued:1|c|#custom:tag,arg:1,arg:2,host:test.host,env:test,name:mock/worker,'\
+          'queue:default',
+      ])
+    end
+  end
+
+  context 'with a list of skipped tags' do
+    let(:tags) { [] }
+    let(:options) { { skip_tags: %i[env host name] } }
+
+    it 'sends metrics without the skipped tags' do
+      subject.call(worker_class, {}, 'default', nil) { 'ok' }
+
+      expect(statsd.messages).to eq([
+        'sidekiq.job_enqueued:1|c|#queue:default',
+      ])
+    end
+  end
+
+  context 'when sidekiq/api is required' do
+    before do
+      require 'sidekiq/api'
+    end
+
+    it 'does not raise any errors' do
+      expect do
+        subject.call(worker_class, {}, 'default', nil) { 'ok' }
+      end.not_to raise_error
+    end
+  end
+end

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

@@ -1,59 +1,107 @@
 require 'spec_helper'
 
 describe Sidekiq::Middleware::Server::Datadog do
+  subject { described_class.new(hostname: 'test.host', statsd: statsd, tags: tags, **options) }
 
   let(:statsd) { Mock::Statsd.new('localhost', 55555) }
   let(:worker) { Mock::Worker.new }
-  let(:tags) {
-    ["custom:tag", lambda{|w, *| "worker:#{w.class.name[1..2]}" }]
-  }
-
-  before  { statsd.written.clear }
-  subject { described_class.new hostname: "test.host", statsd: statsd, tags: tags }
-
-  it 'should send an increment and timing event for each job run' do
-    subject.call(worker, { 'enqueued_at' => 1461881794.9312189 }, 'default') { "ok" }
-    expect(statsd.written).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",
-      "sidekiq.job.queued_time:333|ms|#custom:tag,worker:oc,host:test.host,env:test,name:mock/worker,queue:default,status:ok",
+  let(:tags) do
+    ['custom:tag', ->(w, *) { "worker:#{w.class.name[1..2]}" }]
+  end
+  let(:options) { {} }
+  let(:enqueued_at) { 1461881794.9312189 }
+  let(:expected_queued_time_ms) { 444 }
+
+  before do
+    statsd.messages.clear
+
+    clock_gettime_call_count = 0
+    expect(Process).to receive(:clock_gettime).twice do
+      clock_gettime_call_count += 1
+      clock_gettime_call_count == 1 ? 0 : 333
+    end
+
+    Timecop.freeze(Time.at(enqueued_at + expected_queued_time_ms.to_f / 1000))
+  end
+
+  it 'sends an increment and timing event for each job run' do
+    subject.call(worker, { 'enqueued_at' => enqueued_at }, 'default') { 'ok' }
+    expect(statsd.messages).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',
+      "sidekiq.job.queued_time:#{expected_queued_time_ms}|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, { 'enqueued_at' => 1461881794.9312189, 'wrapped' => 'wrap'}, nil) { "ok" }
-    expect(statsd.written).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",
-      "sidekiq.job.queued_time:333|ms|#custom:tag,worker:oc,host:test.host,env:test,name:wrap,status:ok",
+  it 'supports wrappers' do
+    subject.call(worker, { 'enqueued_at' => enqueued_at, 'wrapped' => 'wrap' }, nil) { 'ok' }
+    expect(statsd.messages).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',
+      "sidekiq.job.queued_time:#{expected_queued_time_ms}|ms|#custom:tag,worker:oc,host:test.host,"\
+        'env:test,name:wrap,status:ok',
     ])
   end
 
-  it 'should handle errors' do
+  it 'handles errors' do
     expect(lambda {
-      subject.call(worker, {}, nil) {  raise RuntimeError, "doh!" }
-    }).to raise_error("doh!")
+      subject.call(worker, {}, nil) { raise 'doh!' }
+    }).to raise_error('doh!')
 
-    expect(statsd.written).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",
+    expect(statsd.messages).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
 
   context 'with a dynamic tag list' do
-    let(:tags) {
-      ["custom:tag", lambda {|w, j, *| j['args'].map { |n| "arg:#{n}"} }]
-    }
+    let(:tags) do
+      ['custom:tag', ->(_w, j, *) { j['args'].map {|n| "arg:#{n}" } }]
+    end
+
+    it 'generates the correct tags' do
+      subject.call(worker, { 'enqueued_at' => enqueued_at, 'args' => [1, 2] }, 'default') { 'ok' }
 
-    it 'should generate the correct tags' do
-      subject.call(worker, { 'enqueued_at' => 1461881794.9312189, 'args' => [1, 2] }, 'default') { "ok" }
+      expect(statsd.messages).to eq([
+        'sidekiq.job:1|c|#custom:tag,arg:1,arg:2,host:test.host,env:test,name:mock/worker,'\
+          'queue:default,status:ok',
+        'sidekiq.job.time:333|ms|#custom:tag,arg:1,arg:2,host:test.host,env:test,name:mock/worker,'\
+          'queue:default,status:ok',
+        "sidekiq.job.queued_time:#{expected_queued_time_ms}|ms|#custom:tag,arg:1,arg:2,"\
+          'host:test.host,env:test,name:mock/worker,queue:default,status:ok',
+      ])
+    end
+  end
+
+  context 'with a list of skipped tags' do
+    let(:tags) { [] }
+    let(:options) { { skip_tags: %i[env host name] } }
+
+    it 'sends metrics without the skipped tags' do
+      subject.call(worker, { 'enqueued_at' => 1461881794.9312189 }, 'default') { 'ok' }
 
-      expect(statsd.written).to eq([
-        "sidekiq.job:1|c|#custom:tag,arg:1,arg:2,host:test.host,env:test,name:mock/worker,queue:default,status:ok",
-        "sidekiq.job.time:333|ms|#custom:tag,arg:1,arg:2,host:test.host,env:test,name:mock/worker,queue:default,status:ok",
-        "sidekiq.job.queued_time:333|ms|#custom:tag,arg:1,arg:2,host:test.host,env:test,name:mock/worker,queue:default,status:ok"
+      expect(statsd.messages).to eq([
+        'sidekiq.job:1|c|#queue:default,status:ok',
+        'sidekiq.job.time:333|ms|#queue:default,status:ok',
+        "sidekiq.job.queued_time:#{expected_queued_time_ms}|ms|#queue:default,status:ok",
       ])
     end
   end
 
+  context 'when sidekiq/api is required' do
+    before do
+      require 'sidekiq/api'
+    end
+
+    it 'does not raise any errors' do
+      expect do
+        subject.call(worker, { 'enqueued_at' => enqueued_at }, 'default') { 'ok' }
+      end.not_to raise_error
+    end
+  end
 end

data/spec/spec_helper.rb

@@ -1,17 +1,18 @@
 ENV['RACK_ENV'] ||= 'test'
-
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
-$LOAD_PATH.unshift(File.dirname(__FILE__))
-
 require 'sidekiq-datadog'
+require 'timecop'
 
 module Mock
-  class Worker
-  end
+  class Worker; end # rubocop:disable Lint/EmptyClass
 
   class Statsd < ::Datadog::Statsd
-    def timing(stat, ms, opts={}); super(stat, 333, opts); end
-    def send_stat(message); written.push(message); end
-    def written; @written ||= []; end
+    def send_stats(stat, delta, type, opts = EMPTY_OPTIONS)
+      full_stat = serializer.to_stat(stat, delta, type, tags: opts[:tags])
+      messages.push full_stat
+    end
+
+    def messages
+      @messages ||= []
+    end
   end
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-datadog
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.6.0
 platform: ruby
 authors:
 - Dimitrij Denissenko
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-08-28 00:00:00.000000000 Z
+date: 2021-06-30 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: dogstatsd-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
 - !ruby/object:Gem::Dependency
   name: sidekiq
   requirement: !ruby/object:Gem::Requirement
@@ -25,19 +39,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: dogstatsd-ruby
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.3.0
-  type: :runtime
+        version: '0'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.3.0
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -53,7 +67,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -67,19 +81,47 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rubocop-bsm
+  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: rubocop-performance
+  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: timecop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
 description: Datadog metrics for sidekiq
 email:
 - dimitrij@blacksquaremedia.com
@@ -87,18 +129,26 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/test.yml"
 - ".gitignore"
-- ".travis.yml"
+- ".rubocop.yml"
 - Gemfile
 - Gemfile.lock
+- Gemfile_dogstats_v4
+- Gemfile_dogstats_v4.lock
 - LICENSE.txt
 - README.md
 - Rakefile
 - lib/sidekiq-datadog.rb
+- lib/sidekiq/datadog.rb
+- lib/sidekiq/datadog/tag_builder.rb
 - lib/sidekiq/datadog/version.rb
+- lib/sidekiq/middleware/client/datadog.rb
 - lib/sidekiq/middleware/server/datadog.rb
 - sidekiq-datadog.gemspec
-- spec/sidekiq/datadog/version_spec.rb
+- spec/sidekiq/datadog/tag_builder_spec.rb
+- spec/sidekiq/datadog_spec.rb
+- spec/sidekiq/middleware/client/datadog_spec.rb
 - spec/sidekiq/middleware/server/datadog_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/bsm/sidekiq-datadog
@@ -112,19 +162,20 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.2.15
 signing_key: 
 specification_version: 4
 summary: Datadog metrics for sidekiq
 test_files:
-- spec/sidekiq/datadog/version_spec.rb
+- spec/sidekiq/datadog/tag_builder_spec.rb
+- spec/sidekiq/datadog_spec.rb
+- spec/sidekiq/middleware/client/datadog_spec.rb
 - spec/sidekiq/middleware/server/datadog_spec.rb
 - spec/spec_helper.rb

data/.travis.yml

@@ -1,5 +0,0 @@
-language: ruby
-cache: bundler
-rvm:
-  - 2.5.1
-  - 2.4.4

data/spec/sidekiq/datadog/version_spec.rb

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