ddtrace 0.45.0 → 0.50.0

data/lib/ddtrace/contrib/sneakers/tracer.rb

@@ -14,7 +14,7 @@ module Datadog
 
         def call(deserialized_msg, delivery_info, metadata, handler)
           trace_options = {
-            service:   configuration[:service_name],
+            service: configuration[:service_name],
             span_type: Datadog::Ext::AppTypes::WORKER,
             on_error: configuration[:error_handler]
           }
@@ -32,9 +32,7 @@ module Datadog
             request_span.set_tag(Ext::TAG_JOB_ROUTING_KEY, delivery_info.routing_key)
             request_span.set_tag(Ext::TAG_JOB_QUEUE, delivery_info.consumer.queue.name)
 
-            if configuration[:tag_body]
-              request_span.set_tag(Ext::TAG_JOB_BODY, deserialized_msg)
-            end
+            request_span.set_tag(Ext::TAG_JOB_BODY, deserialized_msg) if configuration[:tag_body]
 
             @app.call(deserialized_msg, delivery_info, metadata, handler)
           end

data/lib/ddtrace/contrib/status_code_matcher.rb

@@ -5,7 +5,7 @@ module Datadog
   module Contrib
     # Contains methods helpful for tracing/annotating HTTP request libraries
     class StatusCodeMatcher
-      REGEX_PARSER = /^\d{3}(?:-\d{3})?(?:,\d{3}(?:-\d{3})?)*$/
+      REGEX_PARSER = /^\d{3}(?:-\d{3})?(?:,\d{3}(?:-\d{3})?)*$/.freeze
 
       def initialize(range)
         @error_response_range = range
@@ -27,9 +27,10 @@ module Datadog
           set = Set.new
           handle_statuses.each do |statuses|
             status = statuses.to_s.split('-')
-            if status.length == 1
+            case status.length
+            when 1
               set.add(Integer(status[0]))
-            elsif status.length == 2
+            when 2
               min, max = status.minmax
               Array(min..max).each do |i|
                 set.add(Integer(i))
@@ -43,6 +44,7 @@ module Datadog
 
       def error_responses
         return @error_response_range if @error_response_range.is_a?(String) && !@error_response_range.nil?
+
         @error_response_range.join(',') if @error_response_range.is_a?(Array) && !@error_response_range.empty?
       end
 

data/lib/ddtrace/contrib/sucker_punch/exception_handler.rb

@@ -10,13 +10,11 @@ module Datadog
         module_function
 
         def patch!
-          ::SuckerPunch.class_eval do
-            class << self
-              alias_method :__exception_handler, :exception_handler
+          ::SuckerPunch.singleton_class.class_eval do
+            alias_method :__exception_handler, :exception_handler
 
-              def exception_handler
-                ::Datadog::Contrib::SuckerPunch::ExceptionHandler::METHOD
-              end
+            def exception_handler
+              ::Datadog::Contrib::SuckerPunch::ExceptionHandler::METHOD
             end
           end
         end

data/lib/ddtrace/contrib/sucker_punch/instrumentation.rb

@@ -10,6 +10,7 @@ module Datadog
         module_function
 
         # rubocop:disable Metrics/MethodLength
+        # rubocop:disable Metrics/AbcSize
         def patch!
           # rubocop:disable Metrics/BlockLength
           ::SuckerPunch::Job::ClassMethods.class_eval do
@@ -34,6 +35,7 @@ module Datadog
             rescue => e
               ::SuckerPunch.__exception_handler.call(e, self, args)
             end
+            ruby2_keywords :__run_perform if respond_to?(:ruby2_keywords, true)
 
             alias_method :__perform_async, :perform_async
             def perform_async(*args)
@@ -46,6 +48,7 @@ module Datadog
                 __perform_async(*args)
               end
             end
+            ruby2_keywords :perform_async if respond_to?(:ruby2_keywords, true)
 
             alias_method :__perform_in, :perform_in
             def perform_in(interval, *args)
@@ -59,6 +62,7 @@ module Datadog
                 __perform_in(interval, *args)
               end
             end
