datadog 2.12.1 → 2.17.0

data/lib/datadog/core/telemetry/event/generate_metrics.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require_relative 'base'
+
+module Datadog
+  module Core
+    module Telemetry
+      module Event
+        # Telemetry class for the 'generate-metrics' event
+        class GenerateMetrics < Base
+          attr_reader :namespace, :metric_series
+
+          def type
+            'generate-metrics'
+          end
+
+          def initialize(namespace, metric_series)
+            super()
+            @namespace = namespace
+            @metric_series = metric_series
+          end
+
+          def payload
+            {
+              namespace: @namespace,
+              series: @metric_series.map(&:to_h)
+            }
+          end
+
+          def ==(other)
+            other.is_a?(GenerateMetrics) && other.namespace == @namespace && other.metric_series == @metric_series
+          end
+
+          alias_method :eql?, :==
+
+          def hash
+            [self.class, @namespace, @metric_series].hash
+          end
+        end
+      end
+    end
+  end
+end

data/lib/datadog/core/telemetry/event/log.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+require_relative 'base'
+
+module Datadog
+  module Core
+    module Telemetry
+      module Event
+        # Telemetry class for the 'logs' event.
+        # Logs with the same content are deduplicated at flush time.
+        class Log < Base
+          LEVELS = {
+            error: 'ERROR',
+            warn: 'WARN',
+          }.freeze
+
+          LEVELS_STRING = LEVELS.values.freeze
+
+          attr_reader :message, :level, :stack_trace, :count
+
+          def type
+            'logs'
+          end
+
+          # @param message [String] the log message
+          # @param level [Symbol, String] the log level. Either :error, :warn, 'ERROR', or 'WARN'.
+          # @param stack_trace [String, nil] the stack trace
+          # @param count [Integer] the number of times the log was emitted. Used for deduplication.
+          def initialize(message:, level:, stack_trace: nil, count: 1)
+            super()
+            @message = message
+            @stack_trace = stack_trace
+
+            if level.is_a?(String) && LEVELS_STRING.include?(level)
+              # String level is used during object copy for deduplication
+              @level = level
+            elsif level.is_a?(Symbol)
+              # Symbol level is used by the regular log emitter user
+              @level = LEVELS.fetch(level) { |k| raise ArgumentError, "Invalid log level :#{k}" }
+            else
+              raise ArgumentError, "Invalid log level #{level}"
+            end
+
+            @count = count
+          end
+
+          def payload
+            {
+              logs: [
+                {
+                  message: @message,
+                  level: @level,
+                  stack_trace: @stack_trace,
+                  count: @count,
+                }.compact
+              ]
+            }
+          end
+
+          # override equality to allow for deduplication
+          def ==(other)
+            other.is_a?(Log) &&
+              other.message == @message &&
+              other.level == @level && other.stack_trace == @stack_trace && other.count == @count
+          end
+
+          alias_method :eql?, :==
+
+          def hash
+            [self.class, @message, @level, @stack_trace, @count].hash
+          end
+        end
+      end
+    end
+  end
+end

data/lib/datadog/core/telemetry/event/message_batch.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module Datadog
+  module Core
+    module Telemetry
+      module Event
+        # Telemetry class for the 'message-batch' event.
+        class MessageBatch < Base
+          attr_reader :events
+
+          def type
+            'message-batch'
+          end
+
+          def initialize(events)
+            super()
+            @events = events
+          end
+
+          def payload
+            @events.map do |event|
+              {
+                request_type: event.type,
+                payload: event.payload,
+              }
+            end
+          end
+
+          def ==(other)
+            other.is_a?(MessageBatch) && other.events == @events
+          end
+
+          alias_method :eql?, :==
+
+          def hash
+            [self.class, @events].hash
+          end
+        end
+      end
+    end
+  end
+end

