instana 1.193.5 → 1.195.3

data/lib/instana/instrumentation/aws_sdk_sns.rb

@@ -0,0 +1,29 @@
+# (c) Copyright IBM Corp. 2021
+# (c) Copyright Instana Inc. 2021
+
+module Instana
+  module Instrumentation
+    class SNS < Seahorse::Client::Plugin
+      class Handler < Seahorse::Client::Handler
+        def call(context)
+          sns_tags = {
+            topic: context.params[:topic_arn],
+            target: context.params[:target_arn],
+            phone: context.params[:phone_number],
+            subject: context.params[:subject]
+          }.compact
+
+          if context.operation_name == :publish
+            ::Instana.tracer.trace(:sns, {sns: sns_tags}) { @handler.call(context) }
+          else
+            @handler.call(context)
+          end
+        end
+      end
+
+      def add_handlers(handlers, _config)
+        handlers.add(Handler, step: :initialize)
+      end
+    end
+  end
+end

data/lib/instana/instrumentation/aws_sdk_sqs.rb

@@ -0,0 +1,98 @@
+# (c) Copyright IBM Corp. 2021
+# (c) Copyright Instana Inc. 2021
+
+module Instana
+  module Instrumentation
+    class SQS < Seahorse::Client::Plugin
+      class Handler < Seahorse::Client::Handler
+        SPAN_FORMING_OPERATIONS = [:send_message, :send_message_batch, :get_queue_url, :create_queue, :delete_message, :delete_message_batch].freeze
+
+        def call(context)
+          is_tracing = ::Instana.tracer.tracing?
+          unless is_tracing && SPAN_FORMING_OPERATIONS.include?(context.operation_name)
+            return @handler.call(context)
+          end
+
+          span_tags = tags_for(context.operation_name, context.params).compact
+
+          ::Instana.tracer.trace(:sqs, {sqs: span_tags}) do |span|
+            case context.operation_name
+            when :send_message
+              inject_instana_headers(span, context.params)
+            when :send_message_batch
+              context.params[:entries].each { |e| inject_instana_headers(span, e) }
+            end
+
+            response = @handler.call(context)
+
+            span_tags[:queue] = response.queue_url if response.respond_to?(:queue_url)
+            span.set_tags(sqs: span_tags)
+
+            response
+          end
+        end
+
+        private
+
+        def inject_instana_headers(span, params)
+          params[:message_attributes] ||= {}
+          params[:message_attributes].merge!({
+                                               "X_INSTANA_T" => {data_type: 'String', string_value: span.context.trace_id},
+                                               "X_INSTANA_S" => {data_type: 'String', string_value: span.context.span_id},
+                                               "X_INSTANA_L" => {data_type: 'String', string_value: span.context.level.to_s}
+                                             })
+        end
+
+        def tags_for(operation_name, params)
+          case operation_name
+          when :create_queue
+            {
+              sort: 'exit',
+              type: 'create.queue',
+              queue: params[:queue_name]
+            }
+          when :get_queue_url
+            {
+              sort: 'exit',
+              type: 'get.queue',
+              queue: params[:queue_name]
+            }
+          when :send_message
+            {
+              sort: 'exit',
+              type: 'single.sync',
+              queue: params[:queue_url],
+              group: params[:message_group_id]
+            }
+          when :send_message_batch
+            {
+              sort: 'exit',
+              type: 'single.sync',
+              queue: params[:queue_url],
+              size: params[:entries].count
+            }
+          when :delete_message
+            {
+              sort: 'exit',
+              type: 'delete.single.sync',
+              queue: params[:queue_url]
+            }
+          when :delete_message_batch
+            {
+              sort: 'exit',
+              type: 'delete.batch.sync',
+              queue: params[:queue_url],
+              size: params[:entries].count
+            }
+          else
+            {}
+          end
+        end
+      end
+
+      def add_handlers(handlers, _config)
+        handlers.add(Handler, step: :initialize)
+      end
+    end
+  end
+end

data/lib/instana/instrumentation/excon.rb

@@ -5,12 +5,13 @@ module Instana
   module Instrumentation
     class Excon < ::Excon::Middleware::Base
       def request_call(datum)
-        return @stack.request_call(datum) unless ::Instana.tracer.tracing?
+        return @stack.request_call(datum) unless ::Instana.tracer.tracing? && !Instana.tracer.current_span.exit_span?
 
         payload = { :http => {} }