+            ruby2_keywords :perform_in if respond_to?(:ruby2_keywords, true)
 
             private
 

data/lib/ddtrace/correlation.rb

@@ -32,6 +32,7 @@ module Datadog
     # Produces a CorrelationIdentifier from the Context provided
     def identifier_from_context(context)
       return Identifier.new.freeze if context.nil?
+
       Identifier.new(context.trace_id, context.span_id).freeze
     end
   end

data/lib/ddtrace/diagnostics/environment_logger.rb

@@ -7,13 +7,13 @@ module Datadog
     # A holistic collection of the environment in which ddtrace is running.
     # This logger should allow for easy reporting by users to Datadog support.
     #
-    # rubocop:disable Style/DoubleNegation
     module EnvironmentLogger
       class << self
         # Outputs environment information to {Datadog.logger}.
         # Executes only for the lifetime of the program.
         def log!(transport_responses)
-          return if @executed || !log?
+          return if (defined?(@executed) && @executed) || !log?
+
           @executed = true
 
           data = EnvironmentCollector.new.collect!(transport_responses)
@@ -165,6 +165,7 @@ module Datadog
       def tags
         tags = Datadog.configuration.tags
         return nil if tags.empty?
+
         hash_serializer(tags)
       end
 
@@ -258,7 +259,7 @@ module Datadog
 
       # Capture all active integration settings into "integrationName_settingName: value" entries.
       def instrumented_integrations_settings
-        Hash[instrumented_integrations.flat_map do |name, integration|
+        instrumented_integrations.flat_map do |name, integration|
           integration.configuration.to_h.flat_map do |setting, value|
             next [] if setting == :tracer # Skip internal Ruby objects
 
@@ -266,7 +267,7 @@ module Datadog
             # handlers possibly causing errors.
             [[:"integration_#{name}_#{setting}", value.to_s]]
           end
-        end]
+        end.to_h
       end
 
       # Outputs "k1:v1,k2:v2,..."

data/lib/ddtrace/distributed_tracing/headers/headers.rb

@@ -36,6 +36,7 @@ module Datadog
 
           # Zero or greater than max allowed value of 2**64
           return if id.zero? || id > Span::EXTERNAL_MAX_ID
+
           id < 0 ? id + (2**64) : id
         end
 

data/lib/ddtrace/distributed_tracing/headers/helpers.rb

@@ -35,9 +35,7 @@ module Datadog
           #      for us so we want to make sure the comparision will work as expected
           # DEV: regex, remove all leading zeros up until we find the last 0 in the string
           #      or we find the first non-zero, this allows `'0000' -> '0'` and `'00001' -> '1'`
-          value = value.sub(/^0*(?=(0$)|[^0])/, '')
-
-          value
+          value.sub(/^0*(?=(0$)|[^0])/, '')
         end
       end
     end

data/lib/ddtrace/error.rb

@@ -1,21 +1,90 @@
+# frozen_string_literal: true
+
 # Datadog global namespace
 module Datadog
   # Error is a value-object responsible for sanitizing/encapsulating error data
   class Error
     attr_reader :type, :message, :backtrace
 
