ddtrace 0.46.0 → 0.51.0

data/lib/ddtrace/ext/app_types.rb

@@ -6,7 +6,6 @@ module Datadog
       CACHE = 'cache'.freeze
       WORKER = 'worker'.freeze
       CUSTOM = 'custom'.freeze
-      TEST = 'test'.freeze
     end
   end
 end

data/lib/ddtrace/ext/environment.rb

@@ -8,6 +8,13 @@ module Datadog
       ENV_TAGS = 'DD_TAGS'.freeze
       ENV_VERSION = 'DD_VERSION'.freeze
 
+      FALLBACK_SERVICE_NAME =
+        begin
+          File.basename($PROGRAM_NAME, '.*')
+        rescue StandardError
+          'ruby'
+        end.freeze
+
       TAG_ENV = 'env'.freeze
       TAG_SERVICE = 'service'.freeze
       TAG_VERSION = 'version'.freeze

data/lib/ddtrace/ext/git.rb

@@ -3,9 +3,17 @@ module Datadog
     # Defines constants for Git tags
     module Git
       TAG_BRANCH = 'git.branch'.freeze
-      TAG_COMMIT_SHA = 'git.commit.sha'.freeze
       TAG_REPOSITORY_URL = 'git.repository_url'.freeze
       TAG_TAG = 'git.tag'.freeze
+
+      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
     end
   end
 end

data/lib/ddtrace/ext/profiling.rb

@@ -0,0 +1,53 @@
+module Datadog
+  module Ext
+    module Profiling
+      ENV_ENABLED = 'DD_PROFILING_ENABLED'.freeze
+      ENV_UPLOAD_TIMEOUT = 'DD_PROFILING_UPLOAD_TIMEOUT'.freeze
+      ENV_MAX_FRAMES = 'DD_PROFILING_MAX_FRAMES'.freeze
+
+      module Pprof
+        LABEL_KEY_SPAN_ID = 'span id'.freeze
+        LABEL_KEY_THREAD_ID = 'thread id'.freeze
+        LABEL_KEY_TRACE_ID = 'trace id'.freeze
+        SAMPLE_VALUE_NO_VALUE = 0
+        VALUE_TYPE_CPU = 'cpu-time'.freeze
+        VALUE_TYPE_WALL = 'wall-time'.freeze
+        VALUE_UNIT_NANOSECONDS = 'nanoseconds'.freeze
+      end
+
+      module Transport
+        module HTTP
+          URI_TEMPLATE_DD_API = 'https://intake.profile.%s/'.freeze
+
+          FORM_FIELD_DATA = 'data[0]'.freeze
+          FORM_FIELD_FORMAT = 'format'.freeze
+          FORM_FIELD_FORMAT_PPROF = 'pprof'.freeze
+          FORM_FIELD_RECORDING_END = 'recording-end'.freeze
+          FORM_FIELD_RECORDING_START = 'recording-start'.freeze
+          FORM_FIELD_RUNTIME = 'runtime'.freeze
+          FORM_FIELD_RUNTIME_ID = 'runtime-id'.freeze
+          FORM_FIELD_TAG_ENV = 'env'.freeze
+          FORM_FIELD_TAG_HOST = 'host'.freeze
+          FORM_FIELD_TAG_LANGUAGE = 'language'.freeze
+          FORM_FIELD_TAG_PID = 'pid'.freeze
+          FORM_FIELD_TAG_PROFILER_VERSION = 'profiler_version'.freeze
+          FORM_FIELD_TAG_RUNTIME = 'runtime'.freeze
+          FORM_FIELD_TAG_RUNTIME_ENGINE = 'runtime_engine'.freeze
+          FORM_FIELD_TAG_RUNTIME_ID = 'runtime-id'.freeze
+          FORM_FIELD_TAG_RUNTIME_PLATFORM = 'runtime_platform'.freeze
+          FORM_FIELD_TAG_RUNTIME_VERSION = 'runtime_version'.freeze
+          FORM_FIELD_TAG_SERVICE = 'service'.freeze
+          FORM_FIELD_TAG_VERSION = 'version'.freeze
+          FORM_FIELD_TAGS = 'tags'.freeze
+          FORM_FIELD_TYPES = 'types[0]'.freeze
+          FORM_FIELD_TYPES_AUTO = 'auto'.freeze
+
+          HEADER_CONTENT_TYPE = 'Content-Type'.freeze
+          HEADER_CONTENT_TYPE_OCTET_STREAM = 'application/octet-stream'.freeze
+
+          PPROF_DEFAULT_FILENAME = 'profile.pb.gz'.freeze
+        end
+      end
+    end
+  end
+end

