instana 1.195.2 → 1.197.0

data/lib/instana/tracing/processor.rb

@@ -5,7 +5,7 @@ require 'thread'
 
 module Instana
   class Processor
-    def initialize
+    def initialize(logger: ::Instana.logger)
       # The main queue before being reported to the
       # host agent.  Spans in this queue are complete
       # and ready to be sent.
@@ -14,25 +14,22 @@ module Instana
       # This is the maximum number of spans we send to the host
       # agent at once.
       @batch_size = 3000
-    end
-
-    # Adds a Set of spans to the queue
-    #
-    # @param [spans] - the trace to be added to the queue
-    def add_spans(spans)
-      spans.each { |span| @queue.push(span)}
+      @logger = logger
+      @pid = $PROCESS_ID
     end
 
     # Adds a span to the span queue
     #
     # @param [Trace] - the trace to be added to the queue
     def add_span(span)
-      # Occasionally, do a checkup on our background thread.
-      if rand(10) > 8
-        if ::Instana.agent.collect_thread.nil? || !::Instana.agent.collect_thread.alive?
-          ::Instana.agent.spawn_background_thread
-        end
+      # :nocov:
+      if @pid != $PROCESS_ID
+        @logger.info("Proces `#{@pid}` has forked into #{$PROCESS_ID}. Resetting discovery.")
+        ::Instana.agent.spawn_background_thread
+        @pid = $PROCESS_ID
       end
+      # :nocov:
+
       @queue.push(span)
     end
 
@@ -46,18 +43,14 @@ module Instana
     #   - Out of control/growing queue
     #   - Prevent another run of the timer while this is running
     #
-    def send
+    def send(&block)
       return if @queue.empty? || ENV.key?('INSTANA_TEST')
 
       # Retrieve all spans for queued traces
       spans = queued_spans
 
       # Report spans in batches
-      batch = spans.shift(@batch_size)
-      while !batch.empty? do
-        ::Instana.agent.report_spans(batch)
-        batch = spans.shift(@batch_size)
-      end
+      spans.each_slice(@batch_size, &block)
     end
 
     # Retrieves all of the traces in @queue and returns
@@ -75,10 +68,9 @@ module Instana
       until @queue.empty? do
         # Non-blocking pop; ignore exception
         span = @queue.pop(true) rescue nil
-        if span
-          spans << span.raw
-        end
+        spans << span.raw if span.is_a?(Span) && span.context.level == 1
       end
+
       spans
     end
 

data/lib/instana/tracing/span.rb

@@ -20,38 +20,40 @@ module Instana
     def initialize(name, parent_ctx: nil, start_time: ::Instana::Util.now_in_ms)
       @data = {}
 
-      if parent_ctx == nil
-        # No parent specified so we're starting a new Trace - this will be the root span
-        id = ::Instana::Util.generate_id
-        @data[:t] = id                    # Trace ID
-        @data[:s] = id                    # Span ID
-        @is_root = true
-      else
-        if parent_ctx.is_a?(::Instana::Span)
-          @parent = parent_ctx
-          parent_context = parent_ctx.context
-        elsif parent_ctx.is_a?(::Instana::SpanContext)
-          parent_context = parent_ctx
-        end
+      if parent_ctx.is_a?(::Instana::Span)
+        @parent = parent_ctx
+        parent_ctx = parent_ctx.context
+      end
 
-        @data[:t] = parent_context.trace_id       # Trace ID
-        @data[:s] = ::Instana::Util.generate_id # Span ID
-        @data[:p] = parent_context.span_id        # Parent ID
+      if parent_ctx.is_a?(::Instana::SpanContext)
+        @is_root = false
 
-        if parent_context.baggage
-          @baggage = parent_ctx.baggage.dup
+        # If we have a parent trace, link to it
+        if parent_ctx.trace_id
+          @data[:t] = parent_ctx.trace_id       # Trace ID
+          @data[:p] = parent_ctx.span_id        # Parent ID
         else
-          @baggage = nil
+          @data[:t] = ::Instana::Util.generate_id
         end
 
