opentracing-instrumentation 0.1.16 → 0.1.17

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f70d5c2d46c230465ea78fc83db7690a40647f16bc22e4290838993828247cd9
-  data.tar.gz: '097e36d147eca7b17a44bcd7ba1e427fc472af82f3a276a93f92e4c9bfd3592f'
+  metadata.gz: 9ca5229070a9ceefdba01deafe855a8c506018111a073bc627f52b77e67ec07b
+  data.tar.gz: 7afb446993601e8fa9df04c0fca0537495b7125724449c6eab721a45c5e7e5cc
 SHA512:
-  metadata.gz: b77c0678115a4ef11986fb2596ea844315474b0c4301d53c33aae33d30f35b02a55658089ecd46a9b8be060681c5f5dbe7bcffeec8cffcfd360f8b2d2624ebcf
-  data.tar.gz: acf108f2e70b483cb313aa5c0b2780b765fcf9896c4c4f7a80042322bca9e7695d6045c8fbd9a84df686525141be9dcd872baae55e540557cdf4650006a6f1ad
+  metadata.gz: 2ff9411175de0c6b489c05da90e068cc85c4ba177f17bea72658b51ec6258935fdc0b264e4577d64a0ecfc04cb670085ea438c0ff04485f4e97bd3de9008d902
+  data.tar.gz: 1058ed6b1b347a9a596a8e76e14a3822b51cf6b0911fe05f03933dee533db10cd3fd138f3d659523ee907c5cf8b394ef1251bb1332a6705ad306c3e50e3fb297

data/GEM_VERSION

@@ -1 +1 @@
-0.1.16
+0.1.17

data/Gemfile.lock

@@ -18,7 +18,7 @@ GIT
 PATH
   remote: .
   specs:
-    opentracing-instrumentation (0.1.16)
+    opentracing-instrumentation (0.1.17)
       json
       opentracing (~> 0.5.0)
 

data/lib/opentracing/instrumentation/common.rb

@@ -8,6 +8,8 @@ module OpenTracing
     module Common
       autoload :ErrorWriter,
                'opentracing/instrumentation/common/error_writer'
+      autoload :OperationNameBuilder,
+               'opentracing/instrumentation/common/operation_name_builder'
     end
   end
 end

data/lib/opentracing/instrumentation/common/operation_name_builder.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module OpenTracing
+  module Instrumentation
+    module Common
+      # Build operation name by template and tags
+      class OperationNameBuilder
+        def initialize(operation_name_template:)
+          @operation_name_template = operation_name_template
+        end
+
+        # build operation name with tags
+        def build(tags)
+          format(operation_name_template, **tags)
+        end
+
+        private
+
+        attr_reader :operation_name_template
+      end
+    end
+  end
+end

data/lib/opentracing/instrumentation/sidekiq/client_middleware.rb

@@ -7,41 +7,68 @@ module OpenTracing
       class ClientMiddleware
         extend Forwardable
 
-        DEFAULT_SPAN_NAME = 'sidekiq_enqueue'
         DEFAULT_SPAN_KIND = 'producer'
 
+        DEFAULT_OPERATION_NAME_TEMPLATE = \
+          'sidekiq_enqueue(%<sidekiq.class>s)'
+        DEFAULT_OPERATION_NAME_BUILDER = \
+          Common::OperationNameBuilder.new(
+            operation_name_template: DEFAULT_OPERATION_NAME_TEMPLATE,
+          )
+
         attr_reader :tracer
         attr_reader :tagger
         attr_reader :error_writter
+        attr_reader :logger
         attr_reader :span_kind
-        attr_reader :span_name
+        attr_reader :operation_name_builder
 
+        # rubocop:disable Metrics/ParameterLists
         def initialize(
           tracer: OpenTracing.global_tracer,
           tagger: JobTagger.new,
           error_writter: Common::ErrorWriter.new,
+          logger: nil,
           span_kind: DEFAULT_SPAN_KIND,
-          span_name: DEFAULT_SPAN_NAME
+          operation_name_builder: DEFAULT_OPERATION_NAME_BUILDER
         )
           @tracer = tracer
           @tagger = tagger
           @error_writter = error_writter
+          @logger = logger
           @span_kind = span_kind
-          @span_name = span_name
+          @operation_name_builder = operation_name_builder
         end
+        # rubocop:enable Metrics/ParameterLists
 
         def call(_worker_class, job, _queue, _redis_pool)
-          scope = tracer.start_active_span(span_name, **build_span_args(job))
+          scope = safe_start_scope(job)
           inject(scope.span.context, job)
           log(scope.span, job) do
             yield
           end
         ensure
-          scope.close
+          safe_close_scope(scope)
         end
 
         private
 
