datadog 2.21.0 → 2.38.0

data/lib/datadog/di/configuration/settings.rb

@@ -1,212 +0,0 @@
-# frozen_string_literal: true
-
-module Datadog
-  module DI
-    module Configuration
-      # Settings
-      module Settings
-        def self.extended(base)
-          base = base.singleton_class unless base.is_a?(Class)
-          add_settings!(base)
-        end
-
-        def self.add_settings!(base)
-          base.class_eval do
-            settings :dynamic_instrumentation do
-              option :enabled do |o|
-                o.type :bool
-                # The environment variable has an "internal" prefix so that
-                # any customers that have the "proper" environment variable
-                # turned on (i.e. DD_DYNAMIC_INSTRUMENTATION_ENABLED)
-                # do not enable Ruby DI until the latter is ready for
-                # customer testing.
-                o.env "DD_DYNAMIC_INSTRUMENTATION_ENABLED"
-                o.default false
-              end
-
-              # An array of variable and key names to redact in addition to
-              # the built-in list of identifiers.
-              #
-              # The names will be normalized by removing the following
-              # symbols: _, -, @, $, and then matched to the complete
-              # variable or key name while ignoring the case.
-              # For example, specifying pass_word will match password and
-              # PASSWORD, and specifying PASSWORD will match pass_word.
-              # Note that, while the at sign (@) is used in Ruby to refer
-              # to instance variables, it does not have any significance
-              # for this setting (and is removed before matching identifiers).
-              option :redacted_identifiers do |o|
-                o.env "DD_DYNAMIC_INSTRUMENTATION_REDACTED_IDENTIFIERS"
-                o.env_parser do |value|
-                  value&.split(",")&.map(&:strip)
-                end
-
-                o.type :array
-                o.default []
-              end
-
-              # An array of class names, values of which will be redacted from
-              # dynamic instrumentation snapshots. Example: FooClass.
-              # If a name is suffixed by '*', it becomes a wildcard and
-              # instances of any class whose name begins with the specified
-              # prefix will be redacted (example: Foo*).
-              #
-              # The names must all be fully-qualified, if any prefix of a
-              # class name is configured to be redacted, the value will be
-              # subject to redaction. For example, if Foo* is in the
-              # redacted class name list, instances of Foo, FooBar,
-              # Foo::Bar are all subject to redaction, but Bar::Foo will
-              # not be subject to redaction.
-              #
-              # Leading double-colon is permitted but has no effect,
-              # because the names are always considered to be fully-qualified.
-              # For example, adding ::Foo to the list will redact instances
-              # of Foo.
-              #
-              # Trailing colons should not be used because they will trigger
-              # exact match behavior but Ruby class names do not have
-              # trailing colons. For example, Foo:: will not cause anything
-              # to be redacted. Use Foo::* to redact all classes under
-              # the Foo module.
-              option :redacted_type_names do |o|
-                o.env "DD_DYNAMIC_INSTRUMENTATION_REDACTED_TYPES"
-                o.env_parser do |value|
-                  value&.split(",")&.map(&:strip)
-                end
-
-                o.type :array
-                o.default []
-              end
-
-              # Maximum number of object or collection traversals that
-              # will be permitted when serializing captured values.
-              option :max_capture_depth do |o|
-                o.type :int
-                o.default 3
-              end
-
-              # Maximum number of collection (Array and Hash) elements
-              # that will be captured. Arrays and hashes that have more
-              # elements will be truncated to this many elements.
-              option :max_capture_collection_size do |o|
-                o.type :int
-                o.default 100
-              end
-
-              # Strings longer than this length will be truncated to this
-              # length in dynamic instrumentation snapshots.
-              #
-              # Note that while all values are stringified during
-              # serialization, only values which are originally instances
-              # of the String class are subject to this length limit.
-              option :max_capture_string_length do |o|
-                o.type :int
-                o.default 255
-              end
-
-              # Maximim number of attributes that will be captured for
-              # a single non-primitive value.
-              option :max_capture_attribute_count do |o|
-                o.type :int
-                o.default 20
-              end
-
-              # Settings in the 'internal' group are for internal Datadog
-              # use only, and are needed to test dynamic instrumentation or
-              # experiment with features not released to customers.
-              settings :internal do
-                # This option instructs dynamic instrumentation to use
-                # untargeted trace points when installing line probes and
-                # code tracking is not active.
-                # WARNING: untargeted trace points carry a massive performance
-                # penalty for the entire file in which a line probe is placed.
-                #
-                # If this option is set to false, which is the default,
-                # dynamic instrumentation will add probes that reference
-                # unknown files to the list of pending probes, and when
-                # the respective files are loaded, the line probes will be
-                # installed using targeted trace points. If the file in
-                # question is already loaded when the probe is received
-                # (for example, it is in a third-party library loaded during
-                # application boot), and code tracking was not active when
-                # the file was loaded, such files will not be instrumentable
-                # via line probes.
-                #
-                # If this option is set to true, dynamic instrumentation will
-                # install untargeted trace points for all line probes,
-                # regardless of whether the referenced file is loaded.
-                # This permits instrumenting code which was loaded prior to
-                # code tracking being activated and instrumenting lines when
-                # code tracking is not activated at all. However, untargeted
-                # trace points are extremely slow and will greatly degrade
-                # performance of *all* code executed while they are installed,
-                # not just the instrumentation target.
-                option :untargeted_trace_points do |o|
-                  o.type :bool
-                  o.default false
-                end
-
-                # If true, all of the catch-all rescue blocks in DI
-                # will propagate the exceptions onward.
-                # WARNING: for internal Datadog use only - this will break
-                # the DI product and potentially the library in general in
-                # a multitude of ways, cause resource leakage, permanent
-                # performance decreases, etc.
-                option :propagate_all_exceptions do |o|
-                  o.type :bool
-                  o.default false
-                end
-
-                # Minimum interval, in seconds, between probe status and
-                # snapshot submissions to the agent. Probe notifier worker will
-                # batch together payloads submitted during each interval.
-                # A longer interval reduces the overhead imposed by dynamic
-                # instrumentation on the application, but also increases the
-                # time when application code cannot run (when the batches are
-                # being sent out by the probe notifier worker) and creates a
-                # possibility of dropping payloads if the queue gets too long.
-                option :min_send_interval do |o|
-                  o.type :float
-                  o.default 3
-                end
-
-                # Number of snapshots that can be stored in the probe
-                # notifier worker queue. Larger capacity runs the risk of
-                # creating snapshots that exceed the agent's request size
-                # limit. Smaller capacity increases the risk of dropping
-                # snapshots.
-                option :snapshot_queue_capacity do |o|
-                  o.type :int
-                  o.default 100
-                end
-
-                # Enable dynamic instrumentation in development environments.
-                # Currently DI does not fully implement support for code
-                # unloading and reloading, and is not supported in
-                # non-production environments.
-                option :development do |o|
-                  o.type :bool
-                  o.default false
-                end
-
-                # Enable logging of dynamic instrumentation activity.
-                # This is quite verbose.
-                option :trace_logging do |o|
-                  o.type :bool
-                  o.default false
-
-                  # Use the same environment variable as the rest of
-                  # dd-trace-rb logging for now. Could change to a
-                  # dedicated environment variable in the future but
-                  # will likely need a way to turn on remote config
-                  # debugging (since DI uses RC for configuration).
-                  o.env 'DD_TRACE_DEBUG'
-                end
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/datadog/di/transport/http/api.rb