-        @is_root = false
+        @data[:s] = ::Instana::Util.generate_id # Span ID
+
+        @baggage = parent_ctx.baggage.dup
+        @level = parent_ctx.level
+      else
+        # No parent specified so we're starting a new Trace - this will be the root span
+        @is_root = true
+        @level = 1
+
+        id = ::Instana::Util.generate_id
+        @data[:t] = id                    # Trace ID
+        @data[:s] = id                    # Span ID
       end
 
       @data[:data] = {}
 
       # Entity Source
-      @data[:f] = { :e => ::Instana.agent.report_pid,
-                    :h => ::Instana.agent.agent_uuid }
+      @data[:f] = ::Instana.agent.source
       # Start time
       if start_time.is_a?(Time)
         @data[:ts] = ::Instana::Util.time_to_ms(start_time)
@@ -59,17 +61,15 @@ module Instana
         @data[:ts] = start_time
       end
 
-      if ::Instana.config[:collect_backtraces]
-        # Attach a backtrace to all exit spans
-        add_stack if EXIT_SPANS.include?(name)
-      end
-
       # Check for custom tracing
       if REGISTERED_SPANS.include?(name.to_sym)
         @data[:n] = name.to_sym
       else
         configure_custom(name)
       end
+
+      # Attach a backtrace to all exit spans
+      add_stack if ::Instana.config[:collect_backtraces] && exit_span?
     end
 
     # Adds a backtrace to this span
@@ -195,7 +195,7 @@ module Instana
     # @return [Instana::SpanContext]
     #
     def context
-      @context ||= ::Instana::SpanContext.new(@data[:t], @data[:s], 1, @baggage)
+      @context ||= ::Instana::SpanContext.new(@data[:t], @data[:s], @level, @baggage)
     end
 
     # Retrieve the ID for this span
@@ -344,9 +344,7 @@ module Instana
           end
         end
       else
-        if !@data[:data].key?(key)
-          @data[:data][key] = value
-        elsif value.is_a?(Hash) && self[:data][key].is_a?(Hash)
+        if value.is_a?(Hash) && @data[:data][key].is_a?(Hash)
           @data[:data][key].merge!(value)
         else
           @data[:data][key] = value
@@ -381,7 +379,7 @@ module Instana
       if @context
         @context.baggage = @baggage
       else
-        @context ||= ::Instana::SpanContext.new(@data[:t], @data[:s], 1, @baggage)
+        @context ||= ::Instana::SpanContext.new(@data[:t], @data[:s], @level, @baggage)
       end
       self
     end
@@ -393,7 +391,6 @@ module Instana
     # @return Value of the baggage item
     #
     def get_baggage_item(key)
-      return nil if @baggage.nil?
       @baggage[key]
     end
 
@@ -403,7 +400,7 @@ module Instana
       if custom?
         tags = @data[:data][:sdk][:custom][:tags]
       else
-        tags = @data[:data][key]
+        tags = @data[:data]
       end
       key ? tags[key] : tags
     end

data/lib/instana/tracing/span_context.rb

@@ -18,7 +18,7 @@ module Instana
     def initialize(tid, sid, level = 1, baggage = {})
       @trace_id = tid
       @span_id = sid
-      @level = level
+      @level = Integer(level || 1)
       @baggage = baggage || {}
     end
 
@@ -31,19 +31,22 @@ module Instana
     end
 
     def trace_parent_header
-      return '' unless valid?
-
-      trace = (@baggage[:external_trace_id] || @trace_id).rjust(32, '0')
-      parent = @span_id.rjust(16, '0')
+      trace = (@baggage[:external_trace_id] || trace_id_header).rjust(32, '0')
+      parent = span_id_header.rjust(16, '0')
       flags = @level == 1 ? "01" : "00"
 
       "00-#{trace}-#{parent}-#{flags}"
     end
 
     def trace_state_header
-      return '' unless valid?
+      external_state = @baggage[:external_state] || ''
+      state = external_state.split(/,/)
+
+      if @level == 1
+        state = state.reject { |s| s.start_with?('in=') }
+        state.unshift("in=#{trace_id_header};#{span_id_header}")
+      end
 
