datadog 2.4.0 → 2.44.0

data/lib/datadog/tracing/component.rb

@@ -1,26 +1,19 @@
 # frozen_string_literal: true
 
-require_relative 'tracer'
-require_relative 'flush'
-require_relative 'sync_writer'
-require_relative 'sampling/span/rule_parser'
-require_relative 'sampling/span/sampler'
-require_relative 'diagnostics/environment_logger'
+require_relative "otel_thread_context"
+require_relative "tracer"
+require_relative "flush"
+require_relative "sync_writer"
+require_relative "sampling/span/rule_parser"
+require_relative "sampling/span/sampler"
+require_relative "diagnostics/environment_logger"
+require_relative "contrib/component"
 
 module Datadog
   module Tracing
     # Tracing component
     module Component
-      # Methods that interact with component instance fields.
-      module InstanceMethods
-        # Hot-swaps with a new sampler.
-        # This operation acquires the Components lock to ensure
-        # there is no concurrent modification of the sampler.
-        def reconfigure_live_sampler
-          sampler = self.class.build_sampler(Datadog.configuration)
-          Datadog.send(:safely_synchronize) { tracer.sampler.sampler = sampler }
-        end
-      end
+      module_function
 
       def build_tracer(settings, agent_settings, logger:)
         # If a custom tracer has been provided, use it instead.
@@ -49,6 +42,8 @@ module Datadog
         Tracing::Tracer.new(
           default_service: settings.service,
           enabled: settings.tracing.enabled,
+          logger: logger,
+          otel_thread_context: OTelThreadContext.build(settings.tracing),
           trace_flush: trace_flush,
           sampler: sampler_delegator,
           span_sampler: build_span_sampler(settings),
@@ -73,6 +68,12 @@ module Datadog
           return sampler
         end
 
+        # APM Disablement means that we don't want to send traces that only contains APM data.
+        # Other products can then put the sampling priority to MANUAL_KEEP if they want to keep traces.
+        # (e.g.: AppSec will MANUAL_KEEP traces with AppSec events) and clients will be billed only for those traces.
+        # But to keep the service alive on the backend side, we need to send one trace per minute.
+        post_sampler = build_rate_limit_post_sampler(seconds: 60) unless settings.apm.tracing.enabled
+
         # Sampling rules are provided
         if (rules = settings.tracing.sampling.rules)
           post_sampler = Tracing::Sampling::RuleSampler.parse(
@@ -105,9 +106,30 @@ module Datadog
           return writer
         end
 
+        if settings.tracing.native_transport && (transport = build_native_transport(agent_settings))
+          options = options.merge(transport: transport)
+        end
+
         Tracing::Writer.new(agent_settings: agent_settings, **options)
       end
 
+      def build_native_transport(agent_settings)
+        require_relative "transport/native"
+
+        unless Transport::Native.supported?
+          Datadog.logger.warn(
+            "Native transport requested but not available: #{Transport::Native::UNSUPPORTED_REASON}. " \
+            "Falling back to default HTTP transport."
+          )
+          return nil
+        end
+
+        Transport::Native::Transport.new(
+          agent_settings: agent_settings,
+          logger: Datadog.logger
+        )
+      end
+
       def subscribe_to_writer_events!(writer, sampler_delegator, test_mode)
         return unless writer.respond_to?(:events) # Check if it's a custom, external writer
 
@@ -148,11 +170,6 @@ module Datadog
         Tracing::Sampling::Span::Sampler.new(rules || [])
       end
 
-      # Configure non-privileged components.
-      def configure_tracing(settings)
-        Datadog::Tracing::Contrib::Component.configure(settings)
-      end
-
       # Sampler wrapper component, to allow for hot-swapping
       # the sampler instance used by the tracer.
       # Swapping samplers happens during Dynamic Configuration.
@@ -167,6 +184,17 @@ module Datadog
           @sampler.sample!(trace)
         end
 
+        def reconsider_sample_resource!(trace)
+          return unless @sampler.respond_to?(:reconsider_sample_resource!)
+
+          @sampler.reconsider_sample_resource!(trace)
+        end
+
+        def resource_sampling?
+          @sampler.respond_to?(:resource_sampling?) &&
+            @sampler.resource_sampling?
+        end
+
         def update(*args, **kwargs)
           return unless @sampler.respond_to?(:update)
 
@@ -174,8 +202,7 @@ module Datadog
         end
       end
 
-      private
-
+      # @api private
       def build_tracer_tags(settings)
         settings.tags.dup.tap do |tags|
           tags[Core::Environment::Ext::TAG_ENV] = settings.env unless settings.env.nil?
@@ -183,11 +210,23 @@ module Datadog
         end
       end
 
+      # Build a post-sampler that limits the rate of traces to one per `seconds`.
+      # E.g.: `build_rate_limit_post_sampler(seconds: 60)` will limit the rate to one trace per minute.
+      # @api private
+      def build_rate_limit_post_sampler(seconds:)
+        Tracing::Sampling::RuleSampler.new(
+          rate_limiter: Datadog::Core::TokenBucket.new(1.0 / seconds, 1.0),
+          default_sample_rate: 1.0
+        )
+      end
+
+      # @api private
       def build_test_mode_trace_flush(settings)
         # If context flush behavior is provided, use it instead.
         settings.tracing.test_mode.trace_flush || build_trace_flush(settings)
       end
 
+      # @api private
       def build_test_mode_sampler
         # Do not sample any spans for tests; all must be preserved.
         # Set priority sampler to ensure the agent doesn't drop any traces.
@@ -197,6 +236,7 @@ module Datadog
         )
       end
 
+      # @api private
       def build_test_mode_writer(settings, agent_settings)
         writer_options = settings.tracing.test_mode.writer_options || {}
 

data/lib/datadog/tracing/configuration/dynamic/option.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require_relative "../../../core/telemetry/configuration_value"
+
 module Datadog
   module Tracing
     module Configuration
@@ -56,6 +58,8 @@ module Datadog
                 precedence: Core::Configuration::Option::Precedence::REMOTE_CONFIGURATION
               )
             end
