instana 1.11.6 → 1.209.2

data/lib/instana/instrumentation/resque.rb

@@ -1,13 +1,13 @@
+# (c) Copyright IBM Corp. 2021
+# (c) Copyright Instana Inc. 2018
+
 require 'socket'
 
 module Instana
   module Instrumentation
     module ResqueClient
-      def self.included(klass)
+      def self.prepended(klass)
         klass.send :extend, ::Resque
-        ::Instana::Util.method_alias(klass, :enqueue)
-        ::Instana::Util.method_alias(klass, :enqueue_to)
-        ::Instana::Util.method_alias(klass, :dequeue)
       end
 
       def collect_kvs(op, klass, args)
@@ -23,50 +23,48 @@ module Instana
         { :'resque-client' => kvs }
       end
 
-      def enqueue_with_instana(klass, *args)
+      def enqueue(klass, *args)
         if Instana.tracer.tracing?
           kvs = collect_kvs(:enqueue, klass, args)
 
           Instana.tracer.trace(:'resque-client', kvs) do
-            enqueue_without_instana(klass, *args)
+            args.push(::Instana.tracer.context.to_hash) if ::Instana.config[:'resque-client'][:propagate]
+            super(klass, *args)
           end
         else
-          enqueue_without_instana(klass, *args)
+          super(klass, *args)
         end
       end
 
-      def enqueue_to_with_instana(queue, klass, *args)
+      def enqueue_to(queue, klass, *args)
         if Instana.tracer.tracing? && !Instana.tracer.tracing_span?(:'resque-client')
           kvs = collect_kvs(:enqueue_to, klass, args)
           kvs[:Queue] = queue.to_s if queue
 
           Instana.tracer.trace(:'resque-client', kvs) do
-            enqueue_to_without_instana(queue, klass, *args)
+            args.push(::Instana.tracer.context.to_hash) if ::Instana.config[:'resque-client'][:propagate]
+            super(queue, klass, *args)
           end
         else
-          enqueue_to_without_instana(queue, klass, *args)
+          super(queue, klass, *args)
         end
       end
 
-      def dequeue_with_instana(klass, *args)
+      def dequeue(klass, *args)
         if Instana.tracer.tracing?
           kvs = collect_kvs(:dequeue, klass, args)
 
           Instana.tracer.trace(:'resque-client', kvs) do
-            dequeue_without_instana(klass, *args)
+            super(klass, *args)
           end
         else
-          dequeue_without_instana(klass, *args)
+          super(klass, *args)
         end
       end
     end
 
     module ResqueWorker
-      def self.included(klass)
-        ::Instana::Util.method_alias(klass, :perform)
-      end
-
-      def perform_with_instana(job)
+      def perform(job)
         kvs = {}
         kvs[:'resque-worker'] = {}
 
@@ -80,18 +78,22 @@ module Instana
           ::Instana.logger.debug { "#{__method__}:#{File.basename(__FILE__)}:#{__LINE__}: #{e.message}" } if Instana::Config[:verbose]
         end
 
-        Instana.tracer.start_or_continue_trace(:'resque-worker', kvs) do
-          perform_without_instana(job)
+        trace_context = if ::Instana.config[:'resque-client'][:propagate] && job.payload['args'][-1].is_a?(Hash) && job.payload['args'][-1].keys.include?('trace_id')
+                          context_from_wire = job.payload['args'].pop
+                          ::Instana::SpanContext.new(
+                            context_from_wire['trace_id'],
+                            context_from_wire['span_id']
+                          )
+                        end
+
+        Instana.tracer.start_or_continue_trace(:'resque-worker', kvs, trace_context) do
+          super(job)
         end
       end
     end
 
     module ResqueJob
-      def self.included(klass)
-        ::Instana::Util.method_alias(klass, :fail)
-      end
-
-      def fail_with_instana(exception)
+      def fail(exception)
         if Instana.tracer.tracing?
           ::Instana.tracer.log_info(:'resque-worker' => { :error => "#{exception.class}: #{exception}"})
           ::Instana.tracer.log_error(exception)
@@ -99,33 +101,8 @@ module Instana
       rescue Exception => e
         ::Instana.logger.debug { "#{__method__}:#{File.basename(__FILE__)}:#{__LINE__}: #{e.message}" } if Instana::Config[:verbose]
       ensure
-        fail_without_instana(exception)
+        super(exception)
       end
     end
   end
 end