data/lib/datadog/core/telemetry/event/synth_app_client_configuration_change.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require_relative 'base'
+
+module Datadog
+  module Core
+    module Telemetry
+      module Event
+        # app-client-configuration-change event emitted instead of
+        # app-started event for telemetry startups other than the initial
+        # one in a process.
+        #
+        # dd-trace-rb generally creates a new component tree whenever
+        # the tracer is reconfigured via Datadog.configure (with some
+        # components potentially reused, if their configuration has not
+        # changed). Telemetry system tests on the other hand expect there
+        # to be one "tracer" per process, and do not permit multiple
+        # app-started events to be emitted.
+        #
+        # To resolve this conflict, we replace second and onward app-started
+        # events with app-client-configuration-change events.
+        # To avoid diffing configuration, we send all parameters that are
+        # sent in app-started event.
+        #
+        # It's a "quick fix" on top of a not-so-quick fix that omitted
+        # second and subsequent app-started (and app-closing) events in the
+        # first place, and only works with the existing hackery of app-started
+        # and app-closing events.
+        class SynthAppClientConfigurationChange < AppStarted
+          def type
+            'app-client-configuration-change'
+          end
+
+          def payload
+            {
+              configuration: configuration,
+            }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/datadog/core/telemetry/event.rb

@@ -6,8 +6,10 @@ require_relative '../utils/sequence'
 module Datadog
   module Core
     module Telemetry
-      # Collection of telemetry events
-      class Event
+      # Collection of telemetry events.
+      #
+      # @api private
+      module Event
         extend Core::Utils::Forking
 
         # returns sequence that increments every time the configuration changes
@@ -15,477 +17,20 @@ module Datadog
           after_fork! { @sequence = Datadog::Core::Utils::Sequence.new(1) }
           @sequence ||= Datadog::Core::Utils::Sequence.new(1)
         end
