ddtrace 1.4.2 → 1.23.3

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

@@ -1,69 +1,272 @@
-# typed: true
-
-require_relative 'collector'
-require_relative 'v1/app_event'
-require_relative 'v1/telemetry_request'
+# frozen_string_literal: true
 
 module Datadog
   module Core
     module Telemetry
-      # Class defining methods to construct a Telemetry event
       class Event
-        include Kernel
+        # 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; end
+
+          # The JSON payload for the event.
+          # @param seq_id [Integer] The sequence ID for the event.
+          def payload(seq_id)
+            {}
+          end
+        end
+
+        # Telemetry class for the 'app-started' event
+        class AppStarted < Base
+          def type
+            'app-started'
+          end
+
+          def payload(seq_id)
+            @seq_id = seq_id
+            {
+              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.distributed_tracing.propagation_inject_style
+            tracing.distributed_tracing.propagation_extract_style
+            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
+          def configuration
+            config = Datadog.configuration
+
+            list = [
+              conf_value('DD_AGENT_HOST', config.agent.host),
+              conf_value('DD_AGENT_TRANSPORT', agent_transport(config)),
+              conf_value('DD_TRACE_SAMPLE_RATE', to_value(config.tracing.sampling.default_rate)),
+              conf_value(
+                'DD_TRACE_REMOVE_INTEGRATION_SERVICE_NAMES_ENABLED',
+                config.tracing.contrib.global_default_service_name.enabled
+              ),
+            ]
+
+            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)
+
+            # 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)))
+            end
+
+            # Add some more custom additional payload values here
+            list.push(
+              conf_value('tracing.auto_instrument.enabled', !defined?(Datadog::AutoInstrument::LOADED).nil?),
+              conf_value('tracing.writer_options.buffer_size', to_value(config.tracing.writer_options[:buffer_size])),
+              conf_value('tracing.writer_options.flush_interval', to_value(config.tracing.writer_options[:flush_interval])),
+              conf_value('tracing.opentelemetry.enabled', !defined?(Datadog::OpenTelemetry::LOADED).nil?),
+            )
+            list << conf_value('logger.instance', config.logger.instance.class.to_s) if config.logger.instance
+            list << conf_value('appsec.enabled', config.dig('appsec', 'enabled')) if config.respond_to?('appsec')
+            list << conf_value('ci.enabled', config.dig('ci', 'enabled')) if config.respond_to?('ci')
+
+            list.reject! { |entry| entry[:value].nil? }
+            list
+          end
+          # rubocop:enable Metrics/AbcSize
+
+          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, origin = 'code')
+            {
+              name: name,
+              value: value,
+              origin: origin,
+              seq_id: @seq_id,
+            }
+          end
 
-        include Telemetry::Collector
+          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
 
-        API_VERSION = 'v1'.freeze
+        # Telemetry class for the 'app-dependencies-loaded' event
+        class AppDependenciesLoaded < Base
+          def type
+            'app-dependencies-loaded'
+          end
+
+          def payload(seq_id)
+            { dependencies: dependencies }
+          end
 
-        attr_reader \
-          :api_version
+          private
 
-        def initialize
-          @api_version = API_VERSION
+          def dependencies
+            Gem.loaded_specs.collect do |name, gem|
+              {
+                name: name,
+                version: gem.version.to_s,
+                # hash: nil,
+              }
+            end
+          end
         end
 
