ddtrace 1.4.2 → 1.19.0

data/lib/datadog/core/configuration.rb

@@ -1,5 +1,3 @@
-# typed: true
-
 require_relative 'configuration/components'
 require_relative 'configuration/settings'
 require_relative 'telemetry/emitter'
@@ -9,9 +7,7 @@ require_relative 'pin'
 module Datadog
   module Core
     # 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)
-
+    module Configuration
       # Used to ensure that @components initialization/reconfiguration is performed one-at-a-time, by a single thread.
       #
       # This is important because components can end up being accessed from multiple application threads (for instance on
@@ -212,7 +208,11 @@ module Datadog
       # Used internally to ensure a clean environment between test runs.
       def reset!
         safely_synchronize do |write_components|
-          @components.shutdown! if components?
+          if components?
+            @components.shutdown!
+            @temp_logger = nil # Reset to ensure instance and log level are reset for next run
+          end
+
           write_components.call(nil)
           configuration.reset!
         end
@@ -273,6 +273,10 @@ module Datadog
       def handle_interrupt_shutdown!
         logger = Datadog.logger
         shutdown_thread = Thread.new { shutdown! }
+        unless Gem::Version.new(RUBY_VERSION) < Gem::Version.new('2.3')
+          shutdown_thread.name = Datadog::Core::Configuration.name
+        end
+
         print_message_treshold_seconds = 0.2
 
         slow_shutdown = shutdown_thread.join(print_message_treshold_seconds).nil?

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

@@ -1,4 +1,4 @@
-# typed: true
+# frozen_string_literal: true
 
 require 'date'
 require 'json'
@@ -7,275 +7,174 @@ require 'rbconfig'
 module Datadog
   module Core
     module Diagnostics
-      # A holistic collection of the environment in which ddtrace is running.
-      # This logger should allow for easy reporting by users to Datadog support.
-      #
-      module EnvironmentLogger
-        class << self
-          # Outputs environment information to {Datadog.logger}.
-          # Executes only once for the lifetime of the program.
-          def log!(transport_responses)
-            return if (defined?(@executed) && @executed) || !log?
-
-            @executed = true
-
-            data = EnvironmentCollector.new.collect!(transport_responses)
-            data.reject! { |_, v| v.nil? } # Remove empty values from hash output
-
-            log_environment!(data.to_json)
-            log_error!('Agent Error'.freeze, data[:agent_error]) if data[:agent_error]
-          rescue => e
-            Datadog.logger.warn("Failed to collect environment information: #{e} Location: #{Array(e.backtrace).first}")
-          end
-
-          private
-
-          def log_environment!(line)
-            Datadog.logger.info("DATADOG CONFIGURATION - #{line}")
-          end
-
-          def log_error!(type, error)
-            Datadog.logger.warn("DATADOG DIAGNOSTIC - #{type}: #{error}")
-          end
-
-          # Are we logging the environment data?
-          def log?
-            startup_logs_enabled = Datadog.configuration.diagnostics.startup_logs.enabled
-            if startup_logs_enabled.nil?
-              !repl? # Suppress logs if we running in a REPL
-            else
-              startup_logs_enabled
-            end
-          end
-
-          REPL_PROGRAM_NAMES = %w[irb pry].freeze
-
-          def repl?
-            REPL_PROGRAM_NAMES.include?($PROGRAM_NAME)
-          end
+      # Base class for EnvironmentLoggers - should allow for easy reporting by users to Datadog support.
+      module EnvironmentLogging
+        def log_configuration!(prefix, data)
+          logger.info("DATADOG CONFIGURATION - #{prefix} - #{data}")
         end
-      end
 
-      # Collects environment information for diagnostic logging
-      class EnvironmentCollector
-        # @return [String] current time in ISO8601 format
-        def date
-          DateTime.now.iso8601
+        def log_error!(prefix, type, error)
+          logger.warn("DATADOG ERROR - #{prefix} - #{type}: #{error}")
         end
 
