ddtrace 1.9.0 → 1.10.1

data/lib/datadog/core/logger.rb

@@ -1,5 +1,3 @@
-# typed: true
-
 require 'logger'
 
 module Datadog

data/lib/datadog/core/metrics/client.rb

@@ -1,5 +1,3 @@
-# typed: false
-
 require_relative '../utils/time'
 require_relative '../utils/only_once'
 require_relative '../configuration/ext'

data/lib/datadog/core/metrics/ext.rb

@@ -1,5 +1,3 @@
-# typed: true
-
 module Datadog
   module Core
     module Metrics

data/lib/datadog/core/metrics/helpers.rb

@@ -1,5 +1,3 @@
-# typed: false
-
 module Datadog
   module Core
     module Metrics

data/lib/datadog/core/metrics/logging.rb

@@ -1,5 +1,3 @@
-# typed: true
-
 require 'logger'
 require 'json'
 

data/lib/datadog/core/metrics/metric.rb

@@ -1,5 +1,3 @@
-# typed: false
-
 module Datadog
   module Core
     module Metrics

data/lib/datadog/core/metrics/options.rb

@@ -1,5 +1,3 @@
-# typed: true
-
 require_relative 'ext'
 require_relative '../environment/ext'
 require_relative '../environment/identity'

data/lib/datadog/core/pin.rb

@@ -1,5 +1,3 @@
-# typed: true
-
 module Datadog
   module Core
     # A {Datadog::Core::Pin} sets metadata on a particular object.

data/lib/datadog/core/runtime/ext.rb

@@ -1,5 +1,3 @@
-# typed: true
-
 module Datadog
   module Core
     module Runtime
@@ -19,6 +17,8 @@ module Datadog
           METRIC_THREAD_COUNT = 'runtime.ruby.thread_count'.freeze
           METRIC_GLOBAL_CONSTANT_STATE = 'runtime.ruby.global_constant_state'.freeze
           METRIC_GLOBAL_METHOD_STATE = 'runtime.ruby.global_method_state'.freeze
+          METRIC_CONSTANT_CACHE_INVALIDATIONS = 'runtime.ruby.constant_cache_invalidations'.freeze
+          METRIC_CONSTANT_CACHE_MISSES = 'runtime.ruby.constant_cache_misses'.freeze
 
           TAG_SERVICE = 'service'.freeze
         end

data/lib/datadog/core/runtime/metrics.rb

@@ -1,5 +1,3 @@
-# typed: true
-
 require_relative 'ext'
 
 require_relative '../metrics/client'
@@ -57,15 +55,27 @@ module Datadog
 
           try_flush do
             if Core::Environment::VMCache.available?
