instana 1.11.6 → 1.209.2

data/lib/instana/setup.rb

@@ -1,23 +1,47 @@
-require 'oj_check'
+# (c) Copyright IBM Corp. 2021
+# (c) Copyright Instana Inc. 2016
+
+require 'logger'
+require 'concurrent'
+require 'sys-proctable'
+
+require 'instana/logger_delegator'
+require 'instana/instrumented_logger'
 
 require "instana/base"
 require "instana/config"
-require "instana/agent"
-require "instana/collector"
+require "instana/secrets"
 require "instana/tracer"
 require "instana/tracing/processor"
-require "instana/instrumentation"
 
-::Instana.setup
-::Instana.agent.setup
+require 'instana/serverless'
+
+require 'instana/activator'
 
-# Register the metric collectors
-unless RUBY_PLATFORM == 'java'.freeze
-  require 'instana/collectors/gc'
-end
+require 'instana/backend/request_client'
+require 'instana/backend/gc_snapshot'
+require 'instana/backend/process_info'
 
-require 'instana/collectors/memory'
-require 'instana/collectors/thread'
+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/snapshot/lambda_function'
+require 'instana/snapshot/google_cloud_run_instance'
+require 'instana/snapshot/google_cloud_run_process'
+
+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
 
 # 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)
+        }.reject { |_, v| v.nil? }
+      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

data/lib/instana/snapshot/fargate_container.rb

@@ -0,0 +1,88 @@
+# (c) Copyright IBM Corp. 2021
+# (c) Copyright Instana Inc. 2021
+
+module Instana
+  module Snapshot
+    # Describes a Fargate container visible to the current process
+    # @since 1.197.0
+    class FargateContainer
+      ID = 'com.instana.plugin.aws.ecs.container'.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
+        payload = {
+          dockerId: @container['DockerId'],
+          dockerName: @container['DockerName'],
+          containerName: @container['Name'],
+          image: @container['Image'],
+          imageId: @container['ImageID'],
+          taskArn: @container['Labels']['com.amazonaws.ecs.task-arn'],
+          taskDefinition: @container['Labels']['com.amazonaws.ecs.task-definition-data.family'],
+          taskDefinitionVersion: @container['Labels']['com.amazonaws.ecs.task-definition-data.version'],
+          clusterArn: @container['Labels']['com.amazonaws.ecs.cluster'],
+          desiredStatus: @container['DesiredStatus'],
+          knownStatus: @container['KnownStatus'],
+          ports: @container['Ports'],
+          limits: {
+            cpu: @container['Limits']['CPU'],
+            memory: @container['Limits']['Memory']
+          },
+          createdAt: @container['CreatedAt'],
+          startedAt: @container['StartedAt']
+        }
+
+        if current_container?
+          payload[:instrumented] = true
+          payload[:runtime] = 'ruby'
+        end
+
+        payload
+      end
+
+      def snapshot
+        {
+          name: ID,
+          entityId: entity_id,
+          data: data
+        }
+      end
+
+      def source
+        return unless current_container?
+
+        {
+          hl: true,
+          cp: 'aws',
+          e: entity_id
+        }
+      end
+
+      private
+
+      def current_container?
+        return @current_container if @current_container
+
+        current_conatiner_response = current_conatiner
+        @current_container = @container['DockerName'] == current_conatiner_response['DockerName']
+      end
+
+      def current_conatiner
+        path = @metadata_uri.path
+        response = @client.send_request('GET', path)
+
+        raise "Unable to get `#{path}`. Got `#{response.code}`." unless response.ok?
+
+        response.json
+      end
+    end
+  end
+end

data/lib/instana/snapshot/fargate_process.rb