+
+            Core::Telemetry::ConfigurationValue.convert(value)
           end
 
           protected

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative 'dynamic/option'
+require_relative "dynamic/option"
 
 module Datadog
   module Tracing
@@ -11,39 +11,38 @@ module Datadog
         # Dynamic configuration for `DD_LOGS_INJECTION`.
         class LogInjectionEnabled < SimpleOption
           def initialize
-            super('log_injection_enabled', 'DD_LOGS_INJECTION', :log_injection)
+            super("log_injection_enabled", "DD_LOGS_INJECTION", :log_injection)
           end
         end
 
         # Dynamic configuration for `DD_TRACE_HEADER_TAGS`.
         class TracingHeaderTags < SimpleOption
           def initialize
-            super('tracing_header_tags', 'DD_TRACE_HEADER_TAGS', :header_tags)
+            super("tracing_header_tags", "DD_TRACE_HEADER_TAGS", :header_tags)
           end
 
           def call(tracing_header_tags)
             # Modify the remote configuration value that it matches the
             # environment variable it configures.
-            if tracing_header_tags
-              tracing_header_tags.map! do |hash|
-                "#{hash['header']}:#{hash['tag_name']}"
-              end
+            parsed_header_tags = tracing_header_tags&.map do |hash|
+              "#{hash["header"]}:#{hash["tag_name"]}"
             end
 
-            super(tracing_header_tags)
+            super(parsed_header_tags)
           end
         end
 
         # Dynamic configuration for `DD_TRACE_SAMPLE_RATE`.
         class TracingSamplingRate < SimpleOption
           def initialize
-            super('tracing_sampling_rate', 'DD_TRACE_SAMPLE_RATE', :default_rate)
+            super("tracing_sampling_rate", "DD_TRACE_SAMPLE_RATE", :default_rate)
           end
 
           # Ensures sampler is rebuilt and new configuration is applied
           def call(tracing_sampling_rate)
             super
-            Datadog.send(:components).reconfigure_live_sampler
+            Datadog.send(:components).reconfigure_sampler
+            tracing_sampling_rate
           end
 
           protected
@@ -56,7 +55,7 @@ module Datadog
         # Dynamic configuration for `DD_TRACE_SAMPLING_RULES`.
         class TracingSamplingRules < SimpleOption
           def initialize
