ddtrace 1.0.0 → 1.10.1

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
@@ -36,10 +32,10 @@ module Datadog
           define_singleton_method(:now, &block)
         end
 
-        def measure
-          before = get_time
+        def measure(unit = :float_second)
+          before = get_time(unit)
           yield
-          after = get_time
+          after = get_time(unit)
           after - before
         end
 

data/lib/datadog/core/utils.rb

@@ -1,7 +1,4 @@
-# typed: true
-
-require 'datadog/core/utils/forking'
-require 'datadog/tracing/span'
+require_relative 'utils/forking'
 
 module Datadog
   module Core
@@ -11,26 +8,6 @@ module Datadog
       extend Forking
 
       EMPTY_STRING = ''.encode(::Encoding::UTF_8).freeze
-      # We use a custom random number generator because we want no interference
-      # with the default one. Using the default prng, we could break code that
-      # would rely on srand/rand sequences.
-
-      # Return a randomly generated integer, valid as a Span ID or Trace ID.
-      # This method is thread-safe and fork-safe.
-      def self.next_id
-        after_fork! { reset! }
-        id_rng.rand(Tracing::Span::RUBY_MAX_ID) # TODO: This should never return zero
-      end
-
-      def self.id_rng
-        @id_rng ||= Random.new
-      end
-
-      def self.reset!
-        @id_rng = Random.new
-      end
-
-      private_class_method :id_rng, :reset!
 
       # Stringifies `value` and ensures the outcome is
       # string is no longer than `size`.

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,13 +1,11 @@
-# typed: false
-
 #--
 # Copyright (c) 2007-2013 Nick Sieger.
 # See the file README.txt included with the distribution for
 # software license details.
 #++
 
-require 'datadog/core/vendor/multipart-post/multipart/post/parts'
-require 'datadog/core/vendor/multipart-post/multipart/post/composite_read_io'
+require_relative 'parts'
+require_relative 'composite_read_io'
 require 'securerandom'
 
 module Datadog

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
@@ -9,9 +7,9 @@
 require 'net/http'
 require 'stringio'
 require 'cgi'
-require 'datadog/core/vendor/multipart-post/multipart/post/parts'
-require 'datadog/core/vendor/multipart-post/multipart/post/composite_read_io'
-require 'datadog/core/vendor/multipart-post/multipart/post/multipartable'
+require_relative '../../../multipart/post/parts'
+require_relative '../../../multipart/post/composite_read_io'
+require_relative '../../../multipart/post/multipartable'
 
 module Datadog
   module Core

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,6 +1,4 @@
-# typed: false
-
-require 'datadog/core/logger'
+require_relative '../logger'
 
 module Datadog
   module Core
@@ -8,7 +6,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
@@ -138,7 +135,9 @@ module Datadog
               # rubocop:disable Lint/RescueException
               rescue Exception => e
                 @error = e
-                Datadog.logger.debug("Worker thread error. Cause #{e.message} Location: #{Array(e.backtrace).first}")
+                Datadog.logger.debug(
+                  "Worker thread error. Cause: #{e.class.name} #{e.message} Location: #{Array(e.backtrace).first}"
+                )
                 raise
               end
               # rubocop:enable Lint/RescueException
@@ -173,7 +172,6 @@ module Datadog
             end
           end
         end
-        # rubocop:enable Metrics/ModuleLength
       end
     end
   end

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,7 +1,5 @@
-# typed: false
-
-require 'datadog/core/workers/async'
-require 'datadog/core/workers/interval_loop'
+require_relative 'async'
+require_relative 'interval_loop'
 
 module Datadog
   module Core

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,19 +1,14 @@
-# typed: false
+require_relative '../runtime/metrics'
 
-require 'forwardable'
-
-require 'datadog/core/runtime/metrics'
-
-require 'datadog/core/worker'
-require 'datadog/core/workers/async'
-require 'datadog/core/workers/polling'
+require_relative '../worker'
+require_relative 'async'
+require_relative 'polling'
 
 module Datadog
   module Core
     module Workers
       # Emits runtime metrics asynchronously on a timed loop
       class RuntimeMetrics < Worker
-        extend Forwardable
         include Workers::Polling
 
         # In seconds

data/lib/datadog/core.rb

@@ -1,64 +1,35 @@
-# typed: strict
+# frozen_string_literal: true
 
