instana 1.10.1-java

data/lib/instana/tracing/span_context.rb

@@ -0,0 +1,33 @@
+module Instana
+  class SpanContext
+    attr_accessor :trace_id
+    attr_accessor :span_id
+    attr_accessor :baggage
+
+    # Create a new SpanContext
+    #
+    # @param tid [Integer] the trace ID
+    # @param sid [Integer] the span ID
+    # @param level [Integer] default 1
+    # @param baggage [Hash] baggage applied to this trace
+    #
+    def initialize(tid, sid, level = 1, baggage = nil)
+      @trace_id = tid
+      @span_id = sid
+      @level = level
+      @baggage = baggage
+    end
+
+    def trace_id_header
+      ::Instana::Util.id_to_header(@trace_id)
+    end
+
+    def span_id_header
+      ::Instana::Util.id_to_header(@span_id)
+    end
+
+    def to_hash
+      { :trace_id => @trace_id, :span_id => @span_id }
+    end
+  end
+end

data/lib/instana/util.rb

@@ -0,0 +1,261 @@
+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
+      #
+      # @param file [String] The fully qualified path to a file
+      #
+      def get_rb_source(file)
+        if (file =~ /.rb$/).nil?
+          { :error => "Only Ruby source files are allowed. (*.rb)" }
+        else
+          { :data => File.read(file) }
+        end
+      rescue => e
+        return { :error => e.inspect }
+      end
+
+      # Method to collect up process info for snapshots.  This
+      # is generally used once per process.
+      #
+      def take_snapshot
+        data = {}
+
+        data[:sensorVersion] = ::Instana::VERSION
+        data[:ruby_version] = RUBY_VERSION
+        data[:rpl] = RUBY_PATCHLEVEL if defined?(RUBY_PATCHLEVEL)
+
+        # Framework Detection
+        if defined?(::RailsLts::VERSION)
+          data[:framework] = "Rails on Rails LTS-#{::RailsLts::VERSION}"
+
+        elsif defined?(::Rails.version)
+          data[:framework] = "Ruby on Rails #{::Rails.version}"
+
+        elsif defined?(::Grape::VERSION)
+          data[:framework] = "Grape #{::Grape::VERSION}"
+
+        elsif defined?(::Padrino::VERSION)
+          data[:framework] = "Padrino #{::Padrino::VERSION}"
+
+        elsif defined?(::Sinatra::VERSION)
+          data[:framework] = "Sinatra #{::Sinatra::VERSION}"
+        end
+
+        # Report Bundle
+        if defined?(::Gem) && Gem.respond_to?(:loaded_specs)
+          data[:versions] = {}
+
+          Gem.loaded_specs.each do |k, v|
+            data[:versions][k] = v.version.to_s
+          end
+        end
+
+        data
+      rescue => e
+        ::Instana.logger.debug { "#{__method__}:#{File.basename(__FILE__)}:#{__LINE__}: #{e.message}" }
+        ::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
+
+      # Best effort to determine a name for the instrumented application
+      # on the dashboard.
+      #
+      def get_app_name
+        if ENV.key?('INSTANA_SERVICE_NAME')
+          return ENV['INSTANA_SERVICE_NAME']
+        end
+
+
+        if defined?(::Resque) && ($0 =~ /resque-#{Resque::Version}/)
+          return "Resque Worker"
+        end
+
+        if defined?(::RailsLts) || defined?(::Rails)
+          return Rails.application.class.to_s.split('::')[0]
+        end
+
+        return File.basename($0)
+      rescue Exception => e
+        Instana.logger.info "#{__method__}:#{File.basename(__FILE__)}:#{__LINE__}: #{e.message}"
+        Instana.logger.debug { e.backtrace.join("\r\n") }
+      end
+
+      # Get the current time in milliseconds from the epoch
+      #
+      # @return [Integer] the current time in milliseconds
+      #
+      def now_in_ms
+        Process.clock_gettime(Process::CLOCK_REALTIME, :millisecond)
+      end
+      # Prior method name support.  To be deprecated when appropriate.
+      alias ts_now now_in_ms
+
+      # Convert a Time value to milliseconds
+      #
+      # @param time [Time]
+      #
+      def time_to_ms(time)
+        (time.to_f * 1000).floor
+      end
+
+      # Generate a random 64bit ID
+      #
+      # @return [Integer] a random 64bit integer
+      #
+      def generate_id
+        # Max value is 9223372036854775807 (signed long in Java)
+        rand(ID_RANGE)
+      end
+
+      # Convert an ID to a value appropriate to pass in a header.
+      #
+      # @param id [Integer] 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") }
+      end
+
+      # Convert a received header value into a valid ID
+      #
+      # @param header_id [String] the header value to be converted
+      #
+      # @return [Integer]
+      #
+      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") }
+      end
+    end
+  end
+end

data/lib/instana/version.rb

@@ -0,0 +1,4 @@
+module Instana
+  VERSION = "1.10.1"
+  VERSION_FULL = "instana-#{VERSION}"
+end

data/lib/oj_check.rb

@@ -0,0 +1,16 @@
+begin
+  require 'oj'
+rescue LoadError => e
+  # OJ is not available in JRuby
+  module Instana
+    class Oj
+      def self.dump(*args)
+        args.first.to_json
+      end
+
+      def self.load(*args)
+        JSON.parse args.first
+      end
+    end
+  end
+end

data/lib/opentracing.rb

@@ -0,0 +1,6 @@
+require "instana/opentracing/tracer"
+require "instana/opentracing/carrier"
+
+# Set the global tracer to our OT tracer
+# which supports the OT specification
+OpenTracing.global_tracer = ::Instana.tracer

data/test/agent/agent_test.rb

@@ -0,0 +1,143 @@
+require 'test_helper'
+require './lib/oj_check'
+
+class AgentTest < Minitest::Test
+
+  Oj = ::Instana::Oj unless defined?(Oj)
+
+  def test_agent_host_detection
+    url = "http://#{::Instana.config[:agent_host]}:#{::Instana.config[:agent_port]}/"
+    stub_request(:get, url)
+    assert_equal true, ::Instana.agent.host_agent_available?
+  end
+
+  def test_successful_discovery
+    url = "http://#{::Instana.config[:agent_host]}:#{::Instana.config[:agent_port]}/"
+    docker_url = "http://#{::Instana.agent.instance_variable_get(:@default_gateway)}:#{::Instana.config[:agent_port]}/"
+    stub_request(:get, url)
+    stub_request(:get, docker_url)
+    discovered = ::Instana.agent.run_discovery
+
+    assert discovered.is_a?(Hash)
+    assert_equal "127.0.0.1", discovered[:agent_host]
+    assert_equal 42699, discovered[:agent_port]
+  end
+
+  def test_failed_discovery
+    url = "http://#{::Instana.config[:agent_host]}:#{::Instana.config[:agent_port]}/"
+    docker_url = "http://#{::Instana.agent.instance_variable_get(:@default_gateway)}:#{::Instana.config[:agent_port]}/"
+    stub_request(:get, url).to_raise(Errno::ECONNREFUSED)
+    stub_request(:get, docker_url).to_raise(Errno::ECONNREFUSED)
+    discovered = ::Instana.agent.run_discovery
+
+    assert_equal nil, discovered
+  end
+
+  def test_custom_configure_agent
+    original_host = ::Instana.config[:agent_host]
+    original_port = ::Instana.config[:agent_port]
+
+    # Set custom agent/port
+    ::Instana.config[:agent_host] = '172.0.12.100'
+    ::Instana.config[:agent_port] = 12829
+
+    url = "http://#{::Instana.config[:agent_host]}:#{::Instana.config[:agent_port]}/"
+    stub_request(:get, url)
+    discovered = ::Instana.agent.run_discovery
+
+    assert discovered.is_a?(Hash)
+    assert_equal "172.0.12.100", discovered[:agent_host]
+    assert_equal 12829, discovered[:agent_port]
+
+    ::Instana.config[:agent_host] = original_host
+    ::Instana.config[:agent_port] = original_port
+  end
+
+  def test_no_host_agent
+    localhost_url = "http://#{::Instana::Agent::LOCALHOST}:#{::Instana.config[:agent_port]}/"
+    stub_request(:get, localhost_url).to_raise(Errno::ECONNREFUSED)
+    docker_url = "http://#{::Instana.agent.instance_variable_get(:@default_gateway)}:#{::Instana.config[:agent_port]}/"
+    stub_request(:get, docker_url).to_timeout
+    assert_equal false, ::Instana.agent.host_agent_available?
+  end
+
+  def test_announce_sensor
+    # Fake discovery values
+    discovery = {}
+    discovery[:agent_host] = ::Instana.config[:agent_host]
+    discovery[:agent_port] = ::Instana.config[:agent_port]
+    ::Instana.agent.instance_variable_set(:@discovered, discovery)
+
+    url = "http://#{::Instana.config[:agent_host]}:#{::Instana.config[:agent_port]}/com.instana.plugin.ruby.discovery"
+    json = Oj.dump({ 'pid' => Process.pid, 'agentUuid' => 'abc' })
+    stub_request(:put, url).to_return(:body => json, :status => 200)
+
+    assert_equal true, ::Instana.agent.announce_sensor
+  end
+
+  def test_failed_announce_sensor
+    # Fake discovery values
+    discovery = {}
+    discovery[:agent_host] = ::Instana.config[:agent_host]
+    discovery[:agent_port] = ::Instana.config[:agent_port]
+    ::Instana.agent.instance_variable_set(:@discovered, discovery)
+
+    url = "http://#{::Instana.config[:agent_host]}:#{::Instana.config[:agent_port]}/com.instana.plugin.ruby.discovery"
+    stub_request(:put, url).to_raise(Errno::ECONNREFUSED)
+
+    assert_equal false, ::Instana.agent.announce_sensor
+  end
+
+  def test_metric_report
+    # Fake discovery values
+    discovery = {}
+    discovery[:agent_host] = ::Instana.config[:agent_host]
+    discovery[:agent_port] = ::Instana.config[:agent_port]
+    ::Instana.agent.instance_variable_set(:@discovered, discovery)
+
+    url = "http://#{::Instana.config[:agent_host]}:#{::Instana.config[:agent_port]}/com.instana.plugin.ruby.discovery"
+    json = Oj.dump({ 'pid' => Process.pid, 'agentUuid' => 'abc' })
+    stub_request(:put, url).to_return(:body => json, :status => 200)
+    ::Instana.agent.announce_sensor
+
+    url = "http://#{::Instana.config[:agent_host]}:#{::Instana.config[:agent_port]}/com.instana.plugin.ruby.#{Process.pid}"
+    stub_request(:post, url)
+
+    payload = { :test => 'true' }
+    assert_equal true, ::Instana.agent.report_metrics(payload)
+  end
+
+  def test_failed_metric_report
+    # Fake discovery values
+    discovery = {}
+    discovery[:agent_host] = ::Instana.config[:agent_host]
+    discovery[:agent_port] = ::Instana.config[:agent_port]
+    ::Instana.agent.instance_variable_set(:@discovered, discovery)
+
+    url = "http://#{::Instana.config[:agent_host]}:#{::Instana.config[:agent_port]}/com.instana.plugin.ruby.discovery"
+    json = { 'pid' => Process.pid, 'agentUuid' => 'abc' }.to_json
+    stub_request(:put, url).to_return(:body => json, :status => 200)
+
+    ::Instana.agent.announce_sensor
+
+    url = "http://#{::Instana.config[:agent_host]}:#{::Instana.config[:agent_port]}/com.instana.plugin.ruby.#{Process.pid}"
+    stub_request(:post, url).to_raise(Errno::ECONNREFUSED)
+
+    payload = { :test => 'true' }
+    assert_equal false, ::Instana.agent.report_metrics(payload)
+  end
+
+  def test_agent_timeout
+    # Fake discovery values
+    discovery = {}
+    discovery[:agent_host] = ::Instana.config[:agent_host]
+    discovery[:agent_port] = ::Instana.config[:agent_port]
+    ::Instana.agent.instance_variable_set(:@discovered, discovery)
+
+    localhost_url = "http://#{::Instana::Agent::LOCALHOST}:#{::Instana.config[:agent_port]}/"
+    stub_request(:get, localhost_url).to_timeout
+    docker_url = "http://#{::Instana.agent.instance_variable_get(:@default_gateway)}:#{::Instana.config[:agent_port]}/"
+    stub_request(:get, docker_url).to_timeout
+    assert_equal false, ::Instana.agent.host_agent_available?
+  end
+end