data/lib/ddtrace/ext/runtime.rb

@@ -3,13 +3,6 @@ require 'ddtrace/version'
 module Datadog
   module Ext
     module Runtime
-      # Identity
-      LANG = 'ruby'.freeze
-      LANG_INTERPRETER = "#{RUBY_ENGINE}-#{RUBY_PLATFORM}".freeze
-      LANG_VERSION = RUBY_VERSION
-      RUBY_ENGINE =  ::RUBY_ENGINE # e.g. 'ruby', 'jruby', 'truffleruby'
-      TRACER_VERSION = Datadog::VERSION::STRING
-
       TAG_ID = 'runtime-id'.freeze
       TAG_LANG = 'language'.freeze
 

data/lib/ddtrace/ext/test.rb

@@ -1,24 +1,8 @@
 module Datadog
   module Ext
-    # Defines constants for test tags
+    # Defines constants for test behavior
     module Test
-      TAG_ARGUMENTS = 'test.arguments'.freeze
-      TAG_FRAMEWORK = 'test.framework'.freeze
-      TAG_NAME = 'test.name'.freeze
-      TAG_SKIP_REASON = 'test.skip_reason'.freeze
-      TAG_STATUS = 'test.status'.freeze
-      TAG_SUITE = 'test.suite'.freeze
-      TAG_TRAITS = 'test.traits'.freeze
-      TAG_TYPE = 'test.type'.freeze
-
-      # TODO: is there a better place for SPAN_KIND?
-      TAG_SPAN_KIND = 'span.kind'.freeze
-
-      module Status
-        PASS = 'pass'.freeze
-        FAIL = 'fail'.freeze
-        SKIP = 'skip'.freeze
-      end
+      ENV_MODE_ENABLED = 'DD_TRACE_TEST_MODE_ENABLED'.freeze
     end
   end
 end

data/lib/ddtrace/ext/transport.rb

@@ -4,10 +4,12 @@ module Datadog
       module HTTP
         DEFAULT_HOST = '127.0.0.1'.freeze
         DEFAULT_PORT = 8126
+        DEFAULT_TIMEOUT_SECONDS = 1
         ENV_DEFAULT_HOST = 'DD_AGENT_HOST'.freeze
         ENV_DEFAULT_PORT = 'DD_TRACE_AGENT_PORT'.freeze
         ENV_DEFAULT_URL = 'DD_TRACE_AGENT_URL'.freeze
         HEADER_CONTAINER_ID = 'Datadog-Container-ID'.freeze
+        HEADER_DD_API_KEY = 'DD-API-KEY'.freeze
         HEADER_META_LANG = 'Datadog-Meta-Lang'.freeze
         HEADER_META_LANG_VERSION = 'Datadog-Meta-Lang-Version'.freeze
         HEADER_META_LANG_INTERPRETER = 'Datadog-Meta-Lang-Interpreter'.freeze

data/lib/ddtrace/metrics.rb

@@ -2,9 +2,10 @@ require 'ddtrace/ext/metrics'
 
 require 'set'
 require 'logger'
-require 'ddtrace/environment'
+require 'datadog/core/environment/identity'
+require 'ddtrace/ext/environment'
+require 'ddtrace/utils/only_once'
 require 'ddtrace/utils/time'
-require 'ddtrace/runtime/identity'
 
 module Datadog
   # Acts as client for sending metrics (via Statsd)
@@ -12,16 +13,24 @@ module Datadog
   class Metrics
     attr_reader :statsd
 
