sidekiq-instrumentation 1.2.0.pre2 → 1.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: da552b8f001443c2b2b6829a7ed1143bda6748daf470764e4f211199333dd348
-  data.tar.gz: 8031b06930f50e83f05c4cf2c75c8330f8fdfe3cb122af4398df7af5f7d94a59
+  metadata.gz: efa08e01af2293de61c9273900ad7f1fce8202b5ab7a7f3f1c36a53283bbeeaa
+  data.tar.gz: 872499d82c73764390ce913edbadaf6480c40b5d0baeb8c298644c0a4550d8f5
 SHA512:
-  metadata.gz: c94986c2e8cc309cf59c724ef209c57e810113f064c5ded4b63125c25430fbb9f49d7f0dded837bb939def0193b94f57069fdddf675b724dec8b22aa9eaa824d
-  data.tar.gz: 9514d1b79555b429d72d0ac904461c9bd971c575280401bee66638346812aa4583c0fa714a15e99399e7dc989315cb23c115e05c25c405bf45cc337376c02003
+  metadata.gz: 030a00859186218ca81ebb9072f700f87fe77d0a7b03b0d4d7c702c5a62168848d6a9fb0153653082be93cdc55dfa903dede74062f4266d09508316107ac168d
+  data.tar.gz: df571ab4bba110d64fd267819c3eaecc6d30b02337e94433cacbdbcf8f89ddd722254bc8c9917a064494a21a3e0d23455d20830324f26077ed5379e1bbf8df0e

data/CHANGELOG.md

@@ -1,10 +1,17 @@
 
 Changelog
 =========
-## 1.2.0.pre2 05/28/2020
+
+## 1.2.2 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,7 +1,7 @@
 PATH
   remote: .
   specs:
-    sidekiq-instrumentation (1.2.0.pre2)
+    sidekiq-instrumentation (1.2.2)
       opentracing (>= 0.3.1)
 
 GEM
@@ -90,4 +90,4 @@ DEPENDENCIES
   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,36 +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],
-                          ignore_active_scope: true,
-                          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.2.0.pre2"
+    VERSION = "1.2.2"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-instrumentation
 version: !ruby/object:Gem::Version
-  version: 1.2.0.pre2
+  version: 1.2.2
 platform: ruby
 authors:
 - iaintshine
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-06-09 00:00:00.000000000 Z
+date: 2020-09-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: opentracing
@@ -204,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: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.1.2
 signing_key: