ddtrace 1.10.0 → 1.10.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1d6ef41c3e2f14b483d24a4aca9955a2a4b0ddf850d25e5e19932e62299c3905
-  data.tar.gz: de145f2e113f13e6d5d3360967e5fc3dc0273fb62c47dc6fae5d455e9c5f088c
+  metadata.gz: 005fcbaaa9553287f8652a9f437abd144c2ba2ca0f26c83f67de171646f5aae3
+  data.tar.gz: 032c0d3f09ea01779b17ba45a95086ab890b3869208c84b82b548b3cbd41a977
 SHA512:
-  metadata.gz: a3d6558cd4d7bbc1d8c6cdcb0500dec28eb8d451b9a92086db9cb70fec0ebf6f183c5a0b2b31287c364f9f322b3c9ad303f12b9826c808723684bab713e79563
-  data.tar.gz: 7ed0b3255a67e3d8016dc0a6a0769cbd95f960f6a6324ec79a27f16026e08dd3b3e9bb8e28d728797a72e6eca8b1ab73646ff815bae32a52358481c0501b864d
+  metadata.gz: bc868d2e56e5282771cbc7e9447f1fa7504212d31b5bc94db4db9e5f029a00b0a9f988bcab7111f1889eb1f203fffcd81b73700c69f433be4bdaa2045dbfba72
+  data.tar.gz: d2679f725e7991bfa2e34dc6de650e928a59aa02124239d340a396ea40f331ff0a4a2159067df5ade22c1c36daab8e7cbe25db3ddaf55b8c8cb14137e7b2d220

data/CHANGELOG.md

@@ -2,6 +2,15 @@
 
 ## [Unreleased]
 