-        path = datum[:path].split('?').first
+        path, query = datum[:path].split('?', 2)
         payload[:http][:url] = ::Instana.secrets.remove_from_query("#{datum[:connection].instance_variable_get(:@socket_key)}#{path}")
         payload[:http][:method] = datum[:method] if datum.key?(:method)
+        payload[:http][:params] = ::Instana.secrets.remove_from_query(query || '')
 
         if datum[:pipeline] == true
           # Pass the context along in the datum so we get back on response
@@ -26,11 +27,16 @@ module Instana
         datum[:headers]['X-Instana-T'] = t_context.trace_id_header
         datum[:headers]['X-Instana-S'] = t_context.span_id_header
 
+        if ::Instana.config[:w3_trace_correlation]
+          datum[:headers]['Traceparent'] = t_context.trace_parent_header
+          datum[:headers]['Tracestate'] = t_context.trace_state_header
+        end
+
         @stack.request_call(datum)
       end
 
       def error_call(datum)
-        return @stack.error_call(datum) unless ::Instana.tracer.tracing?
+        return @stack.error_call(datum) unless ::Instana.tracer.tracing? || !Instana.tracer.current_span.exit_span?
 
         if datum[:pipeline] == true
           ::Instana.tracer.log_async_error(datum[:error], datum[:instana_span])
@@ -43,7 +49,7 @@ module Instana
       def response_call(datum)
         # FIXME: Will connect exceptions call a response?
         #
-        return @stack.response_call(datum) unless ::Instana.tracer.tracing?
+        return @stack.response_call(datum) unless ::Instana.tracer.tracing? || !Instana.tracer.current_span.exit_span?
 
         result =  @stack.response_call(datum)
 

data/lib/instana/instrumentation/instrumented_request.rb

@@ -9,19 +9,24 @@ require 'rack/request'
 
 module Instana
   class InstrumentedRequest < Rack::Request
+    W3_TRACE_PARENT_FORMAT = /00-(?<trace>[0-9a-f]+)-(?<parent>[0-9a-f]+)-(?<flags>[0-9a-f]+)/.freeze
+    INSTANA_TRACE_STATE = /in=(?<trace>[0-9a-f]+);(?<span>[0-9a-f]+)/.freeze
+
     def skip_trace?
       # Honor X-Instana-L
       @env.has_key?('HTTP_X_INSTANA_L') && @env['HTTP_X_INSTANA_L'].start_with?('0')
     end
 
     def incoming_context
-      context = {}
+      context = if @env['HTTP_X_INSTANA_T']
+                  context_from_instana_headers
+                elsif @env['HTTP_TRACEPARENT'] && ::Instana.config[:w3_trace_correlation]
+                  context_from_trace_parent
+                else
+                  {}
+                end
 
-      if @env['HTTP_X_INSTANA_T']
-        context[:trace_id] = ::Instana::Util.header_to_id(@env['HTTP_X_INSTANA_T'])
-        context[:span_id] = ::Instana::Util.header_to_id(@env['HTTP_X_INSTANA_S']) if @env['HTTP_X_INSTANA_S']
-        context[:level] = @env['HTTP_X_INSTANA_L'][0] if @env['HTTP_X_INSTANA_L']
-      end
+      context[:level] = @env['HTTP_X_INSTANA_L'][0] if @env['HTTP_X_INSTANA_L']
 
       context
     end
@@ -41,12 +46,17 @@ module Instana
       headers
     end
 
+    def request_params
+      ::Instana.secrets.remove_from_query(@env['QUERY_STRING'])
+    end
+
     def request_tags
       {
         method: request_method,
         url: CGI.unescape(path_info),
         host: host_with_port,
-        header: extra_header_tags
+        header: extra_header_tags,
+        params: request_params
       }.compact
     end
 
@@ -54,8 +64,55 @@ module Instana
       @correlation_data ||= parse_correlation_data
     end
 
+    def instana_ancestor
+      @instana_ancestor ||= parse_trace_state
+    end
+
+    def continuing_from_trace_parent?
+      incoming_context.include?(:external_trace_id)
+    end
+
+    def synthetic?
+      @env.has_key?('HTTP_X_INSTANA_SYNTHETIC') && @env['HTTP_X_INSTANA_SYNTHETIC'].eql?('1')
+    end
+
     private
 
