instana 1.11.6 → 1.209.2

data/lib/instana/util.rb

@@ -1,71 +1,10 @@
+# (c) Copyright IBM Corp. 2021
+# (c) Copyright Instana Inc. 2016
+
 module Instana
   module Util
     class << self
       ID_RANGE = -2**63..2**63-1
-
-      # An agnostic approach to method aliasing.
-      #
-      # @param klass [Object] The class or module that holds the method to be alias'd.
-      # @param method [Symbol] The name of the method to be aliased.
-      #
-      def method_alias(klass, method)
-        if klass.method_defined?(method.to_sym) ||
-            klass.private_method_defined?(method.to_sym)
-
-          with = "#{method}_with_instana"
-          without = "#{method}_without_instana"
-
-          klass.class_eval do
-            alias_method without, method.to_s
-            alias_method method.to_s, with
-          end
-        else
-          ::Instana.logger.debug "No such method (#{method}) to alias on #{klass}"
-        end
-      end
-
-      # Calls on target_class to 'extend' cls
-      #
-      # @param target_cls [Object] the class/module to do the 'extending'
-      # @param cls [Object] the class/module to be 'extended'
-      #
-      def send_extend(target_cls, cls)
-        target_cls.send(:extend, cls) if defined?(target_cls)
-      end
-
-      # Calls on <target_cls> to include <cls> into itself.
-      #
-      # @param target_cls [Object] the class/module to do the 'including'
-      # @param cls [Object] the class/module to be 'included'
-      #
-      def send_include(target_cls, cls)
-        target_cls.send(:include, cls) if defined?(target_cls)
-      end
-
-      # 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
       #
@@ -84,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 = {}
 
@@ -123,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']
@@ -206,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
       #
@@ -225,53 +125,41 @@ module Instana
         (time.to_f * 1000).floor
       end
 
-      # Generate a random 64bit ID
+      # Generate a random 64bit/128bit ID
+      #
+      # @param size [Integer] Number of 64 bit integers used to generate the id
       #
-      # @return [Integer] a random 64bit integer
+      # @return [String] a random 64bit/128bit hex encoded string
       #
-      def generate_id
-        # Max value is 9223372036854775807 (signed long in Java)
-        rand(ID_RANGE)
+      def generate_id(size = 1)
+        Array.new(size) { rand(ID_RANGE) }
+          .pack('q>*')
+          .unpack('H*')
+          .first
       end
 
       # Convert an ID to a value appropriate to pass in a header.
       #
-      # @param id [Integer] the id to be converted
+      # @param id [String] the id to be converted
       #
       # @return [String]
       #
       def id_to_header(id)
-        unless id.is_a?(Integer) || id.is_a?(String)
-          Instana.logger.debug "id_to_header received a #{id.class}: returning empty string"
-          return String.new
-        end
-        [id.to_i].pack('q>').unpack('H*')[0].gsub(/^0+/, '')
-      rescue => e
-        Instana.logger.info "#{__method__}:#{File.basename(__FILE__)}:#{__LINE__}: #{e.message}"
-        Instana.logger.debug { e.backtrace.join("\r\n") }
+        return '' unless id.is_a?(String)
+        # Only send 64bit IDs downstream for now
+        id.length == 32 ? id[16..-1] : id
       end
 
       # Convert a received header value into a valid ID
       #
       # @param header_id [String] the header value to be converted
       #
-      # @return [Integer]
+      # @return [String]
       #
-      def header_to_id(header_id)
-        if !header_id.is_a?(String)
-          Instana.logger.debug "header_to_id received a #{header_id.class}: returning 0"
-          return 0
-        end
-        if header_id.length < 16
-          # The header is less than 16 chars.  Prepend
-          # zeros so we can convert correctly
-          missing = 16 - header_id.length
-          header_id = ("0" * missing) + header_id
-        end
-        [header_id].pack("H*").unpack("q>")[0]
-      rescue => e
-        Instana.logger.info "#{__method__}:#{File.basename(__FILE__)}:#{__LINE__}: #{e.message}"
-        Instana.logger.debug { e.backtrace.join("\r\n") }
+      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

@@ -1,4 +1,7 @@
+# (c) Copyright IBM Corp. 2021
+# (c) Copyright Instana Inc. 2016
+
 module Instana
-  VERSION = "1.11.6"
+  VERSION = "1.209.2"
   VERSION_FULL = "instana-#{VERSION}"
 end

data/lib/instana.rb

@@ -1,4 +1,7 @@
-require "instana/setup"
+# (c) Copyright IBM Corp. 2021
+# (c) Copyright Instana Inc. 2016
+
+require 'instana/setup'
 
 # Boot the instana agent background thread.  If you wish to have greater
 # control on the where and which thread this is run in, instead use