-    def self.build_from(value)
-      case value
-      when Error then value
-      when Array then new(*value)
-      when Exception then new(value.class, value.message, value.backtrace)
-      when ContainsMessage then new(value.class, value.message)
-      else BlankError
+    class << self
+      def build_from(value)
+        case value
+        when Error then value
+        when Array then new(*value)
+        when Exception then new(value.class, value.message, full_backtrace(value))
+        when ContainsMessage then new(value.class, value.message)
+        else BlankError
+        end
+      end
+
+      private
+
+      # Returns a stack trace with nested error causes and details.
+      #
+      # This manually implements Ruby >= 2.6 error output for two reasons:
+      #
+      # 1. It is not available in Ruby < 2.6.
+      # 2. It's measurably faster to manually implement it in Ruby.
+      #
+      # This method mimics the exact output of
+      # `ex.full_message(highlight: false, order: :top)`
+      # but it's around 3x faster in our benchmark test
+      # at `error_spec.rb`.
+      def full_backtrace(ex)
+        backtrace = String.new
+        backtrace_for(ex, backtrace)
+
+        # Avoid circular causes
+        causes = {}
+        causes[ex] = true
+
+        cause = ex
+        while (cause = cause.cause) && !causes.key?(cause)
+          backtrace_for(cause, backtrace)
+          causes[cause] = true
+        end
+
+        backtrace
+      end
+
+      # Outputs the following format for exceptions:
+      #
+      # ```
+      # error_spec.rb:55:in `wrapper': wrapper layer (RuntimeError)
+      # 	from error_spec.rb:40:in `wrapper'
+      # 	from error_spec.rb:61:in `caller'
+      #   ...
+      # ```
+      def backtrace_for(ex, backtrace)
+        trace = ex.backtrace
+        return unless trace
+
+        if trace[0]
+          # Add Exception information to error line
+          backtrace << trace[0]
+          backtrace << ': '
+          backtrace << ex.message.to_s
+          backtrace << ' ('
+          backtrace << ex.class.to_s
+          backtrace << ')'
+        end
+
+        if trace[1]
+          # Ident stack trace for caller lines, to separate
+          # them from the main error lines.
+          trace[1..-1].each do |line|
+            backtrace << "\n\tfrom "
+            backtrace << line
+          end
+        end
+
+        backtrace << "\n"
       end
     end
 
     def initialize(type = nil, message = nil, backtrace = nil)
-      backtrace = Array(backtrace).join("\n")
+      backtrace = Array(backtrace).join("\n") unless backtrace.is_a?(String)
+
       @type = Utils.utf8_encode(type)
       @message = Utils.utf8_encode(message)
       @backtrace = Utils.utf8_encode(backtrace)

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/distributed.rb

@@ -22,7 +22,7 @@ module Datadog
       PROPAGATION_STYLE_B3_SINGLE_HEADER = 'B3 single header'.freeze
       PROPAGATION_STYLE_INJECT_ENV = 'DD_PROPAGATION_STYLE_INJECT'.freeze
       PROPAGATION_STYLE_EXTRACT_ENV = 'DD_PROPAGATION_STYLE_EXTRACT'.freeze
-      # Note: the below inject/extract values are deprecated and were defined erronously
+      # NOTE: the below inject/extract values are deprecated and were defined erronously
       # they were never part of the datadog language client standard or documentation
       # some users may already be relying on them, but we should look to remove these in the future
       # or before 1.0.

data/lib/ddtrace/ext/http.rb

@@ -2,7 +2,7 @@ module Datadog
   module Ext
     module HTTP
       BASE_URL = 'http.base_url'.freeze
-      ERROR_RANGE = 500...600
+      ERROR_RANGE = (500...600).freeze
       METHOD = 'http.method'.freeze
       STATUS_CODE = 'http.status_code'.freeze
       TEMPLATE = 'template'.freeze

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

@@ -5,7 +5,9 @@ module Datadog
     module Runtime
       # Identity
       LANG = 'ruby'.freeze
-      LANG_INTERPRETER = (RUBY_ENGINE + '-' + RUBY_PLATFORM).freeze
+      LANG_ENGINE = RUBY_ENGINE
+      LANG_INTERPRETER = "#{RUBY_ENGINE}-#{RUBY_PLATFORM}".freeze
+      LANG_PLATFORM = RUBY_PLATFORM
       LANG_VERSION = RUBY_VERSION
       RUBY_ENGINE =  ::RUBY_ENGINE # e.g. 'ruby', 'jruby', 'truffleruby'
       TRACER_VERSION = Datadog::VERSION::STRING

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/forced_tracing.rb

@@ -7,11 +7,13 @@ module Datadog
     class << self
       def keep(span)
         return if span.nil? || span.context.nil?
+
         span.context.sampling_priority = Datadog::Ext::Priority::USER_KEEP
       end
 
       def drop(span)
         return if span.nil? || span.context.nil?
+
         span.context.sampling_priority = Datadog::Ext::Priority::USER_REJECT
       end
     end

data/lib/ddtrace/logger.rb