@@ -1,42 +0,0 @@
-# frozen_string_literal: true
-
-require_relative '../../../core/encoding'
-require_relative '../../../core/transport/http/api/map'
-require_relative '../../../core/transport/http/api/instance'
-require_relative '../../../core/transport/http/api/spec'
-require_relative 'diagnostics'
-require_relative 'input'
-
-module Datadog
-  module DI
-    module Transport
-      module HTTP
-        # Namespace for API components
-        module API
-          # Default API versions
-          DIAGNOSTICS = 'diagnostics'
-          INPUT = 'input'
-
-          module_function
-
-          def defaults
-            Datadog::Core::Transport::HTTP::API::Map[
-              DIAGNOSTICS => Diagnostics::API::Spec.new do |s|
-                s.diagnostics = Diagnostics::API::Endpoint.new(
-                  '/debugger/v1/diagnostics',
-                  Core::Encoding::JSONEncoder,
-                )
-              end,
-              INPUT => Input::API::Spec.new do |s|
-                s.input = Input::API::Endpoint.new(
-                  '/debugger/v1/input',
-                  Core::Encoding::JSONEncoder,
-                )
-              end,
-            ]
-          end
-        end
-      end
-    end
-  end
-end

data/lib/datadog/di/transport/http/client.rb

@@ -1,47 +0,0 @@
-# frozen_string_literal: true
-
-require_relative '../../../core/transport/http/env'
-require_relative '../../../core/transport/http/response'
-
-# TODO: Decouple transport/http/client
-#
-# The standard one does `include Transport::HTTP::Statistics` and performs
-# stats updates, which may or may not be desirable in general.
-
-module Datadog
-  module DI
-    module Transport
-      module HTTP
-        # Routes, encodes, and sends DI data to the trace agent via HTTP.
-        class Client
-          attr_reader :api, :logger
-
-          def initialize(api, logger:)
-            @api = api
-            @logger = logger
-          end
-
-          def send_request(request, &block)
-            # Build request into env
-            env = build_env(request)
-
-            # Get responses from API
-            yield(api, env)
-          rescue => e
-            message =
-              "Internal error during #{self.class.name} request. Cause: #{e.class.name} #{e.message} " \
-                "Location: #{Array(e.backtrace).first}"
-
-            logger.debug(message)
-
-            Datadog::Core::Transport::InternalErrorResponse.new(e)
-          end
-
-          def build_env(request)
-            Datadog::Core::Transport::HTTP::Env.new(request)
-          end
-        end
-      end
-    end
-  end
-end

