sidekiq-instrumental 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: faa7a76c550d65983211b0f20bbd198d9b7995442e2995de66f24e9240f21ac7
-  data.tar.gz: 58d0d2e0d6388de6bad14c218a910769372f1e0503f1b02daf5b6746da4f3538
+  metadata.gz: 2e3b5be832d57b3a1a67741a65b46b983f0580b56a7ff24db58fb8da85b59ee8
+  data.tar.gz: e2465ae0bad37bd73903c6cd7e4c518c1e3350d508684a30178a6f9929d8a393
 SHA512:
-  metadata.gz: 241240850476d4200464a3b1b2d86b46242c8ed715def7122124057c94327271bf72de83a48b692203bd6170aa98d70f27797cbb714ad8cd85108efde078c736
-  data.tar.gz: ad872a46fdee9de36cd770dff16ff6ed6838b9cf9dfa9f1f14223121b51d2ae5ee17f0f677f13b62b9793703c447312429d6434dc224e70a892aaed41f2788d1
+  metadata.gz: 90e026453667bb00ebf30e992a3b38e1cca3aeb6273e914ef68fb6cdff4340c1e9a8129def78672a9bd64b58d0d71f7f5c9a022a83ea250e59310f412bb9a64d
+  data.tar.gz: f3050927c14134accfba8316f4394bd8ef6bd35aafef32a5ca7c7b1145491a9ab67996e13c6d2c27514e61369ba85ebec8893407b11d6077f658ae819eef3583

data/.circleci/config.yml

@@ -122,6 +122,9 @@ jobs:
     steps:
       - attach_workspace:
           at: .
+      - run:
+          name: Install bundler
+          command: gem install bundler --version=$BUNDLE_VERSION
       - run:
           name: Deploy to gem server
           command: |-

data/.rubocop.yml

@@ -2,5 +2,7 @@ AllCops:
   TargetRubyVersion: 2.3
 Layout/MultilineMethodCallIndentation:
   EnforcedStyle: indented_relative_to_receiver
+Layout/LineLength:
+  Max: 90
 Metrics:
   Enabled: false

data/CHANGELOG.md

@@ -9,6 +9,10 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 ### Changed
 ### Fixed
 
+## [0.3.1]
+### Fixed
+- class name calculation needs to filter out unsupported characters by instrumental
+
 ## [0.3.0]
 ### Fixed
 - class name calculation now uses Sidekiq's display\_class\_name to support ActiveJob jobs

data/lib/sidekiq/instrumental/middleware/base.rb

@@ -39,6 +39,14 @@ module Sidekiq
         def gauge(*args)
           config.I.gauge(*args)
         end
+
+        def build_class_key(klass_name)
+          key = klass_name.underscore
+                  .gsub(/[^\d\w\-_\.]/, '_')
+                  .gsub(/\.{2,}/, '.')
+          key.chomp!('.') while key[-1] == '.'
+          key
+        end
       end
     end
   end

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

@@ -13,7 +13,7 @@ module Sidekiq
           base_key = "sidekiq.#{queue}."
           increment(base_key + 'queued')
 
-          base_key += msg.display_class.underscore.gsub('/', '_') + '.'
+          base_key += build_class_key(msg.display_class) + '.'
 
           increment(base_key + 'queued')
         end

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

@@ -18,7 +18,7 @@ module Sidekiq
           gauge(base_key + 'time', elapsed)
           gauge(base_key + 'enqueued', stats.queues[queue].to_i)
           gauge(base_key + 'latency', Sidekiq::Queue.new(queue.to_s).latency)
-          base_key += msg.display_class.underscore.gsub('/', '_') + '.'
+          base_key += build_class_key(msg.display_class) + '.'
 
           increment(base_key + 'processed')
           gauge(base_key + 'time', elapsed)

data/lib/sidekiq/instrumental/version.rb

@@ -2,6 +2,6 @@
 
 module Sidekiq
   module Instrumental
-    VERSION = '0.3.0'
+    VERSION = '0.3.1'
   end
 end

data/spec/sidekiq/instrumental/middleware/client_spec.rb

@@ -38,6 +38,41 @@ RSpec.describe Sidekiq::Instrumental::Middleware::Client do
     subject
   end
 
+  describe 'metric naming' do
+    context 'when the class name contains unsupported characters' do
+      let(:msg) { { 'class' => 'MyMailer#message/fun' } }
+
+      it 'changes them to _' do
+        expect(middleware).to receive(:increment)
+                                .with("sidekiq.#{queue}.my_mailer_message_fun.queued")
+
+        subject
+      end
+    end
+
+    context 'when the class name causes more then one . in a row' do
+      let(:msg) { { 'class' => 'MyMailer..message' } }
+
+      it 'combines them to one' do
+        expect(middleware).to receive(:increment)
+                                .with("sidekiq.#{queue}.my_mailer.message.queued")
+
+        subject
+      end
+    end
+
+    context 'trims a trailing .' do
+      let(:msg) { { 'class' => 'MyMailer#message.' } }
+
+      it 'combines them to one' do
+        expect(middleware).to receive(:increment)
+                                .with("sidekiq.#{queue}.my_mailer_message.queued")
+
+        subject
+      end
+    end
+  end
+
   it 'calls display_class to get the class name' do
     expect_any_instance_of(::Sidekiq::Job)
       .to receive(:display_class).and_call_original

data/spec/sidekiq/instrumental/middleware/server_spec.rb

@@ -91,6 +91,41 @@ RSpec.describe Sidekiq::Instrumental::Middleware::Server do
     subject
   end
 
+  describe 'metric naming' do
+    context 'when the class name contains unsupported characters' do
+      let(:msg) { { 'class' => 'MyMailer#message/fun' } }
+
+      it 'changes them to _' do
+        expect(middleware).to receive(:increment)
+                                .with("sidekiq.#{queue}.my_mailer_message_fun.processed")
+
+        subject
+      end
+    end
+
+    context 'when the class name causes more then one . in a row' do
+      let(:msg) { { 'class' => 'MyMailer..message' } }
+
+      it 'combines them to one' do
+        expect(middleware).to receive(:increment)
+                                .with("sidekiq.#{queue}.my_mailer.message.processed")
+
+        subject
+      end
+    end
+
+    context 'trims a trailing .' do
+      let(:msg) { { 'class' => 'MyMailer#message.' } }
+
+      it 'combines them to one' do
+        expect(middleware).to receive(:increment)
+                                .with("sidekiq.#{queue}.my_mailer_message.processed")
+
+        subject
+      end
+    end
+  end
+
   it 'gauge elapsed time metric for the class' do
     expect(middleware).to receive(:gauge)
                             .with(

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-instrumental
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Edward Rudd
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-01-28 00:00:00.000000000 Z
+date: 2020-03-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: instrumental_agent