instana 1.217.1 → 2.0.0

data/lib/instana/instrumentation/active_job.rb

@@ -1,5 +1,19 @@
 # (c) Copyright IBM Corp. 2021
 # (c) Copyright Instana Inc. 2021
+module OpenTelemetry
+  module Trace
+    module Propagation
+      module TraceContext
+        # A TraceParent is an implementation of the W3C trace context specification
+        # https://www.w3.org/TR/trace-context/
+        # {Trace::SpanContext}
+        class TraceParent
+          REGEXP = /^(?<version>[A-Fa-f0-9]{2})-(?<trace_id>[A-Fa-f0-9]{32})-(?<span_id>[A-Fa-f0-9]{32})-(?<flags>[A-Fa-f0-9]{2})(?<ignored>-.*)?$/
+        end
+      end
+    end
+  end
+end
 
 module Instana
   module Instrumentation
@@ -15,7 +29,7 @@ module Instana
             }
           }
 
-          ::Instana::Tracer.trace(:activejob, tags) do
+          ::Instana.tracer.in_span(:activejob, attributes: tags) do
             context = ::Instana.tracer.context
             job.arguments.append({
                                    instana_context: context ? context.to_hash : nil
@@ -37,11 +51,12 @@ module Instana
           incoming_context = if job.arguments.is_a?(Array) && job.arguments.last.is_a?(Hash) && job.arguments.last.key?(:instana_context)
                                instana_context = job.arguments.last[:instana_context]
                                job.arguments.pop
-                               instana_context ? ::Instana::SpanContext.new(instana_context[:trace_id], instana_context[:span_id]) : nil
+                               instana_context ? ::Instana::SpanContext.new(trace_id: instana_context[:trace_id], span_id: instana_context[:span_id]) : nil
                              end
-
-          ::Instana::Tracer.start_or_continue_trace(:activejob, tags, incoming_context) do
-            block.call
+          Trace.with_span(OpenTelemetry::Trace.non_recording_span(incoming_context)) do
+            ::Instana.tracer.in_span(:activejob, attributes: tags) do
+              block.call
+            end
           end
         end
       end

data/lib/instana/instrumentation/active_record.rb

@@ -35,7 +35,7 @@ module Instana
 
       def maybe_trace(call_payload, name, &blk)
         if ::Instana.tracer.tracing? && !ignored?(call_payload, name)
-          ::Instana.tracer.trace(:activerecord, call_payload, &blk)
+          ::Instana.tracer.in_span(:activerecord, attributes: call_payload, &blk)
         else
           yield
         end

data/lib/instana/instrumentation/aws_sdk_dynamodb.rb

@@ -11,7 +11,7 @@ module Instana
             table: table_name_from(context)
           }
 
-          ::Instana.tracer.trace(:dynamodb, {dynamodb: dynamo_tags}) { @handler.call(context) }
+          ::Instana.tracer.in_span(:dynamodb, attributes: {dynamodb: dynamo_tags}) { @handler.call(context) }
         end
 
         private

data/lib/instana/instrumentation/aws_sdk_lambda.rb

@@ -25,7 +25,7 @@ module Instana
             type: context.params[:invocation_type]
           }.reject { |_, v| v.nil? }
 
-          ::Instana.tracer.start_or_continue_trace(:"aws.lambda.invoke", {aws: {lambda: {invoke: tags}}}) do
+          ::Instana.tracer.in_span(:"aws.lambda.invoke", attributes: {aws: {lambda: {invoke: tags}}}) do
             response = @handler.call(context)
             if response.respond_to? :status_code
               ::Instana.tracer.log_info(:http => {:status => response.status_code })

data/lib/instana/instrumentation/aws_sdk_s3.rb

@@ -12,7 +12,7 @@ module Instana
             key: key_from_context(context)
           }.reject { |_, v| v.nil? }
 
-          ::Instana.tracer.trace(:s3, {s3: s3_tags}) { @handler.call(context) }
+          ::Instana.tracer.in_span(:s3, attributes: {s3: s3_tags}) { @handler.call(context) }
         end
 
         private