@@ -9,4 +12,11 @@ require "instana/setup"
 # the thread of your choice.
 #
 
-::Instana.agent.spawn_background_thread
+# :nocov:
+unless ENV.fetch('INSTANA_DISABLE', false)
+  ::Instana::Activator.start
+  ::Instana.agent.spawn_background_thread
+
+  ::Instana.logger.info "Stan is on the scene.  Starting Instana instrumentation version #{::Instana::VERSION}"
+end
+# :nocov:

data/lib/opentracing.rb

@@ -1,6 +1,32 @@
-require "instana/opentracing/tracer"
-require "instana/opentracing/carrier"
+# (c) Copyright IBM Corp. 2021
+# (c) Copyright Instana Inc. 2017
+
+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/sonar-project.properties

@@ -0,0 +1,9 @@
+sonar.projectKey=ruby-sensor
+sonar.sources=lib
+sonar.tests=test
+sonar.exclusions=_junit/*
+sonar.ruby.coverage.reportPaths=coverage/coverage.json
+sonar.links.homepage=https://github.com/instana/ruby-sensor/
+sonar.links.ci=https://circleci.com/gh/instana/ruby-sensor
+sonar.links.issue=https://github.com/instana/ruby-sensor/issues
+sonar.links.scm=https://github.com/instana/ruby-sensor/

data/test/activator_test.rb

@@ -0,0 +1,30 @@
+# (c) Copyright IBM Corp. 2021
+# (c) Copyright Instana Inc. 2021
+
+require 'test_helper'
+
+class ActivatorTest < Minitest::Test
+  def test_start
+    refute_nil Instana::Activator.trace_point
+    assert Instana::Activator.trace_point.enabled?
+  end
+
+  def test_klass_call
+    assert_equal [], Instana::Activator.call
+  end
+
+  def test_instance_call
+    subject = Class.new(Instana::Activator) do
+      def can_instrument?
+        true
+      end
+
+      def instrument
+        true
+      end
+    end
+
+    assert_equal 1, Instana::Activator.call.length
+    assert subject.call
+  end
+end

data/test/backend/agent_test.rb

@@ -0,0 +1,80 @@
+# (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_lambda
+    ENV['_HANDLER'] = 'TEST_FUNCTION'
+    ENV['INSTANA_ENDPOINT_URL'] = 'http://example.com'
+
+    subject = Instana::Backend::Agent.new
+    assert_nil subject.delegate
+    subject.setup
+    assert subject.delegate.is_a?(Instana::Backend::ServerlessAgent)
+  ensure
+    ENV['_HANDLER'] = nil
+    ENV['INSTANA_ENDPOINT_URL'] = nil
+  end
+
+  def test_google_cloud
+    ENV['K_REVISION'] = 'TEST'
+    ENV['INSTANA_ENDPOINT_URL'] = 'http://example.com'
+
+    subject = Instana::Backend::Agent.new
+    assert_nil subject.delegate
+    subject.setup
+    assert subject.delegate.is_a?(Instana::Backend::ServerlessAgent)
+  ensure
+    ENV['K_REVISION'] = nil
+    ENV['INSTANA_ENDPOINT_URL'] = 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

data/test/backend/gc_snapshot_test.rb

@@ -0,0 +1,11 @@
+# (c) Copyright IBM Corp. 2021
+# (c) Copyright Instana Inc. 2021
+
+require 'test_helper'
+
+class GcSnapshotTest < Minitest::Test
+  def test_report
+    subject = Instana::Backend::GCSnapshot.instance
+    assert subject.report.is_a?(Hash)
+  end
+end

data/test/backend/host_agent_activation_observer_test.rb

@@ -0,0 +1,73 @@
+# (c) Copyright IBM Corp. 2021
+# (c) Copyright Instana Inc. 2021
+
+require 'test_helper'
+
+class HostAgentActivationObserverTest < Minitest::Test
+  def setup
+    @socket_proc = ->(_c) { OpenStruct.new(fileno: 0) }
+  end
+
+  def test_standard_discovery
+    stub_request(:put, "http://10.10.10.10:9292/com.instana.plugin.ruby.discovery")
+      .and_timeout
+      .and_return(status: 500, body: '{"ok": false}')
+      .and_return(status: 200, body: '[{"pid": 1234}]')
+      .and_return(status: 200, body: '{"pid": 1234}')
+
+    stub_request(:head, "http://10.10.10.10:9292/com.instana.plugin.ruby.1234")
+      .and_return(status: 500, body: '{"ok": false}')
+      .and_return(status: 200, body: '{"ok": true}')
+
+    client = Instana::Backend::RequestClient.new('10.10.10.10', 9292)
+    discovery = Concurrent::Atom.new(nil)
+
+    subject = Instana::Backend::HostAgentActivationObserver.new(client, discovery, wait_time: 0, logger: Logger.new('/dev/null'), max_wait_tries: 1, socket_proc: @socket_proc)
+
+    subject.update(nil, nil, nil)
+    assert_equal({'pid' => 1234}, discovery.value)
+  end
+
+  def test_linux_discovery
+    stub_request(:put, "http://10.10.10.10:9292/com.instana.plugin.ruby.discovery")
+      .and_return(status: 200, body: '{"pid": 1234}')
+
+    stub_request(:head, "http://10.10.10.10:9292/com.instana.plugin.ruby.1234")
+      .and_return(status: 200, body: '{"ok": true}')
+
+    client = Instana::Backend::RequestClient.new('10.10.10.10', 9292)
+    discovery = Concurrent::Atom.new(nil)
+
+    subject = Instana::Backend::HostAgentActivationObserver.new(client, discovery, wait_time: 0, logger: Logger.new('/dev/null'), max_wait_tries: 1, socket_proc: @socket_proc)
+
+    FakeFS.with_fresh do
+      FakeFS::FileSystem.clone('test/support/proc', '/proc')
+      FakeFS::FileSystem.clone('test/support/proc/0', "/proc/#{Process.pid}")
+      Dir.mkdir('/proc/self/fd')
+      File.symlink('/proc/self/sched', "/proc/self/fd/0")
+
+      subject.update(nil, nil, nil)
+    end
+
+    assert_equal({'pid' => 1234}, discovery.value)
+  end
+
+  def test_discovery_standard_error
+    client = Instana::Backend::RequestClient.new('10.10.10.10', 9292)
+    discovery = Concurrent::Atom.new(nil)
+
+    subject = Instana::Backend::HostAgentActivationObserver.new(client, discovery, wait_time: 0, logger: Logger.new('/dev/null'), proc_table: nil, socket_proc: @socket_proc)
+
+    subject.update(nil, nil, nil)
+    assert_nil discovery.value
+  end
+
+  def test_value_present
+    client = Instana::Backend::RequestClient.new('10.10.10.10', 9292)
+    discovery = Concurrent::Atom.new(nil)
+
+    subject = Instana::Backend::HostAgentActivationObserver.new(client, discovery, socket_proc: @socket_proc)
+    assert_nil subject.update(nil, nil, true)
+    assert_nil discovery.value
+  end
+end

data/test/backend/host_agent_lookup_test.rb

@@ -0,0 +1,78 @@
+# (c) Copyright IBM Corp. 2021
+# (c) Copyright Instana Inc. 2021
+
+require 'test_helper'
+
+class HostAgentLookupTest < Minitest::Test
+  def test_lookup
+    stub_request(:get, "http://10.10.10.10:42699/")
+      .to_return(status: 200)
+
+    subject = Instana::Backend::HostAgentLookup.new('10.10.10.10', 42699)
+    client = subject.call
+
+    assert client
+    assert client.send_request('GET', '/').ok?
+  end
+
+  def test_lookup_no_agent
+    stub_request(:get, "http://10.10.10.10:42699/")
+      .to_timeout
+
+    subject = Instana::Backend::HostAgentLookup.new('10.10.10.10', 42699)
+
+    client = FakeFS.with_fresh do
+      FakeFS::FileSystem.clone('test/support/ecs', '/proc')
+
+      subject.call
+    end
+
+    assert_nil client
+  end
+
+  def test_lookup_agent_error
+    stub_request(:get, "http://10.10.10.10:42699/")
+      .to_return(status: 500)
+
+    subject = Instana::Backend::HostAgentLookup.new('10.10.10.10', 42699)
+
+    client = FakeFS.with_fresh do
+      FakeFS::FileSystem.clone('test/support/ecs', '/proc')
+
+      subject.call
+    end
+
+    assert_nil client
+  end
+
+  def test_lookup_with_gateway
+    stub_request(:get, "http://10.10.10.10:42699/")
+      .to_timeout
+    stub_request(:get, "http://172.18.0.1:42699/")
+      .to_return(status: 200)
+
+    subject = Instana::Backend::HostAgentLookup.new('10.10.10.10', 42699)
+
+    client = FakeFS do
+      FakeFS::FileSystem.clone('test/support/proc', '/proc')
+      subject.call
+    end
+
+    assert client
+    assert client.send_request('GET', '/').ok?
+  end
+
+  def test_lookup_with_gateway_no_destination
+    stub_request(:get, "http://10.10.10.10:42699/")
+      .to_timeout
+
+    subject = Instana::Backend::HostAgentLookup.new('10.10.10.10', 42699, destination: '11111111')
+
+    client = FakeFS do
+      FakeFS::FileSystem.clone('test/support/proc', '/proc')
+      subject.call
+    end
+
+    assert_nil client
+  end
+end