-        # Best portable guess of OS information.
-        # @return [String] platform string
-        def os_name
-          RbConfig::CONFIG['host'.freeze]
-        end
-
-        # @return [String] ddtrace version
-        def version
-          DDTrace::VERSION::STRING
-        end
-
-        # @return [String] "ruby"
-        def lang
-          Core::Environment::Ext::LANG
-        end
-
-        # Supported Ruby language version.
-        # Will be distinct from VM version for non-MRI environments.
-        # @return [String]
-        def lang_version
-          Core::Environment::Ext::LANG_VERSION
-        end
+        protected
 
-        # @return [String] configured application environment
-        def env
-          Datadog.configuration.env
+        def logger
+          Datadog.logger
         end
 
-        # @return [Boolean, nil]
-        def enabled
-          Datadog.configuration.tracing.enabled
-        end
+        # If logger should log and hasn't logged already, then output environment configuration and possible errors.
+        def log_once!
+          # Check if already been executed
+          return false if (defined?(@executed) && @executed) || !log?
 
-        # @return [String] configured application service name
-        def service
-          Datadog.configuration.service
-        end
+          yield if block_given?
 
-        # @return [String] configured application version
-        def dd_version
-          Datadog.configuration.version
+          @executed = true
         end
 
-        # @return [String] target agent URL for trace flushing
-        def agent_url
-          # Retrieve the effect agent URL, regardless of how it was configured
-          transport = Tracing.send(:tracer).writer.transport
-          adapter = transport.client.api.adapter
-          adapter.url
+        # Are we logging the environment data?
+        def log?
+          startup_logs_enabled = Datadog.configuration.diagnostics.startup_logs.enabled
+          if startup_logs_enabled.nil?
+            !repl? && !rspec? # Suppress logs if we are running in a REPL or rspec
+          else
+            startup_logs_enabled
+          end
         end
 
-        # Error returned by Datadog agent during a tracer flush attempt
-        # @return [String] concatenated list of transport errors
-        def agent_error(transport_responses)
-          error_responses = transport_responses.reject(&:ok?)
-
-          return nil if error_responses.empty?
+        REPL_PROGRAM_NAMES = %w[irb pry].freeze
 
-          error_responses.map(&:inspect).join(','.freeze)
+        def repl?
+          REPL_PROGRAM_NAMES.include?($PROGRAM_NAME)
         end
 
-        # @return [Boolean, nil] debug mode enabled in configuration
-        def debug
-          !!Datadog.configuration.diagnostics.debug
-        end
-
-        # @return [Boolean, nil] analytics enabled in configuration
-        def analytics_enabled
-          !!Datadog.configuration.tracing.analytics.enabled
+        def rspec?
+          $PROGRAM_NAME.end_with?('rspec')
         end
+      end
 
-        # @return [Numeric, nil] tracer sample rate configured
-        def sample_rate
-          sampler = Datadog.configuration.tracing.sampler
-          return nil unless sampler
+      # Collects and logs Core diagnostic information
+      module EnvironmentLogger
+        extend EnvironmentLogging
 
-          sampler.sample_rate(nil) rescue nil
+        def self.collect_and_log!
+          log_once! do
+            data = EnvironmentCollector.collect_config!
+            log_configuration!('CORE', data.to_json)
+          end
+        rescue => e
+          logger.warn("Failed to collect core environment information: #{e} Location: #{Array(e.backtrace).first}")
         end
+      end
 
-        # DEV: We currently only support SimpleRule instances.
-        # DEV: These are the most commonly used rules.
-        # DEV: We should expand support for other rules in the future,
-        # DEV: although it is tricky to serialize arbitrary rules.
-        #
-        # @return [Hash, nil] sample rules configured
-        def sampling_rules
-          sampler = Datadog.configuration.tracing.sampler
-          return nil unless sampler.is_a?(Tracing::Sampling::PrioritySampler) &&
-            sampler.priority_sampler.is_a?(Tracing::Sampling::RuleSampler)
-
-          sampler.priority_sampler.rules.map do |rule|
-            next unless rule.is_a?(Tracing::Sampling::SimpleRule)
-
+      # Collects environment information for Core diagnostic logging
+      module EnvironmentCollector
+        class << self
+          def collect_config!
             {
-              name: rule.matcher.name,
-              service: rule.matcher.service,
-              sample_rate: rule.sampler.sample_rate(nil)
+              date: date,
+              os_name: os_name,
+              version: version,
+              lang: lang,
+              lang_version: lang_version,
+              env: env,
+              service: service,
+              dd_version: dd_version,
+              debug: debug,
+              tags: tags,
+              runtime_metrics_enabled: runtime_metrics_enabled,
+              vm: vm,
+              health_metrics_enabled: health_metrics_enabled
             }