+    def context_from_instana_headers
+      {
+        trace_id: ::Instana::Util.header_to_id(@env['HTTP_X_INSTANA_T']),
+        span_id: ::Instana::Util.header_to_id(@env['HTTP_X_INSTANA_S'])
+      }.compact
+    end
+
+    def context_from_trace_parent
+      return {} unless @env.has_key?('HTTP_TRACEPARENT')
+      matches = @env['HTTP_TRACEPARENT'].match(W3_TRACE_PARENT_FORMAT)
+      return {} unless matches
+
+      {
+        external_trace_id: matches['trace'],
+        external_state: @env['HTTP_TRACESTATE'],
+        trace_id: ::Instana::Util.header_to_id(matches['trace'][16..-1]), # rubocop:disable Style/SlicingWithRange, Lint/RedundantCopDisableDirective
+        span_id: ::Instana::Util.header_to_id(matches['parent'])
+      }
+    end
+
+    def parse_trace_state
+      return {} unless @env.has_key?('HTTP_TRACESTATE')
+      token = @env['HTTP_TRACESTATE']
+        .split(/,/)
+        .map { |t| t.match(INSTANA_TRACE_STATE) }
+        .reject { |t| t.nil? }
+        .first
+      return {} unless token
+
+      {
+        t: token['trace'],
+        p: token['span']
+      }
+    end
+
     def parse_correlation_data
       return {} unless @env.has_key?('HTTP_X_INSTANA_L')
       _level, *tokens = @env['HTTP_X_INSTANA_L'].split(/[,=;]/)

data/lib/instana/instrumentation/net-http.rb

@@ -7,7 +7,7 @@ module Instana
   module Instrumentation
     module NetHTTPInstrumentation
       def request(*args, &block)
-        if !Instana.tracer.tracing? || !started?
+        if !Instana.tracer.tracing? || Instana.tracer.current_span.exit_span? || !started?
           do_skip = true
           return super(*args, &block)
         end
@@ -22,12 +22,19 @@ module Instana
         request['X-Instana-T'] = t_context.trace_id_header
         request['X-Instana-S'] = t_context.span_id_header
 
+        if ::Instana.config[:w3_trace_correlation]
+          request['Traceparent'] = t_context.trace_parent_header
+          request['Tracestate'] = t_context.trace_state_header
+        end
+
         # Collect up KV info now in case any exception is raised
         kv_payload = { :http => {} }
         kv_payload[:http][:method] = request.method
 
         if request.uri
-          kv_payload[:http][:url] = request.uri.to_s
+          uri_without_query = request.uri.dup.tap { |r| r.query = nil }
+          kv_payload[:http][:url] = uri_without_query.to_s.gsub(/\?\z/, '')
+          kv_payload[:http][:params] = ::Instana.secrets.remove_from_query(request.uri.query)
         else
           if use_ssl?
             kv_payload[:http][:url] = "https://#{@address}:#{@port}#{request.path}"
@@ -36,7 +43,7 @@ module Instana
           end
         end
 
-        kv_payload[:http][:url] = ::Instana.secrets.remove_from_query(kv_payload[:http][:url])
+        kv_payload[:http][:url] = ::Instana.secrets.remove_from_query(kv_payload[:http][:url]).gsub(/\?\z/, '')
 
         # The core call
         response = super(*args, &block)

data/lib/instana/instrumentation/rack.rb

@@ -20,14 +20,26 @@ module Instana
 
       current_span = ::Instana.tracer.log_start_or_continue(:rack, {}, req.incoming_context)
 
-      unless req.correlation_data.empty?
-        current_span[:crid] = req.correlation_data[:id]
-        current_span[:crtp] = req.correlation_data[:type]
-      end
-
       status, headers, response = @app.call(env)
 
       if ::Instana.tracer.tracing?
+        unless req.correlation_data.empty?
+          current_span[:crid] = req.correlation_data[:id]
+          current_span[:crtp] = req.correlation_data[:type]
+        end
+
+        if !req.instana_ancestor.empty? && req.continuing_from_trace_parent?
+          current_span[:ia] = req.instana_ancestor
+        end
+
+        if req.continuing_from_trace_parent?
+          current_span[:tp] = true
+          current_span[:lt] = req.incoming_context[:external_trace_id]
+        end
+
+        if req.synthetic?
+          current_span[:sy] = true
+        end
         # In case some previous middleware returned a string status, make sure that we're dealing with
         # an integer.  In Ruby nil.to_i, "asdfasdf".to_i will always return 0 from Ruby versions 1.8.7 and newer.
         # So if an 0 status is reported here, it indicates some other issue (e.g. no status from previous middleware)
