instana 1.195.2 → 1.197.0

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
+        }.compact
+      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/lambda_function.rb

@@ -0,0 +1,36 @@
+module Instana
+  module Backend
+    # @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
+        {
+
+        }
+      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

data/lib/instana/tracer.rb

@@ -1,16 +1,11 @@
 # (c) Copyright IBM Corp. 2021
 # (c) Copyright Instana Inc. 2016
 
-require "instana/thread_local"
 require "instana/tracing/span"
 require "instana/tracing/span_context"
 
 module Instana
   class Tracer
-    extend ::Instana::ThreadLocal
-
-    thread_local :current_span
-
     # Support ::Instana::Tracer.xxx call style for the instantiated tracer
     class << self
       def method_missing(method, *args, &block)
@@ -22,6 +17,22 @@ module Instana
       end
     end
 
+    def initialize(logger: Instana.logger)
+      @current_span = Concurrent::ThreadLocalVar.new
+      @logger = logger
+    end
+
+    # @return [Instana::Span, NilClass] the current active span or nil if we are not tracing
+    def current_span
+      @current_span.value
+    end
+
+    # @param [Instana::Span, NilClas] v the new current span
+    # Set the value of the current span
+    def current_span=(v)
+      @current_span.value = v
+    end
+
     #######################################
     # Tracing blocks API methods
     #######################################
@@ -85,7 +96,6 @@ module Instana
     #
     def log_start_or_continue(name, kvs = {}, incoming_context = nil)
       return if !::Instana.agent.ready? || !::Instana.config[:tracing][:enabled]
-      ::Instana.logger.debug { "#{__method__} passed a block.  Use `start_or_continue` instead!" } if block_given?
 
       # Handle the potential variations on `incoming_context`
       if incoming_context
@@ -125,11 +135,11 @@ module Instana
     def log_entry(name, kvs = nil, start_time = ::Instana::Util.now_in_ms, child_of = nil)
       return unless self.current_span || child_of
 
-      if child_of && (child_of.is_a?(::Instana::Span) || child_of.is_a?(::Instana::SpanContext))
-        new_span = Span.new(name, parent_ctx: child_of, start_time: start_time)
-      else
-        new_span = Span.new(name, parent_ctx: self.current_span, start_time: start_time)
-      end
+      new_span = if child_of.is_a?(::Instana::Span) || child_of.is_a?(::Instana::SpanContext)
+                   Span.new(name, parent_ctx: child_of, start_time: start_time)
+                 else
+                   Span.new(name, parent_ctx: self.current_span, start_time: start_time)
+                 end
       new_span.set_tags(kvs) if kvs
       self.current_span = new_span
     end
@@ -163,10 +173,8 @@ module Instana
     def log_exit(name, kvs = {})
       return unless self.current_span
 
-      if ENV.key?('INSTANA_DEBUG') || ENV.key?('INSTANA_TEST')
-        unless self.current_span.name == name
-          ::Instana.logger.debug "Span mismatch: Attempt to exit #{name} span but #{self.current_span.name} is active."
-        end
+      if self.current_span.name != name
+        @logger.warn "Span mismatch: Attempt to end #{name} span but #{self.current_span.name} is active."
       end
 
       self.current_span.set_tags(kvs)
@@ -191,10 +199,8 @@ module Instana
     def log_end(name, kvs = {}, end_time = ::Instana::Util.now_in_ms)
       return unless self.current_span
 
-      if ENV.key?('INSTANA_DEBUG') || ENV.key?('INSTANA_TEST')
-        unless self.current_span.name == name
-          ::Instana.logger.debug "Span mismatch: Attempt to end #{name} span but #{self.current_span.name} is active."
-        end
+      if self.current_span.name != name
+        @logger.warn "Span mismatch: Attempt to end #{name} span but #{self.current_span.name} is active."
       end
 
       self.current_span.set_tags(kvs)
@@ -252,88 +258,6 @@ module Instana
       span.close
     end
 
-    ###########################################################################
-    # OpenTracing Support
-    ###########################################################################
-
-    # 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)
-      if child_of && (child_of.is_a?(::Instana::Span) || child_of.is_a?(::Instana::SpanContext))
-        new_span = Span.new(operation_name, parent_ctx: child_of, start_time: start_time)
-      else
-        new_span = 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: self.current_span, start_time: ::Instana::Util.now_in_ms, tags: nil)
-      self.current_span = start_span(operation_name, child_of: child_of, start_time: start_time, tags: tags)
-    end
-
-    # Returns the currently active span
-    #
-    # @return [Span]
-    #
-    def active_span
-      self.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
-
     ###########################################################################
     # Helper methods
     ###########################################################################
@@ -374,48 +298,6 @@ module Instana
       self.current_span.context
     end
 
-    # Take the current trace_id and convert it to a header compatible
-    # format.
-    #
-    # @return [String] a hexadecimal representation of the current trace ID
-    #
-    def trace_id_header
-      if self.current_span
-        self.current_span.context.trace_id_header
-      else
-        ""
-      end
-    end
-
-    # Take the current span_id and convert it to a header compatible
-    # formate.
-    #
-    # @return [String] a hexadecimal representation of the current span ID
-    #
-    def span_id_header
-      if self.current_span
-        self.current_span.context.span_id_header
-      else
-        ""
-      end
-    end
-
-    # Returns the trace ID for the active trace (if there is one),
-    # otherwise nil.
-    #
-    def trace_id
-      self.current_span ? self.current_span.id : nil
-      ::Instana.logger.debug("tracer.trace_id will deprecated in a future version.")
-    end
-
-    # Returns the current [Span] ID for the active trace (if there is one),
-    # otherwise nil.
-    #
-    def span_id
-      self.current_span  ? self.current_span.span_id : nil
-      ::Instana.logger.debug("tracer.span_id will deprecated in a future version.")
-    end
-
     # Used in the test suite, this resets the tracer to non-tracing state.
     #
     def clear!