ddtrace 1.4.2 → 1.23.3

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,4 +1,4 @@
-# typed: true
+# frozen_string_literal: true
 
 module Datadog
   module Core

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

@@ -1,5 +1,3 @@
-# typed: false
-
 require_relative '../logger'
 
 module Datadog
@@ -8,12 +6,15 @@ 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
           SHUTDOWN_TIMEOUT = 1
 
+          # This single shared mutex is used to avoid concurrency issues during the
+          # initialization of per-instance lazy-initialized mutexes.
+          MUTEX_INIT = Mutex.new
+
           def self.included(base)
             base.prepend(PrependedMethods)
           end
@@ -89,7 +90,7 @@ module Datadog
             :result
 
           def mutex
-            @mutex ||= Mutex.new
+            (defined?(@mutex) && @mutex) || MUTEX_INIT.synchronize { @mutex ||= Mutex.new }
           end
 
           def after_fork
@@ -102,7 +103,7 @@ module Datadog
             :pid
 
           def mutex_after_fork
-            @mutex_after_fork ||= Mutex.new
+            (defined?(@mutex_after_fork) && @mutex_after_fork) || MUTEX_INIT.synchronize { @mutex_after_fork ||= Mutex.new }
           end
 
           def worker
@@ -146,6 +147,7 @@ module Datadog
               # rubocop:enable Lint/RescueException
             end
             @worker.name = self.class.name unless Gem::Version.new(RUBY_VERSION) < Gem::Version.new('2.3')
+            @worker.thread_variable_set(:fork_safe, true)
 
             nil
           end
@@ -175,7 +177,6 @@ module Datadog
             end
           end
         end
-        # rubocop:enable Metrics/ModuleLength
       end
     end
   end

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

@@ -1,4 +1,4 @@
-# typed: false
+# frozen_string_literal: true
 
 module Datadog
   module Core
@@ -10,6 +10,10 @@ module Datadog
         BACK_OFF_MAX = 5
         BASE_INTERVAL = 1
 
+        # This single shared mutex is used to avoid concurrency issues during the
+        # initialization of per-instance lazy-initialized mutexes.
+        MUTEX_INIT = Mutex.new
+
         def self.included(base)
           base.prepend(PrependedMethods)
         end
@@ -82,7 +86,7 @@ module Datadog
           :loop_base_interval
 
         def mutex
-          @mutex ||= Mutex.new
+          @mutex || MUTEX_INIT.synchronize { @mutex ||= Mutex.new }
         end
 
         private

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

@@ -1,5 +1,3 @@
-# typed: false
-
 require_relative 'async'
 require_relative 'interval_loop'
 
@@ -8,7 +6,7 @@ module Datadog
     module Workers
       # Adds polling (async looping) behavior to workers
       module Polling
-        SHUTDOWN_TIMEOUT = 1
+        DEFAULT_SHUTDOWN_TIMEOUT = 1
 
         def self.included(base)
           base.include(Workers::IntervalLoop)
@@ -23,7 +21,7 @@ module Datadog
           end
         end
 
-        def stop(force_stop = false, timeout = SHUTDOWN_TIMEOUT)
+        def stop(force_stop = false, timeout = DEFAULT_SHUTDOWN_TIMEOUT)
           if running?
             # Attempt graceful stop and wait
             stop_loop

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

@@ -1,4 +1,4 @@
-# typed: false
+# frozen_string_literal: true
 
 module Datadog
   module Core

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

@@ -1,4 +1,4 @@
-# typed: false
+# frozen_string_literal: true
 
 require_relative '../runtime/metrics'
 

data/lib/datadog/core.rb

@@ -1,58 +1,4 @@
-# typed: strict
-
-# 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_relative 'core/buffer/cruby'
-# require_relative 'core/buffer/random'
-# require_relative 'core/buffer/thread_safe'
-# require_relative 'core/chunker'
-# require_relative 'core/configuration'
-# require_relative 'core/diagnostics/environment_logger'
-# require_relative 'core/diagnostics/ext'
-# require_relative 'core/diagnostics/health'
-# require_relative 'core/encoding'
-# require_relative 'core/environment/cgroup'
-# require_relative 'core/environment/class_count'
-# require_relative 'core/environment/container'
-# require_relative 'core/environment/ext'
-# require_relative 'core/environment/gc'
-# require_relative 'core/environment/identity'
-# require_relative 'core/environment/socket'
-# require_relative 'core/environment/thread_count'
-# require_relative 'core/environment/variable_helpers'
-# require_relative 'core/environment/vm_cache'
-# require_relative 'core/error'
-# require_relative 'core/event'
-# require_relative 'core/git/ext'
-# require_relative 'core/logger'
-# require_relative 'core/metrics/client'
-# require_relative 'core/metrics/ext'
-# require_relative 'core/metrics/helpers'
-# require_relative 'core/metrics/logging'
-# require_relative 'core/metrics/metric'
-# require_relative 'core/metrics/options'
-# require_relative 'core/pin'
-# require_relative 'core/quantization/hash'
-# require_relative 'core/quantization/http'
-# require_relative 'core/runtime/ext'
-# require_relative 'core/runtime/metrics'
-# require_relative 'core/utils'
-# require_relative 'core/utils/compression'
-# require_relative 'core/utils/database'
-# require_relative 'core/utils/forking'
-# require_relative 'core/utils/object_set'
-# require_relative 'core/utils/only_once'
-# require_relative 'core/utils/sequence'
-# require_relative 'core/utils/string_table'
-# require_relative 'core/utils/time'
-# require_relative 'core/worker'
-# require_relative 'core/workers/async'
-# require_relative 'core/workers/interval_loop'
-# require_relative 'core/workers/polling'
-# require_relative 'core/workers/queue'
-# require_relative 'core/workers/runtime_metrics'
+# frozen_string_literal: true
 
 require_relative 'core/extensions'
 
