ddtrace 1.12.1 → 1.14.0

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'date'
 require 'json'
 require 'rbconfig'
@@ -5,280 +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
-        end
-      end
-
-      # Collects environment information for diagnostic logging
-      class EnvironmentCollector
-        # @return [String] current time in ISO8601 format
-        def date
-          DateTime.now.iso8601
-        end
-
-        # Best portable guess of OS information.
-        # @return [String] platform string
-        def os_name
-          RbConfig::CONFIG['host'.freeze]
+      # 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
 
-        # @return [String] ddtrace version
-        def version
-          DDTrace::VERSION::STRING
+        def log_error!(prefix, type, error)
+          logger.warn("DATADOG ERROR - #{prefix} - #{type}: #{error}")
         end
 
-        # @return [String] "ruby"
-        def lang
-          Core::Environment::Ext::LANG
-        end
+        protected
 
-        # Supported Ruby language version.
-        # Will be distinct from VM version for non-MRI environments.
-        # @return [String]
-        def lang_version
-          Core::Environment::Ext::LANG_VERSION
+        def logger
+          Datadog.logger
         end
 
-        # @return [String] configured application environment
-        def env
-          Datadog.configuration.env
-        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 [Boolean, nil]
-        def enabled
-          Datadog.configuration.tracing.enabled
-        end
+          yield if block_given?
 
-        # @return [String] configured application service name
-        def service
-          Datadog.configuration.service
+          @executed = true
         end
 
-        # @return [String] configured application version
-        def dd_version
-          Datadog.configuration.version
-        end
-
-        # @return [String, nil] 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
-
-          # return `nil` with IO transport
-          return unless transport.respond_to?(:client)
-
-          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?)
+        REPL_PROGRAM_NAMES = %w[irb pry].freeze
 
-          return nil if error_responses.empty?
-
-          error_responses.map(&:inspect).join(','.freeze)
-        end
-
-        # @return [Boolean, nil] debug mode enabled in configuration
-        def debug
-          !!Datadog.configuration.diagnostics.debug
+        def repl?
+          REPL_PROGRAM_NAMES.include?($PROGRAM_NAME)
         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
 
-        def profiling_enabled
-          !!Datadog.configuration.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,
-            profiling_enabled: profiling_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/environment/execution.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+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?
+            !!(repl? || test? || rails_development?)
+          end
+
+          private
+
+          # Is this process running a test?
+          def test?
+            rspec? || minitest?
+          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
+
+          # 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
+          def rails_development?
+            defined?(::Spring)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative '../../../ddtrace/version'
 
 module Datadog
@@ -13,12 +15,12 @@ module Datadog
                            RUBY_VERSION
                          end
 
-        ENV_API_KEY = 'DD_API_KEY'.freeze
-        ENV_ENVIRONMENT = 'DD_ENV'.freeze
-        ENV_SERVICE = 'DD_SERVICE'.freeze
-        ENV_SITE = 'DD_SITE'.freeze
-        ENV_TAGS = 'DD_TAGS'.freeze
-        ENV_VERSION = 'DD_VERSION'.freeze
+        ENV_API_KEY = 'DD_API_KEY'
+        ENV_ENVIRONMENT = 'DD_ENV'
+        ENV_SERVICE = 'DD_SERVICE'
+        ENV_SITE = 'DD_SITE'
+        ENV_TAGS = 'DD_TAGS'
+        ENV_VERSION = 'DD_VERSION'
         FALLBACK_SERVICE_NAME =
           begin
             File.basename($PROGRAM_NAME, '.*')
@@ -26,15 +28,15 @@ module Datadog
             'ruby'
           end.freeze
 
-        LANG = 'ruby'.freeze
+        LANG = 'ruby'
         LANG_ENGINE = RUBY_ENGINE
-        LANG_INTERPRETER = "#{RUBY_ENGINE}-#{RUBY_PLATFORM}".freeze
+        LANG_INTERPRETER = "#{RUBY_ENGINE}-#{RUBY_PLATFORM}"
         LANG_PLATFORM = RUBY_PLATFORM
         LANG_VERSION = RUBY_VERSION
         RUBY_ENGINE = ::RUBY_ENGINE # e.g. 'ruby', 'jruby', 'truffleruby'
-        TAG_ENV = 'env'.freeze
-        TAG_SERVICE = 'service'.freeze
-        TAG_VERSION = 'version'.freeze
+        TAG_ENV = 'env'
+        TAG_SERVICE = 'service'
+        TAG_VERSION = 'version'
 
         # TODO: Migrate to Datadog::Tracing
         TRACER_VERSION = DDTrace::VERSION::STRING

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

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module Datadog
+  module Core
+    module Environment
+      # Reports YJIT primitive runtime statistics.
+      module YJIT
+        module_function
+
+        # Inline code size
+        def inline_code_size
+          ::RubyVM::YJIT.runtime_stats[:inline_code_size]
+        end
+
+        # Outlined code size
+        def outlined_code_size
+          ::RubyVM::YJIT.runtime_stats[:outlined_code_size]
+        end
+
+        # GCed pages
+        def freed_page_count
+          ::RubyVM::YJIT.runtime_stats[:freed_page_count]
+        end
+
+        # GCed code size
+        def freed_code_size
+          ::RubyVM::YJIT.runtime_stats[:freed_code_size]
+        end
+
+        # Live pages
+        def live_page_count
+          ::RubyVM::YJIT.runtime_stats[:live_page_count]
+        end
+
+        # Code GC count
+        def code_gc_count
+          ::RubyVM::YJIT.runtime_stats[:code_gc_count]
+        end
+
+        # Size of memory region allocated for JIT code
+        def code_region_size
+          ::RubyVM::YJIT.runtime_stats[:code_region_size]
+        end
+
+        # Total number of object shapes
+        def object_shape_count
+          ::RubyVM::YJIT.runtime_stats[:object_shape_count]
+        end
+
+        def available?
+          defined?(::RubyVM::YJIT) \
+            && ::RubyVM::YJIT.enabled? \
+            && ::RubyVM::YJIT.respond_to?(:runtime_stats)
+        end
+      end
+    end
+  end
+end

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

