instana 1.195.2 → 1.197.0

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

@@ -19,14 +19,16 @@ module Instana
 
         # Set request headers; encode IDs as hexadecimal strings
         t_context = ::Instana.tracer.context
-        request['X-Instana-T'] = t_context.trace_id_header
-        request['X-Instana-S'] = t_context.span_id_header
+        request['X-Instana-L'] = t_context.level.to_s
 
-        if ::Instana.config[:w3_trace_correlation]
-          request['Traceparent'] = t_context.trace_parent_header
-          request['Tracestate'] = t_context.trace_state_header
+        if t_context.active?
+          request['X-Instana-T'] = t_context.trace_id_header
+          request['X-Instana-S'] = t_context.span_id_header
         end
 
+        request['Traceparent'] = t_context.trace_parent_header
+        request['Tracestate'] = t_context.trace_state_header unless t_context.trace_state_header.empty?
+
         # Collect up KV info now in case any exception is raised
         kv_payload = { :http => {} }
         kv_payload[:http][:method] = request.method

data/lib/instana/instrumentation/rack.rb

@@ -12,7 +12,6 @@ module Instana
 
     def call(env)
       req = InstrumentedRequest.new(env)
-      return @app.call(env) if req.skip_trace?
       kvs = {
         http: req.request_tags,
         service: ENV['INSTANA_SERVICE_NAME']
@@ -34,12 +33,16 @@ module Instana
 
         if req.continuing_from_trace_parent?
           current_span[:tp] = true
-          current_span[:lt] = req.incoming_context[:external_trace_id]
+        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)
@@ -70,15 +73,17 @@ module Instana
       if ::Instana.tracer.tracing?
         if headers
           # Set response headers; encode as hex string
-          headers['X-Instana-T'] = trace_context.trace_id_header
-          headers['X-Instana-S'] = trace_context.span_id_header
-          headers['X-Instana-L'] = '1'
+          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'
 
-          if ::Instana.config[:w3_trace_correlation]
-            headers['Traceparent'] = trace_context.trace_parent_header
             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
 

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,6 +6,10 @@ 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
 
@@ -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