-
-if defined?(::Resque) && RUBY_VERSION >= '1.9.3'
-
-  if ::Instana.config[:'resque-client'][:enabled]
-    ::Instana.logger.debug 'Instrumenting Resque Client'
-    ::Instana::Util.send_include(::Resque,         ::Instana::Instrumentation::ResqueClient)
-  end
-
-  if ::Instana.config[:'resque-worker'][:enabled]
-    ::Instana.logger.debug 'Instrumenting Resque Worker'
-
-    ::Instana::Util.send_include(::Resque::Worker, ::Instana::Instrumentation::ResqueWorker)
-    ::Instana::Util.send_include(::Resque::Job,    ::Instana::Instrumentation::ResqueJob)
-
-    ::Resque.before_fork do |job|
-      ::Instana.agent.before_resque_fork
-    end
-    ::Resque.after_fork do |job|
-      ::Instana.agent.after_resque_fork
-    end
-
-    # Set this so we assure that any remaining collected traces are reported at_exit
-    ENV['RUN_AT_EXIT_HOOKS'] = "1"
-  end
-end

data/lib/instana/instrumentation/rest-client.rb

@@ -1,34 +1,22 @@
+# (c) Copyright IBM Corp. 2021
+# (c) Copyright Instana Inc. 2016
+
 module Instana
   module Instrumentation
     module RestClientRequest
-      def self.included(klass)
-        if klass.method_defined?(:execute)
-          klass.class_eval do
-            alias execute_without_instana execute
-            alias execute execute_with_instana
-          end
-        end
-      end
-
-      def execute_with_instana & block
+      def execute(&block)
         # Since RestClient uses net/http under the covers, we just
         # provide span visibility here.  HTTP related KVs are reported
         # in the Net::HTTP instrumentation
         ::Instana.tracer.log_entry(:'rest-client')
 
-        execute_without_instana(&block)
+        super(&block)
       rescue => e
         ::Instana.tracer.log_error(e)
         raise
       ensure
         ::Instana.tracer.log_exit(:'rest-client')
       end
-
     end
   end
 end
-
-if defined?(::RestClient::Request) && ::Instana.config[:'rest-client'][:enabled]
-  ::Instana.logger.debug "Instrumenting RestClient"
-  ::RestClient::Request.send(:include, ::Instana::Instrumentation::RestClientRequest)
-end

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
+        }.reject { |_, v| v.nil? }
+      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/instrumentation/sidekiq-client.rb

@@ -1,10 +1,13 @@
+# (c) Copyright IBM Corp. 2021
+# (c) Copyright Instana Inc. 2017
+
 module Instana
   module Instrumentation
     class SidekiqClient
       def call(worker_class, msg, queue, _redis_pool)
         kv_payload = { :'sidekiq-client' => {} }
         kv_payload[:'sidekiq-client'][:queue] = queue
-        kv_payload[:'sidekiq-client'][:job] = worker_class
+        kv_payload[:'sidekiq-client'][:job] = worker_class.to_s
         kv_payload[:'sidekiq-client'][:retry] = msg['retry'].to_s
         ::Instana.tracer.log_entry(:'sidekiq-client', kv_payload)
 
@@ -34,12 +37,3 @@ module Instana
     end
   end
 end
-
-if defined?(::Sidekiq) && ::Instana.config[:'sidekiq-client'][:enabled]
-  ::Sidekiq.configure_client do |cfg|
-    cfg.client_middleware do |chain|
-      ::Instana.logger.debug "Instrumenting Sidekiq client"
-      chain.add ::Instana::Instrumentation::SidekiqClient
-    end
-  end
-end

data/lib/instana/instrumentation/sidekiq-worker.rb

@@ -1,3 +1,6 @@
+# (c) Copyright IBM Corp. 2021
+# (c) Copyright Instana Inc. 2017
+
 module Instana
   module Instrumentation
     class SidekiqWorker
@@ -5,7 +8,7 @@ module Instana
         kv_payload = { :'sidekiq-worker' => {} }
         kv_payload[:'sidekiq-worker'][:job_id] = msg['jid']
         kv_payload[:'sidekiq-worker'][:queue] = msg['queue']
-        kv_payload[:'sidekiq-worker'][:job] = msg['class']
+        kv_payload[:'sidekiq-worker'][:job] = msg['class'].to_s
         kv_payload[:'sidekiq-worker'][:retry] = msg['retry'].to_s
 
         # Temporary until we move connection collection to redis
@@ -43,12 +46,3 @@ module Instana
     end
   end
 end
