ddtrace 1.4.2 → 1.19.0

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

@@ -1,5 +1,3 @@
-# typed: true
-
 require_relative 'event'
 require_relative 'http/transport'
 require_relative '../utils/sequence'
@@ -23,11 +21,13 @@ module Datadog
 
         # Retrieves and emits a TelemetryRequest object based on the request type specified
         # @param request_type [String] the type of telemetry request to collect data for
-        def request(request_type)
+        # @param data [Object] arbitrary object to be passed to the respective `request_type` handler
+        def request(request_type, data: nil)
           begin
             request = Datadog::Core::Telemetry::Event.new.telemetry_request(
               request_type: request_type,
-              seq_id: self.class.sequence.next
+              seq_id: self.class.sequence.next,
+              data: data,
             ).to_h
             @http_transport.request(request_type: request_type.to_s, payload: request.to_json)
           rescue StandardError => e

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

@@ -1,19 +1,18 @@
-# typed: true
+# frozen_string_literal: true
 
 require_relative 'collector'
 require_relative 'v1/app_event'
 require_relative 'v1/telemetry_request'
+require_relative 'v2/app_client_configuration_change'
 
 module Datadog
   module Core
     module Telemetry
       # Class defining methods to construct a Telemetry event
       class Event
-        include Kernel
-
         include Telemetry::Collector
 
-        API_VERSION = 'v1'.freeze
+        API_VERSION = 'v1'
 
         attr_reader \
           :api_version
@@ -25,12 +24,13 @@ module Datadog
         # 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:)
+        # @param data [Object] arbitrary object to be passed to the respective `request_type` handler
+        def telemetry_request(request_type:, seq_id:, data: nil)
           Telemetry::V1::TelemetryRequest.new(
             api_version: @api_version,
             application: application,
             host: host,
-            payload: payload(request_type),
+            payload: payload(request_type, data),
             request_type: request_type,
             runtime_id: runtime_id,
             seq_id: seq_id,
@@ -40,7 +40,7 @@ module Datadog
 
         private
 
-        def payload(request_type)
+        def payload(request_type, data)
           case request_type
           when :'app-started'
             app_started
@@ -48,6 +48,8 @@ module Datadog
             {}
           when :'app-integrations-change'
             app_integrations_change
+          when 'app-client-configuration-change'
+            app_client_configuration_change(data)
           else
             raise ArgumentError, "Request type invalid, received request_type: #{@request_type}"
           end
@@ -58,13 +60,23 @@ module Datadog
             dependencies: dependencies,
             integrations: integrations,
             configuration: configurations,
-            additional_payload: additional_payload
+            additional_payload: additional_payload,
+            install_signature: install_signature
           )
         end
 
         def app_integrations_change
           Telemetry::V1::AppEvent.new(integrations: integrations)
         end
+
+        # DEV: During the transition from V1 to V2, the backend accepts many V2
+        # DEV: payloads through the V1 transport protocol.
+        # DEV: The `app-client-configuration-change` payload is one of them.
+        # DEV: Once V2 is fully implemented, `Telemetry::V2::AppClientConfigurationChange`
+        # DEV: should be reusable without major modifications.
+        def app_client_configuration_change(data)
+          Telemetry::V2::AppClientConfigurationChange.new(data[:changes], origin: data[:origin])
+        end
       end
     end
   end

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

@@ -1,10 +1,14 @@
-# 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_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/heartbeat.rb

@@ -1,4 +1,4 @@
-# typed: false
+# frozen_string_literal: true
 
 require_relative '../worker'
 require_relative '../workers/polling'
@@ -10,13 +10,11 @@ module Datadog
       class Heartbeat < Core::Worker
         include Core::Workers::Polling
 
-        DEFAULT_INTERVAL_SECONDS = 60
-
-        def initialize(enabled: true, interval: DEFAULT_INTERVAL_SECONDS, &block)
+        def initialize(heartbeat_interval_seconds:, enabled: true, &block)
           # Workers::Polling settings
           self.enabled = enabled
           # Workers::IntervalLoop settings
-          self.loop_base_interval = interval
+          self.loop_base_interval = heartbeat_interval_seconds
           self.fork_policy = Core::Workers::Async::Thread::FORK_POLICY_STOP
           super(&block)
           start

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