data/lib/instana/instrumentation/aws_sdk_sns.rb

@@ -14,7 +14,7 @@ module Instana
           }.reject { |_, v| v.nil? }
 
           if context.operation_name == :publish
-            ::Instana.tracer.trace(:sns, {sns: sns_tags}) { @handler.call(context) }
+            ::Instana.tracer.in_span(:sns, attributes: {sns: sns_tags}) { @handler.call(context) }
           else
             @handler.call(context)
           end

data/lib/instana/instrumentation/aws_sdk_sqs.rb

@@ -15,7 +15,7 @@ module Instana
 
           span_tags = tags_for(context.operation_name, context.params).reject { |_, v| v.nil? }
 
-          ::Instana.tracer.trace(:sqs, {sqs: span_tags}) do |span|
+          ::Instana.tracer.in_span(:sqs, attributes: {sqs: span_tags}) do |span|
             case context.operation_name
             when :send_message
               inject_instana_headers(span, context.params)

data/lib/instana/instrumentation/dalli.rb

@@ -17,7 +17,7 @@ module Instana
         entry_payload[:memcache][:command] = op
         entry_payload[:memcache][:key] = key
 
-        ::Instana.tracer.log_entry(:memcache, entry_payload)
+        ::Instana.tracer.start_span(:memcache, attributes: entry_payload)
         exit_payload = { :memcache => {} }
 
         result = super(*args, &blk)

data/lib/instana/instrumentation/excon.rb

@@ -16,10 +16,10 @@ module Instana
         if datum[:pipeline] == true
           # Pass the context along in the datum so we get back on response
           # and can close out the async span
-          datum[:instana_span] = ::Instana.tracer.log_async_entry(:excon, payload)
+          datum[:instana_span] = ::Instana.tracer.start_span(:excon, attributes: payload)
           t_context = datum[:instana_span].context
         else
-          ::Instana.tracer.log_entry(:excon, payload)
+          ::Instana.tracer.start_span(:excon, attributes: payload)
           t_context = ::Instana.tracer.context
         end
 

data/lib/instana/instrumentation/graphql.rb

@@ -35,13 +35,13 @@ module Instana
         }
 
         begin
-          ::Instana.tracer.log_entry(:'graphql.server')
+          span = ::Instana.tracer.start_span(:'graphql.server', attributes: {graphql: payload})
           yield
         rescue Exception => e
-          ::Instana.tracer.log_error(e)
+          span.record_exception(e)
           raise e
         ensure
-          ::Instana.tracer.log_exit(:'graphql.server', {graphql: payload})
+          span.finish
         end
       end
 

data/lib/instana/instrumentation/grpc.rb

@@ -22,7 +22,7 @@ module Instana
             kvs[:rpc][:call] = method
             kvs[:rpc][:call_type] = call_type
 
-            ::Instana.tracer.log_entry(:'rpc-client', kvs)
+            current_span = ::Instana.tracer.start_span(:'rpc-client', attributes: kvs)
 
             context = ::Instana.tracer.context
             if context
@@ -35,11 +35,11 @@ module Instana
             super(method, *others, **options)
           rescue => e
             kvs[:rpc][:error] = true
-            ::Instana.tracer.log_info(kvs)
-            ::Instana.tracer.log_error(e)
+            current_span.set_tags(kvs)
+            current_span.record_exception(e)
             raise
           ensure
-            ::Instana.tracer.log_exit(:'rpc-client', {})
+            current_span.finish
           end
         end
       end
@@ -60,9 +60,9 @@ module Instana
 
             incoming_context = {}
             if metadata.key?('x-instana-t')