@@ -63,6 +9,25 @@ module Datadog
   # 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

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

@@ -0,0 +1,169 @@
+# 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'
+        SIGNUP_EVENT = 'users.signup'
+
+        class << self
+          # 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. Defaults to
+          #   active trace.
+          # @param span [SpanOperation] Span to attach data to. Defaults to
+          #   active span on trace. Note that this should be a service entry span.
+          #   When AppSec is enabled, the expected span and trace are automatically
+          #   used as defaults.
+          # @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 track_login_success(trace = nil, span = nil, user:, **others)
+            set_trace_and_span_context('track_login_success', trace, span) do |active_trace, active_span|
+              user_options = user.dup
+              user_id = user_options.delete(:id)
+
+              raise ArgumentError, 'missing required key: :user => { :id }' if user_id.nil?
+
+              track(LOGIN_SUCCESS_EVENT, active_trace, active_span, **others)
+
+              Kit::Identity.set_user(active_trace, active_span, id: user_id, **user_options)
+            end
+          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. Defaults to
+          #   active trace.
+          # @param span [SpanOperation] Span to attach data to. Defaults to
+          #   active span on trace. Note that this should be a service entry span.
+          #   When AppSec is enabled, the expected span and trace are automatically
+          #   used as defaults.
+          # @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 track_login_failure(trace = nil, span = nil, user_id:, user_exists:, **others)
+            set_trace_and_span_context('track_login_failure', trace, span) do |active_trace, active_span|
+              raise ArgumentError, 'user_id cannot be nil' if user_id.nil?
+
+              track(LOGIN_FAILURE_EVENT, active_trace, active_span, **others)
+
+              active_span.set_tag('appsec.events.users.login.failure.usr.id', user_id)
+              active_span.set_tag('appsec.events.users.login.failure.usr.exists', user_exists)
+            end
+          end
+
+          # Attach signup event information to the trace
+          #
+          # This method is experimental and may change in the future.
+          #
+          # @param trace [TraceOperation] Trace to attach data to. Defaults to
+          #   active trace.
+          # @param span [SpanOperation] Span to attach data to. Defaults to
+          #   active span on trace. Note that this should be a service entry span.
+          #   When AppSec is enabled, the expected span and trace are automatically
+          #   used as defaults.
+          # @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 track_signup(trace = nil, span = nil, user:, **others)
+            set_trace_and_span_context('track_signup', trace, span) do |active_trace, active_span|
+              user_options = user.dup
+              user_id = user_options.delete(:id)
+
+              raise ArgumentError, 'missing required key: :user => { :id }' if user_id.nil?
+
+              track(SIGNUP_EVENT, active_trace, active_span, **others)
+
+              Kit::Identity.set_user(trace, id: user_id, **user_options)
+            end
+          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. Defaults to
+          #   active trace.
+          # @param span [SpanOperation] Span to attach data to. Defaults to
+          #   active span on trace. Note that this should be a service entry span.
+          #   When AppSec is enabled, the expected span and trace are automatically
+          #   used as defaults.
+          # @param others [Hash<Symbol, String>] Additional free-form
+          #   event information to attach to the trace. Key must not
+          #   be :track.
+          def track(event, trace = nil, span = nil, **others)
+            if trace && span
+              check_trace_span_integrity(trace, span)
+
+              span.set_tag("appsec.events.#{event}.track", 'true')
+              span.set_tag("_dd.appsec.events.#{event}.sdk", 'true')
+
+              others.each do |k, v|
+                raise ArgumentError, 'key cannot be :track' if k.to_sym == :track
+
+                span.set_tag("appsec.events.#{event}.#{k}", v) unless v.nil?
+              end
+
+              trace.keep!
+            else
+              set_trace_and_span_context('track', trace, span) do |active_trace, active_span|
+                active_span.set_tag("appsec.events.#{event}.track", 'true')
+                active_span.set_tag("_dd.appsec.events.#{event}.sdk", 'true')
+
+                others.each do |k, v|
+                  raise ArgumentError, 'key cannot be :track' if k.to_sym == :track
+
+                  active_span.set_tag("appsec.events.#{event}.#{k}", v) unless v.nil?
+                end
+
+                active_trace.keep!
+              end
+            end
+          end
+
+          private
+
+          def set_trace_and_span_context(method, trace = nil, span = nil)
+            if (appsec_scope = Datadog::AppSec.active_scope)
+              trace = appsec_scope.trace
+              span = appsec_scope.service_entry_span
+            end
+
+            trace ||= Datadog::Tracing.active_trace
+            span ||=  trace && trace.active_span || Datadog::Tracing.active_span
+
+            unless trace && span
+              Datadog.logger.debug(
+                "Tracing not enabled. Method ##{method} is a no-op. Please enable tracing if you want ##{method}"\
+                ' to track this events'
+              )
+              return
+            end
+
+            check_trace_span_integrity(trace, span)
+
+            yield(trace, span)
+          end
+
+          def check_trace_span_integrity(trace, span)
+            raise ArgumentError, "span #{span.span_id} does not belong to trace #{trace.id}" if trace.id != span.trace_id
+          end
+        end
+      end
+    end
+  end
+end