-            super('tracing_sampling_rules', 'DD_TRACE_SAMPLING_RULES', :rules)
+            super("tracing_sampling_rules", "DD_TRACE_SAMPLING_RULES", :rules)
           end
 
           # Ensures sampler is rebuilt and new configuration is applied
@@ -65,23 +64,24 @@ module Datadog
             # local environment variable it configures.
             if tracing_sampling_rules
               tracing_sampling_rules.each do |rule|
-                next unless (tags = rule['tags'])
+                next unless (tags = rule["tags"])
 
                 # Tag maps come in as arrays of 'key' and `value_glob`.
                 # We need to convert them into a hash for local use.
                 tag_array = tags.map! do |tag|
-                  [tag['key'], tag['value_glob']]
+                  [tag["key"], tag["value_glob"]]
                 end
 
-                rule['tags'] = tag_array.to_h
+                rule["tags"] = tag_array.to_h
               end
 
               # The configuration is stored as JSON, so we need to convert it back
               tracing_sampling_rules = tracing_sampling_rules.to_json
             end
 
-            super(tracing_sampling_rules)
-            Datadog.send(:components).reconfigure_live_sampler
+            telemetry_value = super
+            Datadog.send(:components).reconfigure_sampler
+            telemetry_value
           end
 
           protected

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative '../../core/configuration/ext'
+require_relative "../../core/configuration/ext"
 
 module Datadog
   module Tracing
@@ -8,84 +8,107 @@ module Datadog
       # Constants for configuration settings
       # e.g. Env vars, default values, enums, etc...
       module Ext
-        ENV_ENABLED = 'DD_TRACE_ENABLED'
-        ENV_OTEL_TRACES_EXPORTER = 'OTEL_TRACES_EXPORTER'
-        ENV_HEADER_TAGS = 'DD_TRACE_HEADER_TAGS'
-        ENV_TRACE_ID_128_BIT_GENERATION_ENABLED = 'DD_TRACE_128_BIT_TRACEID_GENERATION_ENABLED'
+        ENV_ENABLED = "DD_TRACE_ENABLED"
+        ENV_HEADER_TAGS = "DD_TRACE_HEADER_TAGS"
+        ENV_BAGGAGE_TAG_KEYS = "DD_TRACE_BAGGAGE_TAG_KEYS"
+        ENV_TRACE_ID_128_BIT_GENERATION_ENABLED = "DD_TRACE_128_BIT_TRACEID_GENERATION_ENABLED"
+        ENV_NATIVE_SPAN_EVENTS = "DD_TRACE_NATIVE_SPAN_EVENTS"
+        ENV_OTEL_CONTEXT_ENABLED = "DD_TRACE_OTEL_CTX_ENABLED"
+        ENV_RESOURCE_RENAMING_ENABLED = "DD_TRACE_RESOURCE_RENAMING_ENABLED"
+        ENV_RESOURCE_RENAMING_ALWAYS_SIMPLIFIED_ENDPOINT = "DD_TRACE_RESOURCE_RENAMING_ALWAYS_SIMPLIFIED_ENDPOINT"
+        ENV_EXPERIMENTAL_PROPAGATE_PROCESS_TAGS_ENABLED = "DD_EXPERIMENTAL_PROPAGATE_PROCESS_TAGS_ENABLED"
+        ENV_EXPERIMENTAL_NATIVE_TRANSPORT_ENABLED = "DD_EXPERIMENTAL_NATIVE_TRANSPORT_ENABLED"
 
         # @public_api
         module SpanAttributeSchema
-          ENV_GLOBAL_DEFAULT_SERVICE_NAME_ENABLED = 'DD_TRACE_REMOVE_INTEGRATION_SERVICE_NAMES_ENABLED'
-          ENV_PEER_SERVICE_MAPPING = 'DD_TRACE_PEER_SERVICE_MAPPING'
+          ENV_GLOBAL_DEFAULT_SERVICE_NAME_ENABLED = "DD_TRACE_REMOVE_INTEGRATION_SERVICE_NAMES_ENABLED"
+          ENV_PEER_SERVICE_DEFAULTS_ENABLED = "DD_TRACE_PEER_SERVICE_DEFAULTS_ENABLED"
+          ENV_PEER_SERVICE_MAPPING = "DD_TRACE_PEER_SERVICE_MAPPING"
         end
 
         module Analytics
