instana 1.11.6 → 1.209.2

data/lib/instana/activators/dalli.rb

@@ -0,0 +1,23 @@
+# (c) Copyright IBM Corp. 2021
+# (c) Copyright Instana Inc. 2021
+
+module Instana
+  module Activators
+    class Dalli < Activator
+      def can_instrument?
+        defined?(::Dalli::Client) &&
+          defined?(::Dalli::Server) &&
+          Instana.config[:dalli][:enabled]
+      end
+
+      def instrument
+        require 'instana/instrumentation/dalli'
+
+        ::Dalli::Client.prepend ::Instana::Instrumentation::Dalli
+        ::Dalli::Server.prepend ::Instana::Instrumentation::DalliServer
+
+        true
+      end
+    end
+  end
+end

data/lib/instana/activators/excon.rb

@@ -0,0 +1,20 @@
+# (c) Copyright IBM Corp. 2021
+# (c) Copyright Instana Inc. 2021
+
+module Instana
+  module Activators
+    class Excon < Activator
+      def can_instrument?
+        defined?(::Excon) && defined?(::Excon::Middleware::Base) && ::Excon.respond_to?(:defaults) && Instana.config[:excon][:enabled]
+      end
+
+      def instrument
+        require 'instana/instrumentation/excon'
+
+        ::Excon.defaults[:middlewares].unshift(::Instana::Instrumentation::Excon)
+
+        true
+      end
+    end
+  end
+end

data/lib/instana/activators/graphql.rb

@@ -0,0 +1,22 @@
+# (c) Copyright IBM Corp. 2021
+# (c) Copyright Instana Inc. 2021
+
+module Instana
+  module Activators
+    class Graphql < Activator
+      def can_instrument?
+        defined?(::GraphQL::Schema) &&
+          defined?(GraphQL::Tracing::PlatformTracing) &&
+          Instana.config[:graphql][:enabled]
+      end
+
+      def instrument
+        require 'instana/instrumentation/graphql'
+
+        ::GraphQL::Schema.use(::Instana::Instrumentation::GraphqlTracing)
+
+        true
+      end
+    end
+  end
+end

data/lib/instana/activators/grpc_client.rb

@@ -0,0 +1,20 @@
+# (c) Copyright IBM Corp. 2021
+# (c) Copyright Instana Inc. 2021
+
+module Instana
+  module Activators
+    class GrpcClient < Activator
+      def can_instrument?
+        defined?(::GRPC::ActiveCall) && ::Instana.config[:grpc][:enabled]
+      end
+
+      def instrument
+        require 'instana/instrumentation/grpc'
+
+        ::GRPC::ClientStub.prepend(::Instana::Instrumentation::GRPCCientInstrumentation)
+
+        true
+      end
+    end
+  end
+end

data/lib/instana/activators/grpc_server.rb

@@ -0,0 +1,20 @@
+# (c) Copyright IBM Corp. 2021
+# (c) Copyright Instana Inc. 2021
+
+module Instana
+  module Activators
+    class GrpcServer < Activator
+      def can_instrument?
+        defined?(::GRPC::RpcDesc) && ::Instana.config[:grpc][:enabled]
+      end
+
+      def instrument
+        require 'instana/instrumentation/grpc'
+
+        ::GRPC::RpcDesc.prepend(::Instana::Instrumentation::GRPCServerInstrumentation)
+
+        true
+      end
+    end
+  end
+end

data/lib/instana/activators/mongo.rb

@@ -0,0 +1,23 @@
+# (c) Copyright IBM Corp. 2021
+# (c) Copyright Instana Inc. 2021
+
+module Instana
+  module Activators
+    class Mongo < Activator
+      def can_instrument?
+        defined?(::Mongo::Client) && defined?(::Mongo::Monitoring::Global)
+      end
+
+      def instrument
+        require 'instana/instrumentation/mongo'
+
+        ::Mongo::Monitoring::Global.subscribe(
+          ::Mongo::Monitoring::COMMAND,
+          ::Instana::Mongo.new
+        )
+
+        true
+      end
+    end
+  end
+end

data/lib/instana/activators/net_http.rb

@@ -0,0 +1,20 @@
+# (c) Copyright IBM Corp. 2021
+# (c) Copyright Instana Inc. 2021
+
+module Instana
+  module Activators
+    class NetHTTP < Activator
+      def can_instrument?
+        defined?(::Net::HTTP) && ::Instana.config[:nethttp][:enabled]
+      end
+
+      def instrument
+        require 'instana/instrumentation/net-http'
+
+        ::Net::HTTP.prepend(::Instana::Instrumentation::NetHTTPInstrumentation)
+
+        true
+      end
+    end
+  end
+end