@@ -1,5 +1,3 @@
-# typed: true
-
 require_relative '../response'
 
 module Datadog

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,20 @@
+# 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'
 
-          CONTENT_TYPE_APPLICATION_JSON = 'application/json'.freeze
-          API_VERSION = 'v1'.freeze
+          CONTENT_TYPE_APPLICATION_JSON = 'application/json'
+          API_VERSION = 'v1'
 
-          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

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,6 +39,7 @@ module Datadog
 
           def headers(request_type:, api_version: Http::Ext::API_VERSION)
             {
+              Datadog::Core::Transport::Ext::HTTP::HEADER_DD_INTERNAL_UNTRACED_REQUEST => '1',
               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,

data/lib/datadog/core/telemetry/v1/app_event.rb

@@ -1,27 +1,33 @@
+# frozen_string_literal: true
+
 module Datadog
   module Core
     module Telemetry
       module V1
         # Describes payload for telemetry V1 API app-integrations-change event
         class AppEvent
-          include Kernel
-
           attr_reader \
             :additional_payload,
             :configuration,
             :dependencies,
+            :install_signature,
             :integrations
 
           # @param additional_payload [Array<Telemetry::V1::Configuration>] List of Additional payload to track (any key
           #   value not mentioned and doesn't fit under a metric)
           # @param configuration [Array<Telemetry::V1::Configuration>] List of Tracer related configuration data
           # @param dependencies [Array<Telemetry::V1::Dependency>] List of all loaded modules requested by the app
+          # @param install_signature [Telemetry::V1::InstallSignature] Install signature data
           # @param integrations [Array<Telemetry::V1::Integration>] List of integrations that are available within the app
           #   and applicable to be traced
-          def initialize(additional_payload: nil, configuration: nil, dependencies: nil, integrations: nil)
+          def initialize(
+            additional_payload: nil, configuration: nil, dependencies: nil, install_signature: nil,
+            integrations: nil
+          )
             @additional_payload = additional_payload
             @configuration = configuration
             @dependencies = dependencies
+            @install_signature = install_signature
             @integrations = integrations
           end
 
@@ -30,6 +36,7 @@ module Datadog
               hash[:additional_payload] = map_hash(@additional_payload) if @additional_payload
               hash[:configuration] = map_hash(@configuration) if @configuration
               hash[:dependencies] = map_array(@dependencies) if @dependencies
+              hash[:install_signature] = @install_signature.to_h if @install_signature
               hash[:integrations] = map_array(@integrations) if @integrations
             end
           end

data/lib/datadog/core/telemetry/v1/application.rb

@@ -1,9 +1,13 @@
+require_relative '../../utils/hash'
+
 module Datadog
   module Core
     module Telemetry
       module V1
         # Describes attributes for application environment object
         class Application
+          using Core::Utils::Hash::Refinement
+
           ERROR_NIL_LANGUAGE_NAME_MESSAGE = ':language_name must not be nil'.freeze
           ERROR_NIL_LANGUAGE_VERSION_MESSAGE = ':language_version must not be nil'.freeze
           ERROR_NIL_SERVICE_NAME_MESSAGE = ':service_name must not be nil'.freeze
@@ -54,7 +58,7 @@ module Datadog
           end
 
           def to_h
-            {
+            hash = {
               env: @env,
               language_name: @language_name,
               language_version: @language_version,
@@ -66,6 +70,8 @@ module Datadog
               service_version: @service_version,
               tracer_version: @tracer_version
             }
+            hash.compact!
+            hash
           end
 
           private

data/lib/datadog/core/telemetry/v1/dependency.rb

@@ -1,9 +1,13 @@
+require_relative '../../utils/hash'
+
 module Datadog
   module Core
     module Telemetry
       module V1
         # Describes attributes for dependency object
         class Dependency
+          using Core::Utils::Hash::Refinement
+
           ERROR_NIL_NAME_MESSAGE = ':name must not be nil'.freeze
 
           attr_reader \
@@ -13,9 +17,10 @@ module Datadog
 
           # @param name [String] Module name
           # @param version [String] Version of resolved module
-          # @param hash [String] Dependency hash
+          # @param hash [String] Dependency hash, in case `version` is not available
           def initialize(name:, version: nil, hash: nil)
             raise ArgumentError, ERROR_NIL_NAME_MESSAGE if name.nil?
+            raise ArgumentError, 'if both :version and :hash exist, use :version only' if version && hash
 
             @hash = hash
             @name = name
@@ -23,11 +28,13 @@ module Datadog
           end
 
           def to_h
-            {
+            hash = {
               hash: @hash,
               name: @name,
               version: @version
             }
+            hash.compact!
+            hash
           end
         end
       end

data/lib/datadog/core/telemetry/v1/host.rb

@@ -1,9 +1,15 @@
+# frozen_string_literal: true
+
+require_relative '../../utils/hash'
+
 module Datadog
   module Core
     module Telemetry
       module V1
         # Describes attributes for host object
         class Host
+          using Core::Utils::Hash::Refinement
+
           attr_reader \
             :container_id,
             :hostname,
@@ -34,7 +40,7 @@ module Datadog
           end
 
           def to_h
-            {
+            hash = {
               container_id: @container_id,
               hostname: @hostname,
               kernel_name: @kernel_name,
@@ -43,6 +49,8 @@ module Datadog
               os: @os,
               os_version: @os_version,
             }
+            hash.compact!
+            hash
           end
         end
       end

data/lib/datadog/core/telemetry/v1/install_signature.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Datadog
+  module Core
+    module Telemetry
+      module V1
+        # Describes attributes for install signature
+        class InstallSignature
+          using Core::Utils::Hash::Refinement
+
+          attr_reader \
+            :install_id,
+            :install_type,
+            :install_time
+
+          # @param id [String,nil] Install ID
+          # @param type [String,nil] Install type
+          # @param type [String,nil] Install time
+          def initialize(install_id:, install_type:, install_time:)
+            @install_id = install_id
+            @install_type = install_type
+            @install_time = install_time
+          end
+
+          def to_h
+            hash = {
+              install_id: @install_id,
+              install_type: @install_type,
+              install_time: @install_time
+            }
+            hash.compact!
+            hash
+          end
+        end
+      end
+    end
+  end
+end

data/lib/datadog/core/telemetry/v1/integration.rb

@@ -1,9 +1,13 @@
+require_relative '../../utils/hash'
+
 module Datadog
   module Core
     module Telemetry
       module V1
         # Describes attributes for integration object
         class Integration
+          using Core::Utils::Hash::Refinement
+
           ERROR_NIL_ENABLED_MESSAGE = ':enabled must not be nil'.freeze
           ERROR_NIL_NAME_MESSAGE = ':name must not be nil'.freeze
 
@@ -32,7 +36,7 @@ module Datadog
           end
 
           def to_h
-            {
+            hash = {
               auto_enabled: @auto_enabled,
               compatible: @compatible,
               enabled: @enabled,
@@ -40,6 +44,8 @@ module Datadog
               name: @name,
               version: @version
             }
+            hash.compact!
+            hash
           end
 
           private

data/lib/datadog/core/telemetry/v1/product.rb

@@ -1,9 +1,15 @@
+# frozen_string_literal: true
+
+require_relative '../../utils/hash'
+
 module Datadog
   module Core
     module Telemetry
       module V1
         # Describes attributes for products object
         class Product
+          using Core::Utils::Hash::Refinement
+
           attr_reader \
             :appsec,
             :profiler
@@ -16,10 +22,12 @@ module Datadog
           end
 
           def to_h
-            {
+            hash = {
               appsec: @appsec,
               profiler: @profiler
             }
+            hash.compact!
+            hash
           end
         end
       end

data/lib/datadog/core/telemetry/v1/telemetry_request.rb

@@ -1,9 +1,13 @@
+require_relative '../../utils/hash'
+
 module Datadog
   module Core
     module Telemetry
       module V1
         # Describes attributes for telemetry API request
         class TelemetryRequest
+          using Core::Utils::Hash::Refinement
+
           ERROR_NIL_API_VERSION_MESSAGE = ':api_version must not be nil'.freeze
           ERROR_NIL_APPLICATION_MESSAGE = ':application must not be nil'.freeze
           ERROR_NIL_HOST_MESSAGE = ':host must not be nil'.freeze
@@ -64,7 +68,7 @@ module Datadog
           end
 
           def to_h
-            {
+            hash = {
               api_version: @api_version,
               application: @application.to_h,
               debug: @debug,
@@ -76,6 +80,8 @@ module Datadog
               session_id: @session_id,
               tracer_time: @tracer_time
             }
+            hash.compact!
+            hash
           end
 
           private

data/lib/datadog/core/telemetry/v2/app_client_configuration_change.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require_relative 'request'
+
+module Datadog
+  module Core
+    module Telemetry
+      module V2
+        # Telemetry 'app-client-configuration-change' event.
+        # This request should contain client library configuration that have changes since the app-started event.
+        class AppClientConfigurationChange < Request
+          def initialize(configuration_changes, origin: 'unknown')
+            super('app-client-configuration-change')
+
+            @configuration_changes = configuration_changes
+            @origin = origin
+          end
+
+          # @see [Request#to_h]
+          def to_h
+            super.merge(payload: payload)
+          end
+
+          private
+
+          def payload
+            {
+              configuration: @configuration_changes.map do |name, value|
+                {
+                  name: name,
+                  value: value,
+                  origin: @origin,
+                }
+              end
+            }
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Datadog
+  module Core
+    module Telemetry
+      module V2
+        # Base request object for Telemetry V2.
+        #
+        # `#to_h` is the main API, which returns a Ruby
+        # Hash that will be serialized as JSON.
+        class Request
+          # @param [String] request_type the Telemetry request type, which dictates how the Hash payload should be processed
+          def initialize(request_type)
+            @request_type = request_type
+          end
+
+          # Converts this request to a Hash that will
+          # be serialized as JSON.
+          # @return [Hash]
+          def to_h
+            {
+              request_type: @request_type
+            }
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require_relative '../configuration/ext'
+# DEV(2.0): This file should replace /ddtrace/transport/ext.rb
+# WARN: This file is used in /dd trace/transport/ext.rb which is a public API. Any changes here
+# should be treated as changes to a public API.
+module Datadog
+  module Core
+    module Transport
+      module Ext
+        module HTTP
+          ADAPTER = Datadog::Core::Configuration::Ext::Agent::HTTP::ADAPTER
+          DEFAULT_HOST = Datadog::Core::Configuration::Ext::Agent::HTTP::DEFAULT_HOST
+          DEFAULT_PORT = Datadog::Core::Configuration::Ext::Agent::HTTP::DEFAULT_PORT
+
+          HEADER_CONTAINER_ID = 'Datadog-Container-ID'
+          HEADER_DD_API_KEY = 'DD-API-KEY'
+          # Tells agent that `_dd.top_level` metrics have been set by the tracer.
+          # The agent will not calculate top-level spans but instead trust the tracer tagging.
+          #
+          # This prevents partially flushed traces being mistakenly marked as top-level.
+          #
+          # Setting this header to any non-empty value enables this feature.
+          HEADER_CLIENT_COMPUTED_TOP_LEVEL = 'Datadog-Client-Computed-Top-Level'
+          HEADER_META_LANG = 'Datadog-Meta-Lang'
+          HEADER_META_LANG_VERSION = 'Datadog-Meta-Lang-Version'
+          HEADER_META_LANG_INTERPRETER = 'Datadog-Meta-Lang-Interpreter'
+          HEADER_META_TRACER_VERSION = 'Datadog-Meta-Tracer-Version'
+
+          # Header that prevents the Net::HTTP integration from tracing internal trace requests.
+          # Set it to any value to skip tracing.
+          HEADER_DD_INTERNAL_UNTRACED_REQUEST = 'DD-Internal-Untraced-Request'
+        end
+
+        module Test
+          ADAPTER = :test
+        end
+
+        module UnixSocket
+          ADAPTER = Datadog::Core::Configuration::Ext::Agent::UnixSocket::ADAPTER
+          DEFAULT_PATH = Datadog::Core::Configuration::Ext::Agent::UnixSocket::DEFAULT_PATH
+          DEFAULT_TIMEOUT_SECONDS = Datadog::Core::Configuration::Ext::Agent::UnixSocket::DEFAULT_TIMEOUT_SECONDS
+        end
+      end
+    end
+  end
+end