instana 1.195.1 → 1.197.0.pre2

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
@@ -23,19 +24,21 @@ module Instana
         end
 
         # Set request headers; encode IDs as hexadecimal strings
-        datum[:headers]['X-Instana-T'] = t_context.trace_id_header
-        datum[:headers]['X-Instana-S'] = t_context.span_id_header
+        datum[:headers]['X-Instana-L'] = t_context.level.to_s
 
-        if ::Instana.config[:w3_trace_correlation]
-          datum[:headers]['Traceparent'] = t_context.trace_parent_header
-          datum[:headers]['Tracestate'] = t_context.trace_state_header
+        if t_context.active?
+          datum[:headers]['X-Instana-T'] = t_context.trace_id_header
+          datum[:headers]['X-Instana-S'] = t_context.span_id_header
         end
 
+        datum[:headers]['Traceparent'] = t_context.trace_parent_header
+        datum[:headers]['Tracestate'] = t_context.trace_state_header unless t_context.trace_state_header.empty?
+
         @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])
@@ -48,7 +51,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)
 
@@ -71,6 +74,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

@@ -18,16 +18,33 @@ module Instana
     end
 
     def incoming_context
-      context = if @env['HTTP_X_INSTANA_T']
+      context = if !correlation_data.empty?
+                  {}
+                elsif @env['HTTP_X_INSTANA_T']
                   context_from_instana_headers
-                elsif @env['HTTP_TRACEPARENT'] && ::Instana.config[:w3_trace_correlation]
+                elsif @env['HTTP_TRACEPARENT']
                   context_from_trace_parent
+                elsif @env['HTTP_TRACESTATE']
+                  context_from_trace_state
                 else
                   {}
                 end
 
       context[:level] = @env['HTTP_X_INSTANA_L'][0] if @env['HTTP_X_INSTANA_L']
 
+      unless ::Instana.config[:w3_trace_correlation]
+        trace_state = parse_trace_state
+
+        if context[:from_w3] && trace_state.empty?
+          context.delete(:span_id)
+          context[:from_w3] = false
+        elsif context[:from_w3] && !trace_state.empty?
+          context[:trace_id] = trace_state[:t]
+          context[:span_id] = trace_state[:p]
+          context[:from_w3] = false
+        end
+      end
+
       context
     end
 
@@ -46,12 +63,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
 
@@ -64,19 +86,43 @@ module Instana
     end
 
     def continuing_from_trace_parent?
-      incoming_context.include?(:external_trace_id)
+      incoming_context[:from_w3]
     end
 
     def synthetic?
       @env.has_key?('HTTP_X_INSTANA_SYNTHETIC') && @env['HTTP_X_INSTANA_SYNTHETIC'].eql?('1')
     end
 
+    def long_instana_id?
+      ::Instana::Util.header_to_id(@env['HTTP_X_INSTANA_T']).length == 32
+    end
+
+    def external_trace_id?
+      continuing_from_trace_parent? || long_instana_id?
+    end
+
+    def external_trace_id
+      incoming_context[:long_instana_id] || incoming_context[:external_trace_id]
+    end
+
     private
 
     def context_from_instana_headers
+      sanitized_t = ::Instana::Util.header_to_id(@env['HTTP_X_INSTANA_T'])
+      sanitized_s = ::Instana::Util.header_to_id(@env['HTTP_X_INSTANA_S'])
+      external_trace_id = if @env['HTTP_TRACEPARENT']
+                            context_from_trace_parent[:external_trace_id]
+                          elsif long_instana_id?
+                            sanitized_t
+                          end
+
       {
-        trace_id: ::Instana::Util.header_to_id(@env['HTTP_X_INSTANA_T']),
-        span_id: ::Instana::Util.header_to_id(@env['HTTP_X_INSTANA_S'])
+        span_id: sanitized_s,
+        trace_id: long_instana_id? ? sanitized_t[16..-1] : sanitized_t, # rubocop:disable Style/SlicingWithRange, Lint/RedundantCopDisableDirective
+        long_instana_id: long_instana_id? ? sanitized_t : nil,
+        external_trace_id: external_trace_id,
+        external_state: @env['HTTP_TRACESTATE'],
+        from_w3: false
       }.compact
     end
 