-    def initialize(options = {})
-      @statsd = options.fetch(:statsd) { default_statsd_client if supported? }
-      @enabled = options.fetch(:enabled, true)
+    def initialize(statsd: nil, enabled: true, **_)
+      @statsd =
+        if supported?
+          statsd || default_statsd_client
+        else
+          ignored_statsd_warning if statsd
+          nil
+        end
+      @enabled = enabled
     end
 
     def supported?
-      version = Gem.loaded_specs['dogstatsd-ruby'] \
-                  && Gem.loaded_specs['dogstatsd-ruby'].version
+      version = dogstatsd_version
 
-      !version.nil? && (version >= Gem::Version.new('3.3.0'))
+      !version.nil? && version >= Gem::Version.new('3.3.0') &&
+        # dogstatsd-ruby >= 5.0 & < 5.2.0 has known issues with process forks
+        # and do not support the single thread mode we use to avoid this problem.
+        !(version >= Gem::Version.new('5.0') && version < Gem::Version.new('5.2'))
     end
 
     def enabled?
@@ -44,7 +53,22 @@ module Datadog
       require 'datadog/statsd'
 
       # Create a StatsD client that points to the agent.
-      Datadog::Statsd.new(default_hostname, default_port)
+      #
+      # We use `single_thread: true`, as dogstatsd-ruby >= 5.0 creates a background thread
+      # by default, but does not handle forks correctly, causing resource leaks.
+      #
+      # Using dogstatsd-ruby >= 5.0 is still valuable, as it supports
+      # transparent batch metric submission, which reduces submission
+      # overhead.
+      #
+      # Versions < 5.0 are always single-threaded, but do not have the kwarg option.
+      options = if dogstatsd_version >= Gem::Version.new('5.2')
+                  { single_thread: true }
+                else
+                  {}
+                end
+
+      Datadog::Statsd.new(default_hostname, default_port, **options)
     end
 
     def configure(options = {})
@@ -120,6 +144,10 @@ module Datadog
       metrics.each { |m| send(m.type, *[m.name, m.value, m.options].compact) }
     end
 
+    def close
+      @statsd.close if @statsd && @statsd.respond_to?(:close)
+    end
+
     Metric = Struct.new(:type, :name, :value, :options) do
       def initialize(*args)
         super
@@ -131,10 +159,10 @@ module Datadog
     module Options
       DEFAULT = {
         tags: DEFAULT_TAGS = [
-          "#{Ext::Metrics::TAG_LANG}:#{Runtime::Identity.lang}".freeze,
-          "#{Ext::Metrics::TAG_LANG_INTERPRETER}:#{Runtime::Identity.lang_interpreter}".freeze,
-          "#{Ext::Metrics::TAG_LANG_VERSION}:#{Runtime::Identity.lang_version}".freeze,
-          "#{Ext::Metrics::TAG_TRACER_VERSION}:#{Runtime::Identity.tracer_version}".freeze
+          "#{Ext::Metrics::TAG_LANG}:#{Core::Environment::Identity.lang}".freeze,
+          "#{Ext::Metrics::TAG_LANG_INTERPRETER}:#{Core::Environment::Identity.lang_interpreter}".freeze,
+          "#{Ext::Metrics::TAG_LANG_VERSION}:#{Core::Environment::Identity.lang_version}".freeze,
+          "#{Ext::Metrics::TAG_TRACER_VERSION}:#{Core::Environment::Identity.tracer_version}".freeze
         ].freeze
       }.freeze
 
@@ -222,5 +250,32 @@ module Datadog
     include Options
     extend Options
     extend Helpers
+
+    private
+
+    def dogstatsd_version
+      return @dogstatsd_version if instance_variable_defined?(:@dogstatsd_version)
+
+      @dogstatsd_version = (
+        defined?(Datadog::Statsd::VERSION) &&
+          Datadog::Statsd::VERSION &&
+          Gem::Version.new(Datadog::Statsd::VERSION)
+      ) || (
+        Gem.loaded_specs['dogstatsd-ruby'] &&
+          Gem.loaded_specs['dogstatsd-ruby'].version
+      )
+    end
+
+    IGNORED_STATSD_ONLY_ONCE = Datadog::Utils::OnlyOnce.new
+    private_constant :IGNORED_STATSD_ONLY_ONCE
+
+    def ignored_statsd_warning
+      IGNORED_STATSD_ONLY_ONCE.run do
+        Datadog.logger.warn(
+          'Ignoring user-supplied statsd instance as currently-installed version of dogstastd-ruby is incompatible. ' \
+          "To fix this, ensure that you have `gem 'dogstatsd-ruby', '~> 5.2'` on your Gemfile or gems.rb file."
+        )
+      end
+    end
   end
 end