@@ -0,0 +1,67 @@
+# (c) Copyright IBM Corp. 2021
+# (c) Copyright Instana Inc. 2021
+
+module Instana
+  module Snapshot
+    # Describes the current process in terms of its existence inside of a Fargate container
+    # @since 1.197.0
+    class FargateProcess
+      ID = 'com.instana.plugin.process'.freeze
+
+      def initialize(metadata_uri: ENV['ECS_CONTAINER_METADATA_URI'])
+        @metadata_uri = URI(metadata_uri)
+        @client = Backend::RequestClient.new(@metadata_uri.host, @metadata_uri.port, use_ssl: @metadata_uri.scheme == "https")
+        @start_time = Time.now
+      end
+
+      def entity_id
+        Process.pid.to_s
+      end
+
+      def data
+        proc_table = Sys::ProcTable.ps(pid: Process.pid)
+        process = Backend::ProcessInfo.new(proc_table)
+
+        {
+          pid: process.pid.to_i,
+          env: ENV.to_h,
+          exec: process.name,
+          args: process.arguments,
+          user: process.uid,
+          group: process.gid,
+          start: @start_time.to_i * 1000,
+          containerType: 'docker',
+          container: container_id,
+          "com.instana.plugin.host.name": task_id
+        }
+      end
+
+      def snapshot
+        {
+          name: ID,
+          entityId: entity_id,
+          data: data
+        }
+      end
+
+      private
+
+      def lookup(resource = nil)
+        path = resource ? @metadata_uri.path + resource : @metadata_uri.path
+        response = @client.send_request('GET', path)
+
+        raise "Unable to get `#{path}`. Got `#{response.code}`." unless response.ok?
+
+        response.json
+      end
+
+      def container_id
+        @container_id ||= lookup['DockerId']
+      end
+
+      def task_id
+        @task_id ||= lookup('/task')['TaskARN']
+      end
+    end
+  end
+end

data/lib/instana/snapshot/fargate_task.rb

@@ -0,0 +1,72 @@
+# (c) Copyright IBM Corp. 2021
+# (c) Copyright Instana Inc. 2021
+
+module Instana
+  module Snapshot
+    # Describes the current process in terms of its existence inside of a Fargate task
+    # @since 1.197.0
+    class FargateTask
+      ID = 'com.instana.plugin.aws.ecs.task'.freeze
+
+      def initialize(metadata_uri: ENV['ECS_CONTAINER_METADATA_URI'])
+        @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
+        task_metadata['TaskARN']
+      end
+      alias host_name entity_id
+
+      def data
+        {
+          taskArn: task_metadata['TaskARN'],
+          clusterArn: task_metadata['Cluster'],
+          taskDefinition: task_metadata['Family'],
+          taskDefinitionVersion: task_metadata['Revision'],
+          availabilityZone: task_metadata['AvailabilityZone'],
+          desiredStatus: task_metadata['DesiredStatus'],
+          knownStatus: task_metadata['KnownStatus'],
+          pullStartedAt: task_metadata['PullStartedAt'],
+          pullStoppedAt: task_metadata['PullStoppedAt'],
+          instanaZone: instana_zone,
+          tags: instana_tags
+        }.reject { |_, v| v.nil? }
+      end
+
+      def snapshot
+        {
+          name: ID,
+          entityId: entity_id,
+          data: data
+        }
+      end
+
+      private
+
+      def task_metadata
+        lookup('/task')
+      end
+
+      def instana_zone
+        ENV['INSTANA_ZONE']
+      end
+
+      def instana_tags
+        ENV.fetch('INSTANA_TAGS', '')
+           .split(/,/)
+           .map { |t| t.include?('=') ? t.split('=', 2) : [t, nil] }
+           .to_h
+      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

data/lib/instana/snapshot/google_cloud_run_instance.rb

@@ -0,0 +1,69 @@
+# (c) Copyright IBM Corp. 2021
+# (c) Copyright Instana Inc. 2021
+
+module Instana
+  module Snapshot
+    # @since 1.199
+    class GoogleCloudRunInstance
+      ID = 'com.instana.plugin.gcp.run.revision.instance'.freeze
+
+      def initialize(metadata_uri: 'http://metadata.google.internal')
+        @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
+        lookup('/computeMetadata/v1/instance/id')
+      end
+
+      def data
+        {
+          runtime: 'ruby',
+          region: gcp_region,
+          service: ENV['K_SERVICE'],
+          configuration: ENV['K_CONFIGURATION'],
+          revision: ENV['K_REVISION'],
+          instanceId: entity_id,
+          port: ENV['PORT'],
+          numericProjectId: lookup('/computeMetadata/v1/project/numeric-project-id'),
+          projectId: lookup('/computeMetadata/v1/project/project-id')
+        }.reject { |_, v| v.nil? }
+      end
+
+      def snapshot
+        {
+          name: ID,
+          entityId: entity_id,
+          data: data
+        }
+      end
+
+      def source
+        {
+          hl: true,
+          cp: 'gcp',
+          e: entity_id
+        }
+      end
+
+      def host_name
+        "gcp:cloud-run:revision:#{ENV['K_REVISION']}"
+      end
+
+      private
+
+      def gcp_region
+        lookup('/computeMetadata/v1/instance/zone').split('/').last
+      end
+
+      def lookup(resource)
+        path = @metadata_uri.path + resource
+        response = @client.send_request('GET', path, nil, {'Metadata-Flavor' => 'Google'})
+
+        raise "Unable to get `#{path}`. Got `#{response.code}` `#{response['location']}`." unless response.ok?
+
+        response.body
+      end
+    end
+  end
+end

