ddtrace 0.54.2 → 1.10.1

data/lib/datadog/tracing/configuration/settings.rb

@@ -0,0 +1,451 @@
+require_relative '../../tracing/configuration/ext'
+
+module Datadog
+  module Tracing
+    module Configuration
+      # Configuration settings for tracing.
+      # @public_api
+      # rubocop:disable Metrics/AbcSize
+      # rubocop:disable Metrics/BlockLength
+      # rubocop:disable Metrics/CyclomaticComplexity
+      # rubocop:disable Metrics/MethodLength
+      # rubocop:disable Layout/LineLength
+      module Settings
+        def self.extended(base)
+          base.class_eval do
+            # Tracer specific configurations.
+            # @public_api
+            settings :tracing do
+              # Legacy [App Analytics](https://docs.datadoghq.com/tracing/legacy_app_analytics/) configuration.
+              #
+              # @configure_with {Datadog::Tracing}
+              # @deprecated Use [Trace Retention and Ingestion](https://docs.datadoghq.com/tracing/trace_retention_and_ingestion/)
+              #   controls.
+              # @public_api
+              settings :analytics do
+                # @default `DD_TRACE_ANALYTICS_ENABLED` environment variable, otherwise `nil`
+                # @return [Boolean,nil]
+                option :enabled do |o|
+                  o.default { env_to_bool(Tracing::Configuration::Ext::Analytics::ENV_TRACE_ANALYTICS_ENABLED, nil) }
+                  o.lazy
+                end
+              end
+
+              # [Distributed Tracing](https://docs.datadoghq.com/tracing/setup_overview/setup/ruby/#distributed-tracing) propagation
+              # style configuration.
+              #
+              # The supported formats are:
+              # * `Datadog`: Datadog propagation format, described by [Distributed Tracing](https://docs.datadoghq.com/tracing/setup_overview/setup/ruby/#distributed-tracing).
+              # * `b3multi`: B3 Propagation using multiple headers, described by [openzipkin/b3-propagation](https://github.com/openzipkin/b3-propagation#multiple-headers).
+              # * `b3`: B3 Propagation using a single header, described by [openzipkin/b3-propagation](https://github.com/openzipkin/b3-propagation#single-header).
+              #
+              # @public_api
+              settings :distributed_tracing do
+                # An ordered list of what data propagation styles the tracer will use to extract distributed tracing propagation
+                # data from incoming requests and messages.
+                #
+                # The tracer will try to find distributed headers in the order they are present in the list provided to this option.
+                # The first format to have valid data present will be used.
+                #
+                # @default `DD_TRACE_PROPAGATION_STYLE_EXTRACT` environment variable (comma-separated list),
+                #   otherwise `['Datadog','b3multi','b3']`.
+                # @return [Array<String>]
+                option :propagation_extract_style do |o|
+                  o.default do
+                    # DEV-2.0: Change default value to `tracecontext, Datadog`.
+                    # Look for all headers by default
+                    env_to_list(
+                      [
+                        Tracing::Configuration::Ext::Distributed::ENV_PROPAGATION_STYLE_EXTRACT,
+                        Tracing::Configuration::Ext::Distributed::ENV_PROPAGATION_STYLE_EXTRACT_OLD
+                      ],
+                      [
+                        Tracing::Configuration::Ext::Distributed::PROPAGATION_STYLE_DATADOG,
+                        Tracing::Configuration::Ext::Distributed::PROPAGATION_STYLE_B3_MULTI_HEADER,
+                        Tracing::Configuration::Ext::Distributed::PROPAGATION_STYLE_B3_SINGLE_HEADER
+                      ],
+                      comma_separated_only: true
+                    )
+                  end
+
+                  o.on_set do |styles|
+                    # Modernize B3 options
+                    # DEV-2.0: Can be removed with the removal of deprecated B3 constants.
+                    styles.map! do |style|
+                      case style
+                      when Tracing::Configuration::Ext::Distributed::PROPAGATION_STYLE_B3
+                        Tracing::Configuration::Ext::Distributed::PROPAGATION_STYLE_B3_MULTI_HEADER
+                      when Tracing::Configuration::Ext::Distributed::PROPAGATION_STYLE_B3_SINGLE_HEADER_OLD
+                        Tracing::Configuration::Ext::Distributed::PROPAGATION_STYLE_B3_SINGLE_HEADER
+                      else
+                        style
+                      end
+                    end
+                  end
+
+                  o.lazy
+                end
+
+                # The data propagation styles the tracer will use to inject distributed tracing propagation
+                # data into outgoing requests and messages.
+                #
+                # The tracer will inject data from all styles specified in this option.
+                #
+                # @default `DD_TRACE_PROPAGATION_STYLE_INJECT` environment variable (comma-separated list), otherwise `['Datadog']`.
+                # @return [Array<String>]
+                option :propagation_inject_style do |o|
+                  o.default do
+                    # DEV-2.0: Change default value to `tracecontext, Datadog`.
+                    env_to_list(
+                      [
+                        Tracing::Configuration::Ext::Distributed::ENV_PROPAGATION_STYLE_INJECT,
+                        Tracing::Configuration::Ext::Distributed::ENV_PROPAGATION_STYLE_INJECT_OLD
+                      ],
+                      [Tracing::Configuration::Ext::Distributed::PROPAGATION_STYLE_DATADOG],
+                      comma_separated_only: true # Only inject Datadog headers by default
+                    )
+                  end
+
+                  o.on_set do |styles|
+                    # Modernize B3 options
+                    # DEV-2.0: Can be removed with the removal of deprecated B3 constants.
+                    styles.map! do |style|
+                      case style
+                      when Tracing::Configuration::Ext::Distributed::PROPAGATION_STYLE_B3
+                        Tracing::Configuration::Ext::Distributed::PROPAGATION_STYLE_B3_MULTI_HEADER
+                      when Tracing::Configuration::Ext::Distributed::PROPAGATION_STYLE_B3_SINGLE_HEADER_OLD
+                        Tracing::Configuration::Ext::Distributed::PROPAGATION_STYLE_B3_SINGLE_HEADER
+                      else
+                        style
+                      end
+                    end
+                  end
+
+                  o.lazy
+                end
+
+                # An ordered list of what data propagation styles the tracer will use to extract distributed tracing propagation
+                # data from incoming requests and inject into outgoing requests.
+                #
+                # This configuration is the equivalent of configuring both {propagation_extract_style}
+                # {propagation_inject_style} to value set to {propagation_style}.
+                #
+                # @default `DD_TRACE_PROPAGATION_STYLE` environment variable (comma-separated list).
+                # @return [Array<String>]
+                option :propagation_style do |o|
+                  o.default do
+                    env_to_list(Configuration::Ext::Distributed::ENV_PROPAGATION_STYLE, nil, comma_separated_only: true)
+                  end
+
+                  o.on_set do |styles|
+                    next unless styles
+
+                    # Modernize B3 options
+                    # DEV-2.0: Can be removed with the removal of deprecated B3 constants.
+                    styles.map! do |style|
+                      case style
+                      when Tracing::Configuration::Ext::Distributed::PROPAGATION_STYLE_B3
+                        Tracing::Configuration::Ext::Distributed::PROPAGATION_STYLE_B3_MULTI_HEADER
+                      when Tracing::Configuration::Ext::Distributed::PROPAGATION_STYLE_B3_SINGLE_HEADER_OLD
+                        Tracing::Configuration::Ext::Distributed::PROPAGATION_STYLE_B3_SINGLE_HEADER
+                      else
+                        style
+                      end
+                    end
+
+                    set_option(:propagation_extract_style, styles)
+                    set_option(:propagation_inject_style, styles)
+                  end
+
+                  o.lazy
+                end
+              end
+
+              # Enable trace collection and span generation.
+              #
+              # You can use this option to disable tracing without having to
+              # remove the library as a whole.
+              #
+              # @default `DD_TRACE_ENABLED` environment variable, otherwise `true`
+              # @return [Boolean]
+              option :enabled do |o|
+                o.default { env_to_bool(Tracing::Configuration::Ext::ENV_ENABLED, true) }
+                o.lazy
+              end
+
+              # Enable 128 bit trace id generation.
+              #
+              # @default `DD_TRACE_128_BIT_TRACEID_GENERATION_ENABLED` environment variable, otherwise `false`
+              # @return [Boolean]
+              option :trace_id_128_bit_generation_enabled do |o|
+                o.default { env_to_bool(Tracing::Configuration::Ext::ENV_TRACE_ID_128_BIT_GENERATION_ENABLED, false) }
+                o.lazy
+              end
+
+              # Enable 128 bit trace id injected for logging.
+              #
+              # @default `DD_TRACE_128_BIT_TRACEID_LOGGING_ENABLED` environment variable, otherwise `false`
+              # @return [Boolean]
+              #
+              # It is not supported by our backend yet. Do not enable it.
+              option :trace_id_128_bit_logging_enabled do |o|
+                o.default { env_to_bool(Tracing::Configuration::Ext::Correlation::ENV_TRACE_ID_128_BIT_LOGGING_ENABLED, false) }
+                o.lazy
+              end
+
+              # A custom tracer instance.
+              #
+              # It must respect the contract of {Datadog::Tracing::Tracer}.
+              # It's recommended to delegate methods to {Datadog::Tracing::Tracer} to ease the implementation
+              # of a custom tracer.
+              #
+              # This option will not return the live tracer instance: it only holds a custom tracing instance, if any.
+              #
+              # For internal use only.
+              #
+              # @default `nil`
+              # @return [Object,nil]
+              option :instance
+
+              # Automatic correlation between tracing and logging.
+              # @see https://docs.datadoghq.com/tracing/setup_overview/setup/ruby/#trace-correlation
+              # @return [Boolean]
+              option :log_injection do |o|
+                o.default { env_to_bool(Tracing::Configuration::Ext::Correlation::ENV_LOGS_INJECTION_ENABLED, true) }
+                o.lazy
+              end
+
+              # Configures an alternative trace transport behavior, where
+              # traces can be sent to the agent and backend before all spans
+              # have finished.
+              #
+              # This is useful for long-running jobs or very large traces.
+              #
+              # The trace flame graph will display the partial trace as it is received and constantly
+              # update with new spans as they are flushed.
+              # @public_api
+              settings :partial_flush do
+                # Enable partial trace flushing.
+                #
+                # @default `false`
+                # @return [Boolean]
+                option :enabled, default: false
+
+                # Minimum number of finished spans required in a single unfinished trace before
+                # the tracer will consider that trace for partial flushing.
+                #
+                # This option helps preserve a minimum amount of batching in the
+                # flushing process, reducing network overhead.
+                #
+                # This threshold only applies to unfinished traces. Traces that have finished
+                # are always flushed immediately.
+                #
+                # @default 500
+                # @return [Integer]
+                option :min_spans_threshold, default: 500
+              end
+
+              # Enables {https://docs.datadoghq.com/tracing/trace_retention_and_ingestion/#datadog-intelligent-retention-filter
+              # Datadog intelligent retention filter}.
+              # @default `true`
+              # @return [Boolean,nil]
+              option :priority_sampling
+
+              option :report_hostname do |o|
+                o.default { env_to_bool(Tracing::Configuration::Ext::NET::ENV_REPORT_HOSTNAME, false) }
+                o.lazy
+              end
+
+              # A custom sampler instance.
+              # The object must respect the {Datadog::Tracing::Sampling::Sampler} interface.
+              # @default `nil`
+              # @return [Object,nil]
+              option :sampler
+
+              # Client-side sampling configuration.
+              # @see https://docs.datadoghq.com/tracing/trace_ingestion/mechanisms/
+              # @public_api
+              settings :sampling do
+                # Default sampling rate for the tracer.
+                #
+                # If `nil`, the trace uses an automatic sampling strategy that tries to ensure
+                # the collection of traces that are considered important (e.g. traces with an error, traces
+                # for resources not seen recently).
+                #
+                # @default `DD_TRACE_SAMPLE_RATE` environment variable, otherwise `nil`.
+                # @return [Float,nil]
+                option :default_rate do |o|
+                  o.default { env_to_float(Tracing::Configuration::Ext::Sampling::ENV_SAMPLE_RATE, nil) }
+                  o.lazy
+                end
+
+                # Rate limit for number of spans per second.
+                #
+                # Spans created above the limit will contribute to service metrics, but won't
+                # have their payload stored.
+                #
+                # @default `DD_TRACE_RATE_LIMIT` environment variable, otherwise 100.
+                # @return [Numeric,nil]
+                option :rate_limit do |o|
+                  o.default { env_to_float(Tracing::Configuration::Ext::Sampling::ENV_RATE_LIMIT, 100) }
+                  o.lazy
+                end
+
+                # Single span sampling rules.
+                # These rules allow a span to be kept when its encompassing trace is dropped.
+                #
+                # The syntax for single span sampling rules can be found here:
+                # TODO: <Single Span Sampling documentation URL here>
+                #
+                # @default `DD_SPAN_SAMPLING_RULES` environment variable.
+                #   Otherwise, `ENV_SPAN_SAMPLING_RULES_FILE` environment variable.
+                #   Otherwise `nil`.
+                # @return [String,nil]
+                # @public_api
+                option :span_rules do |o|
+                  o.default do
+                    rules = ENV[Tracing::Configuration::Ext::Sampling::Span::ENV_SPAN_SAMPLING_RULES]
+                    rules_file = ENV[Tracing::Configuration::Ext::Sampling::Span::ENV_SPAN_SAMPLING_RULES_FILE]
+
+                    if rules
+                      if rules_file
+                        Datadog.logger.warn(
+                          'Both DD_SPAN_SAMPLING_RULES and DD_SPAN_SAMPLING_RULES_FILE were provided: only ' \
+                            'DD_SPAN_SAMPLING_RULES will be used. Please do not provide DD_SPAN_SAMPLING_RULES_FILE when ' \
+                            'also providing DD_SPAN_SAMPLING_RULES as their configuration conflicts. ' \
+                            "DD_SPAN_SAMPLING_RULES_FILE=#{rules_file} DD_SPAN_SAMPLING_RULES=#{rules}"
+                        )
+                      end
+                      rules
+                    elsif rules_file
+                      begin
+                        File.read(rules_file)
+                      rescue => e
+                        # `File#read` errors have clear and actionable messages, no need to add extra exception info.
+                        Datadog.logger.warn(
+                          "Cannot read span sampling rules file `#{rules_file}`: #{e.message}." \
+                          'No span sampling rules will be applied.'
+                        )
+                        nil
+                      end
+                    end
+                  end
+                  o.lazy
+                end
+              end
+
+              # [Continuous Integration Visibility](https://docs.datadoghq.com/continuous_integration/) configuration.
+              # @public_api
+              settings :test_mode do
+                # Enable test mode. This allows the tracer to collect spans from test runs.
+                #
+                # It also prevents the tracer from collecting spans in a production environment. Only use in a test environment.
+                #
+                # @default `DD_TRACE_TEST_MODE_ENABLED` environment variable, otherwise `false`
+                # @return [Boolean]
+                option :enabled do |o|
+                  o.default { env_to_bool(Tracing::Configuration::Ext::Test::ENV_MODE_ENABLED, false) }
+                  o.lazy
+                end
+
+                option :trace_flush do |o|
+                  o.default { nil }
+                  o.lazy
+                end
+
+                option :writer_options do |o|
+                  o.default { {} }
+                  o.lazy
+                end
+              end
+
+              # @see file:docs/GettingStarted.md#configuring-the-transport-layer Configuring the transport layer
+              #
+              # A {Proc} that configures a custom tracer transport.
+              # @yield Receives a {Datadog::Transport::HTTP} that can be modified with custom adapters and settings.
+              # @yieldparam [Datadog::Transport::HTTP] t transport to be configured.
+              # @default `nil`
+              # @return [Proc,nil]
+              option :transport_options, default: nil
+
+              # A custom writer instance.
+              # The object must respect the {Datadog::Tracing::Writer} interface.
+              #
+              # This option is recommended for internal use only.
+              #
+              # @default `nil`
+              # @return [Object,nil]
+              option :writer
+
+              # A custom {Hash} with keyword options to be passed to {Datadog::Tracing::Writer#initialize}.
+              #
+              # This option is recommended for internal use only.
+              #
+              # @default `{}`
+              # @return [Hash,nil]
+              option :writer_options, default: ->(_i) { {} }, lazy: true
+
+              # Client IP configuration
+              # @public_api
+              settings :client_ip do
+                # Whether client IP collection is enabled. When enabled client IPs from HTTP requests will
+                #   be reported in traces.
+                #
+                # Usage of the DD_TRACE_CLIENT_IP_HEADER_DISABLED environment variable is deprecated.
+                #
+                # @see https://docs.datadoghq.com/tracing/configure_data_security#configuring-a-client-ip-header
+                #
+                # @default `DD_TRACE_CLIENT_IP_ENABLED` environment variable, otherwise `false`.
+                # @return [Boolean]
+                option :enabled do |o|
+                  o.default do
+                    disabled = env_to_bool(Tracing::Configuration::Ext::ClientIp::ENV_DISABLED)
+
+                    enabled = if disabled.nil?
+                                false
+                              else
+                                Datadog.logger.warn { "#{Tracing::Configuration::Ext::ClientIp::ENV_DISABLED} environment variable is deprecated, found set to #{disabled}, use #{Tracing::Configuration::Ext::ClientIp::ENV_ENABLED}=#{!disabled}" }
+
+                                !disabled
+                              end
+
+                    # ENABLED env var takes precedence over deprecated DISABLED
+                    env_to_bool(Tracing::Configuration::Ext::ClientIp::ENV_ENABLED, enabled)
+                  end
+                  o.lazy
+                end
+
+                # An optional name of a custom header to resolve the client IP from.
+                #
+                # @default `DD_TRACE_CLIENT_IP_HEADER` environment variable, otherwise `nil`.
+                # @return [String,nil]
+                option :header_name do |o|
+                  o.default { ENV.fetch(Tracing::Configuration::Ext::ClientIp::ENV_HEADER_NAME, nil) }
+                  o.lazy
+                end
+              end
+
+              # Maximum size for the `x-datadog-tags` distributed trace tags header.
+              #
+              # If the serialized size of distributed trace tags is larger than this value, it will
+              # not be parsed if incoming, nor exported if outgoing. An error message will be logged
+              # in this case.
+              #
+              # @default `DD_TRACE_X_DATADOG_TAGS_MAX_LENGTH` environment variable, otherwise `512`
+              # @return [Integer]
+              option :x_datadog_tags_max_length do |o|
+                o.default { env_to_int(Tracing::Configuration::Ext::Distributed::ENV_X_DATADOG_TAGS_MAX_LENGTH, 512) }
+                o.lazy
+              end
+            end
+          end
+        end
+      end
+      # rubocop:enable Metrics/AbcSize
+      # rubocop:enable Metrics/BlockLength
+      # rubocop:enable Metrics/CyclomaticComplexity
+      # rubocop:enable Metrics/MethodLength
+      # rubocop:enable Layout/LineLength
+    end
+  end
+end

