datadog 2.31.0 → 2.32.0

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

@@ -1,49 +0,0 @@
-# frozen_string_literal: true
-
-require_relative '../../core/environment/variable_helpers'
-require_relative '../ext'
-
-module Datadog
-  module DataStreams
-    module Configuration
-      # Configuration settings for Data Streams Monitoring.
-      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
-            # Data Streams Monitoring configuration
-            # @public_api
-            settings :data_streams do
-              # Whether Data Streams Monitoring is enabled. When enabled, the library will
-              # collect and report data lineage information for messaging systems.
-              #
-              # @default `DD_DATA_STREAMS_ENABLED` environment variable, otherwise `false`.
-              # @return [Boolean]
-              option :enabled do |o|
-                o.type :bool
-                o.env Ext::ENV_ENABLED
-                o.default false
-              end
-
-              # The interval (in seconds) at which Data Streams Monitoring stats are flushed.
-              #
-              # @default 10.0
-              # @env '_DD_TRACE_STATS_WRITER_INTERVAL'
-              # @return [Float]
-              # @!visibility private
-              option :interval do |o|
-                o.type :float
-                o.env '_DD_TRACE_STATS_WRITER_INTERVAL'
-                o.default 10.0
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,243 +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 variable and key names to exclude from the
-              # built-in redaction list.
-              #
-              # This allows users to capture values of variables that would
-              # otherwise be redacted by the default identifier list.
-              # For example, if an application has a "session" variable
-              # that does not contain sensitive data, "session" can be added
-              # to this list to exclude it from redaction.
-              #
-              # The names will be normalized the same way as redacted_identifiers,
-              # by removing the following symbols: _, -, @, $, and then matched
-              # against the complete variable or key name while ignoring the case.
-              option :redaction_excluded_identifiers do |o|
-                o.env "DD_DYNAMIC_INSTRUMENTATION_REDACTION_EXCLUDED_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
-
-                # If the CPU time consumed by the thread performing instrumentation
-                # exceeds this amount, the offending probe will be automatically disabled.
-                # Set to nil to disable the circuit breaker.
-                # Set to zero to disable every probe after it executes once.
-                option :max_processing_time do |o|
-                  o.type :float
-                  o.default 0.5
-                end
-              end
-            end
-          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