instana 2.1.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ca8072a81b44cce54a3a2db8ef236038fa4814226c714e88f12285ea952eede4
-  data.tar.gz: 6f3b666908eb9442c1a8e6d3d1b9a332576bb818810a2c588df4de2232c1b65a
+  metadata.gz: 4a940d6791ca18a45f73ca949de0268cb4195ca269991d78683d1d89c3801919
+  data.tar.gz: c4a79bc94556b873ca0d2cb3cbe2b988914e2579d6fd124bbf4925142316dd85
 SHA512:
-  metadata.gz: 84861f4a775983202c19731ce78302bf5e7cfd677591bf9b42014be4dee8b93efd1e6606910f756bbba495584a932ac860eb76cad5cf6539202d0588c3c01592
-  data.tar.gz: ab26f124f9e087501046f56645649aed9b077ee656120d99ac1c375f44552f92345e338c1d5495c28e4a1959a7c459bf652511e13031912812a1acef003ca3f3
+  metadata.gz: f0c11ead2a6eb5e7cf4811a44b0edb6af0edbed588e712a080b5de07a704fbd28b91474e593b6342537459fe69cc0fcc60dfb83c18618e8e4ca5babea5096d6b
+  data.tar.gz: 5a22a83d6a6f930df189a914116398b372976d95f76ce86ae63b18c2f014eb4aa170a5415f5b6feb2f69b63bc9aff511d16e2d5e5bfb2682c369a0299cb5d2d3

data/lib/instana/instrumentation/instrumented_request.rb

@@ -122,6 +122,7 @@ module Instana
         long_instana_id: long_instana_id? ? sanitized_t : nil,
         external_trace_id: external_trace_id,
         external_state: @env['HTTP_TRACESTATE'],
+        external_trace_flags: context_from_trace_parent[:external_trace_flags],
         from_w3c: false
       }.reject { |_, v| v.nil? }
     end
@@ -140,6 +141,7 @@ module Instana
         external_state: @env['HTTP_TRACESTATE'],
         trace_id: trace_id,
         span_id: span_id,
+        external_trace_flags: matches['flags'],
         from_w3c: true
       }
     end

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

@@ -56,7 +56,8 @@ module Instana
           # without a backtrace (no exception)
           current_span.record_exception(nil)
         end
-
+        extra_headers = ::Instana::Util.extra_header_tags(response)&.merge(::Instana::Util.extra_header_tags(request))
+        kv_payload[:http][:header] = extra_headers unless extra_headers&.empty?
         response
       rescue => e
         current_span&.record_exception(e)

data/lib/instana/instrumentation/rack.rb

@@ -10,7 +10,7 @@ module Instana
       @app = app
     end
 
-    def call(env) # rubocop:disable Metrics/CyclomaticComplexity,Metrics/MethodLength
+    def call(env)
       req = InstrumentedRequest.new(env)
       kvs = {
         http: req.request_tags
@@ -26,75 +26,14 @@ module Instana
       @trace_token = OpenTelemetry::Context.attach(trace_ctx)
       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
-        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)
-        # See Rack Spec: https://www.rubydoc.info/github/rack/rack/file/SPEC#label-The+Status
-        kvs[:http][:status] = status.to_i
-
-        if status.to_i >= 500
-          # Because of the 5xx response, we flag this span as errored but
-          # without a backtrace (no exception)
-          ::Instana.tracer.log_error(nil)
-        end
-
-        # If the framework instrumentation provides a path template,
-        # pass it into the span here.
-        # 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 span context before the trace ends so we can place
-        # them in the response headers in the ensure block
-        trace_context = ::Instana.tracer.current_span.context
-      end
-
+      trace_context = process_span_tags(req, current_span, kvs, status, env) if ::Instana.tracer.tracing?
+      merge_response_headers(kvs, headers)
       [status, headers, response]
     rescue Exception => e
       current_span.record_exception(e) if ::Instana.tracer.tracing?
       raise
     ensure
-      if ::Instana.tracer.tracing?
-        if headers
-          # Set response headers; encode as hex string
-          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'
-
-            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
-        current_span.set_tags(kvs)
-        OpenTelemetry::Context.detach(@trace_token) if @trace_token
-        current_span.finish
-      end
+      finalize_trace(current_span, kvs, headers, trace_context) if ::Instana.tracer.tracing?
     end
 
     private
@@ -112,7 +51,8 @@ module Instana
             level: incoming_context[:level],
             baggage: {
               external_trace_id: incoming_context[:external_trace_id],
-              external_state: incoming_context[:external_state]
+              external_state: incoming_context[:external_state],
+              external_trace_flags: incoming_context[:external_trace_flags]
             }
           )
         end
@@ -121,5 +61,85 @@ module Instana
       end
       parent_context
     end