-              incoming_context[:trace_id]  = ::Instana::Util.header_to_id(metadata['x-instana-t'])
-              incoming_context[:span_id]   = ::Instana::Util.header_to_id(metadata['x-instana-s']) if metadata.key?('x-instana-s')
-              incoming_context[:level]     = metadata['x-instana-l'] if metadata.key?('x-instana-l')
+              incoming_context = SpanContext.new(trace_id: ::Instana::Util.header_to_id(metadata['x-instana-t']),
+                                                 span_id: metadata.key?('x-instana-s') ? ::Instana::Util.header_to_id(metadata['x-instana-s']) : nil,
+                                                 level: metadata.key?('x-instana-l') ? metadata['x-instana-l'] : nil)
             end
 
             kvs[:rpc][:flavor] = :grpc
@@ -71,18 +71,19 @@ module Instana
             kvs[:rpc][:call_type] = call_type
             kvs[:rpc][:peer] = { address: active_call.peer }
 
-            ::Instana.tracer.log_start_or_continue(
-              :'rpc-server', kvs, incoming_context
-            )
+            span = OpenTelemetry::Trace.non_recording_span(incoming_context) if incoming_context
+            parent_context = Trace.context_with_span(span) if incoming_context
+
+            current_span = ::Instana.tracer.start_span(:'rpc-server', attributes: kvs, with_parent: parent_context)
 
             super(active_call, mth, *others)
           rescue => e
             kvs[:rpc][:error] = true
-            ::Instana.tracer.log_info(kvs)
-            ::Instana.tracer.log_error(e)
+            current_span.set_tags(kvs)
+            current_span.record_exception(e)
             raise
           ensure
-            ::Instana.tracer.log_end(:'rpc-server', {}) if ::Instana.tracer.tracing?
+            current_span.finish if ::Instana.tracer.tracing?
           end
         end
       end

data/lib/instana/instrumentation/mongo.rb

@@ -20,19 +20,19 @@ module Instana
         json: filter_statement(event.command)
       }
 
-      @requests[event.request_id] = ::Instana.tracer.log_async_entry(:mongo, {mongo: tags})
+      @requests[event.request_id] = ::Instana.tracer.start_span(:mongo, attributes: {mongo: tags})
     end
 
     def failed(event)
       span = @requests.delete(event.request_id)
       span.add_error(Exception.new(event.message))
 
-      ::Instana.tracer.log_async_exit(:mongo, {}, span)
+      span.finish
     end
 
     def succeeded(event)
       span = @requests.delete(event.request_id)
-      ::Instana.tracer.log_async_exit(:mongo, {}, span)
+      span.finish
     end
 
     private

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

@@ -12,7 +12,7 @@ module Instana
           return super(*args, &block)
         end
 
-        ::Instana.tracer.log_entry(:'net-http')
+        current_span = ::Instana.tracer.start_span(:'net-http')
 
         # Send out the tracing context with the request
         request = args[0]
@@ -54,15 +54,16 @@ module Instana
         if response.code.to_i >= 500
           # Because of the 5xx response, we flag this span as errored but
           # without a backtrace (no exception)
-          ::Instana.tracer.log_error(nil)
+          current_span.record_exception(nil)
         end
 
         response
       rescue => e
-        ::Instana.tracer.log_error(e)
+        current_span&.record_exception(e)
         raise
       ensure
-        ::Instana.tracer.log_exit(:'net-http', kv_payload) unless do_skip
+        current_span&.set_tags(kv_payload)
+        current_span&.finish unless do_skip
       end
 
       def skip_instrumentation?

data/lib/instana/instrumentation/rack.rb

@@ -10,14 +10,20 @@ module Instana
       @app = app
     end
 
-    def call(env)
+    def call(env) # rubocop:disable Metrics/CyclomaticComplexity,Metrics/MethodLength
       req = InstrumentedRequest.new(env)
       kvs = {
         http: req.request_tags
       }.reject { |_, v| v.nil? }
 
-      current_span = ::Instana.tracer.log_start_or_continue(:rack, {}, req.incoming_context)
+      parent_context = extract_trace_context(req.incoming_context)
 
