ddtrace 1.0.0.beta1 → 1.1.0

data/lib/datadog/core/configuration/agent_settings_resolver.rb

@@ -1,4 +1,5 @@
-# typed: false
+# typed: true
+
 require 'uri'
 
 require 'datadog/core/configuration/settings'
@@ -53,6 +54,9 @@ module Datadog
 
             # Returns a frozen copy of this struct
             # with the provided +member_values+ modified.
+            #
+            # TODO: This is only used when configuring profiling, and can be removed once
+            # https://github.com/DataDog/dd-trace-rb/pull/1924 is merged
             def merge(**member_values)
               new_struct = dup
 
@@ -80,6 +84,19 @@ module Datadog
         end
 
         def call
+          # A transport_options proc configured for unix domain socket overrides most of the logic on this file
+          if transport_options.adapter == Transport::Ext::UnixSocket::ADAPTER
+            return AgentSettings.new(
+              adapter: Transport::Ext::UnixSocket::ADAPTER,
+              ssl: false,
+              hostname: nil,
+              port: nil,
+              uds_path: transport_options.uds_path,
+              timeout_seconds: timeout_seconds,
+              deprecated_for_removal_transport_configuration_proc: nil,
+            )
+          end
+
           AgentSettings.new(
             adapter: adapter,
             ssl: ssl?,
@@ -110,6 +127,10 @@ module Datadog
           return @configured_hostname if defined?(@configured_hostname)
 
           @configured_hostname = pick_from(
+            DetectedConfiguration.new(
+              friendly_name: "'c.tracing.transport_options'",
+              value: transport_options.hostname,
+            ),
             DetectedConfiguration.new(
               friendly_name: "'c.agent.host'",
               value: settings.agent.host
@@ -128,48 +149,42 @@ module Datadog
         def configured_port
           return @configured_port if defined?(@configured_port)
 
-          parsed_port_from_env =
+          @configured_port = pick_from(
             try_parsing_as_integer(
-              friendly_name: "#{Datadog::Tracing::Configuration::Ext::Transport::ENV_DEFAULT_PORT} environment variable",
-              value: ENV[Datadog::Tracing::Configuration::Ext::Transport::ENV_DEFAULT_PORT],
-            )
-
-          parsed_settings_tracer_port =
+              friendly_name: "'c.tracing.transport_options'",
+              value: transport_options.port,
+            ),
             try_parsing_as_integer(
               friendly_name: '"c.agent.port"',
               value: settings.agent.port,
-            )
-
-          @configured_port = pick_from(
-            DetectedConfiguration.new(
-              friendly_name: '"c.agent.port"',
-              value: parsed_settings_tracer_port,
             ),
             DetectedConfiguration.new(
               friendly_name: "#{Datadog::Tracing::Configuration::Ext::Transport::ENV_DEFAULT_URL} environment variable",
               value: parsed_url && parsed_url.port,
             ),
-            DetectedConfiguration.new(
+            try_parsing_as_integer(
               friendly_name: "#{Datadog::Tracing::Configuration::Ext::Transport::ENV_DEFAULT_PORT} environment variable",
-              value: parsed_port_from_env,
+              value: ENV[Datadog::Tracing::Configuration::Ext::Transport::ENV_DEFAULT_PORT],
             )
           )
         end
 
         def try_parsing_as_integer(value:, friendly_name:)
-          return unless value
+          value =
+            begin
+              Integer(value) if value
+            rescue ArgumentError, TypeError
+              log_warning("Invalid value for #{friendly_name} (#{value.inspect}). Ignoring this configuration.")
 
-          begin
-            Integer(value)
-          rescue ArgumentError, TypeError
-            log_warning("Invalid value for #{friendly_name} (#{value.inspect}). Ignoring this configuration.")
+              nil
+            end
 
-            nil
-          end
+          DetectedConfiguration.new(friendly_name: friendly_name, value: value)
         end
 
         def ssl?
-          !parsed_url.nil? && parsed_url.scheme == 'https'
+          transport_options.ssl ||
+            (!parsed_url.nil? && parsed_url.scheme == 'https')
         end
 
         def hostname
@@ -188,11 +203,15 @@ module Datadog
         # Defaults to +nil+, letting the adapter choose what default
         # works best in their case.
         def timeout_seconds
-          nil
+          transport_options.timeout_seconds
         end
 
+        # In transport_options, we try to invoke the transport_options proc and get its configuration. In case that
+        # doesn't work, we include the proc directly in the agent settings result.
         def deprecated_for_removal_transport_configuration_proc
-          settings.tracing.transport_options if settings.tracing.transport_options.is_a?(Proc)
+          if settings.tracing.transport_options.is_a?(Proc) && transport_options.adapter.nil?
+            settings.tracing.transport_options
+          end
         end
 
         # We only use the default unix socket if it is already present.
@@ -217,6 +236,8 @@ module Datadog
         def parsed_url
           return @parsed_url if defined?(@parsed_url)
 
+          unparsed_url_from_env = ENV[Datadog::Tracing::Configuration::Ext::Transport::ENV_DEFAULT_URL]
+
           @parsed_url =
             if unparsed_url_from_env
               parsed = URI.parse(unparsed_url_from_env)
@@ -237,12 +258,6 @@ module Datadog
             end
         end
 
-        # NOTE: This should only be used AFTER parsing, via `#parsed_url`. The only other use-case where this can be used
-        # directly without parsing, is when displaying in warning messages, to show users what it actually contains.
-        def unparsed_url_from_env
-          @unparsed_url_from_env ||= ENV[Datadog::Tracing::Configuration::Ext::Transport::ENV_DEFAULT_URL]
-        end
-
         def pick_from(*configurations_in_priority_order)
           detected_configurations_in_priority_order = configurations_in_priority_order.select(&:value?)
 
@@ -270,9 +285,44 @@ module Datadog
           logger.warn(message) if logger
         end
 
-        DetectedConfiguration = Struct.new(:friendly_name, :value) do
+        # The settings.tracing.transport_options allows users to have full control over the settings used to
+        # communicate with the agent. In the general case, we can't extract the configuration from this proc, but
+        # in the specific case of the http and unix socket adapters we can, and we use this method together with the
+        # `TransportOptionsResolver` to call the proc and extract its information.
+        def transport_options
+          return @transport_options if defined?(@transport_options)
+
+          transport_options_proc = settings.tracing.transport_options
+
+          @transport_options = TransportOptions.new
+
+          if transport_options_proc.is_a?(Proc)
+            begin
+              transport_options_proc.call(TransportOptionsResolver.new(@transport_options))
+            rescue NoMethodError => e
+              if logger
+                logger.debug do
+                  'Could not extract configuration from transport_options proc. ' \
+                  "Cause: #{e.class.name} #{e.message} Source: #{Array(e.backtrace).first}"
+                end
+              end
+
+              # Reset the object; we shouldn't return the same one we passed into the proc as it may have
+              # some partial configuration and we want all-or-nothing.
+              @transport_options = TransportOptions.new
+            end
+          end
+
+          @transport_options.freeze
+        end
+
+        # Represents a given configuration value and where we got it from
+        class DetectedConfiguration
+          attr_reader :friendly_name, :value
+
           def initialize(friendly_name:, value:)
-            super(friendly_name, value)
+            @friendly_name = friendly_name
+            @value = value
             freeze
           end
 
@@ -282,13 +332,32 @@ module Datadog
         end
         private_constant :DetectedConfiguration
 
-        # NOTE: Due to... legacy reasons... Some classes like having an `AgentSettings` instance to fall back to.
-        # Because we generate this instance with an empty instance of `Settings`, the resulting `AgentSettings` below
-        # represents only settings specified via environment variables + the usual defaults.
-        #
-        # YOU DO NOT WANT TO USE THE BELOW INSTANCE ON ANY NEWLY WRITTEN CODE, as it ignores any settings specified
-        # by users via `Datadog.configure`.
-        ENVIRONMENT_AGENT_SETTINGS = call(Settings.new, logger: nil)
+        # Used to contain information extracted from the transport_options proc (see #transport_options above)
+        TransportOptions = Struct.new(:adapter, :hostname, :port, :timeout_seconds, :ssl, :uds_path)
+        private_constant :TransportOptions
+
+        # Used to extract information from the transport_options proc (see #transport_options above)
+        class TransportOptionsResolver
+          def initialize(transport_options)
+            @transport_options = transport_options
+          end
+
+          def adapter(kind_or_custom_adapter, *args, **kwargs)
+            case kind_or_custom_adapter
+            when Datadog::Transport::Ext::HTTP::ADAPTER
+              @transport_options.adapter = Datadog::Transport::Ext::HTTP::ADAPTER
+              @transport_options.hostname = args[0] || kwargs[:hostname]
+              @transport_options.port = args[1] || kwargs[:port]
+              @transport_options.timeout_seconds = kwargs[:timeout]
+              @transport_options.ssl = kwargs[:ssl]
+            when Datadog::Transport::Ext::UnixSocket::ADAPTER
+              @transport_options.adapter = Datadog::Transport::Ext::UnixSocket::ADAPTER
+              @transport_options.uds_path = args[0] || kwargs[:uds_path]
+            end
+
+            nil
+          end
+        end
       end
       # rubocop:enable Metrics/ClassLength
     end

data/lib/datadog/core/configuration/base.rb

@@ -1,4 +1,5 @@
 # typed: false
+
 require 'datadog/core/environment/variable_helpers'
 require 'datadog/core/configuration/options'
 

data/lib/datadog/core/configuration/components.rb

@@ -1,4 +1,5 @@
 # typed: false
+
 require 'datadog/core/configuration/agent_settings_resolver'
 require 'datadog/core/diagnostics/environment_logger'
 require 'datadog/core/diagnostics/health'
@@ -10,8 +11,6 @@ require 'datadog/tracing/tracer'
 require 'datadog/tracing/flush'
 require 'datadog/tracing/sync_writer'
 
-require 'datadog/profiling'
-
 module Datadog
   module Core
     module Configuration
@@ -180,7 +179,27 @@ module Datadog
           end
 
           def build_profiler(settings, agent_settings, tracer)
-            return unless Profiling.supported? && settings.profiling.enabled
+            return unless settings.profiling.enabled
+
+            # Workaround for weird dependency direction: the Core::Configuration::Components class currently has a
+            # dependency on individual products, in this case the Profiler.
+            # (Note "currently": in the future we want to change this so core classes don't depend on specific products)
+            #
+            # If the current file included a `require 'datadog/profiler'` at its beginning, we would generate circular
+            # requires when used from profiling:
+            #
+            # datadog/profiling
+            #     └─requires─> datadog/core
+            #                      └─requires─> datadog/core/configuration/components
+            #                                       └─requires─> datadog/profiling       # Loop!
+            #
+            # ...thus in #1998 we removed such a require.
+            #
+            # On the other hand, if datadog/core is loaded by a different product and no general `require 'ddtrace'` is
+            # done, then profiling may not be loaded, and thus to avoid this issue we do a require here (which is a
+            # no-op if profiling is already loaded).
+            require 'datadog/profiling'
+            return unless Profiling.supported?
 
             unless defined?(Profiling::Tasks::Setup)
               # In #1545 a user reported a NameError due to this constant being uninitialized
@@ -277,7 +296,7 @@ module Datadog
 
           def build_profiler_collectors(settings, recorder, trace_identifiers_helper)
             [
-              Profiling::Collectors::Stack.new(
+              Profiling::Collectors::OldStack.new(
                 recorder,
                 trace_identifiers_helper: trace_identifiers_helper,
                 max_frames: settings.profiling.advanced.max_frames

data/lib/datadog/core/configuration/dependency_resolver.rb

@@ -1,4 +1,5 @@
 # typed: false
+
 require 'tsort'
 
 module Datadog

data/lib/datadog/core/configuration/option.rb

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

data/lib/datadog/core/configuration/option_definition.rb

@@ -1,4 +1,5 @@
 # typed: true
+
 require 'datadog/core/configuration/option'
 
 module Datadog

data/lib/datadog/core/configuration/option_definition_set.rb

@@ -1,4 +1,5 @@
 # typed: true
+
 require 'datadog/core/configuration/dependency_resolver'
 
 module Datadog

data/lib/datadog/core/configuration/option_set.rb

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

data/lib/datadog/core/configuration/options.rb

@@ -1,4 +1,5 @@
 # typed: false
+
 require 'datadog/core/configuration/option_set'
 require 'datadog/core/configuration/option_definition'
 require 'datadog/core/configuration/option_definition_set'

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

@@ -1,4 +1,5 @@
 # typed: false
+
 require 'logger'
 
 require 'datadog/core/configuration/base'
@@ -304,7 +305,7 @@ module Datadog
             tags = {}
 
             # Parse tags from environment
-            env_to_list(Core::Environment::Ext::ENV_TAGS).each do |tag|
+            env_to_list(Core::Environment::Ext::ENV_TAGS, comma_separated_only: false).each do |tag|
               pair = tag.split(':')
               tags[pair.first] = pair.last if pair.length == 2
             end
@@ -411,7 +412,7 @@ module Datadog
                     Tracing::Configuration::Ext::Distributed::PROPAGATION_STYLE_DATADOG,
                     Tracing::Configuration::Ext::Distributed::PROPAGATION_STYLE_B3,
                     Tracing::Configuration::Ext::Distributed::PROPAGATION_STYLE_B3_SINGLE_HEADER
-                  ]
+                  ], comma_separated_only: true
                 )
               end
 
@@ -429,7 +430,7 @@ module Datadog
               o.default do
                 env_to_list(
                   Tracing::Configuration::Ext::Distributed::ENV_PROPAGATION_STYLE_INJECT,
-                  [Tracing::Configuration::Ext::Distributed::PROPAGATION_STYLE_DATADOG] # Only inject Datadog headers by default
+                  [Tracing::Configuration::Ext::Distributed::PROPAGATION_STYLE_DATADOG], comma_separated_only: true # Only inject Datadog headers by default
                 )
               end
 
@@ -463,15 +464,6 @@ module Datadog
           # @return [Object,nil]
           option :instance
 
-          # DEV: Alias to Datadog::Tracing::Contrib::Extensions::Configuration::Settings#instrument.
-          # DEV: Should be removed when `c.tracing.instrument` namespacing is complete.
-          define_method(:instrument) do |integration_name, options = {}, &block|
-            Datadog.configuration.send(:instrument, integration_name, options, &block)
-          end
-
-          # TODO: Deprecate in the next major version, as `instrument` better describes this method's purpose
-          alias_method :use, :instrument
-
           # Automatic correlation between tracing and logging.
           # @see https://docs.datadoghq.com/tracing/setup_overview/setup/ruby/#trace-correlation
           # @return [Boolean]

data/lib/datadog/core/configuration.rb

@@ -1,5 +1,5 @@
 # typed: true
-require 'forwardable'
+
 require 'datadog/core/configuration/components'
 require 'datadog/core/configuration/settings'
 require 'datadog/core/logger'
@@ -10,7 +10,6 @@ module Datadog
     # Configuration provides a unique access point for configurations
     module Configuration # rubocop:disable Metrics/ModuleLength
       include Kernel # Ensure that kernel methods are always available (https://sorbet.org/docs/error-reference#7003)
-      extend Forwardable
 
       # Used to ensure that @components initialization/reconfiguration is performed one-at-a-time, by a single thread.
       #
@@ -153,9 +152,13 @@ module Datadog
         pin[option] if pin
       end
 
-      def_delegators \
-        :components,
-        :health_metrics
+      # Internal {Datadog::Statsd} metrics collection.
+      #
+      # The list of metrics collected can be found in {Datadog::Core::Diagnostics::Ext::Health::Metrics}.
+      # @public_api
+      def health_metrics
+        components.health_metrics
+      end
 
       def logger
         # avoid initializing components if they didn't already exist

data/lib/datadog/core/diagnostics/environment_logger.rb

@@ -1,4 +1,5 @@
 # typed: true
+
 require 'date'
 require 'json'
 require 'rbconfig'
@@ -256,7 +257,7 @@ module Datadog
         private
 
         def instrumented_integrations
-          Datadog.configuration.instrumented_integrations
+          Datadog.configuration.tracing.instrumented_integrations
         end
 
         # Capture all active integration settings into "integrationName_settingName: value" entries.

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

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

data/lib/datadog/core/diagnostics/health.rb

@@ -1,4 +1,5 @@
-# typed: false
+# typed: strict
+
 require 'datadog/core/diagnostics/ext'
 require 'datadog/core/metrics/client'
 

data/lib/datadog/core/encoding.rb

@@ -1,4 +1,5 @@
 # typed: true
+
 require 'json'
 require 'msgpack'
 

data/lib/datadog/core/environment/cgroup.rb

@@ -1,4 +1,5 @@
 # typed: true
+
 require 'datadog/core/environment/ext'
 
 module Datadog
@@ -34,7 +35,9 @@ module Datadog
                 end
               end
             rescue StandardError => e
-              Datadog.logger.error("Error while parsing cgroup. Cause: #{e.message} Location: #{Array(e.backtrace).first}")
+              Datadog.logger.error(
+                "Error while parsing cgroup. Cause: #{e.class.name} #{e.message} Location: #{Array(e.backtrace).first}"
+              )
             end
           end
         end

data/lib/datadog/core/environment/class_count.rb

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

data/lib/datadog/core/environment/container.rb

@@ -1,4 +1,5 @@
 # typed: true
+
 require 'datadog/core/environment/cgroup'
 
 module Datadog
@@ -80,7 +81,8 @@ module Datadog
               end
             rescue StandardError => e
               Datadog.logger.error(
-                "Error while parsing container info. Cause: #{e.message} Location: #{Array(e.backtrace).first}"
+                "Error while parsing container info. Cause: #{e.class.name} #{e.message} " \
+                "Location: #{Array(e.backtrace).first}"
               )
             end
           end

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

@@ -1,4 +1,5 @@
 # typed: true
+
 require 'ddtrace/version'
 
 module Datadog

data/lib/datadog/core/environment/gc.rb

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

data/lib/datadog/core/environment/identity.rb

@@ -1,4 +1,5 @@
 # typed: false
+
 require 'securerandom'
 
 require 'datadog/core/environment/ext'

data/lib/datadog/core/environment/socket.rb

@@ -1,4 +1,5 @@
 # typed: false
+
 require 'socket'
 require 'datadog/core/utils/forking'
 

data/lib/datadog/core/environment/thread_count.rb

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

data/lib/datadog/core/environment/variable_helpers.rb

@@ -1,4 +1,5 @@
 # typed: false
+
 module Datadog
   module Core
     # Namespace for handling application environment
@@ -23,10 +24,34 @@ module Datadog
           var && ENV.key?(var) ? ENV[var].to_f : default
         end
 
-        def env_to_list(var, default = [])
+        # Parses comma- or space-separated lists.
+        #
+        # If a comma is present, then the list is considered comma-separated.
+        # Otherwise, it is considered space-separated.
+        #
+        # After the entries are separated, commas and whitespaces that are
+        # either trailing or leading are trimmed.
+        #
+        # Empty entries, after trimmed, are also removed from the result.
+        def env_to_list(var, default = [], comma_separated_only:)
           var = decode_array(var)
           if var && ENV.key?(var)
-            ENV[var].split(',').map(&:strip)
+            value = ENV[var]
+
+            values = if value.include?(',') || comma_separated_only
+                       value.split(',')
+                     else
+                       value.split(' ') # rubocop:disable Style/RedundantArgument
+                     end
+
+            values.map! do |v|
+              v.gsub!(/\A[\s,]*|[\s,]*\Z/, '')
+
+              v.empty? ? nil : v
+            end
+
+            values.compact!
+            values
           else
             default
           end

data/lib/datadog/core/environment/vm_cache.rb

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

data/lib/datadog/core/error.rb

@@ -1,6 +1,7 @@
-# typed: false
 # frozen_string_literal: true
 
+# typed: false
+
 require 'datadog/core/utils'
 
 module Datadog

data/lib/datadog/core/extensions.rb

@@ -1,4 +1,5 @@
-# typed: strict
+# typed: true
+
 require 'datadog/core/configuration'
 
 # Global namespace that includes all Datadog functionality.

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

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

data/lib/datadog/core/logger.rb

@@ -1,4 +1,5 @@
 # typed: true
+
 require 'logger'
 
 module Datadog

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

@@ -0,0 +1,11 @@
+module Datadog
+  module Core
+    module Logging
+      module Ext
+        # The technology from which the log originated.
+        # @see https://docs.datadoghq.com/api/latest/logs/#send-logs
+        DD_SOURCE = 'ruby'.freeze
+      end
+    end
+  end
+end