ddtrace 1.0.0.beta1 → 1.0.0.beta2

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.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'

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'
@@ -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,4 +1,5 @@
 # typed: true
+
 require 'forwardable'
 require 'datadog/core/configuration/components'
 require 'datadog/core/configuration/settings'

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

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

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

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/metrics/client.rb

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

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

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

data/lib/datadog/core/metrics/helpers.rb

@@ -1,3 +1,5 @@
+# typed: false
+
 module Datadog
   module Core
     module Metrics

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

@@ -1,3 +1,5 @@
+# typed: true
+
 require 'logger'
 require 'json'
 

data/lib/datadog/core/metrics/metric.rb

@@ -1,3 +1,5 @@
+# typed: false
+
 module Datadog
   module Core
     module Metrics

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

@@ -1,3 +1,5 @@
+# typed: true
+
 require 'datadog/core/metrics/ext'
 require 'datadog/core/environment/ext'
 require 'datadog/core/environment/identity'

data/lib/datadog/core/pin.rb

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

data/lib/datadog/core/runtime/metrics.rb

@@ -1,4 +1,5 @@
 # typed: true
+
 require 'datadog/core/runtime/ext'
 
 require 'datadog/core/metrics/client'

data/lib/datadog/core/utils/compression.rb

@@ -1,4 +1,5 @@
 # typed: true
+
 require 'stringio'
 require 'zlib'
 

data/lib/datadog/core/utils/forking.rb

@@ -1,4 +1,5 @@
 # typed: false
+
 module Datadog
   module Core
     module Utils

data/lib/datadog/core/utils/object_set.rb

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

data/lib/datadog/core/utils/only_once.rb

@@ -1,6 +1,7 @@
-# typed: true
 # frozen_string_literal: true
 
+# typed: true
+
 module Datadog
   module Core
     module Utils

data/lib/datadog/core/utils/safe_dup.rb

@@ -0,0 +1,27 @@
+# typed: false
+
+module Datadog
+  module Core
+    module Utils
+      # Helper methods for safer dup
+      module SafeDup
+        if RUBY_VERSION < '2.2' # nil.dup only fails in Ruby 2.1
+          # Ensures #initialize can call nil.dup safely
+          module RefineNil
+            refine NilClass do
+              def dup
+                self
+              end
+            end
+          end
+
+          using RefineNil
+        end
+
+        def self.frozen_or_dup(v)
+          v.frozen? ? v : v.dup
+        end
+      end
+    end
+  end
+end

data/lib/datadog/core/utils/sequence.rb

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

data/lib/datadog/core/utils/string_table.rb

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

data/lib/datadog/core/utils/time.rb

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

data/lib/datadog/core/utils.rb

@@ -1,4 +1,5 @@
 # typed: true
+
 require 'datadog/core/utils/forking'
 require 'datadog/tracing/span'
 

data/lib/datadog/core/vendor/multipart-post/multipart/post/composite_read_io.rb

@@ -1,4 +1,5 @@
 # typed: false
+
 #--
 # Copyright (c) 2007-2012 Nick Sieger.
 # See the file README.txt included with the distribution for

data/lib/datadog/core/vendor/multipart-post/multipart/post/multipartable.rb

@@ -1,4 +1,5 @@
 # typed: false
+
 #--
 # Copyright (c) 2007-2013 Nick Sieger.
 # See the file README.txt included with the distribution for

data/lib/datadog/core/vendor/multipart-post/multipart/post/parts.rb

@@ -1,4 +1,5 @@
 # typed: true
+
 #--
 # Copyright (c) 2007-2013 Nick Sieger.
 # See the file README.txt included with the distribution for

data/lib/datadog/core/vendor/multipart-post/multipart/post/version.rb

@@ -1,4 +1,5 @@
 # typed: strict
+
 module Datadog
   module Core
     module Vendor

data/lib/datadog/core/vendor/multipart-post/multipart/post.rb

@@ -1,4 +1,5 @@
 # typed: strict
+
 module Datadog
   module Core
     module Vendor

data/lib/datadog/core/vendor/multipart-post/multipart.rb

@@ -1,4 +1,5 @@
 # typed: strict
+
 #--
 # Copyright (c) 2007-2013 Nick Sieger.
 # See the file README.txt included with the distribution for