instana 1.195.0 → 1.197.0.pre1

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
@@ -35,7 +36,7 @@ module Instana
       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 +49,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 +72,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

@@ -46,12 +46,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
 
@@ -88,7 +93,7 @@ module Instana
       {
         external_trace_id: matches['trace'],
         external_state: @env['HTTP_TRACESTATE'],
-        trace_id: ::Instana::Util.header_to_id(matches['trace'][16..-1]),
+        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'])
       }
     end

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

@@ -32,7 +32,9 @@ module Instana
         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 +43,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/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:

data/lib/instana/secrets.rb

@@ -6,11 +6,15 @@ require 'cgi'
 
 module Instana
   class Secrets
+    def initialize(logger: ::Instana.logger)
+      @logger = logger
+    end
+
     def remove_from_query(str, secret_values = Instana.agent.secret_values)
       return str unless secret_values
 
       url = URI(str)
-      params = CGI.parse(url.query || '')
+      params = url.scheme ? CGI.parse(url.query || '') : CGI.parse(url.to_s)
 
       redacted = params.map do |k, v|
         needs_redaction = secret_values['list']
@@ -19,7 +23,7 @@ module Instana
       end
 
       url.query = URI.encode_www_form(redacted)
-      CGI.unescape(url.to_s)
+      url.scheme ? CGI.unescape(url.to_s) : CGI.unescape(url.query)
     end
 
     private
@@ -37,8 +41,8 @@ module Instana
       when 'regex'
         ->(expected, actual) { !Regexp.new(expected).match(actual).nil? }
       else
-        ::Instana.logger.warn("Matcher #{name} is not supported.")
-        lambda { false }
+        @logger.warn("Matcher #{name} is not supported.")
+        ->(_e, _a) { false }
       end
     end
   end

data/lib/instana/setup.rb

@@ -1,30 +1,39 @@
 # (c) Copyright IBM Corp. 2021
 # (c) Copyright Instana Inc. 2016
 
-require 'oj_check'
+require 'instana/logger_delegator'
 
 require "instana/base"
 require "instana/config"
-require "instana/agent"
-require "instana/collector"
 require "instana/secrets"
 require "instana/tracer"
 require "instana/tracing/processor"
 
 require 'instana/activator'
 
+require 'instana/backend/request_client'
+require 'instana/backend/gc_snapshot'
+require 'instana/backend/process_info'
+
+require 'instana/snapshot/deltable'
+require 'instana/snapshot/ruby_process'
+require 'instana/snapshot/fargate_process'
+require 'instana/snapshot/fargate_task'
+require 'instana/snapshot/fargate_container'
+require 'instana/snapshot/docker_container'
+
+require 'instana/backend/host_agent_lookup'
+require 'instana/backend/host_agent_activation_observer'
+require 'instana/backend/host_agent_reporting_observer'
+
+require 'instana/backend/host_agent'
+require 'instana/backend/serverless_agent'
+require 'instana/backend/agent'
+
 ::Instana.setup
 ::Instana.agent.setup
 ::Instana::Activator.start
 
-# Register the metric collectors
-unless RUBY_PLATFORM == 'java'.freeze
-  require 'instana/collectors/gc'
-end
-
-require 'instana/collectors/memory'
-require 'instana/collectors/thread'
-
 # Require supported OpenTracing interfaces
 require "opentracing"
 

data/lib/instana/snapshot/deltable.rb

@@ -0,0 +1,25 @@
+# (c) Copyright IBM Corp. 2021
+# (c) Copyright Instana Inc. 2021
+
+module Instana
+  module Snapshot
+    # @since 1.197.0
+    module Deltable
+      def delta(key, *rest, compute:, obj:, path: [key, *rest])
+        val = obj[key]
+        return val if val == nil
+
+        if rest.empty?
+          @__delta ||= Hash.new(0)
+          cache_key = path.join('.')
+          old = @__delta[cache_key]
+          @__delta[cache_key] = val
+
+          return compute.call(old, val)
+        end
+
+        delta(*rest, compute: compute, obj: val, path: path)
+      end
+    end
+  end
+end

data/lib/instana/snapshot/docker_container.rb