-          end.compact
-        end
-
-        # @return [Hash, nil] concatenated list of global tracer tags configured
-        def tags
-          tags = Datadog.configuration.tags
-          return nil if tags.empty?
+          end
 
-          hash_serializer(tags)
-        end
+          # @return [String] current time in ISO8601 format
+          def date
+            DateTime.now.iso8601
+          end
 
-        # @return [Boolean, nil] runtime metrics enabled in configuration
-        def runtime_metrics_enabled
-          Datadog.configuration.runtime_metrics.enabled
-        end
+          # Best portable guess of OS information.
+          # @return [String] platform string
+          def os_name
+            RbConfig::CONFIG['host']
+          end
 
-        # Concatenated list of integrations activated, with their gem version.
-        # Example: "rails@6.0.3,rack@2.2.3"
-        #
-        # @return [String, nil]
-        def integrations_loaded
-          integrations = instrumented_integrations
-          return if integrations.empty?
+          # @return [String] ddtrace version
+          def version
+            DDTrace::VERSION::STRING
+          end
 
-          integrations.map { |name, integration| "#{name}@#{integration.class.version}" }.join(','.freeze)
-        end
+          # @return [String] "ruby"
+          def lang
+            Core::Environment::Ext::LANG
+          end
 
-        # Ruby VM name and version.
-        # Examples: "ruby-2.7.1", "jruby-9.2.11.1", "truffleruby-20.1.0"
-        # @return [String, nil]
-        def vm
-          # RUBY_ENGINE_VERSION returns the VM version, which
-          # will differ from RUBY_VERSION for non-mri VMs.
-          if defined?(RUBY_ENGINE_VERSION)
-            "#{RUBY_ENGINE}-#{RUBY_ENGINE_VERSION}"
-          else
-            # Ruby < 2.3 doesn't support RUBY_ENGINE_VERSION
-            "#{RUBY_ENGINE}-#{RUBY_VERSION}"
+          # Supported Ruby language version.
+          # Will be distinct from VM version for non-MRI environments.
+          # @return [String]
+          def lang_version
+            Core::Environment::Ext::LANG_VERSION
           end
-        end
 
-        # @return [Boolean, nil] partial flushing enabled in configuration
-        def partial_flushing_enabled
-          !!Datadog.configuration.tracing.partial_flush.enabled
-        end
+          # @return [String] configured application environment
+          def env
+            Datadog.configuration.env
+          end
 
-        # @return [Boolean, nil] priority sampling enabled in configuration
-        def priority_sampling_enabled
-          !!Datadog.configuration.tracing.priority_sampling
-        end
+          # @return [String] configured application service name
+          def service
+            Datadog.configuration.service
+          end
 
-        # @return [Boolean, nil] health metrics enabled in configuration
-        def health_metrics_enabled
-          !!Datadog.configuration.diagnostics.health_metrics.enabled
-        end
+          # @return [String] configured application version
+          def dd_version
+            Datadog.configuration.version
+          end
 
-        # TODO: Populate when profiling is implemented
-        # def profiling_enabled
-        # end
+          # @return [Boolean, nil] debug mode enabled in configuration
+          def debug
+            !!Datadog.configuration.diagnostics.debug
+          end
 
-        # TODO: Populate when automatic log correlation is implemented
-        # def logs_correlation_enabled
-        # end
+          # @return [Hash, nil] concatenated list of global tracer tags configured
+          def tags
+            tags = Datadog.configuration.tags
+            return nil if tags.empty?
 
