instana 1.193.6 → 1.195.4

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? || !Instana.tracer.current_span.exit_span?
+        return @stack.request_call(datum) unless traceable?
 
         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? || !Instana.tracer.current_span.exit_span?
+        return @stack.error_call(datum) unless traceable?
 
         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? || !Instana.tracer.current_span.exit_span?
+        return @stack.response_call(datum) unless traceable?
 
         result =  @stack.response_call(datum)
 
@@ -66,6 +72,13 @@ module Instana
         end
         result
       end
+
+      private
+
+      def traceable?
+        ::Instana.tracer.tracing? &&
+          (!Instana.tracer.current_span.exit_span? || Instana.tracer.current_span.name == :excon)
+      end
     end
   end
 end

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

@@ -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/secrets.rb

@@ -10,7 +10,7 @@ module Instana
       return str unless secret_values
 
       url = URI(str)
-      params = CGI.parse(url.query || '')
+      params = url.scheme ? CGI.parse(url.query || '') : CGI.parse(url.to_s)
 
       redacted = params.map do |k, v|
         needs_redaction = secret_values['list']
@@ -19,7 +19,7 @@ module Instana
       end
 
       url.query = URI.encode_www_form(redacted)
-      CGI.unescape(url.to_s)
+      url.scheme ? CGI.unescape(url.to_s) : CGI.unescape(url.query)
     end
 
     private

data/lib/instana/tracer.rb

@@ -38,8 +38,8 @@ module Instana
     #     :level specifies data collection level (optional)
     #
     def start_or_continue_trace(name, kvs = {}, incoming_context = nil, &block)
-      log_start_or_continue(name, kvs, incoming_context)
-      yield
+      span = log_start_or_continue(name, kvs, incoming_context)
+      yield(span)
     rescue Exception => e
       log_error(e)
       raise
@@ -59,8 +59,8 @@ module Instana
     # @param kvs [Hash] list of key values to be reported in this new span
     #
     def trace(name, kvs = {}, &block)
-      log_entry(name, kvs)
-      yield
+      span = log_entry(name, kvs)
+      yield(span)
     rescue Exception => e
       log_error(e)
       raise
@@ -91,7 +91,15 @@ module Instana
       if incoming_context
         if incoming_context.is_a?(Hash)
           if !incoming_context.empty?
-            parent_context = SpanContext.new(incoming_context[:trace_id], incoming_context[:span_id], incoming_context[:level])
+            parent_context = SpanContext.new(
+              incoming_context[:trace_id],
+              incoming_context[:span_id],
+              incoming_context[:level],
+              {
+                external_trace_id: incoming_context[:external_trace_id],
+                external_state: incoming_context[:external_state]
+              }
+            )
           end
         else
           parent_context = incoming_context
@@ -103,12 +111,7 @@ module Instana
       else
         self.current_span = Span.new(name)
       end
-      
-      if incoming_context.is_a?(Hash) && incoming_context[:correlation] && !incoming_context[:correlation].empty?
-        self.current_span[:crid] = incoming_context[:correlation][:id]
-        self.current_span[:crtp] = incoming_context[:correlation][:type]
-      end
-      
+
       self.current_span.set_tags(kvs) unless kvs.empty?
       self.current_span
     end

data/lib/instana/tracing/span.rb

@@ -6,10 +6,10 @@ module Instana
     REGISTERED_SPANS = [ :actioncontroller, :actionview, :activerecord, :excon,
                          :memcache, :'net-http', :rack, :render, :'rpc-client',
                          :'rpc-server', :'sidekiq-client', :'sidekiq-worker',
-                         :redis, :'resque-client', :'resque-worker', :'graphql.server', :dynamodb  ].freeze
-    ENTRY_SPANS = [ :rack, :'resque-worker', :'rpc-server', :'sidekiq-worker', :'graphql.server' ].freeze
+                         :redis, :'resque-client', :'resque-worker', :'graphql.server', :dynamodb, :s3, :sns, :sqs  ].freeze
+    ENTRY_SPANS = [ :rack, :'resque-worker', :'rpc-server', :'sidekiq-worker', :'graphql.server', :sqs ].freeze
     EXIT_SPANS = [ :activerecord, :excon, :'net-http', :'resque-client',
-                   :'rpc-client', :'sidekiq-client', :redis, :dynamodb ].freeze
+                   :'rpc-client', :'sidekiq-client', :redis, :dynamodb, :s3, :sns, :sqs ].freeze
     HTTP_SPANS = [ :rack, :excon, :'net-http' ].freeze
 
     attr_accessor :parent

data/lib/instana/tracing/span_context.rb

@@ -6,6 +6,7 @@ module Instana
     attr_accessor :trace_id
     attr_accessor :span_id
     attr_accessor :baggage
+    attr_reader :level
 
     # Create a new SpanContext
     #
@@ -18,7 +19,7 @@ module Instana
       @trace_id = tid
       @span_id = sid
       @level = level
-      @baggage = baggage
+      @baggage = baggage || {}
     end
 
     def trace_id_header
@@ -29,8 +30,31 @@ module Instana
       ::Instana::Util.id_to_header(@span_id)
     end
 
+    def trace_parent_header
+      return '' unless valid?
+
+      trace = (@baggage[:external_trace_id] || @trace_id).rjust(32, '0')
+      parent = @span_id.rjust(16, '0')
+      flags = @level == 1 ? "01" : "00"
+
+      "00-#{trace}-#{parent}-#{flags}"
+    end
+
+    def trace_state_header
+      return '' unless valid?
+
+      state = ["in=#{trace_id_header};#{span_id_header}", @baggage[:external_state]]
+      state.compact.join(',')
+    end
+
     def to_hash
       { :trace_id => @trace_id, :span_id => @span_id }
     end
+
+    private
+
+    def valid?
+      @baggage && @trace_id && @span_id
+    end
   end
 end

data/lib/instana/version.rb

@@ -2,6 +2,6 @@
 # (c) Copyright Instana Inc. 2016
 
 module Instana
-  VERSION = "1.193.6"
+  VERSION = "1.195.4"
   VERSION_FULL = "instana-#{VERSION}"
 end