sidekiq-instrumentation 1.1.0 → 1.2.2.ejacobs2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 25b3b21f6becf08c671e2ea732966e440cb6069a55b4a686998e9bc35b31e7b6
-  data.tar.gz: 5f123ced7f7e8abea18048085e83dfc932fdb779712d455d1c0b6d53c4c9c935
+  metadata.gz: d6641e2c0b30c4ddfd7647986e5608ff11499a87ac9923653c84fbad1c846f3f
+  data.tar.gz: ad72033e048cb3b70307854c938d98922b612f09f30ba945a1503ca099f92ccc
 SHA512:
-  metadata.gz: 2628bc838cd6eb2aaf60d6745adcdf40d80c48ea3ad789b498aba02da57b89839af1388eccdaa7dbfd4e40bef223a3f12b1edd5ded3e2fbdd8a7be971b6e8c92
-  data.tar.gz: f2aa11692bd31b2cc0d168dc64447c999ea063f55e838cc52649d3ef5ded5953c67b872312d4073248ea49d5c89e5bbd127df96c75b96db7b8e5a524e278cb57
+  metadata.gz: 93484dbfcaada95dbeda85518a74ec325fe6c7eeeeea3c153dfb3a4047c27abfcf93ec14dd758bcd6133096c9d8056ba636460f8a4453b59b0840b185313a2af
+  data.tar.gz: 0ae4b86fbb017feefa41ac53fef28896edeec0e6dc88d3a13441f1f2f96717e9e6d4f66f502ed4cf6ff4d5f68e22cb2f535df20f5d50562c049e6ef71ddf3f07

data/.rubocop.yml

@@ -31,5 +31,5 @@
     Exclude:
       - "./**/*_spec*.rb"
 
-  Rails/ApplicationRecord:
+  Rails:
     Enabled: false

data/CHANGELOG.md

@@ -2,7 +2,16 @@
 Changelog
 =========
 
+## 1.2.2.ejacobs2 09/08/2020
+  * Add optional after_trace hook to ClientMiddleware
+
+## 1.2.1 07/09/2020
+  * Ensure child spans are nested under the root Sidekiq span in the trace
+
+## 1.2.0 05/28/2020
+  * Ignore active scope in consumers
+
 ## 1.1.0 05/27/2020
   * Set up build pipeline with circleci and gem-publisher
   * Fixed linting issues
-  * Renamed gem to `sidekiq-instrumentation`
+  * Renamed gem to `sidekiq-instrumentation`

data/Gemfile.lock

@@ -1,9 +1,8 @@
 PATH
   remote: .
   specs:
-    sidekiq-instrumentation (1.1.0)
+    sidekiq-instrumentation (1.2.2.ejacobs2)
       opentracing (>= 0.3.1)
-      sidekiq
 
 GEM
   remote: https://artifacts.dox.support/repository/gems/
@@ -85,9 +84,10 @@ DEPENDENCIES
   rspec
   rspec_junit_formatter
   sdoc
+  sidekiq
   sidekiq-instrumentation!
   test-tracer (~> 1.0, >= 1.2.1)
   tracing-matchers (~> 1.0, >= 1.3.0)
 
 BUNDLED WITH
-   1.17.2
+   1.17.3

data/lib/sidekiq/tracer.rb

@@ -11,9 +11,9 @@ require "sidekiq/tracer/server_middleware"
 module Sidekiq
   module Tracer
     class << self
-      def instrument(tracer: OpenTracing.global_tracer, active_span: nil)
+      def instrument(tracer: OpenTracing.global_tracer, active_span: nil, after_trace: nil)
         instrument_client(tracer: tracer, active_span: active_span)
-        instrument_server(tracer: tracer, active_span: active_span)
+        instrument_server(tracer: tracer, active_span: active_span, after_trace: after_trace)
       end
 
       def instrument_client(tracer: OpenTracing.global_tracer, active_span: nil)
@@ -22,23 +22,23 @@ module Sidekiq
         end
       end
 
-      def instrument_server(tracer: OpenTracing.global_tracer, active_span: nil)
+      def instrument_server(tracer: OpenTracing.global_tracer, active_span: nil, after_trace: nil)
         Sidekiq.configure_server do |config|
           config.client_middleware { |chain| add_client_middleware(chain, tracer, active_span) }
-          config.server_middleware { |chain| add_server_middleware(chain, tracer, active_span) }
+          config.server_middleware { |chain| add_server_middleware(chain, tracer, active_span, after_trace) }
         end
 
         return unless defined?(Sidekiq::Testing)
 