-        # @return [Hash] environment information available at call time
-        def collect!(transport_responses)
-          {
-            date: date,
-            os_name: os_name,
-            version: version,
-            lang: lang,
-            lang_version: lang_version,
-            env: env,
-            enabled: enabled,
-            service: service,
-            dd_version: dd_version,
-            agent_url: agent_url,
-            agent_error: agent_error(transport_responses),
-            debug: debug,
-            analytics_enabled: analytics_enabled,
-            sample_rate: sample_rate,
-            sampling_rules: sampling_rules,
-            tags: tags,
-            runtime_metrics_enabled: runtime_metrics_enabled,
-            integrations_loaded: integrations_loaded,
-            vm: vm,
-            partial_flushing_enabled: partial_flushing_enabled,
-            priority_sampling_enabled: priority_sampling_enabled,
-            health_metrics_enabled: health_metrics_enabled,
-            **instrumented_integrations_settings
-          }
-        end
+            hash_serializer(tags)
+          end
 
-        private
+          # @return [Boolean, nil] runtime metrics enabled in configuration
+          def runtime_metrics_enabled
+            Datadog.configuration.runtime_metrics.enabled
+          end
 
-        def instrumented_integrations
-          Datadog.configuration.tracing.instrumented_integrations
-        end
+          # Ruby VM name and version.
+          # Examples: "ruby-2.7.1", "jruby-9.2.11.1", "truffleruby-20.1.0"
+          # @return [String, nil]
+          def vm
+            # RUBY_ENGINE_VERSION returns the VM version, which
+            # will differ from RUBY_VERSION for non-mri VMs.
+            if defined?(RUBY_ENGINE_VERSION)
+              "#{RUBY_ENGINE}-#{RUBY_ENGINE_VERSION}"
+            else
+              # Ruby < 2.3 doesn't support RUBY_ENGINE_VERSION
+              "#{RUBY_ENGINE}-#{RUBY_VERSION}"
+            end
+          end
 
-        # Capture all active integration settings into "integrationName_settingName: value" entries.
-        def instrumented_integrations_settings
-          instrumented_integrations.flat_map do |name, integration|
-            integration.configuration.to_h.flat_map do |setting, value|
-              next [] if setting == :tracer # Skip internal Ruby objects
+          # @return [Boolean, nil] health metrics enabled in configuration
+          def health_metrics_enabled
+            !!Datadog.configuration.diagnostics.health_metrics.enabled
+          end
 
-              # Convert value to a string to avoid custom #to_json
-              # handlers possibly causing errors.
-              [[:"integration_#{name}_#{setting}", value.to_s]]
-            end
-          end.to_h
-        end
+          private
 
-        # Outputs "k1:v1,k2:v2,..."
-        def hash_serializer(h)
-          h.map { |k, v| "#{k}:#{v}" }.join(','.freeze)
+          # Outputs "k1:v1,k2:v2,..."
+          def hash_serializer(h)
+            h.map { |k, v| "#{k}:#{v}" }.join(',')
+          end
         end
       end
     end

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

@@ -1,7 +1,7 @@
-# typed: strict
+# frozen_string_literal: true
 
-require_relative 'ext'
 require_relative '../metrics/client'
+require_relative '../../tracing/diagnostics/health'
 
 module Datadog
   module Core
@@ -10,26 +10,8 @@ module Datadog
       module Health
         # Health metrics for diagnostics
         class Metrics < Core::Metrics::Client