-# TODO: Move these requires to smaller modules.
-#       Would be better to lazy load these; not
-#       all of these components will be used in
-#       every application.
-# require 'datadog/core/buffer/cruby'
-# require 'datadog/core/buffer/random'
-# require 'datadog/core/buffer/thread_safe'
-# require 'datadog/core/chunker'
-# require 'datadog/core/configuration'
-# require 'datadog/core/diagnostics/environment_logger'
-# require 'datadog/core/diagnostics/ext'
-# require 'datadog/core/diagnostics/health'
-# require 'datadog/core/encoding'
-# require 'datadog/core/environment/cgroup'
-# require 'datadog/core/environment/class_count'
-# require 'datadog/core/environment/container'
-# require 'datadog/core/environment/ext'
-# require 'datadog/core/environment/gc'
-# require 'datadog/core/environment/identity'
-# require 'datadog/core/environment/socket'
-# require 'datadog/core/environment/thread_count'
-# require 'datadog/core/environment/variable_helpers'
-# require 'datadog/core/environment/vm_cache'
-# require 'datadog/core/error'
-# require 'datadog/core/event'
-# require 'datadog/core/git/ext'
-# require 'datadog/core/logger'
-# require 'datadog/core/metrics/client'
-# require 'datadog/core/metrics/ext'
-# require 'datadog/core/metrics/helpers'
-# require 'datadog/core/metrics/logging'
-# require 'datadog/core/metrics/metric'
-# require 'datadog/core/metrics/options'
-# require 'datadog/core/pin'
-# require 'datadog/core/quantization/hash'
-# require 'datadog/core/quantization/http'
-# require 'datadog/core/runtime/ext'
-# require 'datadog/core/runtime/metrics'
-# require 'datadog/core/utils'
-# require 'datadog/core/utils/compression'
-# require 'datadog/core/utils/database'
-# require 'datadog/core/utils/forking'
-# require 'datadog/core/utils/object_set'
-# require 'datadog/core/utils/only_once'
-# require 'datadog/core/utils/sequence'
-# require 'datadog/core/utils/string_table'
-# require 'datadog/core/utils/time'
-# require 'datadog/core/worker'
-# require 'datadog/core/workers/async'
-# require 'datadog/core/workers/interval_loop'
-# require 'datadog/core/workers/polling'
-# require 'datadog/core/workers/queue'
-# require 'datadog/core/workers/runtime_metrics'
-
-require 'datadog/core/extensions'
+require_relative 'core/extensions'
 
 # We must load core extensions to make certain global APIs
 # accessible: both for Datadog features and the core itself.
 module Datadog
+  # Common, lower level, internal code used (or usable) by two or more
+  # products. It is a dependency of each product. Contrast with Datadog::Kit
+  # for higher-level features.
+  module Core
+    class << self
+      # Records the occurrence of a deprecated operation in this library.
+      #
+      # Currently, these operations are logged to `Datadog.logger` at `warn` level.
+      #
+      # `disallowed_next_major` adds a message informing that the deprecated operation
+      # won't be allowed in the next major release.
+      #
+      # @yieldreturn [String] a String with the lazily evaluated deprecation message.
+      # @param [Boolean] disallowed_next_major whether this deprecation will be enforced in the next major release.
+      def log_deprecation(disallowed_next_major: true)
+        Datadog.logger.warn do
+          message = yield
+          message += ' This will be enforced in the next major release.' if disallowed_next_major
+          message
+        end
+        nil
+      end
+    end
+  end
+
   extend Core::Extensions
 
   # Add shutdown hook:

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

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+require_relative '../identity'
+
+module Datadog
+  module Kit
+    module AppSec
+      # Tracking events
+      module Events
+        LOGIN_SUCCESS_EVENT = 'users.login.success'
+        LOGIN_FAILURE_EVENT = 'users.login.failure'
+
+        # Attach login success event information to the trace
+        #
+        # This method is experimental and may change in the future.
+        #
+        # @param trace [TraceOperation] Trace to attach data to.
+        # @param user [Hash<Symbol, String>] User information to pass to
+        #   Datadog::Kit::Identity.set_user. Must contain at least :id as key.
+        # @param others [Hash<String || Symbol, String>] Additional free-form
+        #   event information to attach to the trace.
+        def self.track_login_success(trace, user:, **others)
+          track(LOGIN_SUCCESS_EVENT, trace, **others)
+
+          user_options = user.dup
+          user_id = user_options.delete(:id)
+
+          raise ArgumentError, 'missing required key: :user => { :id }' if user_id.nil?
+
+          Kit::Identity.set_user(trace, id: user_id, **user_options)
+        end
+
+        # Attach login failure event information to the trace
+        #
+        # This method is experimental and may change in the future.
+        #
+        # @param trace [TraceOperation] Trace to attach data to.
+        # @param user_id [String] User id that attempted login
+        # @param user_exists [bool] Whether the user id that did a login attempt exists.
+        # @param others [Hash<String || Symbol, String>] Additional free-form
+        #   event information to attach to the trace.
+        def self.track_login_failure(trace, user_id:, user_exists:, **others)
+          track(LOGIN_FAILURE_EVENT, trace, **others)
+
+          raise ArgumentError, 'user_id cannot be nil' if user_id.nil?
+
+          trace.set_tag('appsec.events.users.login.failure.usr.id', user_id)
+          trace.set_tag('appsec.events.users.login.failure.usr.exists', user_exists)
+        end
+
+        # Attach custom event information to the trace
+        #
+        # This method is experimental and may change in the future.
+        #
+        # @param event [String] Mandatory. Event code.
+        # @param trace [TraceOperation] Trace to attach data to.
+        # @param others [Hash<Symbol, String>] Additional free-form
+        #   event information to attach to the trace. Key must not
+        #   be :track.
+        def self.track(event, trace, **others)
+          trace.set_tag("appsec.events.#{event}.track", 'true')
+
+          others.each do |k, v|
+            raise ArgumentError, 'key cannot be :track' if k.to_sym == :track
+
+            trace.set_tag("appsec.events.#{event}.#{k}", v) unless v.nil?
+          end
+
+          trace.keep!
+        end
+      end
+    end
+  end
+end