data/lib/instana/activators/rack.rb

@@ -0,0 +1,16 @@
+# (c) Copyright IBM Corp. 2021
+# (c) Copyright Instana Inc. 2021
+
+module Instana
+  module Activators
+    class Rack < Activator
+      def can_instrument?
+        defined?(::Rack)
+      end
+
+      def instrument
+        require 'instana/instrumentation/rack'
+      end
+    end
+  end
+end

data/lib/instana/activators/rails.rb

@@ -0,0 +1,18 @@
+# (c) Copyright IBM Corp. 2021
+# (c) Copyright Instana Inc. 2021
+
+module Instana
+  module Activators
+    class Rails < Activator
+      def can_instrument?
+        defined?(::Instana::Rack) &&
+          defined?(::Rails) &&
+          defined?(::Rails::VERSION)
+      end
+
+      def instrument
+        require 'instana/frameworks/rails'
+      end
+    end
+  end
+end

data/lib/instana/activators/redis.rb

@@ -0,0 +1,20 @@
+# (c) Copyright IBM Corp. 2021
+# (c) Copyright Instana Inc. 2021
+
+module Instana
+  module Activators
+    class Redis < Activator
+      def can_instrument?
+        defined?(::Redis) && defined?(::Redis::Client) && ::Instana.config[:redis][:enabled]
+      end
+
+      def instrument
+        require 'instana/instrumentation/redis'
+
+        ::Redis::Client.prepend(::Instana::RedisInstrumentation)
+
+        true
+      end
+    end
+  end
+end

data/lib/instana/activators/resque_client.rb

@@ -0,0 +1,21 @@
+# (c) Copyright IBM Corp. 2021
+# (c) Copyright Instana Inc. 2021
+
+module Instana
+  module Activators
+    class ResqueClient < Activator
+      def can_instrument?
+        defined?(::Resque) &&
+          ::Instana.config[:'resque-client'][:enabled]
+      end
+
+      def instrument
+        require 'instana/instrumentation/resque'
+
+        ::Resque.prepend(::Instana::Instrumentation::ResqueClient)
+
+        true
+      end
+    end
+  end
+end

data/lib/instana/activators/resque_worker.rb

@@ -0,0 +1,32 @@
+# (c) Copyright IBM Corp. 2021
+# (c) Copyright Instana Inc. 2021
+
+module Instana
+  module Activators
+    class ResqueWorker < Activator
+      def can_instrument?
+        defined?(::Resque::Worker) &&
+          defined?(::Resque::Job) &&
+          ::Instana.config[:'resque-worker'][:enabled]
+      end
+
+      def instrument
+        require 'instana/instrumentation/resque'
+
+        ::Resque::Worker.prepend(::Instana::Instrumentation::ResqueWorker)
+        ::Resque::Job.prepend(::Instana::Instrumentation::ResqueJob)
+
+        if ::Instana.config[:'resque-worker'][:'setup-fork']
+          ::Resque.after_fork do |_job|
+            ::Instana.agent.after_fork
+          end
+        end
+
+        # Set this so we assure that any remaining collected traces are reported at_exit
+        ENV['RUN_AT_EXIT_HOOKS'] = "1"
+
+        true
+      end
+    end
+  end
+end

data/lib/instana/activators/rest_client.rb

@@ -0,0 +1,20 @@
+# (c) Copyright IBM Corp. 2021
+# (c) Copyright Instana Inc. 2021
+
+module Instana
+  module Activators
+    class RestClient < Activator
+      def can_instrument?
+        defined?(::RestClient::Request) && ::Instana.config[:'rest-client'][:enabled]
+      end
+
+      def instrument
+        require 'instana/instrumentation/rest-client'
+
+        ::RestClient::Request.prepend ::Instana::Instrumentation::RestClientRequest
+
+        true
+      end
+    end
+  end
+end

data/lib/instana/activators/roda.rb

@@ -0,0 +1,21 @@
+# (c) Copyright IBM Corp. 2021
+# (c) Copyright Instana Inc. 2021
+
+module Instana
+  module Activators
+    class Roda < Activator
+      def can_instrument?
+        defined?(::Instana::Rack) && defined?(::Roda)
+      end
+
+      def instrument
+        require 'instana/frameworks/roda'
+
+        ::Roda.use ::Instana::Rack
+        ::Roda.plugin ::Instana::RodaPathTemplateExtractor
+
+        true
+      end
+    end
+  end
+end