data/lib/datadog/tracing/context.rb

@@ -0,0 +1,66 @@
+require_relative '../core/utils/forking'
+
+module Datadog
+  module Tracing
+    # {Datadog::Tracing::Context} is used to keep track of a the active trace for the current
+    # execution flow. During each logical execution, the same {Datadog::Tracing::Context} is
+    # used to represent a single logical trace, even if the trace is built
+    # asynchronously.
+    #
+    # A single code execution may use multiple {Datadog::Tracing::Context} if part of the execution
+    # must not be related to the current tracing. As example, a delayed job may
+    # compose a standalone trace instead of being related to the same trace that
+    # generates the job itself. On the other hand, if it's part of the same
+    # {Datadog::Tracing::Context}, it will be related to the original trace.
+    class Context
+      include Core::Utils::Forking
+
+      attr_reader \
+        :active_trace
+
+      def initialize(
+        trace: nil
+      )
+        activate!(trace)
+      end
+
+      # Handles trace activation.
+      #
+      # Permits nil, allowing traces to be deactivated.
+      #
+      # If given a block, it will reset to the original
+      # trace after the block completes.
+      #
+      # When restoring the original trace, if it is finished,
+      # it will deactivate it. This prevents the context from
+      # holding references to completed traces thereby releasing
+      # its memory.
+      def activate!(trace)
+        if block_given?
+          begin
+            original_trace = @active_trace
+            set_active_trace!(trace)
+            yield
+          ensure
+            set_active_trace!(original_trace)
+          end
+        else
+          set_active_trace!(trace)
+        end
+      end
+
+      # Creates a copy of the context, when forked.
+      def fork_clone
+        forked_trace = @active_trace && @active_trace.fork_clone
+        self.class.new(trace: forked_trace)
+      end
+
+      private
+
+      def set_active_trace!(trace)
+        # Don't retain finished traces
+        @active_trace = trace && !trace.finished? ? trace : nil
+      end
+    end
+  end
+end