+      span = OpenTelemetry::Trace.non_recording_span(parent_context) if parent_context
+      parent_context = Trace.context_with_span(span) if parent_context
+
+      current_span = ::Instana.tracer.start_span(:rack, attributes: {}, with_parent: parent_context)
+      trace_ctx = OpenTelemetry::Trace.context_with_span(current_span)
+      @trace_token = OpenTelemetry::Context.attach(trace_ctx)
       status, headers, response = @app.call(env)
 
       if ::Instana.tracer.tracing?
@@ -66,7 +72,7 @@ module Instana
 
       [status, headers, response]
     rescue Exception => e
-      ::Instana.tracer.log_error(e) if ::Instana.tracer.tracing?
+      current_span.record_exception(e) if ::Instana.tracer.tracing?
       raise
     ensure
       if ::Instana.tracer.tracing?
@@ -85,9 +91,35 @@ module Instana
           headers['Traceparent'] = trace_context.trace_parent_header
           headers['Server-Timing'] = "intid;desc=#{trace_context.trace_id_header}"
         end
+        current_span.set_tags(kvs)
+        OpenTelemetry::Context.detach(@trace_token) if @trace_token
+        current_span.finish
+      end
+    end
+
+    private
 
-        ::Instana.tracer.log_end(:rack, kvs)
+    def extract_trace_context(incoming_context)
+      return nil unless incoming_context
+
+      parent_context = nil
+
+      if incoming_context.is_a?(Hash)
+        unless incoming_context.empty?
+          parent_context = SpanContext.new(
+            trace_id: incoming_context[:trace_id],
+            span_id: incoming_context[:span_id],
+            level: incoming_context[:level],
+            baggage: {
+              external_trace_id: incoming_context[:external_trace_id],
+              external_state: incoming_context[:external_state]
+            }
+          )
+        end
+      elsif incoming_context.is_a?(SpanContext)
+        parent_context = incoming_context
       end
+      parent_context
     end
   end
 end

data/lib/instana/instrumentation/redis.rb

@@ -66,7 +66,7 @@ module Instana
       kv_payload = { redis: {} }
 
       begin
-        ::Instana.tracer.log_entry(:redis)
+        ::Instana.tracer.start_span(:redis)
 
         begin
           kv_payload[:redis][:connection] = "#{self.host}:#{self.port}"

data/lib/instana/instrumentation/resque.rb

@@ -27,7 +27,7 @@ module Instana
         if Instana.tracer.tracing?
           kvs = collect_kvs(:enqueue, klass, args)
 
-          Instana.tracer.trace(:'resque-client', kvs) do
+          Instana.tracer.in_span(:'resque-client', attributes: kvs) do
             args.push(::Instana.tracer.context.to_hash) if ::Instana.config[:'resque-client'][:propagate]
             super(klass, *args)
           end
@@ -41,7 +41,7 @@ module Instana
           kvs = collect_kvs(:enqueue_to, klass, args)
           kvs[:Queue] = queue.to_s if queue
 
-          Instana.tracer.trace(:'resque-client', kvs) do
+          Instana.tracer.in_span(:'resque-client', attributes: kvs) do
             args.push(::Instana.tracer.context.to_hash) if ::Instana.config[:'resque-client'][:propagate]
             super(queue, klass, *args)
           end
@@ -54,7 +54,7 @@ module Instana
         if Instana.tracer.tracing?
           kvs = collect_kvs(:dequeue, klass, args)
 
-          Instana.tracer.trace(:'resque-client', kvs) do
+          Instana.tracer.in_span(:'resque-client', attributes: kvs) do
             super(klass, *args)
           end
         else
@@ -78,13 +78,15 @@ module Instana
         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']
+                            trace_id: context_from_wire['trace_id'],
+                            span_id: context_from_wire['span_id']
                           )
                         end
-
-        Instana.tracer.start_or_continue_trace(:'resque-worker', kvs, trace_context) do
-          super(job)
+        span = OpenTelemetry::Trace.non_recording_span(trace_context) if trace_context
+        Trace.with_span(span) do
+          Instana.tracer.in_span(:'resque-worker', attributes: kvs) do |span|
+            super(job)
+          end
         end
       end
     end

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