data/lib/datadog/error_tracking/configuration/settings.rb

@@ -1,63 +0,0 @@
-# frozen_string_literal: true
-
-require_relative '../ext'
-
-module Datadog
-  module ErrorTracking
-    module Configuration
-      # Settings
-      module Settings
-        def self.extended(base)
-          base = base.singleton_class unless base.is_a?(Class)
-          add_settings!(base)
-        end
-
-        def self.add_settings!(base)
-          base.class_eval do
-            # Error Tracking specific configurations.
-            # @public_api
-            settings :error_tracking do
-              # Enable automatic reporting of handled errors and defines the scope
-              # for which to report errors: user code, gems, or both. Possible
-              # values are: all | user | third_party.
-              #
-              # @default 'DD_ERROR_TRACKING_HANDLED_ERRORS' environment variable, otherwise `nil`
-              # @return [String, nil]
-              option :handled_errors do |o|
-                o.type :string, nilable: true
-                o.default Ext::DEFAULT_HANDLED_ERRORS
-                o.env Ext::ENV_HANDLED_ERRORS
-                o.setter do |value|
-                  next value if Ext::VALID_HANDLED_ERRORS.include?(value)
-
-                  unless value.nil?
-                    Datadog.logger.warn(
-                      "Invalid handled errors scope: #{value}. " \
-                      "Supported values are: #{Ext::VALID_HANDLED_ERRORS.join(" | ")}. " \
-                      'Deactivating the feature.'
-                    )
-                  end
-
-                  Ext::DEFAULT_HANDLED_ERRORS
-                end
-              end
-
-              # Enable automatic reporting of handled errors and specify what files should be
-              # instrumented. The value is a list of comma separated paths, filenames or gem names.
-              # The paths can be absolute, starting with '/' or relative to directory in which the program
-              # is launched, starting with './'.
-              #
-              # @default 'DD_ERROR_TRACKING_HANDLED_ERRORS_MODULES' environment variable, otherwise `nil`
-              # @return [String, nil]
-              option :handled_errors_include do |o|
-                o.type :array
-                o.default []
-                o.env Ext::ENV_HANDLED_ERRORS_INCLUDE
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/datadog/opentelemetry/api/baggage.rbs