-
-if defined?(::Sidekiq) && ::Instana.config[:'sidekiq-worker'][:enabled]
-  ::Sidekiq.configure_server do |cfg|
-    cfg.server_middleware do |chain|
-      ::Instana.logger.debug "Instrumenting Sidekiq worker"
-      chain.add ::Instana::Instrumentation::SidekiqWorker
-    end
-  end
-end

data/lib/instana/instrumented_logger.rb

@@ -0,0 +1,26 @@
+# (c) Copyright IBM Corp. 2021
+# (c) Copyright Instana Inc. 2021
+
+module Instana
+  class InstrumentedLogger < Logger
+    LEVEL_LABELS = %w[Debug Info Warn Error Fatal Any].freeze
+
+    def instana_log_level
+      WARN
+    end
+
+    def add(severity, message = nil, progname = nil)
+      severity ||= UNKNOWN
+
+      if severity >= instana_log_level && ::Instana.tracer.tracing?
+        tags = {
+          level: LEVEL_LABELS[severity],
+          message: "#{message} #{progname}".strip
+        }
+        Instana::Tracer.trace(:log, {log: tags}) {}
+      end
+
+      super(severity, message, progname)
+    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/carrier.rb

@@ -0,0 +1,7 @@
+# (c) Copyright IBM Corp. 2021
+# (c) Copyright Instana Inc. 2017
+
+module OpenTracing
+  class Carrier < Hash
+  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/rack.rb

@@ -7,4 +7,8 @@
 # require 'instana/rack'
 # config.middleware.use ::Instana::Rack
 #
+
+# (c) Copyright IBM Corp. 2021
+# (c) Copyright Instana Inc. 2016
+
 require 'instana/instrumentation/rack'

data/lib/instana/secrets.rb

@@ -0,0 +1,59 @@
+# (c) Copyright IBM Corp. 2021
+# (c) Copyright Instana Inc. 2021
+
+require 'uri'
+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 && str
+
+      begin
+        url = URI(str)
+        params = url.scheme ? CGI.parse(url.query || '') : CGI.parse(url.to_s)
+
+        redacted = redact(params, secret_values)
+
+        url.query = URI.encode_www_form(redacted)
+        url.scheme ? CGI.unescape(url.to_s) : CGI.unescape(url.query)
+      rescue URI::InvalidURIError => _e
+        params = CGI.parse(str || '')
+        redacted = redact(params, secret_values)
+        CGI.unescape(URI.encode_www_form(redacted))
+      end
+    end
+
+    private
+
+    def redact(params, secret_values)
+      params.map do |k, v|
+        needs_redaction = secret_values['list']
+          .any? { |t| matcher(secret_values['matcher']).(t,k) }
+        [k, needs_redaction ? '<redacted>' : v]
+      end
+    end
+
+    def matcher(name)
+      case name
+      when 'equals-ignore-case'
+        ->(expected, actual) { expected.casecmp(actual) == 0 }
+      when 'equals'
+        ->(expected, actual) { (expected <=> actual) == 0 }
+      when 'contains-ignore-case'
+        ->(expected, actual) { actual.downcase.include?(expected) }
+      when 'contains'
+        ->(expected, actual) { actual.include?(expected) }
+      when 'regex'
+        ->(expected, actual) { !Regexp.new(expected).match(actual).nil? }
+      else
+        @logger.warn("Matcher #{name} is not supported.")
+        ->(_e, _a) { false }
+      end
+    end
+  end
+end

data/lib/instana/serverless.rb