-          ENV_TRACE_ANALYTICS_ENABLED = 'DD_TRACE_ANALYTICS_ENABLED'
+          ENV_TRACE_ANALYTICS_ENABLED = "DD_TRACE_ANALYTICS_ENABLED"
         end
 
         # @public_api
         module Correlation
-          ENV_LOGS_INJECTION_ENABLED = 'DD_LOGS_INJECTION'
-          ENV_TRACE_ID_128_BIT_LOGGING_ENABLED = 'DD_TRACE_128_BIT_TRACEID_LOGGING_ENABLED'
+          ENV_LOGS_INJECTION_ENABLED = "DD_LOGS_INJECTION"
+          ENV_TRACE_ID_128_BIT_LOGGING_ENABLED = "DD_TRACE_128_BIT_TRACEID_LOGGING_ENABLED"
         end
 
         # @public_api
         module Distributed
           # Custom Datadog format
-          PROPAGATION_STYLE_DATADOG = 'datadog'
+          PROPAGATION_STYLE_DATADOG = "datadog"
 
-          PROPAGATION_STYLE_B3_MULTI_HEADER = 'b3multi'
-          PROPAGATION_STYLE_B3_SINGLE_HEADER = 'b3'
+          PROPAGATION_STYLE_B3_MULTI_HEADER = "b3multi"
+          PROPAGATION_STYLE_B3_SINGLE_HEADER = "b3"
 
           # W3C Trace Context
-          PROPAGATION_STYLE_TRACE_CONTEXT = 'tracecontext'
+          PROPAGATION_STYLE_TRACE_CONTEXT = "tracecontext"
+
+          # W3C Baggage
+          # @see https://www.w3.org/TR/baggage/
+          PROPAGATION_STYLE_BAGGAGE = "baggage"
 
           PROPAGATION_STYLE_SUPPORTED = [PROPAGATION_STYLE_DATADOG, PROPAGATION_STYLE_B3_MULTI_HEADER,
-                                         PROPAGATION_STYLE_B3_SINGLE_HEADER, PROPAGATION_STYLE_TRACE_CONTEXT].freeze
+            PROPAGATION_STYLE_B3_SINGLE_HEADER, PROPAGATION_STYLE_TRACE_CONTEXT,
+            PROPAGATION_STYLE_BAGGAGE].freeze
 
           # Sets both extract and inject propagation style tho the provided value.
           # Has lower precedence than `DD_TRACE_PROPAGATION_STYLE_INJECT` or
           # `DD_TRACE_PROPAGATION_STYLE_EXTRACT`.
-          ENV_PROPAGATION_STYLE = 'DD_TRACE_PROPAGATION_STYLE'
-          ENV_OTEL_PROPAGATION_STYLE = 'OTEL_PROPAGATORS'
+          ENV_PROPAGATION_STYLE = "DD_TRACE_PROPAGATION_STYLE"
+
+          ENV_PROPAGATION_STYLE_INJECT = "DD_TRACE_PROPAGATION_STYLE_INJECT"
+
+          ENV_PROPAGATION_STYLE_EXTRACT = "DD_TRACE_PROPAGATION_STYLE_EXTRACT"
+
+          PROPAGATION_BEHAVIOR_EXTRACT_CONTINUE = "continue"
+          PROPAGATION_BEHAVIOR_EXTRACT_RESTART = "restart"
+          PROPAGATION_BEHAVIOR_EXTRACT_IGNORE = "ignore"
 
-          ENV_PROPAGATION_STYLE_INJECT = 'DD_TRACE_PROPAGATION_STYLE_INJECT'
+          PROPAGATION_BEHAVIOR_EXTRACT_SUPPORTED = [
+            PROPAGATION_BEHAVIOR_EXTRACT_CONTINUE,
+            PROPAGATION_BEHAVIOR_EXTRACT_RESTART,
+            PROPAGATION_BEHAVIOR_EXTRACT_IGNORE,
+          ].freeze
 
-          ENV_PROPAGATION_STYLE_EXTRACT = 'DD_TRACE_PROPAGATION_STYLE_EXTRACT'
+          # Behavior applied to a distributed-trace context extracted from incoming requests.
+          ENV_PROPAGATION_BEHAVIOR_EXTRACT = "DD_TRACE_PROPAGATION_BEHAVIOR_EXTRACT"
 
           # A no-op propagator. Compatible with OpenTelemetry's `none` propagator.
           # @see https://opentelemetry.io/docs/concepts/sdk-configuration/general-sdk-configuration/#get_otel__propagators
-          PROPAGATION_STYLE_NONE = 'none'
+          PROPAGATION_STYLE_NONE = "none"
 
           # Strictly stop at the first successfully serialized style.
-          EXTRACT_FIRST = 'DD_TRACE_PROPAGATION_EXTRACT_FIRST'
+          EXTRACT_FIRST = "DD_TRACE_PROPAGATION_EXTRACT_FIRST"
 
-          ENV_X_DATADOG_TAGS_MAX_LENGTH = 'DD_TRACE_X_DATADOG_TAGS_MAX_LENGTH'
+          ENV_X_DATADOG_TAGS_MAX_LENGTH = "DD_TRACE_X_DATADOG_TAGS_MAX_LENGTH"
         end
 
         # @public_api
         module NET
-          ENV_REPORT_HOSTNAME = 'DD_TRACE_REPORT_HOSTNAME'
+          ENV_REPORT_HOSTNAME = "DD_TRACE_REPORT_HOSTNAME"
         end
 
         # @public_api
         module Sampling
-          ENV_SAMPLE_RATE = 'DD_TRACE_SAMPLE_RATE'
-          ENV_RATE_LIMIT = 'DD_TRACE_RATE_LIMIT'
-          ENV_RULES = 'DD_TRACE_SAMPLING_RULES'
-          ENV_OTEL_TRACES_SAMPLER = 'OTEL_TRACES_SAMPLER'
-          OTEL_TRACES_SAMPLER_ARG = 'OTEL_TRACES_SAMPLER_ARG'
+          ENV_SAMPLE_RATE = "DD_TRACE_SAMPLE_RATE"
+          ENV_RATE_LIMIT = "DD_TRACE_RATE_LIMIT"
+          ENV_RULES = "DD_TRACE_SAMPLING_RULES"
+          OTEL_TRACES_SAMPLER_ARG = "OTEL_TRACES_SAMPLER_ARG"
 
           # @public_api
           module Span
-            ENV_SPAN_SAMPLING_RULES = 'DD_SPAN_SAMPLING_RULES'
-            ENV_SPAN_SAMPLING_RULES_FILE = 'DD_SPAN_SAMPLING_RULES_FILE'
+            ENV_SPAN_SAMPLING_RULES = "DD_SPAN_SAMPLING_RULES"
+            ENV_SPAN_SAMPLING_RULES_FILE = "DD_SPAN_SAMPLING_RULES_FILE"
           end
         end
 
         # @public_api
         module Test
-          ENV_MODE_ENABLED = 'DD_TRACE_TEST_MODE_ENABLED'
+          ENV_MODE_ENABLED = "DD_TRACE_TEST_MODE_ENABLED"
         end
 
         # @public_api
@@ -96,8 +119,14 @@ module Datadog
 
         # @public_api
         module ClientIp
-          ENV_ENABLED = 'DD_TRACE_CLIENT_IP_ENABLED'
-          ENV_HEADER_NAME = 'DD_TRACE_CLIENT_IP_HEADER'
+          ENV_ENABLED = "DD_TRACE_CLIENT_IP_ENABLED"
+          ENV_HEADER_NAME = "DD_TRACE_CLIENT_IP_HEADER"
+        end
+
+        # @public_api
+        module HTTPErrorStatuses
+          ENV_SERVER_ERROR_STATUSES = "DD_TRACE_HTTP_SERVER_ERROR_STATUSES"
+          ENV_CLIENT_ERROR_STATUSES = "DD_TRACE_HTTP_CLIENT_ERROR_STATUSES"
         end
       end
     end

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

@@ -19,7 +19,7 @@ module Datadog
             @header_tags = header_tags
 
             @header_tags.each do |header_tag|
-              header, tag = header_tag.split(':', 2)
+              header, tag = header_tag.split(":", 2)
 
               next unless header # Empty string guard
 
@@ -65,7 +65,7 @@ module Datadog
           # For easy configuration inspection,
           # print the original configuration setting.
           def to_s
-            @header_tags.join(',').to_s
+            @header_tags.join(",").to_s
           end
         end
       end