@@ -8,14 +8,14 @@ module Instana
         # 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')
+        span = ::Instana.tracer.start_span(:'rest-client', with_parent: OpenTelemetry::Context.current)
 
-        super(&block)
+        Trace.with_span(span) { super(&block) }
       rescue => e
-        ::Instana.tracer.log_error(e)
+        span.record_exception(e)
         raise
       ensure
-        ::Instana.tracer.log_exit(:'rest-client')
+        span.finish
       end
     end
   end

data/lib/instana/instrumentation/sequel.rb

@@ -3,7 +3,7 @@
 module Instana
   module Instrumentation
     module Sequel
-      IGNORED_SQL = %w[BEGIN COMMIT SET].freeze
+      IGNORED_SQL = %w[BEGIN COMMIT SET PRAGMA].freeze
       VERSION_SELECT_STATEMENT = "SELECT VERSION()".freeze
       SANITIZE_REGEXP = /('[\s\S][^']*'|\d*\.\d+|\d+|NULL)/i
 
@@ -26,9 +26,9 @@ module Instana
         ::Instana.config[:sanitize_sql] ? sql.gsub(SANITIZE_REGEXP, '?') : sql
       end
 
-      def maybe_trace(call_payload, &blk)
+      def maybe_trace(call_payload, &block)
         if ::Instana.tracer.tracing? && !ignored?(call_payload)
-          ::Instana.tracer.trace(:sequel, call_payload, &blk)
+          ::Instana.tracer.in_span(:sequel, attributes: call_payload, &block)
         else
           yield
         end

data/lib/instana/instrumentation/shoryuken.rb

@@ -15,7 +15,10 @@ module Instana
         }
 
         context = incomming_context_from(sqs_message.message_attributes)
-        ::Instana.tracer.start_or_continue_trace(:sqs, {sqs: sqs_tags}, context, &block)
+        instana_context = Instana::SpanContext.new(trace_id: context[:trace_id], span_id: context[:span_id], level: context[:level])
+        Trace.with_span(OpenTelemetry::Trace.non_recording_span(instana_context)) do
+          ::Instana.tracer.in_span(:sqs, attributes: {sqs: sqs_tags}, &block)
+        end
       end
 
       private

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

@@ -5,11 +5,10 @@ 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.to_s
-        kv_payload[:'sidekiq-client'][:retry] = msg['retry'].to_s
-        ::Instana.tracer.log_entry(:'sidekiq-client', kv_payload)
+        kvs = { :'sidekiq-client' => {} }
+        kvs[:'sidekiq-client'][:queue] = queue
+        kvs[:'sidekiq-client'][:job] = worker_class.to_s
+        kvs[:'sidekiq-client'][:retry] = msg['retry'].to_s
 
         # Temporary until we move connection collection to redis
         # instrumentation
@@ -24,24 +23,27 @@ module Instana
                        else # Unexpected version, continue without recording any redis-url
                          break
                        end
-          kv_payload[:'sidekiq-client'][:'redis-url'] = "#{host}:#{port}"
+          kvs[:'sidekiq-client'][:'redis-url'] = "#{host}:#{port}"
         end
 
-        context = ::Instana.tracer.context
-        if context
-          msg['X-Instana-T'] = context.trace_id_header
-          msg['X-Instana-S'] = context.span_id_header
-        end
+        Instana.tracer.in_span(:'sidekiq-client', attributes: kvs) do |span|
+          context = ::Instana.tracer.context
+          if context
+            msg['X-Instana-T'] = context.trace_id_header
+            msg['X-Instana-S'] = context.span_id_header
+          end
+
+          result = yield
 
-        result = yield
+          if result && result['jid']
+            span.set_tag(:'sidekiq-client', { job_id: result['jid'] })
+          end
 