@@ -0,0 +1,160 @@
+# (c) Copyright IBM Corp. 2021
+# (c) Copyright Instana Inc. 2021
+
+require 'base64'
+require 'zlib'
+
+# :nocov:
+begin
+  require 'instana/instrumentation/instrumented_request'
+rescue LoadError => _e
+  Instana.logger.warn("Unable to Instana::InstrumentedRequest. HTTP based triggers won't generate spans.")
+end
+# :nocov:
+
+module Instana
+  # @since 1.198.0
+  class Serverless
+    def initialize(agent: ::Instana.agent, tracer: ::Instana.tracer, logger: ::Instana.logger)
+      @agent = agent
+      @tracer = tracer
+      @logger = logger
+    end
+
+    def wrap_aws(event, context, &block)
+      Thread.current[:instana_function_arn] = [context.invoked_function_arn, context.function_version].join(':')
+      trigger, event_tags, span_context = trigger_from_event(event, context)
+
+      tags = {
+        lambda: {
+          arn: context.invoked_function_arn,
+          functionName: context.function_name,
+          functionVersion: context.function_version,
+          runtime: 'ruby',
+          trigger: trigger
+        }
+      }
+
+      if event_tags.key?(:http)
+        tags = tags.merge(event_tags)
+      else
+        tags[:lambda] = tags[:lambda].merge(event_tags)
+      end
+
+      @tracer.start_or_continue_trace(:'aws.lambda.entry', tags, span_context, &block)
+    ensure
+      begin
+        @agent.send_bundle
+      rescue StandardError => e
+        @logger.error(e.message)
+      end
+      Thread.current[:instana_function_arn] = nil
+    end
+
+    private
+
+    def trigger_from_event(event, context) # rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+      case event
+      when ->(e) { defined?(::Instana::InstrumentedRequest) && e.is_a?(Hash) && e.key?('requestContext') && e['requestContext'].key?('elb') }
+        request = InstrumentedRequest.new(event_to_rack(event))
+        ['aws:application.load.balancer', {http: request.request_tags}, request.incoming_context]
+      when ->(e) { defined?(::Instana::InstrumentedRequest) && e.is_a?(Hash) && e.key?('httpMethod') && e.key?('path') && e.key?('headers') }
+        request = InstrumentedRequest.new(event_to_rack(event))
+        ['aws:api.gateway', {http: request.request_tags}, request.incoming_context]
+      when ->(e) { e.is_a?(Hash) && e['source'] == 'aws.events' && e['detail-type'] == 'Scheduled Event' }
+        tags = decode_cloudwatch_events(event)
+        ['aws:cloudwatch.events', {cw: tags}, {}]
+      when ->(e) { e.is_a?(Hash) && e.key?('awslogs') }
+        tags = decode_cloudwatch_logs(event)
+        ['aws:cloudwatch.logs', {cw: tags}, {}]
+      when ->(e) { e.is_a?(Hash) && e.key?('Records') && e['Records'].is_a?(Array) && e['Records'].first && e['Records'].first['source'] == 'aws:s3' }
+        tags = decode_s3(event)
+        ['aws:s3', {s3: tags}, {}]
+      when ->(e) { e.is_a?(Hash) && e.key?('Records') && e['Records'].is_a?(Array) && e['Records'].first && e['Records'].first['source'] == 'aws:sqs' }
+        tags = decode_sqs(event)
+        ['aws:sqs', {sqs: tags}, {}]
+      else
+        ctx = context_from_lambda_context(context)
+        if ctx.empty?
+          ['aws:api.gateway.noproxy', {}, {}]
+        else
+          ['aws.lambda.invoke', {}, ctx]
+        end
+      end
+    end
+
+    def context_from_lambda_context(context)
+      return {} unless context.client_context
+
+      begin
+        context = JSON.parse(Base64.decode64(context.client_context))
+
+        {
+          trace_id: context['X-INSTANA-T'],
+          span_id: context['X-INSTANA-S'],
+          level: Integer(context['X-INSTANA-L'])
+        }
+      rescue TypeError, JSON::ParserError, NoMethodError => _e
+        {}
+      end
+    end
+
+    def event_to_rack(event)
+      event['headers']
+        .transform_keys { |k| "HTTP_#{k.gsub('-', '_').upcase}" }
+        .merge(
+          'QUERY_STRING' => URI.encode_www_form(event['queryStringParameters'] || {}),
+          'PATH_INFO' => event['path'],
+          'REQUEST_METHOD' => event['httpMethod']
+        )
+    end
+
+    def decode_cloudwatch_events(event)
+      {
+        events: {
+          id: event['id'],
+          resources: event['resources']
+        }
+      }
+    end
+
+    def decode_cloudwatch_logs(event)
+      logs = begin
+        payload = JSON.parse(Zlib::Inflate.inflate(Base64.decode64(event['awslogs']['data'])))
+
+        {
+          group: payload['logGroup'],
+          stream: payload['logStream']
+        }
+      rescue StandardError => e
+        {
+          decodingError: e.message
+        }
+      end
+
+      {logs: logs}
+    end
+
+    def decode_s3(event)
+      span_events = event['Records'].map do |record|
+        {
+          name: record['eventName'],
+          bucket: record['s3'] && record['s3']['bucket'] ? record['s3']['bucket']['name'] : nil,
+          object: record['s3'] && record['s3']['object'] ? record['s3']['object']['key'] : nil
+        }
+      end
+
+      {events: span_events}
+    end
+
+    def decode_sqs(event)
+      span_events = event['Records'].map do |record|
+        {
+          queue: record['eventSourceARN']
+        }
+      end
+
+      {messages: span_events}
+    end
+  end
+end