@@ -85,14 +131,28 @@ module Instana
       matches = @env['HTTP_TRACEPARENT'].match(W3_TRACE_PARENT_FORMAT)
       return {} unless matches
 
+      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'])
+
       {
         external_trace_id: matches['trace'],
         external_state: @env['HTTP_TRACESTATE'],
-        trace_id: ::Instana::Util.header_to_id(matches['trace'][16..-1]),
-        span_id: ::Instana::Util.header_to_id(matches['parent'])
+        trace_id: trace_id,
+        span_id: span_id,
+        from_w3: true
       }
     end
 
+    def context_from_trace_state
+      state = parse_trace_state
+
+      {
+        trace_id: state[:t],
+        span_id: state[:p],
+        from_w3: false
+      }.compact
+    end
+
     def parse_trace_state
       return {} unless @env.has_key?('HTTP_TRACESTATE')
       token = @env['HTTP_TRACESTATE']

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

@@ -19,20 +19,24 @@ module Instana
 
         # Set request headers; encode IDs as hexadecimal strings
         t_context = ::Instana.tracer.context
-        request['X-Instana-T'] = t_context.trace_id_header
-        request['X-Instana-S'] = t_context.span_id_header
+        request['X-Instana-L'] = t_context.level.to_s
 
-        if ::Instana.config[:w3_trace_correlation]
-          request['Traceparent'] = t_context.trace_parent_header
-          request['Tracestate'] = t_context.trace_state_header
+        if t_context.active?
+          request['X-Instana-T'] = t_context.trace_id_header
+          request['X-Instana-S'] = t_context.span_id_header
         end
 
+        request['Traceparent'] = t_context.trace_parent_header
+        request['Tracestate'] = t_context.trace_state_header unless t_context.trace_state_header.empty?
+
         # 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}"
@@ -41,7 +45,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

@@ -12,7 +12,6 @@ module Instana
 
     def call(env)
       req = InstrumentedRequest.new(env)
-      return @app.call(env) if req.skip_trace?
       kvs = {
         http: req.request_tags,
         service: ENV['INSTANA_SERVICE_NAME']
@@ -34,12 +33,16 @@ module Instana
 
         if req.continuing_from_trace_parent?
           current_span[:tp] = true
-          current_span[:lt] = req.incoming_context[:external_trace_id]
+        end
+
+        if req.external_trace_id?
+          current_span[:lt] = req.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)
@@ -70,15 +73,17 @@ module Instana
       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 trace_context.active?
+            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
+          else
+            headers['X-Instana-L'] = '0'
           end
 
+          headers['Traceparent'] = trace_context.trace_parent_header
           headers['Server-Timing'] = "intid;desc=#{trace_context.trace_id_header}"
         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/logger_delegator.rb

@@ -0,0 +1,31 @@
+# (c) Copyright IBM Corp. 2021
+# (c) Copyright Instana Inc. 2021
+
+module Instana
+  class LoggerDelegator < SimpleDelegator
+    def initialize(obj)
+      obj.level = level_from_environment
+      super(obj)
+    end
+
+    private
+
+    def level_from_environment
+      # :nocov:
+      return Logger::FATAL if ENV.key?('INSTANA_TEST') || ENV.key?('RACK_TEST')
+      return Logger::DEBUG if ENV.key?('INSTANA_DEBUG')
+
+      case ENV['INSTANA_LOG_LEVEL']
+      when 'debug'
+        Logger::DEBUG
+      when 'warn'
+        Logger::WARN
+      when 'error'
+        Logger::ERROR
+      else
+        Logger::INFO
+      end
+      # :nocov:
+    end
+  end
+end

data/lib/instana/open_tracing/instana_tracer.rb

