instana 1.217.0 → 2.0.0

data/lib/instana/samplers/samplers.rb

@@ -0,0 +1,76 @@
+# (c) Copyright IBM Corp. 2025
+require 'instana/samplers/result'
+module Instana
+  module Trace
+    # The Samplers module contains the sampling logic for OpenTelemetry. The
+    # reference implementation provides a {TraceIdRatioBased}, {ALWAYS_ON},
+    # {ALWAYS_OFF}, and {ParentBased}.
+    #
+    # Custom samplers can be provided by SDK users. The required interface is:
+    #
+    #   should_sample?(trace_id:, parent_context:, links:, name:, kind:, attributes:) -> Result
+    #   description -> String
+    #
+    # Where:
+    #
+    # @param [String] trace_id The trace_id of the {Span} to be created.
+    # @param [OpenTelemetry::Context] parent_context The
+    #   {OpenTelemetry::Context} with a parent {Span}. The {Span}'s
+    #   {OpenTelemetry::Trace::SpanContext} may be invalid to indicate a
+    #   root span.
+    # @param [Enumerable<Link>] links A collection of links to be associated
+    #   with the {Span} to be created. Can be nil.
+    # @param [String] name Name of the {Span} to be created.
+    # @param [Symbol] kind The {OpenTelemetry::Trace::SpanKind} of the {Span}
+    #   to be created. Can be nil.
+    # @param [Hash<String, Object>] attributes Attributes to be attached
+    #   to the {Span} to be created. Can be nil.
+    # @return [Result] The sampling result.
+    module Samplers
+      # Returns a {Result} with {Decision::RECORD_AND_SAMPLE}.
+      ALWAYS_ON = false
+      # # Returns a {Result} with {Decision::DROP}.
+      ALWAYS_OFF = true
+
+      # Returns a new sampler. It delegates to samplers according to the following rules:
+      #
+      # | Parent | parent.remote? | parent.trace_flags.sampled? | Invoke sampler |
+      # |--|--|--|--|
+      # | absent | n/a | n/a | root |
+      # | present | true | true | remote_parent_sampled |
+      # | present | true | false | remote_parent_not_sampled |
+      # | present | false | true | local_parent_sampled |
+      # | present | false | false | local_parent_not_sampled |
+      #
+      # @param [Sampler] root The sampler to which the sampling
+      #   decision is delegated for spans with no parent (root spans).
+      # @param [optional Sampler] remote_parent_sampled The sampler to which the sampling
+      #   decision is delegated for remote parent sampled spans. Defaults to ALWAYS_ON.
+      # @param [optional Sampler] remote_parent_not_sampled The sampler to which the sampling
+      #   decision is delegated for remote parent not sampled spans. Defaults to ALWAYS_OFF.
+      # @param [optional Sampler] local_parent_sampled The sampler to which the sampling
+      #   decision is delegated for local parent sampled spans. Defaults to ALWAYS_ON.
+      # @param [optional Sampler] local_parent_not_sampled The sampler to which the sampling
+      #   decision is delegated for local parent not sampld spans. Defaults to ALWAYS_OFF.
+      def self.parent_based(_)
+        self
+      end
+
+      # Returns a new sampler. The ratio describes the proportion of the trace ID
+      # space that is sampled.
+      #
+      # @param [Numeric] ratio The desired sampling ratio.
+      #   Must be within [0.0, 1.0].
+      # @raise [ArgumentError] if ratio is out of range
+      def self.trace_id_ratio_based(_)
+        self
+      end
+
+      def self.should_sample?(trace_id:, parent_context:, links:, name:, kind:, attributes:) # rubocop:disable Metrics/ParameterLists, Lint/UnusedMethodArgument:
+        parent_span_context = OpenTelemetry::Trace.current_span(parent_context).context
+        tracestate = parent_span_context&.tracestate
+        Result.new(decision: :__record_only__, tracestate: tracestate)
+      end
+    end
+  end
+end

data/lib/instana/serverless.rb

@@ -42,8 +42,10 @@ module Instana
       else
         tags[:lambda] = tags[:lambda].merge(event_tags)
       end
-
-      @tracer.start_or_continue_trace(:'aws.lambda.entry', tags, span_context, &block)
+      Trace.with_span(OpenTelemetry::Trace.non_recording_span(::Instana::SpanContext.new(trace_id: span_context[:trace_id], span_id: span_context[:span_id],
+                                                                                         level: span_context[:level]))) do
+        @tracer.in_span(:'aws.lambda.entry', attributes: tags, &block)
+      end
     ensure
       begin
         @agent.send_bundle