-
-        # Base class for all Telemetry V2 events.
-        class Base
-          # The type of the event.
-          # It must be one of the stings defined in the Telemetry V2
-          # specification for event names.
-          def type
-            raise NotImplementedError, 'Must be implemented by subclass'
-          end
-
-          # The JSON payload for the event.
-          def payload
-            {}
-          end
-
-          # Override equality to allow for deduplication
-          # The basic implementation is to check if the other object is an instance of the same class.
-          # This works for events that have no attributes.
-          # For events with attributes, you should override this method to compare the attributes.
-          def ==(other)
-            other.is_a?(self.class)
-          end
-
-          # @see #==
-          alias eql? ==
-
-          # @see #==
-          def hash
-            self.class.hash
-          end
-        end
-
-        # Telemetry class for the 'app-started' event
-        class AppStarted < Base
-          def type
-            'app-started'
-          end
-
-          def payload
-            {
-              products: products,
-              configuration: configuration,
-              install_signature: install_signature,
-              # DEV: Not implemented yet
-              # error: error, # Start-up errors
-            }
-          end
-
-          private
-
-          def products
-            # @type var products: Hash[Symbol, Hash[Symbol, Object]]
-            products = {
-              appsec: {
-                enabled: Datadog::AppSec.enabled?,
-              },
-              profiler: {
-                enabled: Datadog::Profiling.enabled?,
-              },
-              # DEV: Not implemented yet
-              # dynamic_instrumentation: {
-              #   enabled: true,
-              # }
-            }
-
-            if (unsupported_reason = Datadog::Profiling.unsupported_reason)
-              products[:profiler][:error] = {
-                code: 1, # Error code. 0 if no error.
-                message: unsupported_reason,
-              }
-            end
-
-            products
-          end
-
-          TARGET_OPTIONS = %w[
-            logger.level
-            profiling.advanced.code_provenance_enabled
-            profiling.advanced.endpoint.collection.enabled
-            profiling.enabled
-            runtime_metrics.enabled
-            tracing.analytics.enabled
-            tracing.propagation_style_extract
-            tracing.propagation_style_inject
-            tracing.enabled
-            tracing.log_injection
-            tracing.partial_flush.enabled
-            tracing.partial_flush.min_spans_threshold
-            tracing.report_hostname
-            tracing.sampling.rate_limit
-          ].freeze
-
-          # rubocop:disable Metrics/AbcSize
-          # rubocop:disable Metrics/MethodLength
-          def configuration
-            config = Datadog.configuration
-            seq_id = Event.configuration_sequence.next
-
-            list = [
-              conf_value('DD_AGENT_HOST', config.agent.host, seq_id),
-              conf_value('DD_AGENT_TRANSPORT', agent_transport(config), seq_id),
-              conf_value('DD_TRACE_SAMPLE_RATE', to_value(config.tracing.sampling.default_rate), seq_id),
-              conf_value(
-                'DD_TRACE_REMOVE_INTEGRATION_SERVICE_NAMES_ENABLED',
-                config.tracing.contrib.global_default_service_name.enabled,
-                seq_id
-              ),
-              conf_value(
-                'DD_TRACE_PEER_SERVICE_DEFAULTS_ENABLED',
-                config.tracing.contrib.peer_service_defaults,
-                seq_id
-              ),
-            ]
-
-            peer_service_mapping_str = ''
-            unless config.tracing.contrib.peer_service_mapping.empty?
-              peer_service_mapping = config.tracing.contrib.peer_service_mapping
-              peer_service_mapping_str = peer_service_mapping.map { |key, value| "#{key}:#{value}" }.join(',')
-            end
-            list << conf_value('DD_TRACE_PEER_SERVICE_MAPPING', peer_service_mapping_str, seq_id)
-
-            # Whitelist of configuration options to send in additional payload object
-            TARGET_OPTIONS.each do |option|
-              split_option = option.split('.')
-              list << conf_value(option, to_value(config.dig(*split_option)), seq_id)
-            end
-
-            # Add some more custom additional payload values here
-            list.push(
-              conf_value('tracing.auto_instrument.enabled', !defined?(Datadog::AutoInstrument::LOADED).nil?, seq_id),
-              conf_value(
-                'tracing.writer_options.buffer_size',
-                to_value(config.tracing.writer_options[:buffer_size]),
-                seq_id
-              ),
-              conf_value(
-                'tracing.writer_options.flush_interval',
-                to_value(config.tracing.writer_options[:flush_interval]),
-                seq_id
-              ),
-              conf_value(
-                'tracing.opentelemetry.enabled',
-                !defined?(Datadog::OpenTelemetry::LOADED).nil?,
-                seq_id
-              ),
-            )
-            list << conf_value('logger.instance', config.logger.instance.class.to_s, seq_id) if config.logger.instance
-            if config.respond_to?('appsec')
-              list << conf_value('appsec.enabled', config.dig('appsec', 'enabled'), seq_id)
-              list << conf_value('appsec.sca_enabled', config.dig('appsec', 'sca_enabled'), seq_id)
-            end
-            list << conf_value('ci.enabled', config.dig('ci', 'enabled'), seq_id) if config.respond_to?('ci')
-
-            list.reject! { |entry| entry[:value].nil? }
-            list
-          end
-          # rubocop:enable Metrics/AbcSize
-          # rubocop:enable Metrics/MethodLength
-
-          def agent_transport(config)
-            adapter = Core::Configuration::AgentSettingsResolver.call(config).adapter
-            if adapter == Datadog::Core::Transport::Ext::UnixSocket::ADAPTER
-              'UDS'
-            else
-              'TCP'
-            end
-          end
-
-          def conf_value(name, value, seq_id, origin = 'code')
-            {
-              name: name,
-              value: value,
-              origin: origin,
-              seq_id: seq_id,
-            }
-          end
-
-          def to_value(value)
-            # TODO: Add float if telemetry starts accepting it
-            case value
-            when Integer, String, true, false, nil
-              value
-            else
-              value.to_s
-            end
-          end
-
-          def install_signature
-            config = Datadog.configuration
-            {
-              install_id: config.dig('telemetry', 'install_id'),
-              install_type: config.dig('telemetry', 'install_type'),
-              install_time: config.dig('telemetry', 'install_time'),
-            }
-          end
-        end
-
-        # Telemetry class for the 'app-dependencies-loaded' event
-        class AppDependenciesLoaded < Base
-          def type
-            'app-dependencies-loaded'
-          end
-
-          def payload
-            { dependencies: dependencies }
-          end
-
-          private
-
-          def dependencies
-            Gem.loaded_specs.collect do |name, gem|
-              {
-                name: name,
-                version: gem.version.to_s,
-                # hash: nil,
-              }
-            end
-          end
-        end
-
-        # Telemetry class for the 'app-integrations-change' event
-        class AppIntegrationsChange < Base
-          def type
-            'app-integrations-change'
-          end
-
-          def payload
-            { integrations: integrations }
-          end
-
-          private
-
-          def integrations
-            instrumented_integrations = Datadog.configuration.tracing.instrumented_integrations
-            Datadog.registry.map do |integration|
-              is_instrumented = instrumented_integrations.include?(integration.name)
-
-              is_enabled = is_instrumented ? !!integration.klass.patcher.patch_successful : false
-
-              version = integration.klass.class.version ? integration.klass.class.version.to_s : nil
-
-              res = {
-                name: integration.name.to_s,
-                enabled: is_enabled,
-                version: version,
-                compatible: integration.klass.class.compatible?,
-                error: (patch_error(integration) if is_instrumented && !is_enabled),
-                # TODO: Track if integration is instrumented by manual configuration or by auto instrumentation
-                # auto_enabled: is_enabled && ???,
-              }
-              res.reject! { |_, v| v.nil? }
-              res
-            end
-          end
-
-          def patch_error(integration)
-            patch_error_result = integration.klass.patcher.patch_error_result
-            return patch_error_result.compact.to_s if patch_error_result
-
-            # If no error occurred during patching, but integration is still not instrumented
-            "Available?: #{integration.klass.class.available?}" \
-            ", Loaded? #{integration.klass.class.loaded?}" \
-            ", Compatible? #{integration.klass.class.compatible?}" \
-            ", Patchable? #{integration.klass.class.patchable?}"
-          end
-        end
-
-        # Telemetry class for the 'app-client-configuration-change' event
-        class AppClientConfigurationChange < Base
-          attr_reader :changes, :origin
-
-          def type
-            'app-client-configuration-change'
-          end
-
-          def initialize(changes, origin)
-            super()
-            @changes = changes
-            @origin = origin
-          end
-
-          def payload
-            { configuration: configuration }
-          end
-
-          def configuration
-            config = Datadog.configuration
-            seq_id = Event.configuration_sequence.next
-
-            res = @changes.map do |name, value|
-              {
-                name: name,
-                value: value,
-                origin: @origin,
-                seq_id: seq_id,
-              }
-            end
-
-            unless config.dig('appsec', 'sca_enabled').nil?
-              res << {
-                name: 'appsec.sca_enabled',
-                value: config.appsec.sca_enabled,
-                origin: 'code',
-                seq_id: seq_id,
-              }
-            end
-
-            res
-          end
-
-          def ==(other)
-            other.is_a?(AppClientConfigurationChange) && other.changes == @changes && other.origin == @origin
-          end
-
-          alias eql? ==
-
-          def hash
-            [self.class, @changes, @origin].hash
-          end
-        end
-
-        # Telemetry class for the 'app-heartbeat' event
-        class AppHeartbeat < Base
-          def type
-            'app-heartbeat'
-          end
-        end
-
-        # Telemetry class for the 'app-closing' event
-        class AppClosing < Base
-          def type
-            'app-closing'
-          end
-        end
-
-        # Telemetry class for the 'generate-metrics' event
-        class GenerateMetrics < Base
-          attr_reader :namespace, :metric_series
-
-          def type
-            'generate-metrics'
-          end
-
-          def initialize(namespace, metric_series)
-            super()
-            @namespace = namespace
-            @metric_series = metric_series
-          end
-
-          def payload
-            {
-              namespace: @namespace,
-              series: @metric_series.map(&:to_h)
-            }
-          end
-
-          def ==(other)
-            other.is_a?(GenerateMetrics) && other.namespace == @namespace && other.metric_series == @metric_series
-          end
-
-          alias eql? ==
-
-          def hash
-            [self.class, @namespace, @metric_series].hash
-          end
-        end
-
-        # Telemetry class for the 'logs' event.
-        # Logs with the same content are deduplicated at flush time.
-        class Log < Base
-          LEVELS = {
-            error: 'ERROR',
-            warn: 'WARN',
-          }.freeze
-
-          LEVELS_STRING = LEVELS.values.freeze
-
-          attr_reader :message, :level, :stack_trace, :count
-
-          def type
-            'logs'
-          end
-
-          # @param message [String] the log message
-          # @param level [Symbol, String] the log level. Either :error, :warn, 'ERROR', or 'WARN'.
-          # @param stack_trace [String, nil] the stack trace
-          # @param count [Integer] the number of times the log was emitted. Used for deduplication.
-          def initialize(message:, level:, stack_trace: nil, count: 1)
-            super()
-            @message = message
-            @stack_trace = stack_trace
-
-            if level.is_a?(String) && LEVELS_STRING.include?(level)
-              # String level is used during object copy for deduplication
-              @level = level
-            elsif level.is_a?(Symbol)
-              # Symbol level is used by the regular log emitter user
-              @level = LEVELS.fetch(level) { |k| raise ArgumentError, "Invalid log level :#{k}" }
-            else
-              raise ArgumentError, "Invalid log level #{level}"
-            end
-
-            @count = count
-          end
-
-          def payload
-            {
-              logs: [
-                {
-                  message: @message,
-                  level: @level,
-                  stack_trace: @stack_trace,
-                  count: @count,
-                }.compact
-              ]
-            }
-          end
-
-          # override equality to allow for deduplication
-          def ==(other)
-            other.is_a?(Log) &&
-              other.message == @message &&
-              other.level == @level && other.stack_trace == @stack_trace && other.count == @count
-          end
-
-          alias eql? ==
-
-          def hash
-            [self.class, @message, @level, @stack_trace, @count].hash
-          end
-        end
-
-        # Telemetry class for the 'distributions' event
-        class Distributions < GenerateMetrics
-          def type
-            'distributions'
-          end
-        end
-
-        # Telemetry class for the 'message-batch' event
-        class MessageBatch
-          attr_reader :events
-
-          def type
-            'message-batch'
-          end
-
-          def initialize(events)
-            @events = events
-          end
-
-          def payload
-            @events.map do |event|
-              {
-                request_type: event.type,
-                payload: event.payload,
-              }
-            end
-          end
-
-          def ==(other)
-            other.is_a?(MessageBatch) && other.events == @events
-          end
-
-          alias eql? ==
-
-          def hash
-            [self.class, @events].hash
-          end
-        end
       end
     end
   end
 end
+
+require_relative 'event/base'
+require_relative 'event/app_client_configuration_change'
+require_relative 'event/app_closing'
+require_relative 'event/app_dependencies_loaded'
+require_relative 'event/app_heartbeat'
+require_relative 'event/app_integrations_change'
+require_relative 'event/app_started'
+require_relative 'event/synth_app_client_configuration_change'
+require_relative 'event/generate_metrics'
+require_relative 'event/distributions'
+require_relative 'event/log'
+require_relative 'event/message_batch'