-        Sidekiq::Testing.server_middleware { |chain| add_server_middleware(chain, tracer, active_span) }
+        Sidekiq::Testing.server_middleware { |chain| add_server_middleware(chain, tracer, active_span, after_trace) }
       end
 
       def add_client_middleware(chain, tracer, active_span)
         chain.add Sidekiq::Tracer::ClientMiddleware, tracer: tracer, active_span: active_span
       end
 
-      def add_server_middleware(chain, tracer, active_span)
-        chain.add Sidekiq::Tracer::ServerMiddleware, tracer: tracer, active_span: active_span
+      def add_server_middleware(chain, tracer, active_span, after_trace)
+        chain.add Sidekiq::Tracer::ServerMiddleware, tracer: tracer, active_span: active_span, after_trace: after_trace
       end
     end
   end

data/lib/sidekiq/tracer/server_middleware.rb

@@ -5,35 +5,37 @@ module Sidekiq
     class ServerMiddleware
       include Commons
 
-      attr_reader :tracer, :active_span
+      attr_reader :tracer, :active_span, :after_trace
 
-      def initialize(tracer:, active_span:)
+      def initialize(tracer:, active_span:, after_trace:)
         @tracer = tracer
         @active_span = active_span
+        @after_trace = after_trace
       end
 
+      # rubocop:disable Metrics/MethodLength
       def call(_worker, job, _queue)
-        span = build_span(job)
-
-        yield
-      rescue StandardError => e
-        tag_errors(span, e) if span
-        raise
-      ensure
-        span&.finish
-      end
-
-      private
-
-      def build_span(job)
         parent_span_context = extract(job)
 
         follows_from = OpenTracing::Reference.follows_from(parent_span_context)
 
-        tracer.start_span(operation_name(job),
-                          references: [follows_from],
-                          tags: tags(job, "consumer"))
+        tracer.start_active_span(operation_name(job),
+                                 references: [follows_from],
+                                 ignore_active_scope: true,
+                                 tags: tags(job, "consumer")) do |scope|
+          begin
+            yield
+          rescue StandardError => e
+            tag_errors(scope.span, e) if scope.span
+            raise
+          ensure
+            after_trace&.call(scope.span) if scope.span
+          end
+        end
       end
+      # rubocop:enable Metrics/MethodLength
+
+      private
 
       def tag_errors(span, error)
         span.set_tag("error", true)

data/lib/sidekiq/tracer/version.rb

@@ -2,6 +2,6 @@
 
 module Sidekiq
   module Tracer
-    VERSION = "1.1.0"
+    VERSION = "1.2.2.ejacobs2"
   end
 end

data/sidekiq-instrumentation.gemspec

@@ -23,7 +23,6 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "opentracing", ">= 0.3.1"
-  spec.add_dependency "sidekiq"
 
   spec.add_development_dependency "bundler", "~> 1.17"
   spec.add_development_dependency "dox-style"
@@ -31,6 +30,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rspec"
   spec.add_development_dependency "rspec_junit_formatter"
   spec.add_development_dependency "sdoc"
+  spec.add_development_dependency "sidekiq"
   spec.add_development_dependency "test-tracer", "~> 1.0", ">= 1.2.1"
   spec.add_development_dependency "tracing-matchers", "~> 1.0", ">= 1.3.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-instrumentation
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.2.ejacobs2
 platform: ruby
 authors:
 - iaintshine
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-05-27 00:00:00.000000000 Z
+date: 2020-09-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: opentracing
@@ -25,20 +25,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.3.1
-- !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: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -123,6 +109,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: sidekiq
+  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: test-tracer
   requirement: !ruby/object:Gem::Requirement
@@ -174,7 +174,6 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
-- ".ruby-version"
 - ".travis.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
@@ -189,7 +188,6 @@ files:
 - lib/sidekiq/tracer/constants.rb
 - lib/sidekiq/tracer/server_middleware.rb
 - lib/sidekiq/tracer/version.rb
-- lib/sidekiq_instrumentation.rb
 - sidekiq-instrumentation.gemspec
 homepage: https://github.com/doximity/ruby-sidekiq-tracer
 licenses:
@@ -206,9 +204,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubygems_version: 3.1.2
 signing_key: 

data/lib/sidekiq_instrumentation.rb

@@ -1,3 +0,0 @@
-# frozen_string_literal: true
-
-require "sidekiq/tracer"