+## [1.10.1] - 2023-03-10
+
+### Fixed
+
+* CI: Update TeamCity environment variable support ([#2668][])
+* Core: Fix spurious dependency on AppSec when loading CI with `require 'datadog/ci'` ([#2679][])
+* Core: Allow multiple headers and multiple IPs per header for client IP ([#2665][])
+* AppSec: prevent side-effect on AppSec login event tracking method arguments ([#2663][]) ([@coneill-enhance][])
+
 ## [1.10.0] - 2023-03-06
 
 ### Added
@@ -2314,7 +2323,8 @@ 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.10.0...master
+[Unreleased]: https://github.com/DataDog/dd-trace-rb/compare/v1.10.1...master
+[1.10.1]: https://github.com/DataDog/dd-trace-rb/compare/v1.10.0...v1.10.1
 [1.10.0]: https://github.com/DataDog/dd-trace-rb/compare/v1.9.0...v1.10.0
 [1.9.0]: https://github.com/DataDog/dd-trace-rb/compare/v1.8.0...v1.9.0
 [1.8.0]: https://github.com/DataDog/dd-trace-rb/compare/v1.7.0...v1.8.0
@@ -3321,6 +3331,10 @@ Git diff: https://github.com/DataDog/dd-trace-rb/compare/v0.3.0...v0.3.1
 [#2657]: https://github.com/DataDog/dd-trace-rb/issues/2657
 [#2659]: https://github.com/DataDog/dd-trace-rb/issues/2659
 [#2662]: https://github.com/DataDog/dd-trace-rb/issues/2662
+[#2663]: https://github.com/DataDog/dd-trace-rb/issues/2663
+[#2665]: https://github.com/DataDog/dd-trace-rb/issues/2665
+[#2668]: https://github.com/DataDog/dd-trace-rb/issues/2668
+[#2679]: https://github.com/DataDog/dd-trace-rb/issues/2679
 [@AdrianLC]: https://github.com/AdrianLC
 [@Azure7111]: https://github.com/Azure7111
 [@BabyGroot]: https://github.com/BabyGroot
@@ -3365,6 +3379,7 @@ Git diff: https://github.com/DataDog/dd-trace-rb/compare/v0.3.0...v0.3.1
 [@cjford]: https://github.com/cjford
 [@ck3g]: https://github.com/ck3g
 [@components]: https://github.com/components
+[@coneill-enhance]: https://github.com/coneill-enhance
 [@cswatt]: https://github.com/cswatt
 [@cwoodcox]: https://github.com/cwoodcox
 [@danhodge]: https://github.com/danhodge
@@ -3466,4 +3481,4 @@ Git diff: https://github.com/DataDog/dd-trace-rb/compare/v0.3.0...v0.3.1
 [@y-yagi]: https://github.com/y-yagi
 [@yujideveloper]: https://github.com/yujideveloper
 [@yukimurasawa]: https://github.com/yukimurasawa
-[@zachmccormick]: https://github.com/zachmccormick
+[@zachmccormick]: https://github.com/zachmccormick

data/LICENSE-3rdparty.csv

@@ -5,3 +5,4 @@ lib/datadog/tracing/contrib/utils/quantization/http.rb,https://github.com/ruby/u
 ext/ddtrace_profiling_native_extension/private_vm_api_access,https://github.com/ruby/ruby,BSD-2-Clause,"Copyright (C) 1993-2013 Yukihiro Matsumoto. All rights reserved."
 msgpack,https://rubygems.org/gems/msgpack,Apache-2.0,"Copyright (c) 2008-2015 Sadayuki Furuhashi"
 debase-ruby_core_source,https://rubygems.org/gems/debase-ruby_core_source,MIT for gem and BSD-2-Clause for Ruby sources,"Copyright (c) 2012 Gabriel Horner. Files from Ruby sources are Copyright (C) 1993-2013 Yukihiro Matsumoto. All rights reserved."
+lib/datadog/core/vendor/ipaddr,https://github.com/ruby/ipaddr/blob/master/lib/ipaddr.rb,BSD 2-Clause "Simplified" License,"Copyright (c) 2002 Hajimu UMEMOTO <ume@mahoroba.org> Copyright (c) 2007-2017 Akinori MUSHA <knu@iDaemons.org>"

data/lib/datadog/appsec/component.rb

@@ -8,7 +8,7 @@ module Datadog
     class Component
       class << self
         def build_appsec_component(settings)
-          return unless settings.enabled
+          return unless settings.respond_to?(:appsec) && settings.appsec.enabled
 
           processor = create_processor
           new(processor: processor)

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

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
 require_relative '../../../instrumentation/gateway/argument'
+require_relative '../../../../core/header_collection'
 require_relative '../../../../tracing/client_ip'
-require_relative '../../../../tracing/contrib/rack/header_collection'
 
 module Datadog
   module AppSec
@@ -85,16 +85,9 @@ module Datadog
 
             def client_ip
               remote_ip = remote_addr
-              headers = Datadog::Tracing::Contrib::Rack::Header::RequestHeaderCollection.new(env)
+              header_collection = Datadog::Core::HeaderCollection.from_hash(headers)
 
-              result = Datadog::Tracing::ClientIp.raw_ip_from_request(headers, remote_ip)
-
-              if result.raw_ip
-                ip = Datadog::Tracing::ClientIp.strip_decorations(result.raw_ip)
-                return unless Datadog::Tracing::ClientIp.valid_ip?(ip)
-
-                ip
-              end
+              Datadog::Tracing::ClientIp.extract_client_ip(header_collection, remote_ip)
             end
           end
         end

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

@@ -174,9 +174,6 @@ module Datadog
             TAG_PIPELINE_URL => url,
             TAG_PROVIDER_NAME => 'bitbucket',
             TAG_WORKSPACE_PATH => env['BITBUCKET_CLONE_DIR'],
-            Core::Git::Ext::TAG_COMMIT_AUTHOR_NAME => env['BUILD_REQUESTEDFORID'],
-            Core::Git::Ext::TAG_COMMIT_AUTHOR_EMAIL => env['BUILD_REQUESTEDFOREMAIL'],
-            Core::Git::Ext::TAG_COMMIT_MESSAGE => env['BUILD_SOURCEVERSIONMESSAGE']
           }
         end
 
@@ -265,9 +262,6 @@ module Datadog
             TAG_PIPELINE_URL => pipeline_url,
             TAG_PROVIDER_NAME => 'github',
             TAG_WORKSPACE_PATH => env['GITHUB_WORKSPACE'],
-            Core::Git::Ext::TAG_COMMIT_AUTHOR_NAME => env['BUILD_REQUESTEDFORID'],
-            Core::Git::Ext::TAG_COMMIT_AUTHOR_EMAIL => env['BUILD_REQUESTEDFOREMAIL'],
-            Core::Git::Ext::TAG_COMMIT_MESSAGE => env['BUILD_SOURCEVERSIONMESSAGE'],
             TAG_CI_ENV_VARS => {
               'GITHUB_SERVER_URL' => env['GITHUB_SERVER_URL'],
               'GITHUB_REPOSITORY' => env['GITHUB_REPOSITORY'],
@@ -325,9 +319,6 @@ module Datadog
             TAG_PIPELINE_URL => env['BUILD_URL'],
             TAG_PROVIDER_NAME => 'jenkins',
             TAG_WORKSPACE_PATH => env['WORKSPACE'],
-            Core::Git::Ext::TAG_COMMIT_AUTHOR_NAME => env['BUILD_REQUESTEDFORID'],
-            Core::Git::Ext::TAG_COMMIT_AUTHOR_EMAIL => env['BUILD_REQUESTEDFOREMAIL'],
-            Core::Git::Ext::TAG_COMMIT_MESSAGE => env['BUILD_SOURCEVERSIONMESSAGE'],
             TAG_CI_ENV_VARS => {
               'DD_CUSTOM_TRACE_ID' => env['DD_CUSTOM_TRACE_ID']
             }.to_json
@@ -337,17 +328,8 @@ module Datadog
         def extract_teamcity(env)
           {
             TAG_PROVIDER_NAME => 'teamcity',
-            Core::Git::Ext::TAG_REPOSITORY_URL => env['BUILD_VCS_URL'],
-            Core::Git::Ext::TAG_COMMIT_SHA => env['BUILD_VCS_NUMBER'],
-            TAG_WORKSPACE_PATH => env['BUILD_CHECKOUTDIR'],
-            TAG_PIPELINE_ID => env['BUILD_ID'],
-            TAG_PIPELINE_NUMBER => env['BUILD_NUMBER'],
-            TAG_PIPELINE_URL => (
-              env['SERVER_URL'] && env['BUILD_ID'] ? "#{env['SERVER_URL']}/viewLog.html?buildId=#{env['BUILD_ID']}" : nil
-            ),
-            Core::Git::Ext::TAG_COMMIT_AUTHOR_NAME => env['BUILD_REQUESTEDFORID'],
-            Core::Git::Ext::TAG_COMMIT_AUTHOR_EMAIL => env['BUILD_REQUESTEDFOREMAIL'],
-            Core::Git::Ext::TAG_COMMIT_MESSAGE => env['BUILD_SOURCEVERSIONMESSAGE']
+            TAG_JOB_NAME => env['TEAMCITY_BUILDCONF_NAME'],
+            TAG_JOB_URL => env['BUILD_URL'],
           }
         end
 

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

@@ -88,7 +88,7 @@ module Datadog
           @telemetry = self.class.build_telemetry(settings)
 
           # AppSec
-          @appsec = Datadog::AppSec::Component.build_appsec_component(settings.appsec)
+          @appsec = Datadog::AppSec::Component.build_appsec_component(settings)
         end
 
         # Starts up components

data/lib/datadog/core/utils/network.rb

@@ -0,0 +1,140 @@
+# frozen_string_literal: true
+
+require 'ipaddr'
+require_relative '../vendor/ipaddr'
+
+module Datadog
+  module Core
+    module Utils
+      # Common Network utility functions.
+      module Network
+        DEFAULT_IP_HEADERS_NAMES = %w[
+          x-forwarded-for
+          x-real-ip
+          true-client-ip
+          x-client-ip
+          x-forwarded
+          forwarded-for
+          x-cluster-client-ip
+          fastly-client-ip
+          cf-connecting-ip
+          cf-connecting-ipv6
+        ].freeze
+
+        class << self
+          # Returns a client IP associated with the request if it was
+          #   retrieved successfully.
+          #
+          #
+          # @param [Datadog::Core::HeaderCollection, #get, nil] headers The request headers
+          # @param [Array<String>] list of headers to check.
+          # @return [String] IP value without the port and the zone indentifier.
+          # @return [nil] when no valid IP value found.
+          def stripped_ip_from_request_headers(headers, ip_headers_to_check: DEFAULT_IP_HEADERS_NAMES)
+            ip = ip_header(headers, ip_headers_to_check)
+
+            ip ? ip.to_s : nil
+          end
+
+          # @param [String] IP value.
+          # @return [String] IP value without the port and the zone indentifier.
+          # @return [nil] when no valid IP value found.
+          def stripped_ip(ip)
+            ip = ip_to_ipaddr(ip)
+            ip ? ip.to_s : nil
+          end
+
+          private
+
+          # @param [String] IP value.
+          # @return [IPaddr]
+          # @return [nil] when no valid IP value found.
+          def ip_to_ipaddr(ip)
+            return unless ip
+
+            clean_ip = if likely_ipv4?(ip)
+                         strip_ipv4_port(ip)
+                       else
+                         strip_zone_specifier(strip_ipv6_port(ip))
+                       end
+
+            begin
+              IPAddr.new(clean_ip)
+            rescue IPAddr::Error
+              nil
+            end
+          end
+
+          def ip_header(headers, ip_headers_to_check)
+            return unless headers
+
+            ip_headers_to_check.each do |name|
+              value = headers.get(name)
+
+              next unless value
+
+              ips = value.split(',')
+              ips.each do |ip|
+                parsed_ip = ip_to_ipaddr(ip.strip)
+
+                return parsed_ip if global_ip?(parsed_ip)
+              end
+            end
+
+            nil
+          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 likely_ipv4?(value)
+            dot_index = value.index('.') || value.size
+            colon_index = value.index(':') || value.size
+
+            dot_index < colon_index
+          end
+
+          def strip_zone_specifier(ipv6)
+            ipv6.gsub(/%.*/, '')
+          end
+
+          def strip_ipv6_port(ip)
+            if /\[(.*)\](?::\d+)?/ =~ ip
+              Regexp.last_match(1)
+            else
+              ip
+            end
+          end
+
+          def strip_ipv4_port(ip)
+            ip.gsub(/:\d+\z/, '')
+          end
+
+          def global_ip?(parsed_ip)
+            parsed_ip && !private?(parsed_ip) && !loopback?(parsed_ip) && !link_local?(parsed_ip)
+          end
+
+          # TODO: remove once we drop support for ruby 2.1, 2.2, 2.3, 2.4
+          # replace with ip.private?
+          def private?(ip)
+            Datadog::Core::Vendor::IPAddr.private?(ip)
+          end
+
+          # TODO: remove once we drop support for ruby 2.1, 2.2, 2.3, 2.4
+          # replace with ip.link_local?
+          def link_local?(ip)
+            Datadog::Core::Vendor::IPAddr.link_local?(ip)
+          end
+
+          # TODO: remove once we drop support for ruby 2.1, 2.2, 2.3, 2.4
+          # replace with ip.loopback
+          def loopback?(ip)
+            Datadog::Core::Vendor::IPAddr.loopback?(ip)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/datadog/core/vendor/ipaddr.rb

@@ -0,0 +1,78 @@
+# Copyright (c) 2002 Hajimu UMEMOTO <ume@mahoroba.org>
+# Copyright (c) 2007-2017 Akinori MUSHA <knu@iDaemons.org>
+
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions
+# are met:
+# 1. Redistributions of source code must retain the above copyright
+# notice, this list of conditions and the following disclaimer.
+# 2. Redistributions in binary form must reproduce the above copyright
+# notice, this list of conditions and the following disclaimer in the
+# documentation and/or other materials provided with the distribution.
+
+# THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
+# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+# ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
+# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+# OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+# HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+# OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+# SUCH DAMAGE.
+
+module Datadog
+  module Core
+    module Vendor
+      # vendor code from https://github.com/ruby/ipaddr/blob/master/lib/ipaddr.rb
+      # Ruby version below 2.5 does not have the IpAddr#private? method
+      # We have to vendor the code because ruby versions below 2.5 did not extract ipaddr as a gem
+      # So we can not specify a specific version for ipaddr for ruby versions: 2.1, 2.2, 2.3, 2.4
+      module IPAddr
+        class << self
+          def private?(ip)
+            addr = ip.instance_variable_get(:@addr)
+
+            case ip.family
+            when Socket::AF_INET
+              addr & 0xff000000 == 0x0a000000 ||    # 10.0.0.0/8
+                addr & 0xfff00000 == 0xac100000 ||  # 172.16.0.0/12
+                addr & 0xffff0000 == 0xc0a80000     # 192.168.0.0/16
+            when Socket::AF_INET6
+              addr & 0xfe00_0000_0000_0000_0000_0000_0000_0000 == 0xfc00_0000_0000_0000_0000_0000_0000_0000
+            else
+              raise ::IPAddr::AddressFamilyError, 'unsupported address family'
+            end
+          end
+
+          def link_local?(ip)
+            addr = ip.instance_variable_get(:@addr)
+
+            case ip.family
+            when Socket::AF_INET
+              addr & 0xffff0000 == 0xa9fe0000 # 169.254.0.0/16
+            when Socket::AF_INET6
+              addr & 0xffc0_0000_0000_0000_0000_0000_0000_0000 == 0xfe80_0000_0000_0000_0000_0000_0000_0000
+            else
+              raise ::IPAddr::AddressFamilyError, 'unsupported address family'
+            end
+          end
+
+          def loopback?(ip)
+            addr = ip.instance_variable_get(:@addr)
+
+            case ip.family
+            when Socket::AF_INET
+              addr & 0xff000000 == 0x7f000000
+            when Socket::AF_INET6
+              addr == 1
+            else
+              raise ::IPAddr::AddressFamilyError, 'unsupported address family'
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/datadog/kit/appsec/events.rb

@@ -23,7 +23,7 @@ module Datadog
           track(LOGIN_SUCCESS_EVENT, trace, **others)
 
           user_options = user.dup
-          user_id = user.delete(:id)
+          user_id = user_options.delete(:id)
 
           raise ArgumentError, 'missing required key: :user => { :id }' if user_id.nil?
 

data/lib/datadog/tracing/client_ip.rb

@@ -1,162 +1,61 @@
+# frozen_string_literal: true
+
 require_relative '../core/configuration'
+require_relative '../core/utils/network'
 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
-
-        set_client_ip_tag!(span, headers: headers, remote_ip: remote_ip)
-      end
-
-      # Forcefully sets the `http.client_ip` tag on the given span.
-      #
-      # This function ignores the user's `enabled` setting.
-      #
-      # @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)
-        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(','))
+      class << self
+        # 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.
+        #
+        # @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 set_client_ip_tag(span, headers: nil, remote_ip: nil)
+          return unless configuration.enabled
+
+          set_client_ip_tag!(span, headers: headers, remote_ip: remote_ip)
         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)
+        # Forcefully sets the `http.client_ip` tag on the given span.
+        #
+        # This function ignores the user's `enabled` setting.
+        #
+        # @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 set_client_ip_tag!(span, headers: nil, remote_ip: nil)
+          ip = extract_client_ip(headers, remote_ip)
+
+          span.set_tag(Tracing::Metadata::Ext::HTTP::TAG_CLIENT_IP, ip) if ip
         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)
+        def extract_client_ip(headers, remote_ip)
+          if headers && configuration.header_name
+            return Datadog::Core::Utils::Network.stripped_ip_from_request_headers(
+              headers,
+              ip_headers_to_check: Array(configuration.header_name)
+            )
+          end
 
-        address = strip_ipv6_port(address)
-
-        strip_zone_specifier(address)
-      end
+          ip_from_headers = Datadog::Core::Utils::Network.stripped_ip_from_request_headers(headers) if headers
 
-      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
+          ip_from_headers || Datadog::Core::Utils::Network.stripped_ip(remote_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?('/')
+        private
 
-        begin
-          IPAddr.new(ip)
-
-          true
-        rescue IPAddr::Error
-          false
+        def configuration
+          Datadog.configuration.tracing.client_ip
         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/ddtrace/transport/http/traces.rb

@@ -25,7 +25,7 @@ module Datadog
 
         # Extensions for HTTP client
         module Client
-          def send_payload(request)
+          def send_traces_payload(request)
             send_request(request) do |api, env|
               api.send_traces(env)
             end

data/lib/ddtrace/transport/traces.rb

@@ -128,7 +128,7 @@ module Datadog
           responses = chunker.encode_in_chunks(traces.lazy).map do |encoded_traces, trace_count|
             request = Request.new(EncodedParcel.new(encoded_traces, trace_count))
 
-            client.send_payload(request).tap do |response|
+            client.send_traces_payload(request).tap do |response|
               if downgrade?(response)
                 downgrade!
                 return send_traces(traces)

data/lib/ddtrace/version.rb

@@ -2,7 +2,7 @@ module DDTrace
   module VERSION
     MAJOR = 1
     MINOR = 10
-    PATCH = 0
+    PATCH = 1
     PRE = nil
 
     STRING = [MAJOR, MINOR, PATCH, PRE].compact.join('.')

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ddtrace
 version: !ruby/object:Gem::Version
-  version: 1.10.0
+  version: 1.10.1
 platform: ruby
 authors:
 - Datadog, Inc.
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-03-06 00:00:00.000000000 Z
+date: 1980-01-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: msgpack
@@ -281,12 +281,14 @@ files:
 - lib/datadog/core/utils.rb
 - lib/datadog/core/utils/compression.rb
 - lib/datadog/core/utils/forking.rb
+- lib/datadog/core/utils/network.rb
 - lib/datadog/core/utils/object_set.rb
 - lib/datadog/core/utils/only_once.rb
 - lib/datadog/core/utils/safe_dup.rb
 - lib/datadog/core/utils/sequence.rb
 - lib/datadog/core/utils/string_table.rb
 - lib/datadog/core/utils/time.rb
+- lib/datadog/core/vendor/ipaddr.rb
 - lib/datadog/core/vendor/multipart-post/LICENSE
 - lib/datadog/core/vendor/multipart-post/multipart.rb
 - lib/datadog/core/vendor/multipart-post/multipart/post.rb
@@ -826,7 +828,7 @@ licenses:
 - BSD-3-Clause
 metadata:
   allowed_push_host: https://rubygems.org
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -844,8 +846,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 2.0.0
 requirements: []
-rubygems_version: 3.3.15
-signing_key: 
+rubygems_version: 3.3.20
+signing_key:
 specification_version: 4
 summary: Datadog tracing code for your Ruby applications
 test_files: []