-      state = ["in=#{trace_id_header};#{span_id_header}", @baggage[:external_state]]
       state.compact.join(',')
     end
 
@@ -51,10 +54,12 @@ module Instana
       { :trace_id => @trace_id, :span_id => @span_id }
     end
 
-    private
-
     def valid?
-      @baggage && @trace_id && @span_id
+      @baggage && @trace_id && !@trace_id.emtpy?
+    end
+
+    def active?
+      @level == 1
     end
   end
 end

data/lib/instana/util.rb

@@ -5,30 +5,6 @@ module Instana
   module Util
     class << self
       ID_RANGE = -2**63..2**63-1
-      # Debugging helper method
-      #
-      def pry!
-        # Only valid for development or test environments
-        #env = ENV['RACK_ENV'] || ENV['RAILS_ENV']
-        #return unless %w(development, test).include? env
-        require 'pry-byebug'
-
-        if defined?(PryByebug)
-          Pry.commands.alias_command 'c', 'continue'
-          Pry.commands.alias_command 's', 'step'
-          Pry.commands.alias_command 'n', 'next'
-          Pry.commands.alias_command 'f', 'finish'
-
-          Pry::Commands.command(/^$/, 'repeat last command') do
-            _pry_.run_command Pry.history.to_a.last
-          end
-        end
-
-        binding.pry
-      rescue LoadError
-        ::Instana.logger.warn("No debugger in bundle.  Couldn't load pry-byebug.")
-      end
-
       # Retrieves and returns the source code for any ruby
       # files requested by the UI via the host agent
       #
@@ -47,6 +23,7 @@ module Instana
       # Method to collect up process info for snapshots.  This
       # is generally used once per process.
       #
+      # :nocov:
       def take_snapshot
         data = {}
 
@@ -86,53 +63,12 @@ module Instana
         ::Instana.logger.debug { e.backtrace.join("\r\n") }
         return data
       end
-
-      # Used in class initialization and after a fork, this method
-      # collects up process information
-      #
-      def collect_process_info
-        process = {}
-        cmdline_file = "/proc/#{Process.pid}/cmdline"
-
-        # If there is a /proc filesystem, we read this manually so
-        # we can split on embedded null bytes.  Otherwise (e.g. OSX, Windows)
-        # use ProcTable.
-        if File.exist?(cmdline_file)
-          cmdline = IO.read(cmdline_file).split(?\x00)
-        else
-          # Attempt to support older versions of sys-proctable and ffi.
-          #
-          # Alternatively we could use Sys::ProcTable::VERSION here but the
-          # consistency across historical versions is unknown.  Alternative
-          # to the alternative, would be Ruby metaprogramming using the `arity`
-          # and `parameters` methods.
-          # e.g ProcTable.method(:ps).arity/parameters
-          if Gem.loaded_specs.key?("sys-proctable") &&
-            (Gem.loaded_specs["sys-proctable"].version >= Gem::Version.new("1.2.0"))
-            cmdline = ProcTable.ps(:pid => Process.pid).cmdline.split(' ')
-          else
-            cmdline = ProcTable.ps(Process.pid).cmdline.split(' ')
-          end
-        end
-
-        if RUBY_PLATFORM =~ /darwin/i
-          cmdline.delete_if{ |e| e.include?('=') }
-          process[:name] = cmdline.join(' ')
-        else
-          process[:name] = cmdline.shift
-          process[:arguments] = cmdline
-        end
-
-        process[:pid] = Process.pid
-        # This is usually Process.pid but in the case of containers, the host agent
-        # will return to us the true host pid in which we use to report data.
-        process[:report_pid] = nil
-        process
-      end
+      # :nocov:
 
       # Best effort to determine a name for the instrumented application
       # on the dashboard.
       #
+      # :nocov:
       def get_app_name
         if ENV.key?('INSTANA_SERVICE_NAME')
           return ENV['INSTANA_SERVICE_NAME']
@@ -169,6 +105,7 @@ module Instana
         Instana.logger.debug { e.backtrace.join("\r\n") }
         return "Ruby"
       end