@@ -1,32 +1,34 @@
+# frozen_string_literal: true
+
 module Datadog
   module Core
     module Git
       # Defines constants for Git tags
       module Ext
-        TAG_BRANCH = 'git.branch'.freeze
-        TAG_REPOSITORY_URL = 'git.repository_url'.freeze
-        TAG_TAG = 'git.tag'.freeze
+        TAG_BRANCH = 'git.branch'
+        TAG_REPOSITORY_URL = 'git.repository_url'
+        TAG_TAG = 'git.tag'
 
-        TAG_COMMIT_AUTHOR_DATE = 'git.commit.author.date'.freeze
-        TAG_COMMIT_AUTHOR_EMAIL = 'git.commit.author.email'.freeze
-        TAG_COMMIT_AUTHOR_NAME = 'git.commit.author.name'.freeze
-        TAG_COMMIT_COMMITTER_DATE = 'git.commit.committer.date'.freeze
-        TAG_COMMIT_COMMITTER_EMAIL = 'git.commit.committer.email'.freeze
-        TAG_COMMIT_COMMITTER_NAME = 'git.commit.committer.name'.freeze
-        TAG_COMMIT_MESSAGE = 'git.commit.message'.freeze
-        TAG_COMMIT_SHA = 'git.commit.sha'.freeze
+        TAG_COMMIT_AUTHOR_DATE = 'git.commit.author.date'
+        TAG_COMMIT_AUTHOR_EMAIL = 'git.commit.author.email'
+        TAG_COMMIT_AUTHOR_NAME = 'git.commit.author.name'
+        TAG_COMMIT_COMMITTER_DATE = 'git.commit.committer.date'
+        TAG_COMMIT_COMMITTER_EMAIL = 'git.commit.committer.email'
+        TAG_COMMIT_COMMITTER_NAME = 'git.commit.committer.name'
+        TAG_COMMIT_MESSAGE = 'git.commit.message'
+        TAG_COMMIT_SHA = 'git.commit.sha'
 
-        ENV_REPOSITORY_URL = 'DD_GIT_REPOSITORY_URL'.freeze
-        ENV_COMMIT_SHA = 'DD_GIT_COMMIT_SHA'.freeze
-        ENV_BRANCH = 'DD_GIT_BRANCH'.freeze
-        ENV_TAG = 'DD_GIT_TAG'.freeze
-        ENV_COMMIT_MESSAGE = 'DD_GIT_COMMIT_MESSAGE'.freeze
-        ENV_COMMIT_AUTHOR_NAME = 'DD_GIT_COMMIT_AUTHOR_NAME'.freeze
-        ENV_COMMIT_AUTHOR_EMAIL = 'DD_GIT_COMMIT_AUTHOR_EMAIL'.freeze
-        ENV_COMMIT_AUTHOR_DATE = 'DD_GIT_COMMIT_AUTHOR_DATE'.freeze
-        ENV_COMMIT_COMMITTER_NAME = 'DD_GIT_COMMIT_COMMITTER_NAME'.freeze
-        ENV_COMMIT_COMMITTER_EMAIL = 'DD_GIT_COMMIT_COMMITTER_EMAIL'.freeze
-        ENV_COMMIT_COMMITTER_DATE = 'DD_GIT_COMMIT_COMMITTER_DATE'.freeze
+        ENV_REPOSITORY_URL = 'DD_GIT_REPOSITORY_URL'
+        ENV_COMMIT_SHA = 'DD_GIT_COMMIT_SHA'
+        ENV_BRANCH = 'DD_GIT_BRANCH'
+        ENV_TAG = 'DD_GIT_TAG'
+        ENV_COMMIT_MESSAGE = 'DD_GIT_COMMIT_MESSAGE'
+        ENV_COMMIT_AUTHOR_NAME = 'DD_GIT_COMMIT_AUTHOR_NAME'
+        ENV_COMMIT_AUTHOR_EMAIL = 'DD_GIT_COMMIT_AUTHOR_EMAIL'
+        ENV_COMMIT_AUTHOR_DATE = 'DD_GIT_COMMIT_AUTHOR_DATE'
+        ENV_COMMIT_COMMITTER_NAME = 'DD_GIT_COMMIT_COMMITTER_NAME'
+        ENV_COMMIT_COMMITTER_EMAIL = 'DD_GIT_COMMIT_COMMITTER_EMAIL'
+        ENV_COMMIT_COMMITTER_DATE = 'DD_GIT_COMMIT_COMMITTER_DATE'
       end
     end
   end

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

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
+
 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
+        DD_SOURCE = 'ruby'
       end
     end
   end