@@ -1,26 +0,0 @@
-# frozen_string_literal: true
-
-module Datadog
-  module OpenTelemetry
-    module API
-      module Baggage
-        def initialize: (?trace: Datadog::Tracing::TraceOperation?) -> void
-
-        # Returns a new context with empty baggage
-        def clear: (?context: OpenTelemetry::Context) -> OpenTelemetry::Context
-
-        # Returns the corresponding value for key
-        def value: (String key, ?context: OpenTelemetry::Context) -> String?
-
-        # Returns all baggage values
-        def values: (?context: OpenTelemetry::Context) -> Hash[String, String]
-
-        # Returns a new context with key-value pair
-        def set_value: (String key, String value, ?metadata: String?, ?context: OpenTelemetry::Context) -> OpenTelemetry::Context
-
-        # Returns a new context with value at key removed
-        def remove_value: (String key, ?context: OpenTelemetry::Context) -> OpenTelemetry::Context
-      end
-    end
-  end
-end 

data/lib/datadog/tracing/transport/http/api.rb

@@ -1,44 +0,0 @@
-# frozen_string_literal: true
-
-require_relative '../../../core/encoding'
-
-require_relative '../../../core/transport/http/api/map'
-require_relative '../../../core/transport/http/api/instance'
-require_relative '../../../core/transport/http/api/spec'
-
-require_relative 'traces'
-
-module Datadog
-  module Tracing
-    module Transport
-      module HTTP
-        # Namespace for API components
-        module API
-          # Default API versions
-          V4 = 'v0.4'
-          V3 = 'v0.3'
-
-          module_function
-
-          def defaults
-            Core::Transport::HTTP::API::Map[
-              V4 => Traces::API::Spec.new do |s|
-                s.traces = Traces::API::Endpoint.new(
-                  '/v0.4/traces',
-                  Core::Encoding::MsgpackEncoder,
-                  service_rates: true
-                )
-              end,
-              V3 => Traces::API::Spec.new do |s|
-                s.traces = Traces::API::Endpoint.new(
-                  '/v0.3/traces',
-                  Core::Encoding::MsgpackEncoder
-                )
-              end,
-            ].with_fallbacks(V4 => V3)
-          end
-        end
-      end
-    end
-  end
-end

data/lib/datadog/tracing/workers/trace_writer.rb