-        kv_payload[:'sidekiq-client'][:job_id] = result['jid']
-        result
-      rescue => e
-        ::Instana.tracer.log_error(e)
-        raise
-      ensure
-        ::Instana.tracer.log_exit(:'sidekiq-client', kv_payload)
+          result
+        rescue => e
+          span.record_exception(e)
+          raise
+        end
       end
     end
   end

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

@@ -5,11 +5,11 @@ module Instana
   module Instrumentation
     class SidekiqWorker
       def call(_worker, msg, _queue)
-        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'].to_s
-        kv_payload[:'sidekiq-worker'][:retry] = msg['retry'].to_s
+        kvs = { :'sidekiq-worker' => {} }
+        kvs[:'sidekiq-worker'][:job_id] = msg['jid']
+        kvs[:'sidekiq-worker'][:queue] = msg['queue']
+        kvs[:'sidekiq-worker'][:job] = msg['class'].to_s
+        kvs[:'sidekiq-worker'][:retry] = msg['retry'].to_s
 
         # Temporary until we move connection collection to redis
         # instrumentation
@@ -24,29 +24,30 @@ module Instana
                        else # Unexpected version, continue without recording any redis-url
                          break
                        end
-          kv_payload[:'sidekiq-worker'][:'redis-url'] = "#{host}:#{port}"
+          kvs[:'sidekiq-worker'][:'redis-url'] = "#{host}:#{port}"
         end
 
-        context = {}
+        trace_context = nil
         if msg.key?('X-Instana-T')
           trace_id = msg.delete('X-Instana-T')
           span_id = msg.delete('X-Instana-S')
-          context[:trace_id] = ::Instana::Util.header_to_id(trace_id)
-          context[:span_id] = ::Instana::Util.header_to_id(span_id) if span_id
+          trace_context = ::Instana::SpanContext.new(
+            trace_id: ::Instana::Util.header_to_id(trace_id),
+            span_id: span_id ? ::Instana::Util.header_to_id(span_id) : nil
+          )
         end
 
-        ::Instana.tracer.log_start_or_continue(
-          :'sidekiq-worker', kv_payload, context
-        )
-
-        yield
-      rescue => e
-        kv_payload[:'sidekiq-worker'][:error] = true
-        ::Instana.tracer.log_info(kv_payload)
-        ::Instana.tracer.log_error(e)
-        raise
-      ensure
-        ::Instana.tracer.log_end(:'sidekiq-worker', {}) if ::Instana.tracer.tracing?
+        parent_non_recording_span = OpenTelemetry::Trace.non_recording_span(trace_context) if trace_context
+        Trace.with_span(parent_non_recording_span) do
+          Instana.tracer.in_span(:'sidekiq-worker', attributes: kvs) do |span|
+            yield
+          rescue => e
+            kvs[:'sidekiq-worker'][:error] = true
+            span.set_tags(kvs)
+            span.record_exception(e)
+            raise
+          end
+        end
       end
     end
   end

data/lib/instana/instrumented_logger.rb

@@ -17,7 +17,7 @@ module Instana
           level: LEVEL_LABELS[severity],
           message: "#{message} #{progname}".strip
         }
-        Instana::Tracer.trace(:log, {log: tags}) {}
+        Instana.tracer.in_span(:log, attributes: {log: tags}) {}
       end
 
       super(severity, message, progname)

data/lib/instana/samplers/result.rb

@@ -0,0 +1,32 @@
+# (c) Copyright IBM Corp. 2025
+
+module Instana
+  module Trace
+    module Samplers
+      class Result
+        EMPTY_HASH = {}.freeze
+        attr_reader :tracestate, :attributes
+
+        def initialize(decision:, tracestate:, attributes: nil)
+          @decision = decision
+          @attributes = attributes.freeze || EMPTY_HASH
+          @tracestate = tracestate
+        end
+
+        # Returns true if this span should be sampled.
+        #
+        # @return FALSE always
+        def sampled?
+          false
+        end
+
+        # Returns true if this span should record events, attributes, status, etc.
+        #
+        # returns TRUE always
+        def recording?
+          true
+        end
+      end
+    end
+  end
+end