data/lib/ddtrace/opentelemetry/extensions.rb

@@ -6,7 +6,7 @@ module Datadog
     # Defines extensions to ddtrace for OpenTelemetry support
     module Extensions
       def self.extended(base)
-        Datadog::Span.send(:prepend, OpenTelemetry::Span)
+        Datadog::Span.prepend(OpenTelemetry::Span)
       end
     end
   end

data/lib/ddtrace/opentracer.rb

@@ -1,40 +1,21 @@
-module Datadog
-  # Namespace for ddtrace OpenTracing implementation
-  module OpenTracer
-    module_function
+require 'opentracing'
+require 'opentracing/carrier'
+require 'ddtrace'
+require 'ddtrace/opentracer/carrier'
+require 'ddtrace/opentracer/tracer'
+require 'ddtrace/opentracer/span'
+require 'ddtrace/opentracer/span_context'
+require 'ddtrace/opentracer/span_context_factory'
+require 'ddtrace/opentracer/scope'
+require 'ddtrace/opentracer/scope_manager'
+require 'ddtrace/opentracer/thread_local_scope'
+require 'ddtrace/opentracer/thread_local_scope_manager'
+require 'ddtrace/opentracer/distributed_headers'
+require 'ddtrace/opentracer/propagator'
+require 'ddtrace/opentracer/text_map_propagator'
+require 'ddtrace/opentracer/binary_propagator'
+require 'ddtrace/opentracer/rack_propagator'
+require 'ddtrace/opentracer/global_tracer'
 
-    def supported?
-      Gem::Version.new(RUBY_VERSION) >= Gem::Version.new('2.1')
-    end
-
-    def load_opentracer
-      require 'opentracing'
-      require 'opentracing/carrier'
-      require 'ddtrace'
-      require 'ddtrace/opentracer/carrier'
-      require 'ddtrace/opentracer/tracer'
-      require 'ddtrace/opentracer/span'
-      require 'ddtrace/opentracer/span_context'
-      require 'ddtrace/opentracer/span_context_factory'
-      require 'ddtrace/opentracer/scope'
-      require 'ddtrace/opentracer/scope_manager'
-      require 'ddtrace/opentracer/thread_local_scope'
-      require 'ddtrace/opentracer/thread_local_scope_manager'
-      require 'ddtrace/opentracer/distributed_headers'
-      require 'ddtrace/opentracer/propagator'
-      require 'ddtrace/opentracer/text_map_propagator'
-      require 'ddtrace/opentracer/binary_propagator'
-      require 'ddtrace/opentracer/rack_propagator'
-      require 'ddtrace/opentracer/global_tracer'
-
-      # Modify the OpenTracing module functions
-      OpenTracing.module_eval do
-        class << self
-          prepend Datadog::OpenTracer::GlobalTracer
-        end
-      end
-    end
-
-    load_opentracer if supported?
-  end
-end
+# Modify the OpenTracing module functions
+::OpenTracing.singleton_class.prepend(Datadog::OpenTracer::GlobalTracer)

data/lib/ddtrace/patcher.rb

@@ -1,9 +1,23 @@
+require 'ddtrace/utils/only_once'
+
 module Datadog
-  # Defines some useful patching methods for integrations
+  # Deprecated: This module should no longer be included. It's only being kept around for backwards compatibility
+  # concerns regarding customer usage.
   module Patcher
+    INCLUDED_WARN_ONLY_ONCE = Datadog::Utils::OnlyOnce.new
+    DO_ONCE_USAGE_WARN_ONLY_ONCE = Datadog::Utils::OnlyOnce.new
+
     def self.included(base)