@@ -1,199 +0,0 @@
-# frozen_string_literal: true
-
-require_relative '../../core/worker'
-require_relative '../../core/workers/async'
-require_relative '../../core/workers/polling'
-require_relative '../../core/workers/queue'
-
-require_relative '../buffer'
-require_relative '../pipeline'
-require_relative '../event'
-
-require_relative '../transport/http'
-
-module Datadog
-  module Tracing
-    module Workers
-      # Writes traces to transport synchronously
-      class TraceWriter < Core::Worker
-        attr_reader \
-          :logger,
-          :transport,
-          :agent_settings
-
-        # rubocop:disable Lint/MissingSuper
-        def initialize(options = {})
-          @logger = options[:logger] || Datadog.logger
-
-          transport_options = options.fetch(:transport_options, {})
-          @agent_settings = options[:agent_settings]
-
-          @transport = options.fetch(:transport) do
-            Datadog::Tracing::Transport::HTTP.default(agent_settings: agent_settings, logger: logger, **transport_options)
-          end
-        end
-        # rubocop:enable Lint/MissingSuper
-
-        def perform(traces)
-          write_traces(traces)
-        end
-
-        def write(trace)
-          write_traces([trace])
-        end
-
-        def write_traces(traces)
-          traces = process_traces(traces)
-          flush_traces(traces)
-        rescue => e
-          logger.warn(
-            "Error while writing traces: dropped #{traces.length} items. Cause: #{e} Location: #{Array(e.backtrace).first}"
-          )
-        end
-
-        def process_traces(traces)
-          # Run traces through the processing pipeline
-          Pipeline.process!(traces)
-        end
-
-        def flush_traces(traces)
-          transport.send_traces(traces).tap do |response|
-            flush_completed.publish(response)
-          end
-        end
-
-        # TODO: Register `Datadog::Tracing::Diagnostics::EnvironmentLogger.collect_and_log!`
-        # TODO: as a flush_completed subscriber when the `TraceWriter`
-        # TODO: instantiation code is implemented.
-        def flush_completed
-          @flush_completed ||= FlushCompleted.new
-        end
-
-        # Flush completed event for worker
-        class FlushCompleted < Event
-          def initialize
-            super(:flush_completed)
-          end
-        end
-      end
-
-      # Writes traces to transport asynchronously,
-      # using a thread & buffer.
-      class AsyncTraceWriter < TraceWriter
-        include Core::Workers::Queue
-        include Core::Workers::Polling
-
-        DEFAULT_BUFFER_MAX_SIZE = 1000
-        FORK_POLICY_ASYNC = :async
-        FORK_POLICY_SYNC = :sync
-
-        attr_writer \
-          :async
-
-        def initialize(options = {})
-          # Workers::TraceWriter settings
-          super
-
-          # Workers::Polling settings
-          self.enabled = options.fetch(:enabled, true)
-
-          # Workers::Async::Thread settings
-          @async = true
-          self.fork_policy = options.fetch(:fork_policy, FORK_POLICY_ASYNC)
-
-          # Workers::IntervalLoop settings
-          self.loop_base_interval = options[:interval] if options.key?(:interval)
-          self.loop_back_off_ratio = options[:back_off_ratio] if options.key?(:back_off_ratio)
-          self.loop_back_off_max = options[:back_off_max] if options.key?(:back_off_max)
-
-          # Workers::Queue settings
-          @buffer_size = options.fetch(:buffer_size, DEFAULT_BUFFER_MAX_SIZE)
-          self.buffer = TraceBuffer.new(@buffer_size)
-
-          @shutdown_timeout = options.fetch(:shutdown_timeout, Core::Workers::Polling::DEFAULT_SHUTDOWN_TIMEOUT)
-        end
-
-        # NOTE: #perform is wrapped by other modules:
-        #       Polling --> Async --> IntervalLoop --> AsyncTraceWriter --> TraceWriter
-        #
-        # WARNING: This method breaks the Liskov Substitution Principle -- TraceWriter#perform is spec'd to return the
-        # result from the writer, whereas this method always returns nil.
-        def perform(traces)
-          super.tap do |responses|
-            loop_back_off! if responses.find(&:server_error?)
-          end
-
-          nil
-        end
-
-        def stop(force_stop = false, timeout = @shutdown_timeout)
-          buffer.close if running?
-          super
-        end
-
-        def enqueue(trace)
-          buffer.push(trace)
-        end
-
-        def dequeue
-          # Wrap results in Array because they are
-          # splatted as args against TraceWriter#perform.
-          [buffer.pop]
-        end
-
-        # Are there more traces to be processed next?
-        def work_pending?
-          !buffer.empty?
-        end
-
-        def async?
-          @async == true
-        end
-
-        def fork_policy=(policy)
-          # Translate to Workers::Async::Thread policy
-          thread_fork_policy = case policy
-          when Core::Workers::Async::Thread::FORK_POLICY_STOP
-            policy
-          when FORK_POLICY_SYNC
-            # Stop the async thread because the writer
-            # will bypass and run synchronously.
-            Core::Workers::Async::Thread::FORK_POLICY_STOP
-          else
-            Core::Workers::Async::Thread::FORK_POLICY_RESTART
-          end
-
-          # Update thread fork policy
-          super(thread_fork_policy)
-
-          # Update local policy
-          @writer_fork_policy = policy
-        end
-
-        def after_fork
-          # In multiprocess environments, forks will share the same buffer until its written to.
-          # A.K.A. copy-on-write. We don't want forks to write traces generated from another process.
-          # Instead, we reset it after the fork. (Make sure any enqueue operations happen after this.)
-          self.buffer = TraceBuffer.new(@buffer_size)
-
-          # Switch to synchronous mode if configured to do so.
-          # In some cases synchronous writing is preferred because the fork will be short lived.
-          @async = false if @writer_fork_policy == FORK_POLICY_SYNC
-        end
-
-        # WARNING: This method breaks the Liskov Substitution Principle -- TraceWriter#write is spec'd to return the
-        # result from the writer, whereas this method returns something else when running in async mode.
-        def write(trace)
-          # Start worker thread. If the process has forked, it will trigger #after_fork to
-          # reconfigure the worker accordingly.
-          # NOTE: It's important we do this before queuing or it will drop the current trace,
-          #       because #after_fork resets the buffer.
-          perform
-
-          # Queue the trace if running asynchronously, otherwise short-circuit and write it directly.
-          async? ? enqueue(trace) : write_traces([trace])
-        end
-      end
-    end
-  end
-end