data/lib/datadog/tracing/context_provider.rb

@@ -0,0 +1,80 @@
+require_relative '../core/utils/sequence'
+require_relative 'context'
+
+module Datadog
+  module Tracing
+    # DefaultContextProvider is a default context provider that retrieves
+    # all contexts from the current fiber-local storage. It is suitable for
+    # synchronous programming.
+    #
+    # @see https://ruby-doc.org/core-3.1.2/Thread.html#method-i-5B-5D Thread attributes are fiber-local
+    class DefaultContextProvider
+      # Initializes the default context provider with a fiber-bound context.
+      def initialize
+        @context = FiberLocalContext.new
+      end
+
+      # Sets the current context.
+      def context=(ctx)
+        @context.local = ctx
+      end
+
+      # Return the local context.
+      def context(key = nil)
+        current_context = key.nil? ? @context.local : @context.local(key)
+
+        # Rebuild/reset context after a fork
+        #
+        # We don't want forked processes to copy and retransmit spans
+        # that were generated from the parent process. Reset it such
+        # that it acts like a distributed trace.
+        current_context.after_fork! do
+          # TODO: Only assign to `self.context` when working on the current thread (`key == nil`)
+          current_context = self.context = current_context.fork_clone
+        end
+
+        current_context
+      end
+    end
+
+    # FiberLocalContext can be used as a tracer global reference to create
+    # a different {Datadog::Tracing::Context} for each fiber. This allows for the tracer
+    # to create a serial execution graph regardless of any concurrent execution: each
+    # concurrent execution path creates a new trace graph.
+    #
+    # @see https://ruby-doc.org/core-3.1.2/Thread.html#method-i-5B-5D Thread attributes are fiber-local
+    class FiberLocalContext
+      # To support multiple tracers simultaneously, each {Datadog::Tracing::FiberLocalContext}
+      # instance has its own fiber-local variable.
+      def initialize
+        @key = "datadog_context_#{FiberLocalContext.next_instance_id}".to_sym
+
+        self.local = Context.new
+      end
+
+      # Override the fiber-local context with a new context.
+      def local=(ctx)
+        Thread.current[@key] = ctx
+      end
+
+      # Return the fiber-local context.
+      def local(storage = Thread.current)
+        storage[@key] ||= Context.new
+      end
+
+      # Ensure two instances of {FiberLocalContext} do not conflict.
+      # We previously used {FiberLocalContext#object_id} to ensure uniqueness
+      # but the VM is allowed to reuse `object_id`, allow for the possibility that
+      # a new FiberLocalContext would be able to read an old FiberLocalContext's
+      # value.
+      UNIQUE_INSTANCE_MUTEX = Mutex.new
+      UNIQUE_INSTANCE_GENERATOR = Datadog::Core::Utils::Sequence.new
+
+      private_constant :UNIQUE_INSTANCE_MUTEX, :UNIQUE_INSTANCE_GENERATOR
+
+      def self.next_instance_id
+        UNIQUE_INSTANCE_MUTEX.synchronize { UNIQUE_INSTANCE_GENERATOR.next }
+      end
+    end
+  end
+end

data/lib/datadog/tracing/contrib/action_cable/configuration/settings.rb

@@ -0,0 +1,33 @@
+require_relative '../../configuration/settings'
+require_relative '../ext'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module ActionCable
+        module Configuration
+          # Custom settings for the ActionCable integration
+          # @public_api
+          class Settings < Contrib::Configuration::Settings
+            option :enabled do |o|
+              o.default { env_to_bool(Ext::ENV_ENABLED, true) }
+              o.lazy
+            end
+
+            option :analytics_enabled do |o|
+              o.default { env_to_bool(Ext::ENV_ANALYTICS_ENABLED, false) }
+              o.lazy
+            end
+
+            option :analytics_sample_rate do |o|
+              o.default { env_to_float(Ext::ENV_ANALYTICS_SAMPLE_RATE, 1.0) }
+              o.lazy
+            end
+
+            option :service_name
+          end
+        end
+      end
+    end
+  end
+end