@@ -45,23 +57,31 @@ module Instana
         # See: https://www.instana.com/docs/tracing/custom-best-practices/#path-templates-visual-grouping-of-http-endpoints
         kvs[:http][:path_tpl] = env['INSTANA_HTTP_PATH_TEMPLATE'] if env['INSTANA_HTTP_PATH_TEMPLATE']
 
-        # Save the IDs before the trace ends so we can place
+        # Save the span context before the trace ends so we can place
         # them in the response headers in the ensure block
-        trace_id = ::Instana.tracer.current_span.trace_id
-        span_id = ::Instana.tracer.current_span.id
+        trace_context = ::Instana.tracer.current_span.context
       end
 
       [status, headers, response]
     rescue Exception => e
-      ::Instana.tracer.log_error(e)
+      ::Instana.tracer.log_error(e) if ::Instana.tracer.tracing?
       raise
     ensure
-      if headers && ::Instana.tracer.tracing?
-        # Set reponse headers; encode as hex string
-        headers['X-Instana-T'] = ::Instana::Util.id_to_header(trace_id)
-        headers['X-Instana-S'] = ::Instana::Util.id_to_header(span_id)
-        headers['X-Instana-L'] = '1'
-        headers['Server-Timing'] = "intid;desc=#{::Instana::Util.id_to_header(trace_id)}"
+      if ::Instana.tracer.tracing?
+        if headers
+          # Set response headers; encode as hex string
+          headers['X-Instana-T'] = trace_context.trace_id_header
+          headers['X-Instana-S'] = trace_context.span_id_header
+          headers['X-Instana-L'] = '1'
+
+          if ::Instana.config[:w3_trace_correlation]
+            headers['Traceparent'] = trace_context.trace_parent_header
+            headers['Tracestate'] = trace_context.trace_state_header
+          end
+
+          headers['Server-Timing'] = "intid;desc=#{trace_context.trace_id_header}"
+        end
+
         ::Instana.tracer.log_end(:rack, kvs)
       end
     end

data/lib/instana/instrumentation/shoryuken.rb

@@ -0,0 +1,44 @@
+# (c) Copyright IBM Corp. 2021
+# (c) Copyright Instana Inc. 2021
+
+module Instana
+  module Instrumentation
+    class Shoryuken
+      def call(_worker_instance, _queue, sqs_message, _body, &block)
+        if sqs_message.is_a? Array
+          return yield
+        end
+
+        sqs_tags = {
+          sort: 'entry',
+          queue: sqs_message.queue_url
+        }
+
+        context = incomming_context_from(sqs_message.message_attributes)
+        ::Instana.tracer.start_or_continue_trace(:sqs, {sqs: sqs_tags}, context, &block)
+      end
+
+      private
+
+      def incomming_context_from(attributes)
+        trace_id = try(attributes, 'X_INSTANA_T', 'X_INSTANA_ST')
+        span_id = try(attributes, 'X_INSTANA_S', 'X_INSTANA_SS')
+        level = try(attributes, 'X_INSTANA_L', 'X_INSTANA_SL')
+
+        {
+          trace_id: trace_id,
+          span_id: span_id,
+          level: level
+        }.compact
+      end
+
+      def try(attributes, *args)
+        key = args.detect do |a|
+          attributes && attributes[a] && attributes[a].respond_to?(:string_value)
+        end
+
+        attributes[key].string_value if attributes && key
+      end
+    end
+  end
+end

data/lib/instana/instrumentation/sidekiq-client.rb

@@ -7,7 +7,7 @@ module Instana
       def call(worker_class, msg, queue, _redis_pool)
         kv_payload = { :'sidekiq-client' => {} }
         kv_payload[:'sidekiq-client'][:queue] = queue
-        kv_payload[:'sidekiq-client'][:job] = worker_class
+        kv_payload[:'sidekiq-client'][:job] = worker_class.to_s
         kv_payload[:'sidekiq-client'][:retry] = msg['retry'].to_s
         ::Instana.tracer.log_entry(:'sidekiq-client', kv_payload)
 

data/lib/instana/instrumentation/sidekiq-worker.rb

@@ -8,7 +8,7 @@ module Instana
         kv_payload = { :'sidekiq-worker' => {} }
         kv_payload[:'sidekiq-worker'][:job_id] = msg['jid']
         kv_payload[:'sidekiq-worker'][:queue] = msg['queue']
-        kv_payload[:'sidekiq-worker'][:job] = msg['class']
+        kv_payload[:'sidekiq-worker'][:job] = msg['class'].to_s
         kv_payload[:'sidekiq-worker'][:retry] = msg['retry'].to_s
 
         # Temporary until we move connection collection to redis