-              gauge(
+              # Only on Ruby < 3.2
+              gauge_if_not_nil(
                 Core::Runtime::Ext::Metrics::METRIC_GLOBAL_CONSTANT_STATE,
                 Core::Environment::VMCache.global_constant_state
               )
 
-              # global_method_state is not available since Ruby >= 3.0,
-              # as method caching was moved to a per-class basis.
-              global_method_state = Core::Environment::VMCache.global_method_state
-              gauge(Core::Runtime::Ext::Metrics::METRIC_GLOBAL_METHOD_STATE, global_method_state) if global_method_state
+              # Only on Ruby 2.x
+              gauge_if_not_nil(
+                Core::Runtime::Ext::Metrics::METRIC_GLOBAL_METHOD_STATE,
+                Core::Environment::VMCache.global_method_state
+              )
+
+              # Only on Ruby >= 3.2
+              gauge_if_not_nil(
+                Core::Runtime::Ext::Metrics::METRIC_CONSTANT_CACHE_INVALIDATIONS,
+                Core::Environment::VMCache.constant_cache_invalidations
+              )
+              gauge_if_not_nil(
+                Core::Runtime::Ext::Metrics::METRIC_CONSTANT_CACHE_MISSES,
+                Core::Environment::VMCache.constant_cache_misses
+              )
             end
           end
         end
@@ -120,6 +130,10 @@ module Datadog
         def to_metric_name(str)
           str.downcase.gsub(/[-\s]/, '_')
         end
+
+        def gauge_if_not_nil(metric_name, metric_value)
+          gauge(metric_name, metric_value) if metric_value
+        end
       end
     end
   end

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

@@ -1,5 +1,3 @@
-# typed: true
-
 require_relative 'emitter'
 require_relative 'heartbeat'
 require_relative '../utils/forking'

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

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-# typed: true
-
 require 'etc'
 
 require_relative '../configuration/agent_settings_resolver'

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

@@ -1,5 +1,3 @@
-# typed: true
-
 require_relative 'event'
 require_relative 'http/transport'
 require_relative '../utils/sequence'

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

@@ -1,5 +1,3 @@
-# typed: true
-
 require_relative 'collector'
 require_relative 'v1/app_event'
 require_relative 'v1/telemetry_request'
@@ -9,8 +7,6 @@ module Datadog
     module Telemetry
       # Class defining methods to construct a Telemetry event
       class Event
-        include Kernel
-
         include Telemetry::Collector
 
         API_VERSION = 'v1'.freeze

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

@@ -1,5 +1,3 @@
-# typed: true
-
 module Datadog
   module Core
     module Telemetry

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

@@ -1,5 +1,3 @@
-# typed: false
-
 require_relative '../worker'
 require_relative '../workers/polling'
 

data/lib/datadog/core/telemetry/http/adapters/net.rb

@@ -1,5 +1,3 @@
-# typed: true
-
 require_relative '../response'
 
 module Datadog

data/lib/datadog/core/telemetry/http/env.rb

@@ -1,5 +1,3 @@
-# typed: true
-
 module Datadog
   module Core
     module Telemetry

data/lib/datadog/core/telemetry/http/response.rb

@@ -1,13 +1,9 @@
-# typed: true
-
 module Datadog
   module Core
     module Telemetry
       module Http
         # Module for base HTTP response
         module Response
-          include Kernel
-
           def payload
             nil
           end

data/lib/datadog/core/telemetry/http/transport.rb

@@ -1,5 +1,3 @@
-# typed: true
-
 require_relative '../../configuration/settings'
 require_relative 'env'
 require_relative 'ext'

data/lib/datadog/core/telemetry/v1/app_event.rb

@@ -4,8 +4,6 @@ module Datadog
       module V1
         # Describes payload for telemetry V1 API app-integrations-change event
         class AppEvent
-          include Kernel
-
           attr_reader \
             :additional_payload,
             :configuration,

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

@@ -1,5 +1,3 @@
-# typed: true
-
 require 'stringio'
 require 'zlib'
 

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

@@ -1,5 +1,3 @@
-# typed: false
-
 module Datadog
   module Core
     module Utils

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/utils/object_set.rb

@@ -1,5 +1,3 @@
-# typed: true
-
 require_relative 'sequence'
 
 module Datadog

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

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-# typed: true
-
 module Datadog
   module Core
     module Utils

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

@@ -1,5 +1,3 @@
-# typed: false
-
 module Datadog
   module Core
     module Utils

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

@@ -1,5 +1,3 @@
-# typed: true
-
 module Datadog
   module Core
     module Utils

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

@@ -1,5 +1,3 @@
-# typed: true
-
 require_relative 'sequence'
 
 module Datadog

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

@@ -1,12 +1,8 @@
-# typed: true
-
 module Datadog
   module Core
     module Utils
       # Common database-related utility functions.
       module Time
-        include Kernel # Ensure that kernel methods are always available (https://sorbet.org/docs/error-reference#7003)
-
         module_function
 
         # Current monotonic time

data/lib/datadog/core/utils.rb

@@ -1,5 +1,3 @@
-# typed: true
-
 require_relative 'utils/forking'
 
 module Datadog

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/core/vendor/multipart-post/multipart/post/composite_read_io.rb

@@ -1,5 +1,3 @@
-# typed: false
-
 #--
 # Copyright (c) 2007-2012 Nick Sieger.
 # See the file README.txt included with the distribution for

data/lib/datadog/core/vendor/multipart-post/multipart/post/multipartable.rb

@@ -1,5 +1,3 @@
-# typed: false
-
 #--
 # Copyright (c) 2007-2013 Nick Sieger.
 # See the file README.txt included with the distribution for

data/lib/datadog/core/vendor/multipart-post/multipart/post/parts.rb

@@ -1,5 +1,3 @@
-# typed: true
-
 #--
 # Copyright (c) 2007-2013 Nick Sieger.
 # See the file README.txt included with the distribution for

data/lib/datadog/core/vendor/multipart-post/multipart/post/version.rb

@@ -1,5 +1,3 @@
-# typed: strict
-
 module Datadog
   module Core
     module Vendor

data/lib/datadog/core/vendor/multipart-post/multipart/post.rb

@@ -1,5 +1,3 @@
-# typed: strict
-
 module Datadog
   module Core
     module Vendor

data/lib/datadog/core/vendor/multipart-post/multipart.rb

@@ -1,5 +1,3 @@
-# typed: strict
-
 #--
 # Copyright (c) 2007-2013 Nick Sieger.
 # See the file README.txt included with the distribution for

data/lib/datadog/core/vendor/multipart-post/net/http/post/multipart.rb

@@ -1,5 +1,3 @@
-# typed: strict
-
 #--
 # Copyright (c) 2007-2012 Nick Sieger.
 # See the file README.txt included with the distribution for

data/lib/datadog/core/worker.rb

@@ -1,5 +1,3 @@
-# typed: true
-
 module Datadog
   module Core
     # Base class for work tasks

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

@@ -1,5 +1,3 @@
-# typed: false
-
 require_relative '../logger'
 
 module Datadog

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

@@ -1,5 +1,3 @@
-# typed: false
-
 module Datadog
   module Core
     module Workers

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

@@ -1,5 +1,3 @@
-# typed: false
-
 require_relative 'async'
 require_relative 'interval_loop'
 

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

@@ -1,5 +1,3 @@
-# typed: false
-
 module Datadog
   module Core
     module Workers

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

@@ -1,5 +1,3 @@
-# typed: false
-
 require_relative '../runtime/metrics'
 
 require_relative '../worker'

data/lib/datadog/core.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# typed: true
 
 require_relative 'core/extensions'
 

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

@@ -1,4 +1,3 @@
-# typed: false
 # frozen_string_literal: true
 
 require_relative '../identity'
@@ -24,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/kit/enable_core_dumps.rb

@@ -1,4 +1,3 @@
-# typed: ignore
 # frozen_string_literal: true
 
 module Datadog
@@ -18,10 +17,10 @@ module Datadog
           end
 
         if maximum_size <= 0
-          Kernel.warn("[DDTRACE] Could not enable core dumps on crash, maximum size is #{maximum_size} (disabled).")
+          Kernel.warn("[ddtrace] Could not enable core dumps on crash, maximum size is #{maximum_size} (disabled).")
           return
         elsif maximum_size == current_size
-          Kernel.warn('[DDTRACE] Core dumps already enabled, nothing to do!')
+          Kernel.warn('[ddtrace] Core dumps already enabled, nothing to do!')
           return
         end
 
@@ -29,17 +28,17 @@ module Datadog
           Process.setrlimit(:CORE, maximum_size)
         rescue => e
           Kernel.warn(
-            "[DDTRACE] Failed to enable core dumps. Cause: #{e.class.name} #{e.message} " \
+            "[ddtrace] Failed to enable core dumps. Cause: #{e.class.name} #{e.message} " \
             "Location: #{Array(e.backtrace).first}"
           )
           return
         end
 
         if current_size == 0
-          Kernel.warn("[DDTRACE] Enabled core dumps. Maximum size: #{maximum_size} Output pattern: '#{core_pattern}'")
+          Kernel.warn("[ddtrace] Enabled core dumps. Maximum size: #{maximum_size} Output pattern: '#{core_pattern}'")
         else
           Kernel.warn(
-            "[DDTRACE] Raised core dump limit. Old size: #{current_size} " \
+            "[ddtrace] Raised core dump limit. Old size: #{current_size} " \
             "Maximum size: #{maximum_size} Output pattern: '#{core_pattern}'"
           )
         end