data/lib/datadog/kit/enable_core_dumps.rb

@@ -1,4 +1,4 @@
-# typed: ignore
+# frozen_string_literal: true
 
 module Datadog
   module Kit
@@ -16,11 +16,13 @@ module Datadog
             '(Could not open /proc/sys/kernel/core_pattern)'
           end
 
+        enabled_status = "Maximum size: #{maximum_size} Output pattern: '#{core_pattern}'"
+
         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. #{enabled_status}")
           return
         end
 
@@ -28,19 +30,16 @@ 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. #{enabled_status}")
         else
-          Kernel.warn(
-            "[DDTRACE] Raised core dump limit. Old size: #{current_size} " \
-            "Maximum size: #{maximum_size} Output pattern: '#{core_pattern}'"
-          )
+          Kernel.warn("[ddtrace] Raised core dump limit. Old size: #{current_size} #{enabled_status}")
         end
       end
     end

data/lib/datadog/kit/identity.rb

@@ -1,63 +1,104 @@
-# typed: false
+# 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<String || 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)
+      class << self
+        # Attach user information to the trace
+        #
+        # @param trace [TraceOperation] Trace to attach data to. Defaults to
+        #   active trace.
+        # @param span [SpanOperation] Span to attach data to. Defaults to
+        #   active span on trace. Note that this should be a service entry span.
+        #   When AppSec is enabled, the expected span and trace are automatically
+        #   used as defaults.
+        # @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 set_user(
+          trace = nil, span = nil, 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_trace_and_span_context('set_user', trace, span) do |_active_trace, active_span|
+            # set tags once data is known consistent
+            active_span.set_tag('usr.id', id)
+            active_span.set_tag('usr.email', email)           unless email.nil?
+            active_span.set_tag('usr.name', name)             unless name.nil?
+            active_span.set_tag('usr.session_id', session_id) unless session_id.nil?
+            active_span.set_tag('usr.role', role)             unless role.nil?
+            active_span.set_tag('usr.scope', scope)           unless scope.nil?
+
+            others.each do |k, v|
+              active_span.set_tag("usr.#{k}", v) unless v.nil?
+            end
+
+            if Datadog::AppSec.active_scope
+              user = ::Datadog::AppSec::Instrumentation::Gateway::User.new(id)
+              ::Datadog::AppSec::Instrumentation.gateway.push('identity.set_user', user)
+            end
+          end
         end
+        # rubocop:enable Metrics/PerceivedComplexity
+        # rubocop:enable Metrics/CyclomaticComplexity
+
+        private
+
+        def set_trace_and_span_context(method, trace = nil, span = nil)
+          if (appsec_scope = Datadog::AppSec.active_scope)
+            trace = appsec_scope.trace
+            span = appsec_scope.service_entry_span
+          end
+
+          trace ||= Datadog::Tracing.active_trace
+          span ||= trace && trace.active_span || Datadog::Tracing.active_span
 
-        # set tags once data is known consistent
+          unless trace && span
+            Datadog.logger.debug(
+              "Tracing not enabled. Method ##{method} is a no-op. Please enable tracing if you want ##{method}"\
+              ' to track this events'
+            )
+            return
+          end
 
-        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?
+          raise ArgumentError, "span #{span.span_id} does not belong to trace #{trace.id}" if trace.id != span.trace_id
 
-        others.each do |k, v|
-          trace.set_tag("usr.#{k}", v) unless v.nil?
+          yield(trace, span)
         end
       end
-      # rubocop:enable Metrics/PerceivedComplexity
-      # rubocop:enable Metrics/CyclomaticComplexity
     end
   end
 end

data/lib/datadog/kit.rb

@@ -1,4 +1,4 @@
-# typed: false
+# frozen_string_literal: true
 
 module Datadog
   # Datadog::Kit holds public-facing APIs for higher level user-facing