-        # Forms a TelemetryRequest object based on the event request_type
-        # @param request_type [String] the type of telemetry request to collect data for
-        # @param seq_id [Integer] the ID of the request; incremented each time a telemetry request is sent to the API
-        def telemetry_request(request_type:, seq_id:)
-          Telemetry::V1::TelemetryRequest.new(
-            api_version: @api_version,
-            application: application,
-            host: host,
-            payload: payload(request_type),
-            request_type: request_type,
-            runtime_id: runtime_id,
-            seq_id: seq_id,
-            tracer_time: tracer_time,
-          )
+        # Telemetry class for the 'app-integrations-change' event
+        class AppIntegrationsChange < Base
+          def type
+            'app-integrations-change'
+          end
+
+          def payload(seq_id)
+            { 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
 
-        private
+        # Telemetry class for the 'app-client-configuration-change' event
+        class AppClientConfigurationChange < Base
+          def type
+            'app-client-configuration-change'
+          end
 
-        def payload(request_type)
-          case request_type
-          when :'app-started'
-            app_started
-          when :'app-closing', :'app-heartbeat'
-            {}
-          when :'app-integrations-change'
-            app_integrations_change
-          else
-            raise ArgumentError, "Request type invalid, received request_type: #{@request_type}"
+          def initialize(changes, origin)
+            super()
+            @changes = changes
+            @origin = origin
+          end
+
+          def payload(seq_id)
+            {
+              configuration: @changes.map do |name, value|
+                {
+                  name: name,
+                  value: value,
+                  origin: @origin,
+                }
+              end
+            }
           end
         end
 
-        def app_started
-          Telemetry::V1::AppEvent.new(
-            dependencies: dependencies,
-            integrations: integrations,
-            configuration: configurations,
-            additional_payload: additional_payload
-          )
+        # Telemetry class for the 'app-heartbeat' event
+        class AppHeartbeat < Base
+          def type
+            'app-heartbeat'
+          end
         end
 
-        def app_integrations_change
-          Telemetry::V1::AppEvent.new(integrations: integrations)
+        # Telemetry class for the 'app-closing' event
+        class AppClosing < Base
+          def type
+            'app-closing'
+          end
         end
       end
     end

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

@@ -1,10 +1,15 @@
-# typed: true
+# frozen_string_literal: true
 
 module Datadog
   module Core
     module Telemetry
       module Ext
-        ENV_ENABLED = 'DD_INSTRUMENTATION_TELEMETRY_ENABLED'.freeze
+        ENV_ENABLED = 'DD_INSTRUMENTATION_TELEMETRY_ENABLED'
+        ENV_HEARTBEAT_INTERVAL = 'DD_TELEMETRY_HEARTBEAT_INTERVAL'
+        ENV_DEPENDENCY_COLLECTION = 'DD_TELEMETRY_DEPENDENCY_COLLECTION_ENABLED'
+        ENV_INSTALL_ID = 'DD_INSTRUMENTATION_INSTALL_ID'
+        ENV_INSTALL_TYPE = 'DD_INSTRUMENTATION_INSTALL_TYPE'
+        ENV_INSTALL_TIME = 'DD_INSTRUMENTATION_INSTALL_TIME'
       end
     end
   end

data/lib/datadog/core/telemetry/http/adapters/net.rb

@@ -1,5 +1,3 @@
-# typed: true
-
 require_relative '../response'
 
 module Datadog
@@ -15,7 +13,7 @@ module Datadog
               :timeout,
               :ssl
 
-            DEFAULT_TIMEOUT = 30
+            DEFAULT_TIMEOUT = 2
 
             def initialize(hostname:, port: nil, timeout: DEFAULT_TIMEOUT, ssl: true)
               @hostname = hostname

data/lib/datadog/core/telemetry/http/env.rb

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

data/lib/datadog/core/telemetry/http/ext.rb

@@ -1,18 +1,23 @@
+# frozen_string_literal: true
+
 module Datadog
   module Core
     module Telemetry
       module Http
         module Ext
-          HEADER_DD_API_KEY = 'DD-API-KEY'.freeze
-          HEADER_CONTENT_TYPE = 'Content-Type'.freeze
-          HEADER_CONTENT_LENGTH = 'Content-Length'.freeze
-          HEADER_DD_TELEMETRY_API_VERSION = 'DD-Telemetry-API-Version'.freeze
-          HEADER_DD_TELEMETRY_REQUEST_TYPE = 'DD-Telemetry-Request-Type'.freeze
+          HEADER_DD_API_KEY = 'DD-API-KEY'
+          HEADER_CONTENT_TYPE = 'Content-Type'
+          HEADER_CONTENT_LENGTH = 'Content-Length'
+          HEADER_DD_TELEMETRY_API_VERSION = 'DD-Telemetry-API-Version'
+          HEADER_DD_TELEMETRY_REQUEST_TYPE = 'DD-Telemetry-Request-Type'
+          HEADER_TELEMETRY_DEBUG_ENABLED = 'DD-Telemetry-Debug-Enabled'
+          HEADER_CLIENT_LIBRARY_LANGUAGE = 'DD-Client-Library-Language'
+          HEADER_CLIENT_LIBRARY_VERSION = 'DD-Client-Library-Version'
 
-          CONTENT_TYPE_APPLICATION_JSON = 'application/json'.freeze
-          API_VERSION = 'v1'.freeze
+          CONTENT_TYPE_APPLICATION_JSON = 'application/json'
+          API_VERSION = 'v2'
 
-          AGENT_ENDPOINT = '/telemetry/proxy/api/v2/apmtelemetry'.freeze
+          AGENT_ENDPOINT = '/telemetry/proxy/api/v2/apmtelemetry'
         end
       end
     end

data/lib/datadog/core/telemetry/http/response.rb

@@ -1,13 +1,9 @@
-# typed: true
-
 module Datadog
   module Core
     module Telemetry
       module Http
         # Module for base HTTP response
         module Response
-          include Kernel
-
           def payload
             nil
           end
@@ -36,6 +32,10 @@ module Datadog
             nil
           end
 
+          def code
+            nil
+          end
+
           def inspect
             "#{self.class} ok?:#{ok?} unsupported?:#{unsupported?}, " \
             "not_found?:#{not_found?}, client_error?:#{client_error?}, " \

data/lib/datadog/core/telemetry/http/transport.rb

@@ -1,6 +1,7 @@
-# typed: true
+# frozen_string_literal: true
 
 require_relative '../../configuration/settings'
+require_relative '../../transport/ext'
 require_relative 'env'
 require_relative 'ext'
 require_relative 'adapters/net'
@@ -10,6 +11,7 @@ module Datadog
     module Telemetry
       module Http
         # Class to send telemetry data to Telemetry API
+        # Currently only supports the HTTP protocol.
         class Transport
           attr_reader \
             :host,
@@ -37,9 +39,15 @@ module Datadog
 
           def headers(request_type:, api_version: Http::Ext::API_VERSION)
             {
-              Http::Ext::HEADER_CONTENT_TYPE => Http::Ext::CONTENT_TYPE_APPLICATION_JSON,
-              Http::Ext::HEADER_DD_TELEMETRY_API_VERSION => api_version,
-              Http::Ext::HEADER_DD_TELEMETRY_REQUEST_TYPE => request_type,
+              Core::Transport::Ext::HTTP::HEADER_DD_INTERNAL_UNTRACED_REQUEST => '1',
+              Ext::HEADER_CONTENT_TYPE => Http::Ext::CONTENT_TYPE_APPLICATION_JSON,
+              Ext::HEADER_DD_TELEMETRY_API_VERSION => api_version,
+              Ext::HEADER_DD_TELEMETRY_REQUEST_TYPE => request_type,
+              Ext::HEADER_CLIENT_LIBRARY_LANGUAGE => Core::Environment::Ext::LANG,
+              Ext::HEADER_CLIENT_LIBRARY_VERSION => DDTrace::VERSION::STRING,
+
+              # Enable debug mode for telemetry
+              # HEADER_TELEMETRY_DEBUG_ENABLED => 'true',
             }
           end
 

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

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+require_relative '../environment/platform'
+require_relative '../utils/hash'
+
+module Datadog
+  module Core
+    module Telemetry
+      # Module defining methods for collecting metadata for telemetry
+      module Request
+        class << self
+          using Core::Utils::Hash::Refinement
+
+          def build_payload(event, seq_id)
+            hash = {
+              api_version: Http::Ext::API_VERSION,
+              application: application,
+              debug: false,
+              host: host,
+              payload: event.payload(seq_id),
+              request_type: event.type,
+              runtime_id: Core::Environment::Identity.id,
+              seq_id: seq_id,
+              tracer_time: Time.now.to_i,
+            }
+            hash.compact!
+            hash
+          end
+
+          private
+
+          def application
+            config = Datadog.configuration
+            {
+              env: config.env,
+              language_name: Core::Environment::Ext::LANG,
+              language_version: Core::Environment::Ext::LANG_VERSION,
+              runtime_name: Core::Environment::Ext::RUBY_ENGINE,
+              runtime_version: Core::Environment::Ext::ENGINE_VERSION,
+              service_name: config.service,
+              service_version: config.version,
+              tracer_version: Core::Environment::Identity.tracer_version
+            }
+          end
+
+          def host
+            {
+              architecture: Core::Environment::Platform.architecture,
+              hostname: Core::Environment::Platform.hostname,
+              kernel_name: Core::Environment::Platform.kernel_name,
+              kernel_release: Core::Environment::Platform.kernel_release,
+              kernel_version: Core::Environment::Platform.kernel_version
+            }
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,158 @@
+# frozen_string_literal: true
+
+require_relative 'event'
+
+require_relative '../utils/only_once_successful'
+require_relative '../workers/polling'
+require_relative '../workers/queue'
+
+module Datadog
+  module Core
+    module Telemetry
+      # Accumulates events and sends them to the API at a regular interval, including heartbeat event.
+      class Worker
+        include Core::Workers::Queue
+        include Core::Workers::Polling
+
+        DEFAULT_BUFFER_MAX_SIZE = 1000
+        APP_STARTED_EVENT_RETRIES = 10
+
+        TELEMETRY_STARTED_ONCE = Utils::OnlyOnceSuccessful.new(APP_STARTED_EVENT_RETRIES)
+
+        def initialize(
+          heartbeat_interval_seconds:,
+          emitter:,
+          dependency_collection:,
+          enabled: true,
+          shutdown_timeout: Workers::Polling::DEFAULT_SHUTDOWN_TIMEOUT,
+          buffer_size: DEFAULT_BUFFER_MAX_SIZE
+        )
+          @emitter = emitter
+          @dependency_collection = dependency_collection
+
+          # Workers::Polling settings
+          self.enabled = enabled
+          # Workers::IntervalLoop settings
+          self.loop_base_interval = heartbeat_interval_seconds
+          self.fork_policy = Core::Workers::Async::Thread::FORK_POLICY_STOP
+
+          @shutdown_timeout = shutdown_timeout
+          @buffer_size = buffer_size
+
+          self.buffer = buffer_klass.new(@buffer_size)
+        end
+
+        def start
+          return if !enabled? || forked?
+
+          # starts async worker
+          perform
+        end
+
+        def stop(force_stop = false, timeout = @shutdown_timeout)
+          buffer.close if running?
+
+          super
+        end
+
+        def enqueue(event)
+          return if !enabled? || forked?
+
+          buffer.push(event)
+        end
+
+        def sent_started_event?
+          TELEMETRY_STARTED_ONCE.success?
+        end
+
+        def failed_to_start?
+          TELEMETRY_STARTED_ONCE.failed?
+        end
+
+        private
+
+        def perform(*events)
+          return if !enabled? || forked?
+
+          started! unless sent_started_event?
+
+          heartbeat!
+
+          flush_events(events)
+        end
+
+        def flush_events(events)
+          return if events.nil?
+          return if !enabled? || !sent_started_event?
+
+          Datadog.logger.debug { "Sending #{events.count} telemetry events" }
+          events.each do |event|
+            send_event(event)
+          end
+        end
+
+        def heartbeat!
+          return if !enabled? || !sent_started_event?
+
+          send_event(Event::AppHeartbeat.new)
+        end
+
+        def started!
+          return unless enabled?
+
+          if failed_to_start?
+            Datadog.logger.debug('Telemetry app-started event exhausted retries, disabling telemetry worker')
+            self.enabled = false
+            return
+          end
+
+          TELEMETRY_STARTED_ONCE.run do
+            res = send_event(Event::AppStarted.new)
+
+            if res.ok?
+              Datadog.logger.debug('Telemetry app-started event is successfully sent')
+
+              send_event(Event::AppDependenciesLoaded.new) if @dependency_collection
+
+              true
+            else
+              Datadog.logger.debug('Error sending telemetry app-started event, retry after heartbeat interval...')
+              false
+            end
+          end
+        end
+
+        def send_event(event)
+          res = @emitter.request(event)
+
+          disable_on_not_found!(res)
+
+          res
+        end
+
+        def dequeue
+          buffer.pop
+        end
+
+        def work_pending?
+          run_loop? || !buffer.empty?
+        end
+
+        def buffer_klass
+          if Core::Environment::Ext::RUBY_ENGINE == 'ruby'
+            Core::Buffer::CRuby
+          else
+            Core::Buffer::ThreadSafe
+          end
+        end
+
+        def disable_on_not_found!(response)
+          return unless response.not_found?
+
+          Datadog.logger.debug('Agent does not support telemetry; disabling future telemetry events.')
+          self.enabled = false
+        end
+      end
+    end
+  end
+end