-          count :api_errors, Ext::Health::Metrics::METRIC_API_ERRORS
-          count :api_requests, Ext::Health::Metrics::METRIC_API_REQUESTS
-          count :api_responses, Ext::Health::Metrics::METRIC_API_RESPONSES
-          count :error_context_overflow, Ext::Health::Metrics::METRIC_ERROR_CONTEXT_OVERFLOW
-          count :error_instrumentation_patch, Ext::Health::Metrics::METRIC_ERROR_INSTRUMENTATION_PATCH
-          count :error_span_finish, Ext::Health::Metrics::METRIC_ERROR_SPAN_FINISH
-          count :error_unfinished_spans, Ext::Health::Metrics::METRIC_ERROR_UNFINISHED_SPANS
-          count :instrumentation_patched, Ext::Health::Metrics::METRIC_INSTRUMENTATION_PATCHED
-          count :queue_accepted, Ext::Health::Metrics::METRIC_QUEUE_ACCEPTED
-          count :queue_accepted_lengths, Ext::Health::Metrics::METRIC_QUEUE_ACCEPTED_LENGTHS
-          count :queue_dropped, Ext::Health::Metrics::METRIC_QUEUE_DROPPED
-          count :traces_filtered, Ext::Health::Metrics::METRIC_TRACES_FILTERED
-          count :transport_trace_too_large, Ext::Health::Metrics::METRIC_TRANSPORT_TRACE_TOO_LARGE
-          count :transport_chunked, Ext::Health::Metrics::METRIC_TRANSPORT_CHUNKED
-          count :writer_cpu_time, Ext::Health::Metrics::METRIC_WRITER_CPU_TIME
-
-          gauge :queue_length, Ext::Health::Metrics::METRIC_QUEUE_LENGTH
-          gauge :queue_max_length, Ext::Health::Metrics::METRIC_QUEUE_MAX_LENGTH
-          gauge :queue_spans, Ext::Health::Metrics::METRIC_QUEUE_SPANS
-          gauge :sampling_service_cache_length, Ext::Health::Metrics::METRIC_SAMPLING_SERVICE_CACHE_LENGTH
+          # TODO: Don't reference this. Have tracing add its metrics behavior.
+          extend Tracing::Diagnostics::Health::Metrics
         end
       end
     end

data/lib/datadog/core/encoding.rb

@@ -1,5 +1,3 @@
-# typed: true
-
 require 'json'
 require 'msgpack'
 
@@ -10,8 +8,6 @@ module Datadog
       # Encoder interface that provides the logic to encode traces and service
       # @abstract
       module Encoder
-        include Kernel # Ensure that kernel methods are always available (https://sorbet.org/docs/error-reference#7003)
-
         def content_type
           raise NotImplementedError
         end

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

@@ -1,5 +1,3 @@
-# typed: true
-
 require_relative 'ext'
 
 module Datadog
@@ -10,8 +8,6 @@ module Datadog
       # about the current Linux container identity.
       # @see https://man7.org/linux/man-pages/man7/cgroups.7.html
       module Cgroup