+      # :nocov:
 
       # Get the current time in milliseconds from the epoch
       #
@@ -219,8 +156,10 @@ module Instana
       #
       # @return [String]
       #
-      def header_to_id(header_id)
-        header_id.is_a?(String) && header_id.match(/\A[a-z\d]{16,32}\z/i) ? header_id : ''
+      def header_to_id(given)
+        return '' unless given.is_a?(String)
+        return '' unless given.match(/\A[a-z\d]{16,32}\z/i)
+        given
       end
     end
   end

data/lib/instana/version.rb

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

data/lib/opentracing.rb

@@ -1,9 +1,32 @@
 # (c) Copyright IBM Corp. 2021
 # (c) Copyright Instana Inc. 2017
 
-require "instana/opentracing/tracer"
-require "instana/opentracing/carrier"
+require "instana/open_tracing/carrier"
+require "instana/open_tracing/instana_tracer"
+
+module OpenTracing
+  class << self
+    # Text format for #inject and #extract
+    FORMAT_TEXT_MAP = 1
+
+    # Binary format for #inject and #extract
+    FORMAT_BINARY = 2
+
+    # Ruby Specific format to handle how Rack changes environment variables.
+    FORMAT_RACK = 3
+
+    attr_accessor :global_tracer
+
+    def method_missing(method_name, *args, &block)
+      @global_tracer.send(method_name, *args, &block)
+    end
+
+    def respond_to_missing?(name, all)
+      @global_tracer.respond_to?(name, all)
+    end
+  end
+end
 
 # Set the global tracer to our OT tracer
 # which supports the OT specification
-OpenTracing.global_tracer = ::Instana.tracer
+OpenTracing.global_tracer = OpenTracing::InstanaTracer.new(::Instana.tracer)

data/test/backend/agent_test.rb

@@ -0,0 +1,54 @@
+# (c) Copyright IBM Corp. 2021
+# (c) Copyright Instana Inc. 2021
+
+require 'test_helper'
+
+class AgentTest < Minitest::Test
+  def test_host
+    subject = Instana::Backend::Agent.new
+    assert_nil subject.delegate
+    subject.setup
+    assert subject.delegate.is_a?(Instana::Backend::HostAgent)
+  end
+
+  def test_fargate
+    ENV['ECS_CONTAINER_METADATA_URI'] = 'https://10.10.10.10:9292/v3'
+    ENV['INSTANA_ENDPOINT_URL'] = 'http://example.com'
+
+    stub_request(:get, 'https://10.10.10.10:9292/v3/task')
+      .to_return(status: 200, body: File.read('test/support/ecs/task.json'))
+
+    subject = Instana::Backend::Agent.new(fargate_metadata_uri: 'https://10.10.10.10:9292/v3')
+    assert_nil subject.delegate
+    subject.setup
+    assert subject.delegate.is_a?(Instana::Backend::ServerlessAgent)
+  ensure
+    ENV['INSTANA_ENDPOINT_URL'] = nil
+    ENV['ECS_CONTAINER_METADATA_URI'] = nil
+  end
+
+  def test_fargate_error
+    ENV['ECS_CONTAINER_METADATA_URI'] = 'https://10.10.10.10:9292/v3'
+    ENV['INSTANA_ENDPOINT_URL'] = 'http://example.com'
+
+    stub_request(:get, 'https://10.10.10.10:9292/v3/task')
+      .to_return(status: 500)
+
+    subject = Instana::Backend::Agent.new(logger: Logger.new('/dev/null'))
+    assert_nil subject.delegate
+    subject.setup
+    assert subject.delegate.is_a?(Instana::Backend::ServerlessAgent)
+  ensure
+    ENV['INSTANA_ENDPOINT_URL'] = nil
+    ENV['ECS_CONTAINER_METADATA_URI'] = nil
+  end
+
+  def test_delegate_super
+    subject = Instana::Backend::Agent.new
+    assert_raises NoMethodError do
+      subject.invalid
+    end
+
+    refute subject.respond_to?(:invalid)
+  end
+end