data/lib/instana/snapshot/google_cloud_run_process.rb

@@ -0,0 +1,58 @@
+# (c) Copyright IBM Corp. 2021
+# (c) Copyright Instana Inc. 2021
+
+module Instana
+  module Snapshot
+    # @since 1.199.0
+    class GoogleCloudRunProcess
+      ID = 'com.instana.plugin.process'.freeze
+
+      def initialize(metadata_uri: 'http://metadata.google.internal')
+        @metadata_uri = URI(metadata_uri)
+        @client = Backend::RequestClient.new(@metadata_uri.host, @metadata_uri.port, use_ssl: @metadata_uri.scheme == "https")
+        @start_time = Time.now
+      end
+
+      def entity_id
+        Process.pid.to_s
+      end
+
+      def data
+        proc_table = Sys::ProcTable.ps(pid: Process.pid)
+        process = Backend::ProcessInfo.new(proc_table)
+
+        {
+          pid: process.pid.to_i,
+          env: ENV.to_h,
+          exec: process.name,
+          args: process.arguments,
+          user: process.uid,
+          group: process.gid,
+          start: @start_time.to_i * 1000,
+          containerType: 'gcpCloudRunInstance',
+          container: lookup('/computeMetadata/v1/instance/id'),
+          "com.instana.plugin.host.name": "gcp:cloud-run:revision:#{ENV['K_REVISION']}"
+        }
+      end
+
+      def snapshot
+        {
+          name: ID,
+          entityId: entity_id,
+          data: data
+        }
+      end
+
+      private
+
+      def lookup(resource)
+        path = @metadata_uri.path + resource
+        response = @client.send_request('GET', path, nil, {'Metadata-Flavor' => 'Google'})
+
+        raise "Unable to get `#{path}`. Got `#{response.code}` `#{response['location']}`." unless response.ok?
+
+        response.body
+      end
+    end
+  end
+end

data/lib/instana/snapshot/lambda_function.rb

@@ -0,0 +1,39 @@
+# (c) Copyright IBM Corp. 2021
+# (c) Copyright Instana Inc. 2021
+
+module Instana
+  module Snapshot
+    # @since 1.198.0
+    class LambdaFunction
+      ID = "com.instana.plugin.aws.lambda".freeze
+
+      def entity_id
+        Thread.current[:instana_function_arn]
+      end
+
+      def data
+        {}
+      end
+
+      def snapshot
+        {
+          name: ID,
+          entityId: entity_id,
+          data: data
+        }
+      end
+
+      def source
+        {
+          hl: true,
+          cp: "aws",
+          e: entity_id
+        }
+      end
+
+      def host_name
+        entity_id
+      end
+    end
+  end
+end

data/lib/instana/snapshot/ruby_process.rb

@@ -0,0 +1,48 @@
+# (c) Copyright IBM Corp. 2021
+# (c) Copyright Instana Inc. 2021
+
+module Instana
+  module Snapshot
+    # Describes the current Ruby process
+    # @since 1.197.0
+    class RubyProcess
+      ID = 'com.instana.plugin.ruby'.freeze
+
+      def initialize(pid: Process.pid)
+        @pid = pid
+      end
+
+      def entity_id
+        @pid.to_s
+      end
+
+      def data
+        metrics_data.merge(Util.take_snapshot)
+      end
+
+      def snapshot
+        {
+          name: ID,
+          entityId: entity_id,
+          data: data
+        }
+      end
+
+      private
+
+      def metrics_data
+        proc_table = Sys::ProcTable.ps(pid: Process.pid)
+        process = Backend::ProcessInfo.new(proc_table)
+
+        {
+          pid: @pid,
+          name: Util.get_app_name,
+          exec_args: process.arguments,
+          gc: Backend::GCSnapshot.instance.report,
+          thread: {count: ::Thread.list.count},
+          memory: {rss_size: proc_table.rss / 1024} # Bytes to Kilobytes
+        }
+      end
+    end
+  end
+end