ddtrace 0.34.1 → 1.23.1

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

@@ -0,0 +1,183 @@
+require_relative '../logger'
+
+module Datadog
+  module Core
+    module Workers
+      module Async
+        # Adds threading behavior to workers
+        # to run tasks asynchronously.
+        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
+
+          # Methods that must be prepended
+          module PrependedMethods
+            def perform(*args)
+              start_async { self.result = super(*args) } unless started?
+            end
+          end
+
+          attr_reader \
+            :error,
+            :result
+
+          attr_writer \
+            :fork_policy
+
+          def join(timeout = nil)
+            return true unless running?
+
+            !worker.join(timeout).nil?
+          end
+
+          def terminate
+            return false unless running?
+
+            @run_async = false
+            Datadog.logger.debug { "Forcibly terminating worker thread for: #{self}" }
+            worker.terminate
+            true
+          end
+
+          def run_async?
+            return false unless instance_variable_defined?(:@run_async)
+
+            @run_async == true
+          end
+
+          def started?
+            !(worker.nil? || forked?)
+          end
+
+          def running?
+            !worker.nil? && worker.alive?
+          end
+
+          def error?
+            return false unless instance_variable_defined?(:@error)
+
+            !@error.nil?
+          end
+
+          def completed?
+            !worker.nil? && worker.status == false && !error?
+          end
+
+          def failed?
+            !worker.nil? && worker.status.nil?
+          end
+
+          def forked?
+            !pid.nil? && pid != Process.pid
+          end
+
+          def fork_policy
+            @fork_policy ||= FORK_POLICY_STOP
+          end
+
+          protected
+
+          attr_writer \
+            :result
+
+          def mutex
+            (defined?(@mutex) && @mutex) || MUTEX_INIT.synchronize { @mutex ||= Mutex.new }
+          end
+
+          def after_fork
+            # Do nothing by default
+          end
+
+          private
+
+          attr_reader \
+            :pid
+
+          def mutex_after_fork
+            (defined?(@mutex_after_fork) && @mutex_after_fork) || MUTEX_INIT.synchronize { @mutex_after_fork ||= Mutex.new }
+          end
+
+          def worker
+            @worker ||= nil
+          end
+
+          def start_async(&block)
+            mutex.synchronize do
+              return if running?
+
+              if forked?
+                case fork_policy
+                when FORK_POLICY_STOP
+                  stop_fork
+                when FORK_POLICY_RESTART
+                  restart_after_fork(&block)
+                end
+              elsif !run_async?
+                start_worker(&block)
+              end
+            end
+          end
+
+          def start_worker
+            @run_async = true
+            @pid = Process.pid
+            @error = nil
+            Datadog.logger.debug { "Starting thread for: #{self}" }
+
+            @worker = ::Thread.new do
+              begin
+                yield
+              # rubocop:disable Lint/RescueException
+              rescue Exception => e
+                @error = e
+                Datadog.logger.debug(
+                  "Worker thread error. Cause: #{e.class.name} #{e.message} Location: #{Array(e.backtrace).first}"
+                )
+                raise
+              end
+              # 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
+
+          def stop_fork
+            mutex_after_fork.synchronize do
+              if forked?
+                # Trigger callback to allow workers to reset themselves accordingly
+                after_fork
+
+                # Reset and turn off
+                @pid = Process.pid
+                @run_async = false
+              end
+            end
+          end
+
+          def restart_after_fork(&block)
+            mutex_after_fork.synchronize do
+              if forked?
+                # Trigger callback to allow workers to reset themselves accordingly
+                after_fork
+
+                # Start worker
+                start_worker(&block)
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,123 @@
+# frozen_string_literal: true
+
+module Datadog
+  module Core
+    module Workers
+      # Adds looping behavior to workers, with a sleep
+      # interval between each loop.
+      module IntervalLoop
+        BACK_OFF_RATIO = 1.2
+        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
+
+        # Methods that must be prepended
+        module PrependedMethods
+          def perform(*args)
+            perform_loop { super(*args) }
+          end
+        end
+
+        def stop_loop
+          mutex.synchronize do
+            return false unless run_loop?
+
+            @run_loop = false
+            shutdown.signal
+          end
+
+          true
+        end
+
+        def work_pending?
+          run_loop?
+        end
+
+        def run_loop?
+          return false unless instance_variable_defined?(:@run_loop)
+
+          @run_loop == true
+        end
+
+        def loop_base_interval
+          @loop_base_interval ||= BASE_INTERVAL
+        end
+
+        def loop_back_off_ratio
+          @loop_back_off_ratio ||= BACK_OFF_RATIO
+        end
+
+        def loop_back_off_max
+          @loop_back_off_max ||= BACK_OFF_MAX
+        end
+
+        def loop_wait_time
+          @loop_wait_time ||= loop_base_interval
+        end
+
+        def loop_wait_time=(value)
+          @loop_wait_time = value
+        end
+
+        def loop_back_off!
+          self.loop_wait_time = [loop_wait_time * BACK_OFF_RATIO, BACK_OFF_MAX].min
+        end
+
+        # Should perform_loop just straight into work, or start by waiting?
+        #
+        # The use case is if we want to report some information (like profiles) from time to time, we may not want to
+        # report empty/zero/some residual value immediately when the worker starts.
+        def loop_wait_before_first_iteration?
+          false
+        end
+
+        protected
+
+        attr_writer \
+          :loop_back_off_max,
+          :loop_back_off_ratio,
+          :loop_base_interval
+
+        def mutex
+          @mutex || MUTEX_INIT.synchronize { @mutex ||= Mutex.new }
+        end
+
+        private
+
+        def perform_loop
+          mutex.synchronize do
+            @run_loop = true
+
+            shutdown.wait(mutex, loop_wait_time) if loop_wait_before_first_iteration?
+          end
+
+          loop do
+            if work_pending?
+              # There's work to do...
+              # Run the task
+              yield
+            end
+
+            # Wait for an interval, unless shutdown has been signaled.
+            mutex.synchronize do
+              return unless run_loop? || work_pending?
+
+              shutdown.wait(mutex, loop_wait_time) if run_loop?
+            end
+          end
+        end
+
+        def shutdown
+          @shutdown ||= ConditionVariable.new
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,57 @@
+require_relative 'async'
+require_relative 'interval_loop'
+
+module Datadog
+  module Core
+    module Workers
+      # Adds polling (async looping) behavior to workers
+      module Polling
+        DEFAULT_SHUTDOWN_TIMEOUT = 1
+
+        def self.included(base)
+          base.include(Workers::IntervalLoop)
+          base.include(Workers::Async::Thread)
+          base.prepend(PrependedMethods)
+        end
+
+        # Methods that must be prepended
+        module PrependedMethods
+          def perform(*args)
+            super if enabled?
+          end
+        end
+
+        def stop(force_stop = false, timeout = DEFAULT_SHUTDOWN_TIMEOUT)
+          if running?
+            # Attempt graceful stop and wait
+            stop_loop
+            graceful = join(timeout)
+
+            if !graceful && force_stop
+              Datadog.logger.debug do
+                "Timeout while waiting for worker to finish gracefully, forcing termination for: #{self}"
+              end
+              terminate
+            else
+              graceful
+            end
+          else
+            false
+          end
+        end
+
+        def enabled?
+          return true unless instance_variable_defined?(:@enabled)
+
+          @enabled
+        end
+
+        # Allow worker to be started
+        def enabled=(value)
+          # Coerce to boolean
+          @enabled = (value == true)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Datadog
+  module Core
+    module Workers
+      # Adds queue behavior to workers, with a buffer
+      # to which items can be queued then dequeued.
+      module Queue
+        def self.included(base)
+          base.prepend(PrependedMethods)
+        end
+
+        # Methods that must be prepended
+        module PrependedMethods
+          def perform(*args)
+            super(*dequeue) if work_pending?
+          end
+        end
+
+        def buffer
+          @buffer ||= []
+        end
+
+        def enqueue(*args)
+          buffer.push(args)
+        end
+
+        def dequeue
+          buffer.shift
+        end
+
+        # Are there more items to be processed next?
+        def work_pending?
+          !buffer.empty?
+        end
+
+        protected
+
+        attr_writer \
+          :buffer
+      end
+    end
+  end
+end

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

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+require_relative '../runtime/metrics'
+
+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
+        include Workers::Polling
+
+        # In seconds
+        DEFAULT_FLUSH_INTERVAL = 10
+        DEFAULT_BACK_OFF_MAX = 30
+
+        attr_reader \
+          :metrics
+
+        def initialize(options = {})
+          @metrics = options.fetch(:metrics) { Core::Runtime::Metrics.new }
+
+          # Workers::Async::Thread settings
+          self.fork_policy = options.fetch(:fork_policy, Workers::Async::Thread::FORK_POLICY_STOP)
+
+          # Workers::IntervalLoop settings
+          self.loop_base_interval = options.fetch(:interval, DEFAULT_FLUSH_INTERVAL)
+          self.loop_back_off_ratio = options[:back_off_ratio] if options.key?(:back_off_ratio)
+          self.loop_back_off_max = options.fetch(:back_off_max, DEFAULT_BACK_OFF_MAX)
+
+          self.enabled = options.fetch(:enabled, false)
+        end
+
+        def perform
+          metrics.flush
+          true
+        end
+
+        def register_service(service)
+          # Start the worker
+          metrics.register_service(service).tap { perform }
+        end
+
+        # TODO: `close_metrics` is only needed because
+        # Datadog::Core::Configuration::Components directly manipulates
+        # the lifecycle of Runtime::Metrics.statsd instances.
+        # This should be avoided, as it prevents this class from
+        # ensuring correct resource decommission of its internal
+        # dependencies.
+        def stop(*args, close_metrics: true)
+          self.enabled = false
+          result = super(*args)
+          @metrics.close if close_metrics
+          result
+        end
+      end
+    end
+  end
+end

data/lib/datadog/core.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+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:
+  # Ensures the Datadog components have a chance to gracefully
+  # shut down and cleanup before terminating the process.
+  at_exit do
+    if Interrupt === $! # rubocop:disable Style/SpecialGlobalVars is process terminating due to a ctrl+c or similar?
+      Datadog.send(:handle_interrupt_shutdown!)
+    else
+      Datadog.shutdown!
+    end
+  end
+end

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