@@ -23,7 +23,7 @@ module Datadog
       end
 
       if message.nil?
-        if block_given?
+        if block
           super(severity, message, progname) do
             "[#{self.progname}] #{where}#{yield}"
           end

data/lib/ddtrace/metrics.rb

@@ -3,8 +3,9 @@ require 'ddtrace/ext/metrics'
 require 'set'
 require 'logger'
 require 'ddtrace/environment'
-require 'ddtrace/utils/time'
 require 'ddtrace/runtime/identity'
+require 'ddtrace/utils/only_once'
+require 'ddtrace/utils/time'
 
 module Datadog
   # Acts as client for sending metrics (via Statsd)
@@ -18,8 +19,14 @@ module Datadog
     end
 
     def supported?
-      version = Gem.loaded_specs['dogstatsd-ruby'] \
-                  && Gem.loaded_specs['dogstatsd-ruby'].version
+      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
+        )
 
       !version.nil? && (version >= Gem::Version.new('3.3.0'))
     end
@@ -41,7 +48,9 @@ module Datadog
     end
 
     def default_statsd_client
-      require 'datadog/statsd' unless defined?(::Datadog::Statsd)
+      require 'datadog/statsd'
+
+      incompatible_statsd_warning
 
       # Create a StatsD client that points to the agent.
       Datadog::Statsd.new(default_hostname, default_port)
@@ -58,7 +67,8 @@ module Datadog
 
     def count(stat, value = nil, options = nil, &block)
       return unless send_stats? && statsd.respond_to?(:count)
-      value, options = yield if block_given?
+
+      value, options = yield if block
       raise ArgumentError if value.nil?
 
       statsd.count(stat, value, metric_options(options))
@@ -68,7 +78,8 @@ module Datadog
 
     def distribution(stat, value = nil, options = nil, &block)
       return unless send_stats? && statsd.respond_to?(:distribution)
-      value, options = yield if block_given?
+
+      value, options = yield if block
       raise ArgumentError if value.nil?
 
       statsd.distribution(stat, value, metric_options(options))
@@ -78,6 +89,7 @@ module Datadog
 
     def increment(stat, options = nil)
       return unless send_stats? && statsd.respond_to?(:increment)
+
       options = yield if block_given?
 
       statsd.increment(stat, metric_options(options))
@@ -87,7 +99,8 @@ module Datadog
 
     def gauge(stat, value = nil, options = nil, &block)
       return unless send_stats? && statsd.respond_to?(:gauge)
-      value, options = yield if block_given?
+
+      value, options = yield if block
       raise ArgumentError if value.nil?
 
       statsd.gauge(stat, value, metric_options(options))
@@ -100,7 +113,7 @@ module Datadog
 
       # Calculate time, send it as a distribution.
       start = Utils::Time.get_time
-      return yield
+      yield
     ensure
       begin
         if send_stats? && !start.nil?
@@ -116,6 +129,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
@@ -186,7 +203,7 @@ module Datadog
         attr_accessor :logger
 
         def initialize(logger = nil)
-          @logger = logger || Logger.new(STDOUT).tap do |l|
+          @logger = logger || Logger.new($stdout).tap do |l|
             l.level = Logger::INFO
             l.progname = nil
             l.formatter = proc do |_severity, datetime, _progname, msg|
@@ -218,5 +235,21 @@ module Datadog
     include Options
     extend Options
     extend Helpers
+
+    private
+
+    INCOMPATIBLE_STATSD_ONLY_ONCE = Datadog::Utils::OnlyOnce.new
+    private_constant :INCOMPATIBLE_STATSD_ONLY_ONCE
+
+    def incompatible_statsd_warning
+      return if Gem.loaded_specs['dogstatsd-ruby'].version < Gem::Version.new('5.0')
+
+      INCOMPATIBLE_STATSD_ONLY_ONCE.run do
+        Datadog.logger.warn(
+          'This version of `ddtrace` is incompatible with `dogstastd-ruby` version >= 5.0 and can ' \
+          'cause unbounded memory usage. Please use `dogstastd-ruby` version < 5.0 instead.'
+        )
+      end
+    end
   end
 end