+
+    def process_span_tags(req, current_span, kvs, status, env)
+      add_correlation_data(req, current_span)
+      add_trace_parent_data(req, current_span)
+      add_status_and_error(kvs, status)
+      add_path_template(kvs, env)
+
+      # Save the span context before the trace ends so we can place
+      # them in the response headers in the ensure block
+      ::Instana.tracer.current_span.context
+    end
+
+    def add_correlation_data(req, current_span)
+      return if req.correlation_data.empty?
+
+      current_span[:crid] = req.correlation_data[:id]
+      current_span[:crtp] = req.correlation_data[:type]
+    end
+
+    def add_trace_parent_data(req, current_span)
+      if !req.instana_ancestor.empty? && req.continuing_from_trace_parent?
+        current_span[:ia] = req.instana_ancestor
+      end
+
+      current_span[:tp] = true if req.continuing_from_trace_parent?
+      current_span[:lt] = req.external_trace_id if req.external_trace_id?
+      current_span[:sy] = true if req.synthetic?
+    end
+
+    def add_status_and_error(kvs, status)
+      # 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)
+      # See Rack Spec: https://www.rubydoc.info/github/rack/rack/file/SPEC#label-The+Status
+      kvs[:http][:status] = status.to_i
+
+      return unless status.to_i >= 500
+
+      # Because of the 5xx response, we flag this span as errored but
+      # without a backtrace (no exception)
+      ::Instana.tracer.log_error(nil)
+    end
+
+    def add_path_template(kvs, env)
+      # If the framework instrumentation provides a path template,
+      # pass it into the span here.
+      # 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']
+    end
+
+    def merge_response_headers(kvs, headers)
+      extra_response_headers = ::Instana::Util.extra_header_tags(headers)
+      if kvs[:http][:header].nil?
+        kvs[:http][:header] = extra_response_headers
+      else
+        kvs[:http][:header].merge!(extra_response_headers)
+      end
+    end
+
+    def finalize_trace(current_span, kvs, headers, trace_context)
+      set_response_headers(headers, trace_context) if headers
+      current_span.set_tags(kvs)
+      OpenTelemetry::Context.detach(@trace_token) if @trace_token
+      current_span.finish
+    end
+
+    def set_response_headers(headers, trace_context)
+      # Set response headers; encode as hex string
+      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'
+        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
   end
 end

data/lib/instana/trace/span_context.rb

@@ -42,8 +42,16 @@ module Instana
     def trace_parent_header
       trace = (@baggage[:external_trace_id] || trace_id_header).rjust(32, '0')
       parent = span_id_header.rjust(16, '0')
-      flags = @level == 1 ? "01" : "00"
-
+      flags = if @baggage[:external_trace_flags]
+                # Parse external flags as 8-bit hex, clear LSB, then set LSB based on level
+                external_flags = @baggage[:external_trace_flags].to_i(16) & 0xFE # Clear LSB
+                combined_flags = external_flags | (@level == 1 ? 1 : 0) # Set LSB based on level
+                combined_flags = [combined_flags, 0xFF].min # Cap at 8-bit max
+                format('%02x', combined_flags)
+              else
+                @level == 1 ? "03" : "02"
+              end
+      flags = "03" if flags > "03"
       "00-#{trace}-#{parent}-#{flags}"
     end
 

data/lib/instana/trace/tracer.rb

@@ -307,27 +307,6 @@ module Instana
       self.current_span = nil
     end
 
-    # Creates a span that is active during the execution of the provided block.
-    # The span is automatically closed when the block completes, whether it completes
-    # normally or with an exception.
-    #
-    # @param name [String, Symbol] the name of the span to create
-    # @param attributes [Hash, nil] optional attributes to set on the span
-    # @param links [Array<Link>, nil] optional links to associate with the span
-    # @param start_timestamp [Integer, nil] optional start time for the span in milliseconds
-    # @param kind [Symbol, nil] optional span kind (e.g., :internal, :client, :server)
-    #
-    # @return [Object] the return value of the block
-    #
-    # @note This method is a wrapper around the parent class implementation and
-    #   will only create a span if the Instana agent is ready and tracing is enabled.
-    #
-    def in_span(name, attributes: nil, links: nil, start_timestamp: nil, kind: nil)
-      return if !::Instana.agent.ready? || !::Instana.config[:tracing][:enabled]
-
-      super
-    end
-
     # Starts a new span with the given parameters.
     #
     # @param name [String, Symbol] the name of the span to create (defaults to 'empty' if nil)

data/lib/instana/util.rb

@@ -181,6 +181,19 @@ module Instana
         timeout -= (timeout_timestamp - start_time)
         timeout.positive? ? timeout : 0
       end
+
+      def extra_header_tags(req_res_headers)
+        return {} if req_res_headers.nil?
+        return nil unless ::Instana.agent.extra_headers
+
+        headers = {}
+
+        ::Instana.agent.extra_headers.each do |custom_header|
+          headers[custom_header.to_sym] = req_res_headers[custom_header] if req_res_headers.key?(custom_header)
+        end
+
+        headers
+      end
     end
   end
 end

data/lib/instana/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: instana
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.2.0
 platform: ruby
 authors:
 - Peter Giacomo Lombardo