-        include Kernel # Ensure that kernel methods are always available (https://sorbet.org/docs/error-reference#7003)
-
         LINE_REGEX = /^(\d+):([^:]*):(.+)$/.freeze
 
         Descriptor = Struct.new(

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

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

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

@@ -1,5 +1,3 @@
-# typed: true
-
 require_relative 'cgroup'
 
 module Datadog
@@ -7,8 +5,6 @@ module Datadog
     module Environment
       # For container environments
       module Container
-        include Kernel # Ensure that kernel methods are always available (https://sorbet.org/docs/error-reference#7003)
-
         UUID_PATTERN = '[0-9a-f]{8}[-_]?[0-9a-f]{4}[-_]?[0-9a-f]{4}[-_]?[0-9a-f]{4}[-_]?[0-9a-f]{12}'.freeze
         CONTAINER_PATTERN = '[0-9a-f]{64}'.freeze
 

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

@@ -0,0 +1,103 @@
+# frozen_string_literal: true
+
+require 'set'
+
+module Datadog
+  module Core
+    module Environment
+      # Provides information about the execution environment on the current process.
+      module Execution
+        class << self
+          # Is this process running in a development environment?
+          # This can be used to make decisions about when to enable
+          # background systems like worker threads or telemetry.
+          def development?
+            !!(webmock_enabled? || repl? || test? || rails_development?)
+          end
+
+          # WebMock stores the reference to `Net::HTTP` with constant `OriginalNetHTTP`, and when WebMock enables,
+          # the adapter swaps `Net::HTTP` reference to its mock object, @webMockNetHTTP.
+          #
+          # Hence, we can detect by
+          #   1. Checking if `Net::HTTP` is referring to mock object
+          #   => ::Net::HTTP.equal?(::WebMock::HttpLibAdapters::NetHttpAdapter.instance_variable_get(:@webMockNetHTTP))
+          #
+          #   2. Checking if `Net::HTTP` is referring to the original one
+          #   => ::Net::HTTP.equal?(::WebMock::HttpLibAdapters::NetHttpAdapter::OriginalNetHTTP)
+          def webmock_enabled?
+            defined?(::WebMock::HttpLibAdapters::NetHttpAdapter) &&
+              defined?(::Net::HTTP) &&
+              ::Net::HTTP.equal?(::WebMock::HttpLibAdapters::NetHttpAdapter.instance_variable_get(:@webMockNetHTTP))
+          end
+
+          private
+
+          # Is this process running a test?
+          def test?
+            rspec? || minitest? || cucumber?
+          end
+
+          # Is this process running inside on a Read–eval–print loop?
+          # DEV: REPLs always set the program name to the exact REPL name.
+          def repl?
+            REPL_PROGRAM_NAMES.include?($PROGRAM_NAME)
+          end
+
+          REPL_PROGRAM_NAMES = %w[irb pry].freeze
+          private_constant :REPL_PROGRAM_NAMES
+
+          # RSpec always runs using the `rspec` file https://github.com/rspec/rspec-core/blob/main/exe/rspec
+          def rspec?
+            $PROGRAM_NAME.end_with?(RSPEC_PROGRAM_NAME)
+          end
+
+          RSPEC_PROGRAM_NAME = '/rspec'
+          private_constant :RSPEC_PROGRAM_NAME
+
+          # Check if Minitest is present and installed to run.
+          def minitest?
+            # Minitest >= 5
+            (defined?(::Minitest) &&
+              ::Minitest.class_variable_defined?(:@@installed_at_exit) &&
+              ::Minitest.class_variable_get(:@@installed_at_exit)) ||
+              # Minitest < 5
+              (defined?(::Minitest::Unit) &&
+                ::Minitest::Unit.class_variable_defined?(:@@installed_at_exit) &&
+                ::Minitest::Unit.class_variable_get(:@@installed_at_exit))
+          end
+
+          # Check if we are running from `bin/cucumber` or `cucumber/rake/task`.
+          def cucumber?
+            defined?(::Cucumber::Cli)
+          end
+
+          # If this is a Rails application, use different heuristics to detect
+          # whether this is a development environment or not.
+          def rails_development?
+            # A Rails Spring Ruby process is a bit peculiar: the process is agnostic
+            # whether the application is running as a console or server.
+            # Luckily, the Spring gem *must not* be installed in a production environment so
+            # detecting its presence is enough to deduct if this is a development environment.
+            #
+            # @see https://github.com/rails/spring/blob/48b299348ace2188444489a0c216a6f3e9687281/README.md?plain=1#L204-L207
+            defined?(::Spring) || rails_env_development?
+          end
+
+          RAILS_ENV_DEVELOPMENT = Set['development', 'test'].freeze
+          private_constant :RAILS_ENV_DEVELOPMENT
+
+          # By default, every Rails application has three environments: `development`, `test`, and `production`.
+          # This has been the case since Rails 3.0.0:
+          # https://github.com/rails/rails/blob/3e48484ff16ea07ffe5db232bf43c14992e273c1/railties/doc/guides/getting_started_with_rails/getting_started_with_rails.txt#L144
+          #
+          # Instead of checking for "not production", we instead check for "development" and "test" because
+          # it's common to have a custom "staging" environment, and such environment normally want to run as close
+          # to production as possible.
+          def rails_env_development?
+            defined?(::Rails.env) && RAILS_ENV_DEVELOPMENT.include?(::Rails.env)
+          end
+        end
+      end
+    end
+  end
+end