@@ -0,0 +1,99 @@
+# (c) Copyright IBM Corp. 2021
+# (c) Copyright Instana Inc. 2021
+
+require 'delegate'
+# :nocov:
+module OpenTracing
+  class InstanaTracer < SimpleDelegator
+    Span = ::Instana::Span
+
+    # Start a new span
+    #
+    # @param operation_name [String] The name of the operation represented by the span
+    # @param child_of [Span] A span to be used as the ChildOf reference
+    # @param start_time [Time] the start time of the span
+    # @param tags [Hash] Starting tags for the span
+    #
+    # @return [Span]
+    #
+    def start_span(operation_name, child_of: nil, start_time: ::Instana::Util.now_in_ms, tags: nil)
+      new_span = if child_of && (child_of.is_a?(::Instana::Span) || child_of.is_a?(::Instana::SpanContext))
+                   Span.new(operation_name, parent_ctx: child_of, start_time: start_time)
+                 else
+                   Span.new(operation_name, start_time: start_time)
+                 end
+      new_span.set_tags(tags) if tags
+      new_span
+    end
+
+    # Start a new span which is the child of the current span
+    #
+    # @param operation_name [String] The name of the operation represented by the span
+    # @param child_of [Span] A span to be used as the ChildOf reference
+    # @param start_time [Time] the start time of the span
+    # @param tags [Hash] Starting tags for the span
+    #
+    # @return [Span]
+    #
+    def start_active_span(operation_name, child_of: active_span, start_time: ::Instana::Util.now_in_ms, tags: nil)
+      ::Instana.tracer.current_span = start_span(operation_name, child_of: child_of, start_time: start_time, tags: tags)
+      block_given? ? yield(::Instana.tracer.current_span) : ::Instana.tracer.current_span
+    end
+
+    # Returns the currently active span
+    #
+    # @return [Span]
+    #
+    def active_span
+      ::Instana.tracer.current_span
+    end
+
+    # Inject a span into the given carrier
+    #
+    # @param span_context [SpanContext]
+    # @param format [OpenTracing::FORMAT_TEXT_MAP, OpenTracing::FORMAT_BINARY, OpenTracing::FORMAT_RACK]
+    # @param carrier [Carrier]
+    #
+    def inject(span_context, format, carrier)
+      case format
+      when OpenTracing::FORMAT_TEXT_MAP, OpenTracing::FORMAT_BINARY
+        ::Instana.logger.debug 'Unsupported inject format'
+      when OpenTracing::FORMAT_RACK
+        carrier['X-Instana-T'] = ::Instana::Util.id_to_header(span_context.trace_id)
+        carrier['X-Instana-S'] = ::Instana::Util.id_to_header(span_context.span_id)
+      else
+        ::Instana.logger.debug 'Unknown inject format'
+      end
+    end
+
+    # Extract a span from a carrier
+    #
+    # @param format [OpenTracing::FORMAT_TEXT_MAP, OpenTracing::FORMAT_BINARY, OpenTracing::FORMAT_RACK]
+    # @param carrier [Carrier]
+    #
+    # @return [SpanContext]
+    #
+    def extract(format, carrier)
+      case format
+      when OpenTracing::FORMAT_TEXT_MAP, OpenTracing::FORMAT_BINARY
+        ::Instana.logger.debug 'Unsupported extract format'
+      when OpenTracing::FORMAT_RACK
+        ::Instana::SpanContext.new(::Instana::Util.header_to_id(carrier['HTTP_X_INSTANA_T']),
+                                   ::Instana::Util.header_to_id(carrier['HTTP_X_INSTANA_S']))
+      else
+        ::Instana.logger.debug 'Unknown inject format'
+        nil
+      end
+    end
+
+    def method_missing(method, *args, &block)
+      ::Instana.logger.warn { "You are invoking `#{m}` on Instana::Tracer via OpenTracing." }
+      super(method, *args, &block)
+    end
+
+    def respond_to_missing?(*)
+      super(method)
+    end
+  end
+end
+# :nocov: