ddtrace 1.4.2 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e708799bd5320bcc45e0cd79d9893ef278ea1b30205058cae88ed9409371bd56
-  data.tar.gz: c34df6aaebb0a8a16b68a6ccd12397b101fe5e74f450b599d9a94bb01cc272b5
+  metadata.gz: 480825e1e52697f2e7b49f605a733b2e53072b36aac74b664c62fada4e6acac2
+  data.tar.gz: 288731a19cf08d4fb6d546ef3481a6a571823de993df97d5e5b14ff4cfc3b820
 SHA512:
-  metadata.gz: f33d2ddfb796efa2dfda6b5b02dab623e8fcfbcf263cb820a0e78d291f49dc06e587e535c7a8afe40e26c830b2b0dac7539c4302ed76aa24579560fa687ea154
-  data.tar.gz: 7cc6918e72984329af2f5a002a131d8ef965a276b9dc4ca74e1e6bda595f8c106f535c98bc69626e4394ba0f5c6a4e5103606e9946453bbe3ef8eb5d12922e0a
+  metadata.gz: 902874e4c974a680373aa6c6ecf0b40a21bb285c266dd340e5d89c92827375e5e3c6480cc7988719a54eaa8e5e3829ddbb914afc84179e53d99fa1dff50759ad
+  data.tar.gz: 890b97da4ceda1d07358b3a019a23ce0d224410359ea30f9128050c1de3a05ce077bd4592517b0606323215a6dac9b306bde38efddf69e742c6b324f52c239e7

data/CHANGELOG.md

@@ -2,11 +2,37 @@
 
 ## [Unreleased]
 
+## [1.5.0] - 2022-09-29
+
+### Deprecation notice
+
+* `c.tracing.instrument :rack, { quantize: { base: ... } }` will change its default from `:exclude` to `:show` in a future version. Voluntarily moving to `:show` is recommended.
+* `c.tracing.instrument :rack, { quantize: { query: { show: ... } }` will change its default to `:all` in a future version, together with `quantize.query.obfuscate` changing to `:internal`. Voluntarily moving to these future values is recommended.
+
+### Added
+
+* Feature: Single Span Sampling ([#2128][])
+* Add query string automatic redaction ([#2283][])
+* Use full URL in `http.url` tag ([#2265][])
+* Add `http.useragent` tag ([#2252][])
+* Add `http.client_ip` tag for Rack-based frameworks ([#2248][])
+* Ci-app: CI: Fetch committer and author in Bitrise ([#2258][])
+
+### Changed
+
+* Bump allowed version of debase-ruby_core_source to include v0.10.17 ([#2267][])
+
+### Fixed
+
+* Bug: Fix `service_nam` typo to `service_name` ([#2296][])
+* Bug: Check AppSec Rails for railties instead of rails meta gem ([#2293][]) ([@seuros][])
+* Ci-app: Correctly extract commit message from AppVeyor ([#2257][])
+
 ## [1.4.2] - 2022-09-27
 
 ### Fixed
 
-OpenTracing context propagation (#2191, #2289)
+OpenTracing context propagation ([#2191][], [#2289][])
 
 ## [1.4.1] - 2022-09-15
 
@@ -2104,6 +2130,7 @@ Release notes: https://github.com/DataDog/dd-trace-rb/releases/tag/v0.3.1
 Git diff: https://github.com/DataDog/dd-trace-rb/compare/v0.3.0...v0.3.1
 
 [Unreleased]: https://github.com/DataDog/dd-trace-rb/compare/v1.4.2...master
+[1.5.0]: https://github.com/DataDog/dd-trace-rb/compare/v1.4.2...v1.5.0
 [1.4.1]: https://github.com/DataDog/dd-trace-rb/compare/v1.4.1...v1.4.2
 [1.4.1]: https://github.com/DataDog/dd-trace-rb/compare/v1.4.0...v1.4.1
 [1.4.0]: https://github.com/DataDog/dd-trace-rb/compare/v1.3.0...v1.4.0
@@ -2973,6 +3000,7 @@ Git diff: https://github.com/DataDog/dd-trace-rb/compare/v0.3.0...v0.3.1
 [#2113]: https://github.com/DataDog/dd-trace-rb/issues/2113
 [#2118]: https://github.com/DataDog/dd-trace-rb/issues/2118
 [#2125]: https://github.com/DataDog/dd-trace-rb/issues/2125
+[#2128]: https://github.com/DataDog/dd-trace-rb/issues/2128
 [#2134]: https://github.com/DataDog/dd-trace-rb/issues/2134
 [#2138]: https://github.com/DataDog/dd-trace-rb/issues/2138
 [#2140]: https://github.com/DataDog/dd-trace-rb/issues/2140
@@ -2985,12 +3013,23 @@ Git diff: https://github.com/DataDog/dd-trace-rb/compare/v0.3.0...v0.3.1
 [#2173]: https://github.com/DataDog/dd-trace-rb/issues/2173
 [#2174]: https://github.com/DataDog/dd-trace-rb/issues/2174
 [#2180]: https://github.com/DataDog/dd-trace-rb/issues/2180
+[#2191]: https://github.com/DataDog/dd-trace-rb/issues/2191
 [#2200]: https://github.com/DataDog/dd-trace-rb/issues/2200
 [#2201]: https://github.com/DataDog/dd-trace-rb/issues/2201
 [#2219]: https://github.com/DataDog/dd-trace-rb/issues/2219
 [#2229]: https://github.com/DataDog/dd-trace-rb/issues/2229
+[#2248]: https://github.com/DataDog/dd-trace-rb/issues/2248
 [#2250]: https://github.com/DataDog/dd-trace-rb/issues/2250
+[#2252]: https://github.com/DataDog/dd-trace-rb/issues/2252
+[#2257]: https://github.com/DataDog/dd-trace-rb/issues/2257
+[#2258]: https://github.com/DataDog/dd-trace-rb/issues/2258
+[#2265]: https://github.com/DataDog/dd-trace-rb/issues/2265
+[#2267]: https://github.com/DataDog/dd-trace-rb/issues/2267
 [#2279]: https://github.com/DataDog/dd-trace-rb/issues/2279
+[#2283]: https://github.com/DataDog/dd-trace-rb/issues/2283
+[#2289]: https://github.com/DataDog/dd-trace-rb/issues/2289
+[#2293]: https://github.com/DataDog/dd-trace-rb/issues/2293
+[#2296]: https://github.com/DataDog/dd-trace-rb/issues/2296
 [@AdrianLC]: https://github.com/AdrianLC
 [@Azure7111]: https://github.com/Azure7111
 [@BabyGroot]: https://github.com/BabyGroot
@@ -3112,6 +3151,7 @@ Git diff: https://github.com/DataDog/dd-trace-rb/compare/v0.3.0...v0.3.1
 [@saturnflyer]: https://github.com/saturnflyer
 [@sco11morgan]: https://github.com/sco11morgan
 [@senny]: https://github.com/senny
+[@seuros]: https://github.com/seuros
 [@shayonj]: https://github.com/shayonj
 [@sinsoku]: https://github.com/sinsoku
 [@skcc321]: https://github.com/skcc321
@@ -3132,4 +3172,4 @@ Git diff: https://github.com/DataDog/dd-trace-rb/compare/v0.3.0...v0.3.1
 [@walterking]: https://github.com/walterking
 [@y-yagi]: https://github.com/y-yagi
 [@yukimurasawa]: https://github.com/yukimurasawa
-[@zachmccormick]: https://github.com/zachmccormick
+[@zachmccormick]: https://github.com/zachmccormick

data/ext/ddtrace_profiling_native_extension/native_extension_helpers.rb

@@ -68,7 +68,6 @@ module Datadog
 
       # Used to check if profiler is supported, including user-visible clear messages explaining why their
       # system may not be supported.
-      # rubocop:disable Metrics/ModuleLength
       module Supported
         private_class_method def self.explain_issue(*reason, suggested:)
           { reason: reason, suggested: suggested }
@@ -284,7 +283,6 @@ module Datadog
           no_binaries_for_current_platform unless Libdatadog.pkgconfig_folder
         end
       end
-      # rubocop:enable Metrics/ModuleLength
     end
   end
 end

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

@@ -5,7 +5,6 @@ module Datadog
     module Configuration
       # Configuration settings, acting as an integration registry
       # TODO: as with Configuration, this is a trivial implementation
-      # rubocop:disable Metrics/ClassLength
       class Settings
         class << self
           def boolean
@@ -188,7 +187,6 @@ module Datadog
           initialize
         end
       end
-      # rubocop:enable Metrics/ClassLength
     end
   end
 end

data/lib/datadog/appsec/contrib/rack/gateway/watcher.rb

@@ -13,7 +13,6 @@ module Datadog
       module Rack
         module Gateway
           # Watcher for Rack gateway events
-          # rubocop:disable Metrics/ModuleLength
           module Watcher
             # rubocop:disable Metrics/AbcSize
             # rubocop:disable Metrics/MethodLength
@@ -161,7 +160,6 @@ module Datadog
               end
             end
           end
-          # rubocop:enable Metrics/ModuleLength
         end
       end
     end

data/lib/datadog/appsec/contrib/rails/integration.rb

@@ -19,7 +19,7 @@ module Datadog
           register_as :rails, auto_patch: false
 
           def self.version
-            Gem.loaded_specs['rails'] && Gem.loaded_specs['rails'].version
+            Gem.loaded_specs['railties'] && Gem.loaded_specs['railties'].version
           end
 
           def self.loaded?

data/lib/datadog/ci/ext/environment.rb

@@ -10,7 +10,6 @@ module Datadog
   module CI
     module Ext
       # Defines constants for CI tags
-      # rubocop:disable Metrics/ModuleLength:
       module Environment
         include Kernel # Ensure that kernel methods are always available (https://sorbet.org/docs/error-reference#7003)
 
@@ -97,6 +96,12 @@ module Datadog
             tag = env['APPVEYOR_REPO_TAG_NAME']
           end
 
+          commit_message = env['APPVEYOR_REPO_COMMIT_MESSAGE']
+          if commit_message
+            extended = env['APPVEYOR_REPO_COMMIT_MESSAGE_EXTENDED']
+            commit_message = "#{commit_message}\n#{extended}" if extended
+          end
+
           {
             TAG_PROVIDER_NAME => 'appveyor',
             Core::Git::Ext::TAG_REPOSITORY_URL => repository,
@@ -111,7 +116,7 @@ module Datadog
             Core::Git::Ext::TAG_TAG => tag,
             Core::Git::Ext::TAG_COMMIT_AUTHOR_NAME => env['APPVEYOR_REPO_COMMIT_AUTHOR'],
             Core::Git::Ext::TAG_COMMIT_AUTHOR_EMAIL => env['APPVEYOR_REPO_COMMIT_AUTHOR_EMAIL'],
-            Core::Git::Ext::TAG_COMMIT_MESSAGE => env['APPVEYOR_REPO_COMMIT_MESSAGE_EXTENDED']
+            Core::Git::Ext::TAG_COMMIT_MESSAGE => commit_message
           }
         end
 
@@ -330,6 +335,10 @@ module Datadog
           branch = (
             env['BITRISEIO_GIT_BRANCH_DEST'] || env['BITRISE_GIT_BRANCH']
           )
+          commiter_email = (
+            env['GIT_CLONE_COMMIT_COMMITER_EMAIL'] || env['GIT_CLONE_COMMIT_COMMITER_NAME']
+          )
+
           {
             TAG_PROVIDER_NAME => 'bitrise',
             TAG_PIPELINE_ID => env['BITRISE_BUILD_SLUG'],
@@ -341,7 +350,11 @@ module Datadog
             Core::Git::Ext::TAG_COMMIT_SHA => commit,
             Core::Git::Ext::TAG_BRANCH => branch,
             Core::Git::Ext::TAG_TAG => env['BITRISE_GIT_TAG'],
-            Core::Git::Ext::TAG_COMMIT_MESSAGE => env['BITRISE_GIT_MESSAGE']
+            Core::Git::Ext::TAG_COMMIT_MESSAGE => env['BITRISE_GIT_MESSAGE'],
+            Core::Git::Ext::TAG_COMMIT_AUTHOR_NAME => env['GIT_CLONE_COMMIT_AUTHOR_NAME'],
+            Core::Git::Ext::TAG_COMMIT_AUTHOR_EMAIL => env['GIT_CLONE_COMMIT_AUTHOR_EMAIL'],
+            Core::Git::Ext::TAG_COMMIT_COMMITTER_NAME => env['GIT_CLONE_COMMIT_COMMITER_NAME'],
+            Core::Git::Ext::TAG_COMMIT_COMMITTER_EMAIL => commiter_email
           }
         end
 
@@ -499,7 +512,6 @@ module Datadog
           [nil, name_and_email]
         end
       end
-      # rubocop:enable Metrics/ModuleLength:
     end
   end
 end

data/lib/datadog/core/configuration/agent_settings_resolver.rb

@@ -18,8 +18,6 @@ module Datadog
       #
       # Whenever there is a conflict (different configurations are provided in different orders), it MUST warn the users
       # about it and pick a value based on the following priority: code > environment variable > defaults.
-      #
-      # rubocop:disable Metrics/ClassLength
       class AgentSettingsResolver
         AgentSettings = \
           Struct.new(
@@ -359,7 +357,6 @@ module Datadog
           end
         end
       end
-      # rubocop:enable Metrics/ClassLength
     end
   end
 end

data/lib/datadog/core/configuration/components.rb

@@ -11,12 +11,13 @@ require_relative '../workers/runtime_metrics'
 require_relative '../../tracing/tracer'
 require_relative '../../tracing/flush'
 require_relative '../../tracing/sync_writer'
+require_relative '../../tracing/sampling/span/rule_parser'
+require_relative '../../tracing/sampling/span/sampler'
 
 module Datadog
   module Core
     module Configuration
       # Global components for the trace library.
-      # rubocop:disable Metrics/ClassLength
       class Components
         class << self
           def build_health_metrics(settings)
@@ -80,6 +81,7 @@ module Datadog
               enabled: settings.tracing.enabled,
               trace_flush: trace_flush,
               sampler: sampler,
+              span_sampler: build_span_sampler(settings),
               writer: writer,
               tags: build_tracer_tags(settings),
             )
@@ -183,6 +185,11 @@ module Datadog
             end
           end
 
+          def build_span_sampler(settings)
+            rules = Tracing::Sampling::Span::RuleParser.parse_json(settings.tracing.sampling.span_rules)
+            Tracing::Sampling::Span::Sampler.new(rules || [])
+          end
+
           def build_profiler(settings, agent_settings, tracer)
             return unless settings.profiling.enabled
 
@@ -423,7 +430,6 @@ module Datadog
           telemetry.emit_closing! unless replacement
         end
       end
-      # rubocop:enable Metrics/ClassLength
     end
   end
 end

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

@@ -15,7 +15,6 @@ module Datadog
       # Global configuration settings for the trace library.
       # @public_api
       # rubocop:disable Metrics/BlockLength
-      # rubocop:disable Metrics/ClassLength
       # rubocop:disable Layout/LineLength
       class Settings
         include Base
@@ -540,6 +539,7 @@ module Datadog
           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.
@@ -566,6 +566,48 @@ module Datadog
               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.
@@ -618,6 +660,32 @@ module Datadog
           # @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.
+            #
+            # @see https://docs.datadoghq.com/tracing/configure_data_security#configuring-a-client-ip-header
+            #
+            # @default The negated value of the `DD_TRACE_CLIENT_IP_HEADER_DISABLED` environment
+            #   variable or `true` if it doesn't exist.
+            # @return [Boolean]
+            option :enabled do |o|
+              o.default { !env_to_bool(Tracing::Configuration::Ext::ClientIp::ENV_DISABLED, false) }
+              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
         end
 
         # The `version` tag in Datadog. Use it to enable [Deployment Tracking](https://docs.datadoghq.com/tracing/deployment_tracking/).
@@ -645,7 +713,6 @@ module Datadog
         end
       end
       # rubocop:enable Metrics/BlockLength
-      # rubocop:enable Metrics/ClassLength
       # rubocop:enable Layout/LineLength
     end
   end

data/lib/datadog/core/configuration.rb

@@ -9,7 +9,7 @@ require_relative 'pin'
 module Datadog
   module Core
     # Configuration provides a unique access point for configurations
-    module Configuration # rubocop:disable Metrics/ModuleLength
+    module Configuration
       include Kernel # Ensure that kernel methods are always available (https://sorbet.org/docs/error-reference#7003)
 
       # Used to ensure that @components initialization/reconfiguration is performed one-at-a-time, by a single thread.

data/lib/datadog/core/header_collection.rb

@@ -0,0 +1,41 @@
+module Datadog
+  module Core
+    # A some-what abstract class representing a collection of headers.
+    #
+    # Use the `HeaderCollection.from_hash` function to create a header collection from a `Hash`.
+    # Another option is to use `HashHeaderCollection` directly.
+    class HeaderCollection
+      # Gets a single value of the header with the given name, case insensitive.
+      #
+      # @param [String] header_name Name of the header to get the value of.
+      # @returns [String, nil] A single value of the header, or nil if the header with
+      #   the given name is missing from the collection.
+      def get(header_name)
+        nil
+      end
+
+      # Create a header collection that retrieves headers from the given Hash.
+      #
+      # This can be useful for testing or other trivial use cases.
+      #
+      # @param [Hash] hash Hash with the headers.
+      def self.from_hash(hash)
+        HashHeaderCollection.new(hash)
+      end
+    end
+
+    # A header collection implementation that looks up headers in a Hash.
+    class HashHeaderCollection < HeaderCollection
+      def initialize(hash)
+        super()
+        @hash = {}.tap do |res|
+          hash.each_pair { |key, value| res[key.downcase] = value }
+        end
+      end
+
+      def get(header_name)
+        @hash[header_name.downcase]
+      end
+    end
+  end
+end

data/lib/datadog/core/telemetry/collector.rb

@@ -18,7 +18,6 @@ module Datadog
   module Core
     module Telemetry
       # Module defining methods for collecting metadata for telemetry
-      # rubocop:disable Metrics/ModuleLength
       module Collector
         include Datadog::Core::Configuration
 
@@ -228,7 +227,6 @@ module Datadog
           end
         end
       end
-      # rubocop:enable Metrics/ModuleLength
     end
   end
 end

data/lib/datadog/core/workers/async.rb

@@ -8,7 +8,6 @@ module Datadog
       module Async
         # Adds threading behavior to workers
         # to run tasks asynchronously.
-        # rubocop:disable Metrics/ModuleLength
         module Thread
           FORK_POLICY_STOP = :stop
           FORK_POLICY_RESTART = :restart
@@ -175,7 +174,6 @@ module Datadog
             end
           end
         end
-        # rubocop:enable Metrics/ModuleLength
       end
     end
   end

data/lib/datadog/profiling/collectors/old_stack.rb

@@ -15,7 +15,7 @@ module Datadog
       # Runs on its own background thread.
       #
       # This class has the prefix "Old" because it will be deprecated by the new native CPU Profiler
-      class OldStack < Core::Worker # rubocop:disable Metrics/ClassLength
+      class OldStack < Core::Worker
         include Core::Workers::Polling
 
         DEFAULT_MAX_TIME_USAGE_PCT = 2.0

data/lib/datadog/profiling.rb

@@ -6,7 +6,7 @@ require_relative 'core/utils/only_once'
 
 module Datadog
   # Contains profiler for generating stack profiles, etc.
-  module Profiling # rubocop:disable Metrics/ModuleLength
+  module Profiling
     GOOGLE_PROTOBUF_MINIMUM_VERSION = Gem::Version.new('3.0')
     private_constant :GOOGLE_PROTOBUF_MINIMUM_VERSION
 

data/lib/datadog/tracing/client_ip.rb

@@ -0,0 +1,153 @@
+# typed: true
+
+require_relative '../core/configuration'
+require_relative 'metadata/ext'
+require_relative 'span'
+
+require 'ipaddr'
+
+module Datadog
+  module Tracing
+    # Common functions for supporting the `http.client_ip` span attribute.
+    module ClientIp
+      DEFAULT_IP_HEADERS_NAMES = %w[
+        x-forwarded-for
+        x-real-ip
+        x-client-ip
+        x-forwarded
+        x-cluster-client-ip
+        forwarded-for
+        forwarded
+        via
+        true-client-ip
+      ].freeze
+
+      TAG_MULTIPLE_IP_HEADERS = '_dd.multiple-ip-headers'.freeze
+
+      # Sets the `http.client_ip` tag on the given span.
+      #
+      # This function respects the user's settings: if they disable the client IP tagging,
+      #   or provide a different IP header name.
+      #
+      # If multiple IP headers are present in the request, this function will instead set
+      #   the `_dd.multiple-ip-headers` tag with the names of the present headers,
+      #   and **NOT** set the `http.client_ip` tag.
+      #
+      # @param [Span] span The span that's associated with the request.
+      # @param [HeaderCollection, #get, nil] headers A collection with the request headers.
+      # @param [String, nil] remote_ip The remote IP the request associated with the span is sent to.
+      def self.set_client_ip_tag(span, headers: nil, remote_ip: nil)
+        return unless configuration.enabled
+
+        result = raw_ip_from_request(headers, remote_ip)
+
+        if result.raw_ip
+          ip = strip_decorations(result.raw_ip)
+          return unless valid_ip?(ip)
+
+          span.set_tag(Tracing::Metadata::Ext::HTTP::TAG_CLIENT_IP, ip)
+        elsif result.multiple_ip_headers
+          span.set_tag(TAG_MULTIPLE_IP_HEADERS, result.multiple_ip_headers.keys.join(','))
+        end
+      end
+
+      IpExtractionResult = Struct.new(:raw_ip, :multiple_ip_headers)
+
+      # Returns a result struct that holds the raw client IP associated with the request if it was
+      #   retrieved successfully.
+      #
+      # The client IP is looked up by the following logic:
+      # * If the user has configured a header name, return that header's value.
+      # * If exactly one of the known IP headers is present, return that header's value.
+      # * If none of the known IP headers are present, return the remote IP from the request.
+      #
+      # If more than one of the known IP headers is present, the result will have a `multiple_ip_headers`
+      #   field with the name of the present IP headers.
+      #
+      # @param [Datadog::Core::HeaderCollection, #get, nil] headers The request headers
+      # @param [String] remote_ip The remote IP of the request.
+      # @return [IpExtractionResult] A struct that holds the unprocessed IP value,
+      #   or `nil` if it wasn't found. Additionally, the `multiple_ip_headers` fields will hold the
+      #   name of known IP headers present in the request if more than one of these were found.
+      def self.raw_ip_from_request(headers, remote_ip)
+        return IpExtractionResult.new(headers && headers.get(configuration.header_name), nil) if configuration.header_name
+
+        headers_present = ip_headers(headers)
+
+        case headers_present.size
+        when 0
+          IpExtractionResult.new(remote_ip, nil)
+        when 1
+          IpExtractionResult.new(headers_present.values.first, nil)
+        else
+          IpExtractionResult.new(nil, headers_present)
+        end
+      end
+
+      # Removes any port notations or zone specifiers from the IP address without
+      #   verifying its validity.
+      def self.strip_decorations(address)
+        return strip_ipv4_port(address) if likely_ipv4?(address)
+
+        address = strip_ipv6_port(address)
+
+        strip_zone_specifier(address)
+      end
+
+      def self.strip_zone_specifier(ipv6)
+        ipv6.gsub(/%.*/, '')
+      end
+
+      def self.strip_ipv4_port(ip)
+        ip.gsub(/:\d+\z/, '')
+      end
+
+      def self.strip_ipv6_port(ip)
+        if /\[(.*)\](?::\d+)?/ =~ ip
+          Regexp.last_match(1)
+        else
+          ip
+        end
+      end
+
+      # Returns whether the given value is more likely to be an IPv4 than an IPv6 address.
+      #
+      # This is done by checking if a dot (`'.'`) character appears before a colon (`':'`) in the value.
+      # The rationale is that in valid IPv6 addresses, colons will always preced dots,
+      #   and in valid IPv4 addresses dots will always preced colons.
+      def self.likely_ipv4?(value)
+        dot_index = value.index('.') || value.size
+        colon_index = value.index(':') || value.size
+
+        dot_index < colon_index
+      end
+
+      # Determines whether the given string is a valid IPv4 or IPv6 address.
+      def self.valid_ip?(ip)
+        # Client IPs should not have subnet masks even though IPAddr can parse them.
+        return false if ip.include?('/')
+
+        begin
+          IPAddr.new(ip)
+
+          true
+        rescue IPAddr::Error
+          false
+        end
+      end
+
+      def self.ip_headers(headers)
+        return {} unless headers
+
+        DEFAULT_IP_HEADERS_NAMES.each_with_object({}) do |name, result|
+          value = headers.get(name)
+          result[name] = value unless value.nil?
+        end
+      end
+
+      def self.configuration
+        Datadog.configuration.tracing.client_ip
+      end
+    end
+  end
+end

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

@@ -32,6 +32,12 @@ module Datadog
         module Sampling
           ENV_SAMPLE_RATE = 'DD_TRACE_SAMPLE_RATE'.freeze
           ENV_RATE_LIMIT = 'DD_TRACE_RATE_LIMIT'.freeze
+
+          # @public_api
+          module Span
+            ENV_SPAN_SAMPLING_RULES = 'DD_SPAN_SAMPLING_RULES'.freeze
+            ENV_SPAN_SAMPLING_RULES_FILE = 'DD_SPAN_SAMPLING_RULES_FILE'.freeze
+          end
         end
 
         # @public_api
@@ -45,6 +51,12 @@ module Datadog
           ENV_DEFAULT_PORT = 'DD_TRACE_AGENT_PORT'.freeze
           ENV_DEFAULT_URL = 'DD_TRACE_AGENT_URL'.freeze
         end
+
+        # @public_api
+        module ClientIp
+          ENV_DISABLED = 'DD_TRACE_CLIENT_IP_HEADER_DISABLED'.freeze
+          ENV_HEADER_NAME = 'DD_TRACE_CLIENT_IP_HEADER'.freeze
+        end
       end
     end
   end