@@ -0,0 +1,151 @@
+# (c) Copyright IBM Corp. 2021
+# (c) Copyright Instana Inc. 2021
+
+module Instana
+  module Snapshot
+    # Describes a Docker container visible to the current process
+    # @since 1.197.0
+    class DockerContainer
+      include Deltable
+      ID = 'com.instana.plugin.docker'.freeze
+
+      def initialize(container, metadata_uri: ENV['ECS_CONTAINER_METADATA_URI'])
+        @container = container
+        @metadata_uri = URI(metadata_uri)
+        @client = Backend::RequestClient.new(@metadata_uri.host, @metadata_uri.port, use_ssl: @metadata_uri.scheme == "https")
+      end
+
+      def entity_id
+        "#{@container['Labels']['com.amazonaws.ecs.task-arn']}::#{@container['Name']}"
+      end
+
+      def data
+        metrics = lookup('/task/stats').fetch(@container['DockerId'], {})
+
+        container_metrics(metrics)
+          .merge(container_metadata)
+      end
+
+      def snapshot
+        {
+          name: ID,
+          entityId: entity_id,
+          data: data
+        }
+      end
+
+      private
+
+      def container_metadata
+        {
+          Id: @container['DockerId'],
+          Created: @container['CreatedAt'],
+          Started: @container['StartedAt'],
+          Image: @container['Image'],
+          Labels: @container['Labels'],
+          Ports: @container['Ports'],
+          NetworkMode: @container['Networks'].first['NetworkMode']
+        }
+      end
+
+      def container_metrics(metrics)
+        return {} if metrics.empty?
+
+        {
+          memory: memory_stats(metrics),
+          blkio: blkio_stats(metrics),
+          cpu: cpu_stats(metrics),
+          network: network_stats(metrics)
+        }.compact
+      end
+
+      def memory_stats(metrics)
+        identity = ->(_old, new) { new }
+
+        {
+          active_anon: delta('memory_stats', 'stats', 'active_anon', compute: identity, obj: metrics),
+          active_file: delta('memory_stats', 'stats', 'active_file', compute: identity, obj: metrics),
+          inactive_anon: delta('memory_stats', 'stats', 'inactive_anon', compute: identity, obj: metrics),
+          inactive_file: delta('memory_stats', 'stats', 'inactive_file', compute: identity, obj: metrics),
+          total_cache: delta('memory_stats', 'stats', 'total_cache', compute: identity, obj: metrics),
+          total_rss: delta('memory_stats', 'stats', 'total_rss', compute: identity, obj: metrics),
+          usage: delta('memory_stats', 'usage', compute: identity, obj: metrics),
+          max_usage: delta('memory_stats', 'max_usage', compute: identity, obj: metrics),
+          limit: delta('memory_stats', 'limit', compute: identity, obj: metrics)
+        }
+      end
+
+      def blkio_stats(metrics)
+        delta = ->(old, new) { new - old }
+        bytes = {
+          'block_bytes' => metrics['blkio_stats']['io_service_bytes_recursive'].map { |r| [r['op'], r['value']] }.to_h
+        }
+
+        {
+          blk_read: delta('block_bytes', 'Read', compute: delta, obj: bytes),
+          blk_write: delta('block_bytes', 'Write', compute: delta, obj: bytes)
+        }
+      end
+
+      def cpu_stats(metrics)
+        delta = ->(old, new) { new - old }
+        identity = ->(_old, new) { new }
+
+        cpu_system_delta = delta('cpu_stats', 'system_cpu_usage', compute: delta, obj: metrics).to_f
+        online_cpus = delta('cpu_stats', 'online_cpus', compute: identity, obj: metrics) || 1
+
+        {
+          total_usage: (delta('cpu_stats', 'cpu_usage', 'total_usage', compute: delta, obj: metrics) / cpu_system_delta) * online_cpus,
+          user_usage: (delta('cpu_stats', 'cpu_usage', 'usage_in_usermode', compute: delta, obj: metrics) / cpu_system_delta) * online_cpus,
+          system_usage: (delta('cpu_stats', 'cpu_usage', 'usage_in_kernelmode', compute: delta, obj: metrics) / cpu_system_delta) * online_cpus,
+          throttling_count: delta('cpu_stats', 'throttling_data', 'periods', compute: delta, obj: metrics),
+          throttling_time: delta('cpu_stats', 'throttling_data', 'throttled_time', compute: delta, obj: metrics)
+        }
+      end
+
+      def network_stats(metrics)
+        delta = ->(old, new) { new - old }
+        return nil unless metrics['networks']
+
+        interfaces = metrics['networks'].keys
+        payload = {
+          rx: {
+            bytes: 0,
+            dropped: 0,
+            errors: 0,
+            packet: 0
+          },
+          tx: {
+            bytes: 0,
+            dropped: 0,
+            errors: 0,
+            packet: 0
+          }
+        }
+
+        interfaces.each do |interface|
+          payload[:rx][:bytes] += delta('networks', interface, 'rx_bytes', compute: delta, obj: metrics)
+          payload[:rx][:dropped] += delta('networks', interface, 'rx_dropped', compute: delta, obj: metrics)
+          payload[:rx][:errors] += delta('networks', interface, 'rx_errors', compute: delta, obj: metrics)
+          payload[:rx][:packet] += delta('networks', interface, 'rx_packets', compute: delta, obj: metrics)
+
+          payload[:tx][:bytes] += delta('networks', interface, 'tx_bytes', compute: delta, obj: metrics)
+          payload[:tx][:dropped] += delta('networks', interface, 'tx_packets', compute: delta, obj: metrics)
+          payload[:tx][:errors] += delta('networks', interface, 'tx_errors', compute: delta, obj: metrics)
+          payload[:tx][:packet] += delta('networks', interface, 'tx_dropped', compute: delta, obj: metrics)
+        end
+
+        payload
+      end
+
+      def lookup(resource)
+        path = @metadata_uri.path + resource
+        response = @client.send_request('GET', path)
+
+        raise "Unable to get `#{path}`. Got `#{response.code}`." unless response.ok?
+
+        response.json
+      end
+    end
+  end
+end