-      base.send(:extend, CommonMethods)
-      base.send(:include, CommonMethods)
+      INCLUDED_WARN_ONLY_ONCE.run do
+        Datadog.logger.warn(
+          'Including Datadog::Patcher is deprecated. ' \
+          'For the #do_once behavior, use Datadog::Utils::OnlyOnce instead. ' \
+          'For the #without_warnings behavior, use Datadog::Patcher.without_warnings { ... } as a module function.'
+        )
+      end
+
+      base.extend(CommonMethods)
+      base.include(CommonMethods)
     end
 
     # Defines some common methods for patching, that can be used
@@ -22,6 +36,10 @@ module Datadog
       end
 
       def do_once(key = nil, options = {})
+        DO_ONCE_USAGE_WARN_ONLY_ONCE.run do
+          Datadog.logger.warn('Datadog::Patcher#do_once is deprecated. Use Datadog::Utils::OnlyOnce instead.')
+        end
+
         # If already done, don't do again
         @done_once ||= Hash.new { |h, k| h[k] = {} }
         return @done_once[key][options[:for]] if @done_once.key?(key) && @done_once[key].key?(options[:for])
@@ -34,6 +52,10 @@ module Datadog
       end
 
       def done?(key, options = {})
+        DO_ONCE_USAGE_WARN_ONLY_ONCE.run do
+          Datadog.logger.warn('Datadog::Patcher#done? is deprecated. Use Datadog::Utils::OnlyOnce instead.')
+        end
+
         return false unless instance_variable_defined?(:@done_once)
 
         !@done_once.nil? && @done_once.key?(key) && @done_once[key].key?(options[:for])

data/lib/ddtrace/pin.rb

@@ -1,4 +1,5 @@
 require 'ddtrace/patcher'
+require 'ddtrace/utils/only_once'
 
 # \Datadog global namespace that includes all tracing functionality for Tracer and Span classes.
 module Datadog
@@ -7,6 +8,8 @@ module Datadog
   # This is useful if you wanted to, say, trace two different
   # database clusters.
   class Pin
+    DEPRECATION_WARN_ONLY_ONCE = Datadog::Utils::OnlyOnce.new
+
     def self.get_from(obj)
       return nil unless obj.respond_to? :datadog_pin
 
@@ -74,15 +77,8 @@ module Datadog
       ).freeze
 
     def deprecation_warning
-      log_deprecation_warning('Datadog::Pin.new')
-    end
-
-    include Datadog::Patcher
-
-    def log_deprecation_warning(method_name)
-      # Only log each deprecation warning once (safeguard against log spam)
-      do_once(method_name) do
-        Datadog.logger.warn("#{method_name}:#{DEPRECATION_WARNING}")
+      DEPRECATION_WARN_ONLY_ONCE.run do
+        Datadog.logger.warn("Datadog::Pin.new:#{DEPRECATION_WARNING}")
       end
     end
   end

data/lib/ddtrace/profiling.rb