data/lib/datadog/kit/enable_core_dumps.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module Datadog
+  module Kit
+    # This helper is used to enable core dumps for the current Ruby app. This is useful when debugging native-level
+    # crashes.
+    #
+    # It can be enabled simply by adding `require 'datadog/kit/enable_core_dumps'` to start of the app.
+    module EnableCoreDumps
+      def self.call
+        current_size, maximum_size = Process.getrlimit(:CORE)
+        core_pattern =
+          begin
+            File.read('/proc/sys/kernel/core_pattern').strip
+          rescue
+            '(Could not open /proc/sys/kernel/core_pattern)'
+          end
+
+        if maximum_size <= 0
+          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!')
+          return
+        end
+
+        begin
+          Process.setrlimit(:CORE, maximum_size)
+        rescue => e
+          Kernel.warn(
+            "[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}'")
+        else
+          Kernel.warn(
+            "[ddtrace] Raised core dump limit. Old size: #{current_size} " \
+            "Maximum size: #{maximum_size} Output pattern: '#{core_pattern}'"
+          )
+        end
+      end
+    end
+  end
+end
+
+Datadog::Kit::EnableCoreDumps.call

data/lib/datadog/kit/identity.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+require_relative '../appsec/instrumentation/gateway/argument'
+
+module Datadog
+  module Kit
+    # Tracking identity via traces
+    module Identity
+      # Attach user information to the trace
+      #
+      # @param trace [TraceOperation] Trace to attach data to.
+      # @param id [String] Mandatory. Username or client id extracted
+      #   from the access token or Authorization header in the inbound request
+      #   from outside the system.
+      # @param email [String] Email of the authenticated user associated
+      #   to the trace.
+      # @param name [String] User-friendly name. To be displayed in the
+      #   UI if set.
+      # @param session_id [String] Session ID of the authenticated user.
+      # @param role [String] Actual/assumed role the client is making
+      #   the request under extracted from token or application security
+      #   context.
+      # @param scope [String] Scopes or granted authorities the client
+      #   currently possesses extracted from token or application security
+      #   context. The value would come from the scope associated with an OAuth
+      #   2.0 Access Token or an attribute value in a SAML 2.0 Assertion.
+      # @param others [Hash<Symbol, String>] Additional free-form
+      #   user information to attach to the trace.
+      #
+      # rubocop:disable Metrics/CyclomaticComplexity
+      # rubocop:disable Metrics/PerceivedComplexity
+      def self.set_user(trace, id:, email: nil, name: nil, session_id: nil, role: nil, scope: nil, **others)
+        raise ArgumentError, 'missing required key: :id' if id.nil?
+
+        # enforce types
+
+        raise TypeError, ':id must be a String'         unless id.is_a?(String)
+        raise TypeError, ':email must be a String'      unless email.nil? || email.is_a?(String)
+        raise TypeError, ':name must be a String'       unless name.nil? || name.is_a?(String)
+        raise TypeError, ':session_id must be a String' unless session_id.nil? || session_id.is_a?(String)
+        raise TypeError, ':role must be a String'       unless role.nil? || role.is_a?(String)
+        raise TypeError, ':scope must be a String'      unless scope.nil? || scope.is_a?(String)
+
+        others.each do |k, v|
+          raise TypeError, "#{k.inspect} must be a String" unless v.nil? || v.is_a?(String)
+        end
+
+        # set tags once data is known consistent
+
+        trace.set_tag('usr.id', id)
+        trace.set_tag('usr.email', email)           unless email.nil?
+        trace.set_tag('usr.name', name)             unless name.nil?
+        trace.set_tag('usr.session_id', session_id) unless session_id.nil?
+        trace.set_tag('usr.role', role)             unless role.nil?
+        trace.set_tag('usr.scope', scope)           unless scope.nil?
+
+        others.each do |k, v|
+          trace.set_tag("usr.#{k}", v) unless v.nil?
+        end
+
+        if Datadog.configuration.appsec.enabled
+          user = ::Datadog::AppSec::Instrumentation::Gateway::User.new(id)
+          ::Datadog::AppSec::Instrumentation.gateway.push('identity.set_user', user)
+        end
+      end
+      # rubocop:enable Metrics/PerceivedComplexity
+      # rubocop:enable Metrics/CyclomaticComplexity
+    end
+  end
+end

data/lib/datadog/kit.rb

@@ -0,0 +1,9 @@
+module Datadog
+  # Datadog::Kit holds public-facing APIs for higher level user-facing
+  # features, these features not belonging to a specific product. Contrary to
+  # Datadog::Core, Kit depends on products.
+  module Kit
+  end
+end
+
+require_relative 'kit/identity'