data/lib/instana/activators/shoryuken.rb

@@ -0,0 +1,24 @@
+# (c) Copyright IBM Corp. 2021
+# (c) Copyright Instana Inc. 2021
+
+module Instana
+  module Activators
+    class Shoryuken < Activator
+      def can_instrument?
+        defined?(::Shoryuken) && ::Shoryuken.respond_to?(:configure_server)
+      end
+
+      def instrument
+        require 'instana/instrumentation/shoryuken'
+
+        ::Shoryuken.configure_server do |config|
+          config.server_middleware do |chain|
+            chain.add ::Instana::Instrumentation::Shoryuken
+          end
+        end
+
+        true
+      end
+    end
+  end
+end

data/lib/instana/activators/sidekiq_client.rb

@@ -0,0 +1,24 @@
+# (c) Copyright IBM Corp. 2021
+# (c) Copyright Instana Inc. 2021
+
+module Instana
+  module Activators
+    class SidekiqClient < Activator
+      def can_instrument?
+        defined?(::Sidekiq) && ::Sidekiq.respond_to?(:configure_client) && ::Instana.config[:'sidekiq-client'][:enabled]
+      end
+
+      def instrument
+        require 'instana/instrumentation/sidekiq-client'
+
+        ::Sidekiq.configure_client do |cfg|
+          cfg.client_middleware do |chain|
+            chain.add ::Instana::Instrumentation::SidekiqClient
+          end
+        end
+
+        true
+      end
+    end
+  end
+end

data/lib/instana/activators/sidekiq_worker.rb

@@ -0,0 +1,24 @@
+# (c) Copyright IBM Corp. 2021
+# (c) Copyright Instana Inc. 2021
+
+module Instana
+  module Activators
+    class SidekiqWorker < Activator
+      def can_instrument?
+        defined?(::Sidekiq) && ::Sidekiq.respond_to?(:configure_server) && ::Instana.config[:'sidekiq-worker'][:enabled]
+      end
+
+      def instrument
+        require 'instana/instrumentation/sidekiq-worker'
+
+        ::Sidekiq.configure_server do |cfg|
+          cfg.server_middleware do |chain|
+            chain.add ::Instana::Instrumentation::SidekiqWorker
+          end
+        end
+
+        true
+      end
+    end
+  end
+end

data/lib/instana/activators/sinatra.rb

@@ -0,0 +1,21 @@
+# (c) Copyright IBM Corp. 2021
+# (c) Copyright Instana Inc. 2021
+
+module Instana
+  module Activators
+    class Sinatra < Activator
+      def can_instrument?
+        defined?(::Instana::Rack) && defined?(::Sinatra) && defined?(::Sinatra::Base) && !::Sinatra::Base.middleware.nil?
+      end
+
+      def instrument
+        require 'instana/frameworks/sinatra'
+
+        ::Sinatra::Base.use ::Instana::Rack
+        ::Sinatra::Base.register ::Instana::SinatraPathTemplateExtractor
+
+        true
+      end
+    end
+  end
+end

data/lib/instana/backend/agent.rb

@@ -0,0 +1,68 @@
+# (c) Copyright IBM Corp. 2021
+# (c) Copyright Instana Inc. 2021
+
+module Instana
+  module Backend
+    # Wrapper class around the various transport backends
+    # @since 1.197.0
+    class Agent
+      attr_reader :delegate
+
+      def initialize(fargate_metadata_uri: ENV['ECS_CONTAINER_METADATA_URI'], logger: ::Instana.logger)
+        @delegate = nil
+        @logger = logger
+        @fargate_metadata_uri = fargate_metadata_uri
+      end
+
+      def setup
+        @delegate = if ENV.key?('_HANDLER')
+                      ServerlessAgent.new([Snapshot::LambdaFunction.new])
+                    elsif ENV.key?('K_REVISION') && ENV.key?('INSTANA_ENDPOINT_URL')
+                      ServerlessAgent.new([
+                                            Snapshot::GoogleCloudRunProcess.new,
+                                            Snapshot::GoogleCloudRunInstance.new,
+                                            Snapshot::RubyProcess.new
+                                          ])
+                    elsif @fargate_metadata_uri && ENV.key?('INSTANA_ENDPOINT_URL')
+                      ServerlessAgent.new(fargate_snapshots)
+                    else
+                      HostAgent.new
+                    end
+
+        @delegate.setup
+      end
+
+      def method_missing(mth, *args, &block)
+        if @delegate.respond_to?(mth)
+          @delegate.public_send(mth, *args, &block)
+        else
+          super(mth, *args, &block)
+        end
+      end
+
+      def respond_to_missing?(mth, include_all = false)
+        @delegate.respond_to?(mth, include_all)
+      end
+
+      private
+
+      def fargate_snapshots
+        metadata_uri = URI(@fargate_metadata_uri)
+        client = Backend::RequestClient.new(metadata_uri.host, metadata_uri.port, use_ssl: metadata_uri.scheme == "https")
+        response = client.send_request('GET', "#{metadata_uri.path}/task")
+
+        if response.ok?
+          docker = response
+                   .json['Containers']
+                   .map { |c| [Snapshot::DockerContainer.new(c), Snapshot::FargateContainer.new(c)] }
+                   .flatten
+
+          docker + [Snapshot::FargateProcess.new, Snapshot::RubyProcess.new, Snapshot::FargateTask.new]
+        else
+          @logger.warn("Received #{response.code} when requesting containers.")
+          []
+        end
+      end
+    end
+  end
+end

