ddtrace 0.40.0 → 0.50.0

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

@@ -14,33 +14,28 @@ module Datadog
 
         def call(deserialized_msg, delivery_info, metadata, handler)
           trace_options = {
-            service:   configuration[:service_name],
-            span_type: Datadog::Ext::AppTypes::WORKER
+            service: configuration[:service_name],
+            span_type: Datadog::Ext::AppTypes::WORKER,
+            on_error: configuration[:error_handler]
           }
-          request_span = tracer.trace(Ext::SPAN_JOB, trace_options)
 
-          # Set analytics sample rate
-          if Datadog::Contrib::Analytics.enabled?(configuration[:analytics_enabled])
-            Datadog::Contrib::Analytics.set_sample_rate(request_span, configuration[:analytics_sample_rate])
-          end
+          tracer.trace(Ext::SPAN_JOB, trace_options) do |request_span|
+            # Set analytics sample rate
+            if Datadog::Contrib::Analytics.enabled?(configuration[:analytics_enabled])
+              Datadog::Contrib::Analytics.set_sample_rate(request_span, configuration[:analytics_sample_rate])
+            end
 
-          # Measure service stats
-          Contrib::Analytics.set_measured(request_span)
+            # Measure service stats
+            Contrib::Analytics.set_measured(request_span)
 
-          request_span.resource = @app.to_proc.binding.eval('self.class').to_s
-          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)
+            request_span.resource = @app.to_proc.binding.eval('self.class').to_s
+            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)
-        rescue StandardError => e
-          request_span.set_error(e) unless request_span.nil?
-          raise e
-        ensure
-          request_span.finish if request_span
+            @app.call(deserialized_msg, delivery_info, metadata, handler)
+          end
         end
 
         private

data/lib/ddtrace/contrib/status_code_matcher.rb

@@ -0,0 +1,69 @@
+require 'set'
+require 'ddtrace/ext/http'
+
+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})?)*$/.freeze
+
+      def initialize(range)
+        @error_response_range = range
+        set_range
+      end
+
+      def include?(exception_status)
+        set_range.include?(exception_status)
+      end
+
+      def to_s
+        @error_response_range.to_s
+      end
+
+      private
+
+      def set_range
+        @datadog_set ||= begin
+          set = Set.new
+          handle_statuses.each do |statuses|
+            status = statuses.to_s.split('-')
+            case status.length
+            when 1
+              set.add(Integer(status[0]))
+            when 2
+              min, max = status.minmax
+              Array(min..max).each do |i|
+                set.add(Integer(i))
+              end
+            end
+          end
+          set
+        end
+        @datadog_set
+      end
+
+      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
+
+      def handle_statuses
+        if error_responses
+          filter_error_responses = error_responses.gsub(/\s+/, '').split(',').select do |code|
+            if !code.to_s.match(REGEX_PARSER)
+              Datadog.logger.debug("Invalid config provided: #{code}. Must be formatted like '400-403,405,410-499'.")
+              next
+            else
+              true
+            end
+          end
+          filter_error_responses.empty? ? Datadog::Ext::HTTP::ERROR_RANGE.to_a : filter_error_responses
+        else
+          Datadog.logger.debug('No valid config was provided for :error_statuses - falling back to default.')
+          Datadog::Ext::HTTP::ERROR_RANGE.to_a
+        end
+      end
+    end
+  end
+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/distributed.rb

@@ -20,8 +20,14 @@ module Datadog
       PROPAGATION_STYLE_DATADOG = 'Datadog'.freeze
       PROPAGATION_STYLE_B3 = 'B3'.freeze
       PROPAGATION_STYLE_B3_SINGLE_HEADER = 'B3 single header'.freeze
-      PROPAGATION_INJECT_STYLE_ENV = 'DD_PROPAGATION_INJECT_STYLE'.freeze
-      PROPAGATION_EXTRACT_STYLE_ENV = 'DD_PROPAGATION_EXTRACT_STYLE'.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
+      # 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.
+      PROPAGATION_INJECT_STYLE_ENV_OLD = 'DD_PROPAGATION_INJECT_STYLE'.freeze
+      PROPAGATION_EXTRACT_STYLE_ENV_OLD = 'DD_PROPAGATION_EXTRACT_STYLE'.freeze
 
       # gRPC metadata keys for distributed tracing. https://github.com/grpc/grpc-go/blob/v1.10.x/Documentation/grpc-metadata.md
       GRPC_METADATA_TRACE_ID = 'x-datadog-trace-id'.freeze

data/lib/ddtrace/ext/git.rb

@@ -0,0 +1,11 @@
+module Datadog
+  module Ext
+    # 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
+    end
+  end
+end

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

@@ -0,0 +1,8 @@
+module Datadog
+  module Ext
+    module Integration
+      # Name of external service that performed the work
+      TAG_PEER_SERVICE = 'peer.service'.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