+        def safe_start_scope(job)
+          tags = build_tags(job)
+          operation_name = operation_name_builder.build(tags)
+          tracer.start_active_span(operation_name, tags: tags)
+        rescue StandardError => e
+          logger&.error(e)
+        end
+
+        def safe_close_scope(scope)
+          return unless scope
+
+          scope.close
+        rescue StandardError => e
+          logger&.error(e)
+        end
+
         def log(span, job)
           tagger.write_args_log(span, job['jid'], job['args'])
 
@@ -51,10 +78,8 @@ module OpenTracing
           raise
         end
 
-        def build_span_args(job)
-          {
-            tags: tagger.build_tags(job, span_kind),
-          }
+        def build_tags(job)
+          tagger.build_tags(job, span_kind)
         end
 
         def inject(span_context, carrier)

data/lib/opentracing/instrumentation/sidekiq/job_tagger.rb

@@ -30,11 +30,11 @@ module OpenTracing
         # build tags from job data and static attributes
         def build_tags(job, span_kind)
           {
-            'component' => component,
-            'span.kind' => span_kind,
-            'sidekiq.queue' => job['queue'],
-            'sidekiq.class' => job['class'],
-            'sidekiq.retry' => job['retry'],
+            component: component,
+            'span.kind': span_kind,
+            'sidekiq.queue': job['queue'],
+            'sidekiq.class': job['class'],
+            'sidekiq.retry': job['retry'],
           }
         end
 

data/lib/opentracing/instrumentation/sidekiq/server_middleware.rb

@@ -9,41 +9,68 @@ module OpenTracing
       class ServerMiddleware
         extend Forwardable
 
-        DEFAULT_SPAN_NAME = 'sidekiq_perform'
         DEFAULT_SPAN_KIND = 'consumer'
 
+        DEFAULT_OPERATION_NAME_TEMPLATE = \
+          'sidekiq_perform(%<sidekiq.class>s)'
+        DEFAULT_OPERATION_NAME_BUILDER = \
+          Common::OperationNameBuilder.new(
+            operation_name_template: DEFAULT_OPERATION_NAME_TEMPLATE,
+          )
+
         attr_reader :tracer
         attr_reader :tagger
         attr_reader :error_writter
+        attr_reader :logger
         attr_reader :span_kind
-        attr_reader :span_name
+        attr_reader :operation_name_builder
 
+        # rubocop:disable Metrics/ParameterLists
         def initialize(
           tracer: OpenTracing.global_tracer,
           tagger: JobTagger.new,
           error_writter: Common::ErrorWriter.new,
+          logger: nil,
           span_kind: DEFAULT_SPAN_KIND,
-          span_name: DEFAULT_SPAN_NAME
+          operation_name_builder: DEFAULT_OPERATION_NAME_BUILDER
         )
           @tracer = tracer
           @tagger = tagger
           @error_writter = error_writter
+          @logger = logger
           @span_kind = span_kind
-          @span_name = span_name
+          @operation_name_builder = operation_name_builder
         end
+        # rubocop:enable Metrics/ParameterLists
 
         def call(_worker, job, _queue)
-          scope = tracer.start_active_span(span_name, **build_span_args(job))
+          scope = safe_start_scope(job)
 
           log(scope.span, job) do
             yield
           end
         ensure
-          scope.close
+          scope&.close
         end
 
         private
 
+        def safe_start_scope(job)
+          tags =  tagger.build_tags(job, span_kind)
+          operation_name = operation_name_builder.build(tags)
+          tracer.start_active_span(operation_name, tags: tags, **build_span_args(job))
+        rescue StandardError => e
+          logger&.error(e)
+        end
+
+        def safe_close_scope(scope)
+          return unless socpe
+
+          scope.close
+        rescue StandardError => e
+          logger&.error(e)
+        end
+
         def log(span, job)
           tagger.write_args_log(span, job['jid'], job['args'])
 
@@ -56,7 +83,6 @@ module OpenTracing
         def build_span_args(job)
           {
             references: extract_references(job),
-            tags: tagger.build_tags(job, span_kind),
           }
         end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opentracing-instrumentation
 version: !ruby/object:Gem::Version
-  version: 0.1.16
+  version: 0.1.17
 platform: ruby
 authors:
 - Fedorenko Dmitrij
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-04-06 00:00:00.000000000 Z
+date: 2020-04-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -284,6 +284,7 @@ files:
 - lib/opentracing/instrumentation/bunny/regexp_routing_key_sanitazer.rb
 - lib/opentracing/instrumentation/common.rb
 - lib/opentracing/instrumentation/common/error_writer.rb
+- lib/opentracing/instrumentation/common/operation_name_builder.rb
 - lib/opentracing/instrumentation/faraday.rb
 - lib/opentracing/instrumentation/faraday/response_logger.rb
 - lib/opentracing/instrumentation/faraday/trace_middleware.rb