@@ -0,0 +1,107 @@
+module Datadog
+  # Contains profiler for generating stack profiles, etc.
+  module Profiling
+    module_function
+
+    GOOGLE_PROTOBUF_MINIMUM_VERSION = Gem::Version.new('3.0')
+    private_constant :GOOGLE_PROTOBUF_MINIMUM_VERSION
+
+    def supported?
+      unsupported_reason.nil?
+    end
+
+    def unsupported_reason
+      # NOTE: Only the first matching reason is returned, so try to keep a nice order on reasons -- e.g. tell users
+      # first that they can't use this on JRuby before telling them that they are missing protobuf
+
+      ruby_engine_unsupported? || protobuf_gem_unavailable? || protobuf_version_unsupported? || protobuf_failed_to_load?
+    end
+
+    def self.ruby_engine_unsupported?
+      'JRuby is not supported' if RUBY_ENGINE == 'jruby'
+    end
+    private_class_method :ruby_engine_unsupported?
+
+    def self.protobuf_gem_unavailable?
+      # NOTE: On environments where protobuf is already loaded, we skip the check. This allows us to support environments
+      # where no Gem.loaded_version is NOT available but customers are able to load protobuf; see for instance
+      # https://github.com/teamcapybara/capybara/commit/caf3bcd7664f4f2691d0ca9ef3be9a2a954fecfb
+      if !defined?(::Google::Protobuf) && Gem.loaded_specs['google-protobuf'].nil?
+        "Missing google-protobuf dependency; please add `gem 'google-protobuf', '~> 3.0'` to your Gemfile or gems.rb file"
+      end
+    end
+    private_class_method :protobuf_gem_unavailable?
+
+    def self.protobuf_version_unsupported?
+      # See above for why we skip the check when protobuf is already loaded; note that when protobuf was already loaded
+      # we skip the version check to avoid the call to Gem.loaded_specs. Unfortunately, protobuf does not seem to
+      # expose the gem version constant elsewhere, so in that setup we are not able to check the version.
+      if !defined?(::Google::Protobuf) && Gem.loaded_specs['google-protobuf'].version < GOOGLE_PROTOBUF_MINIMUM_VERSION
+        'Your google-protobuf is too old; ensure that you have google-protobuf >= 3.0 by ' \
+        "adding `gem 'google-protobuf', '~> 3.0'` to your Gemfile or gems.rb file"
+      end
+    end
+    private_class_method :protobuf_version_unsupported?
+
+    def self.protobuf_failed_to_load?
+      unless protobuf_loaded_successfully?
+        'There was an error loading the google-protobuf library; see previous warning message for details'
+      end
+    end
+    private_class_method :protobuf_failed_to_load?
+
+    # The `google-protobuf` gem depends on a native component, and its creators helpfully tried to provide precompiled
+    # versions of this extension on rubygems.org.
+    #
+    # Unfortunately, for a long time, the supported Ruby versions metadata on these precompiled versions of the extension
+    # was not correctly set. (This is fixed in newer versions -- but not all Ruby versions we want to support can use
+    # these.)
+    #
+    # Thus, the gem can still be installed, but can be in a broken state. To avoid breaking customer applications, we
+    # use this helper to load it and gracefully handle failures.
+    def self.protobuf_loaded_successfully?
+      return @protobuf_loaded if defined?(@protobuf_loaded)
+
+      begin
+        require 'google/protobuf'
+        @protobuf_loaded = true
+      rescue LoadError => e
+        # NOTE: We use Kernel#warn here because this code gets run BEFORE Datadog.logger is actually set up.
+        # In the future it'd be nice to shuffle the logger startup to happen first to avoid this special case.
+        Kernel.warn(
+          "[DDTRACE] Error while loading google-protobuf gem. Cause: '#{e.message}' Location: '#{e.backtrace.first}'. " \
+          'This can happen when google-protobuf is missing its native components. ' \
+          'To fix this, try removing and reinstalling the gem, forcing it to recompile the components: ' \
+          '`gem uninstall google-protobuf -a; BUNDLE_FORCE_RUBY_PLATFORM=true bundle install`. ' \
+          'If the error persists, please contact support via <https://docs.datadoghq.com/help/> or ' \
+          'file a bug at <https://github.com/DataDog/dd-trace-rb/blob/master/CONTRIBUTING.md#found-a-bug>.'
+        )
+        @protobuf_loaded = false
+      end
+    end
+    private_class_method :protobuf_loaded_successfully?
+
+    def self.load_profiling
+      return false unless supported?
+
+      require 'ddtrace/profiling/ext/cpu'
+      require 'ddtrace/profiling/ext/forking'
+
+      require 'ddtrace/profiling/collectors/stack'
+      require 'ddtrace/profiling/exporter'
+      require 'ddtrace/profiling/recorder'
+      require 'ddtrace/profiling/scheduler'
+      require 'ddtrace/profiling/tasks/setup'
+      require 'ddtrace/profiling/transport/io'
+      require 'ddtrace/profiling/transport/http'
+      require 'ddtrace/profiling/profiler'
+
+      require 'ddtrace/profiling/pprof/pprof_pb'
+
+      true
+    end
+    private_class_method :load_profiling
+
+    load_profiling if supported?
+  end
+end