data/lib/instana/backend/gc_snapshot.rb

@@ -0,0 +1,41 @@
+# (c) Copyright IBM Corp. 2021
+# (c) Copyright Instana Inc. 2021
+
+require 'singleton'
+
+module Instana
+  module Backend
+    # Keeps track of garbage collector related metrics
+    # @since 1.197.0
+    class GCSnapshot
+      include Singleton
+
+      def initialize
+        ::GC::Profiler.enable
+
+        @last_major_count = 0
+        @last_minor_count = 0
+      end
+
+      def report
+        stats = ::GC.stat
+        total_time = ::GC::Profiler.total_time * 1000
+
+        ::GC::Profiler.clear
+
+        payload = {
+          totalTime: total_time,
+          heap_live: stats[:heap_live_slots] || stats[:heap_live_num],
+          heap_free: stats[:heap_free_slots] || stats[:heap_free_num],
+          minorGcs: stats[:minor_gc_count] - @last_minor_count,
+          majorGcs: stats[:major_gc_count] - @last_major_count
+        }
+
+        @last_major_count = stats[:major_gc_count]
+        @last_minor_count = stats[:minor_gc_count]
+
+        payload
+      end
+    end
+  end
+end

data/lib/instana/backend/host_agent.rb

@@ -0,0 +1,83 @@
+# (c) Copyright IBM Corp. 2021
+# (c) Copyright Instana Inc. 2021
+
+module Instana
+  module Backend
+    # @since 1.197.0
+    class HostAgent
+      attr_reader :future, :client
+
+      def initialize(discovery: Concurrent::Atom.new(nil), logger: ::Instana.logger)
+        @discovery = discovery
+        @logger = logger
+        @future = nil
+        @client = nil
+      end
+
+      def setup; end
+
+      def spawn_background_thread
+        return if ENV.key?('INSTANA_TEST')
+
+        @future = Concurrent::Promises.future do
+          announce
+        end
+      end
+
+      alias start spawn_background_thread
+
+      def announce
+        @client = until_not_nil { HostAgentLookup.new.call }
+        @discovery.delete_observers
+        @discovery
+          .with_observer(HostAgentActivationObserver.new(@client, @discovery))
+          .with_observer(HostAgentReportingObserver.new(@client, @discovery))
+
+        @discovery.swap { nil }
+        @client
+      end
+
+      alias after_fork announce
+
+      # @return [Boolean] true if the agent able to send spans to the backend
+      def ready?
+        ENV.key?('INSTANA_TEST') || !@discovery.value.nil?
+      end
+
+      # @return [Hash, NilClass] the backend friendly description of the current in process collector
+      def source
+        {
+          e: discovery_value['pid'],
+          h: discovery_value['agentUuid']
+        }.reject { |_, v| v.nil? }
+      end
+
+      # @return [Array] extra headers to include in the trace
+      def extra_headers
+        discovery_value['extraHeaders']
+      end
+
+      # @return [Hash] values which are removed from urls sent to the backend
+      def secret_values
+        discovery_value['secrets']
+      end
+
+      private
+
+      def until_not_nil
+        loop do
+          result = yield
+          return result unless result.nil?
+
+          @logger.debug("Waiting on a connection to the agent.")
+          sleep(1)
+        end
+      end
+
+      def discovery_value
+        v = @discovery.value
+        v || {}
+      end
+    end
+  end
+end