data/lib/instana/setup.rb

@@ -11,8 +11,8 @@ require 'instana/instrumented_logger'
 require "instana/base"
 require "instana/config"
 require "instana/secrets"
-require "instana/tracer"
-require "instana/tracing/processor"
+require "instana/trace/tracer"
+require "instana/trace/processor"
 
 require 'instana/serverless'
 
@@ -39,13 +39,12 @@ require 'instana/backend/host_agent_reporting_observer'
 require 'instana/backend/host_agent'
 require 'instana/backend/serverless_agent'
 require 'instana/backend/agent'
+require 'instana/trace'
+require 'instana/trace/tracer_provider'
 
 ::Instana.setup
 ::Instana.agent.setup
 
-# Require supported OpenTracing interfaces
-require "opentracing"
-
 # The Instana agent is now setup.  The only remaining
 # task for a complete boot is to call
 # `Instana.agent.start` in the thread of your choice.

data/lib/instana/trace/export.rb

@@ -0,0 +1,36 @@
+# (c) Copyright IBM Corp. 2025
+
+module Instana
+  module Trace
+    # The Export module contains the built-in exporters and span processors for the OpenTelemetry
+    # reference implementation.
+    module Export
+      # Raised when an export fails; spans are available via :spans accessor
+      class ExportError < OpenTelemetry::Error
+        # Returns the {Span} array for this exception
+        #
+        # @return [Array<OpenTelemetry::SDK::Trace::Span>]
+        attr_reader :spans
+
+        # @param [Array<OpenTelemetry::SDK::Trace::Span>] spans the array of spans that failed to export
+        def initialize(spans)
+          super("Unable to export #{spans.size} spans")
+          @spans = spans
+        end
+      end
+
+      # Result codes for the SpanExporter#export method and the SpanProcessor#force_flush and SpanProcessor#shutdown methods.
+
+      # The operation finished successfully.
+      SUCCESS = 0
+
+      # The operation finished with an error.
+      FAILURE = 1
+
+      # Additional result code for the SpanProcessor#force_flush and SpanProcessor#shutdown methods.
+
+      # The operation timed out.
+      TIMEOUT = 2
+    end
+  end
+end

data/lib/instana/{tracing → trace}/processor.rb

@@ -1,7 +1,6 @@
 # (c) Copyright IBM Corp. 2021
 # (c) Copyright Instana Inc. 2016
 
-require 'thread'
 require 'forwardable'
 
 module Instana
@@ -25,10 +24,13 @@ module Instana
       @spans_closed = Concurrent::AtomicFixnum.new(0)
     end
 
-    # Adds a span to the span queue
-    #
-    # @param [Trace] - the trace to be added to the queue
-    def add_span(span)
+    # Note that we've started a new span. Used to
+    # generate monitoring metrics.
+    def on_start(_)
+      @spans_opened.increment
+    end
+
+    def on_finish(span)
       # :nocov:
       if @pid != Process.pid
         @logger.info("Proces `#{@pid}` has forked into #{Process.pid}. Running post fork hook.")
@@ -41,12 +43,6 @@ module Instana
       @queue.push(span)
     end
 
-    # Note that we've started a new span. Used to
-    # generate monitoring metrics.
-    def start_span(_)
-      @spans_opened.increment
-    end
-
     # Clears and retrieves metrics associated with span creation and submission
     def span_metrics
       response = {
@@ -94,9 +90,13 @@ module Instana
       return [] if @queue.empty?
 
       spans = []
-      until @queue.empty? do
+      until @queue.empty?
         # Non-blocking pop; ignore exception
-        span = @queue.pop(true) rescue nil
+        span = begin
+          @queue.pop(true)
+        rescue
+          nil
+        end
         spans << span.raw if span.is_a?(Span) && span.context.level == 1
       end
 
@@ -110,9 +110,13 @@ module Instana
       @spans_opened.value = 0
       @spans_closed.value = 0
 
-      until @queue.empty? do
+      until @queue.empty?
         # Non-blocking pop; ignore exception
-        @queue.pop(true) rescue nil
+        begin
+          @queue.pop(true)
+        rescue
+          nil
+        end
       end
     end
   end