ddtrace 0.38.0 → 0.43.0

data/lib/ddtrace/tracer.rb

@@ -1,4 +1,3 @@
-require 'pp'
 require 'thread'
 require 'logger'
 require 'pathname'
@@ -8,6 +7,7 @@ require 'ddtrace/span'
 require 'ddtrace/context'
 require 'ddtrace/logger'
 require 'ddtrace/writer'
+require 'ddtrace/runtime/identity'
 require 'ddtrace/sampler'
 require 'ddtrace/sampling'
 require 'ddtrace/correlation'
@@ -60,8 +60,8 @@ module Datadog
     #
     # This method makes use of a \ContextProvider that is automatically set during the tracer
     # initialization, or while using a library instrumentation.
-    def call_context
-      @provider.context
+    def call_context(key = nil)
+      @provider.context(key)
     end
 
     # Initialize a new \Tracer used to create, sample and submit spans that measure the
@@ -186,8 +186,7 @@ module Datadog
     # * +start_time+: when the span actually starts (defaults to \now)
     # * +tags+: extra tags which should be added to the span.
     def start_span(name, options = {})
-      start_time = options.fetch(:start_time, Time.now.utc)
-
+      start_time = options[:start_time]
       tags = options.fetch(:tags, {})
 
       span_options = options.select do |k, _v|
@@ -203,6 +202,7 @@ module Datadog
         # root span
         @sampler.sample!(span)
         span.set_tag('system.pid', Process.pid)
+        span.set_tag(Datadog::Ext::Runtime::TAG_ID, Datadog::Runtime::Identity.id)
 
         if ctx && ctx.trace_id
           span.trace_id = ctx.trace_id
@@ -212,9 +212,10 @@ module Datadog
         # child span
         span.parent = parent # sets service, trace_id, parent_id, sampled
       end
+
       span.set_tags(@tags) unless @tags.empty?
       span.set_tags(tags) unless tags.empty?
-      span.start_time = start_time
+      span.start(start_time)
 
       # this could at some point be optional (start_active_span vs start_manual_span)
       ctx.add_span(span) unless ctx.nil?
@@ -288,8 +289,19 @@ module Datadog
         # and it is user code which should be executed no matter what.
         # It's not a problem since we re-raise it afterwards so for example a
         # SignalException::Interrupt would still bubble up.
+        # rubocop:disable Metrics/BlockNesting
         rescue Exception => e
-          (options[:on_error] || DEFAULT_ON_ERROR).call(span, e)
+          if (on_error_handler = options[:on_error]) && on_error_handler.respond_to?(:call)
+            begin
+              on_error_handler.call(span, e)
+            rescue
+              Datadog.logger.debug('Custom on_error handler failed, falling back to default')
+              DEFAULT_ON_ERROR.call(span, e)
+            end
+          else
+            Datadog.logger.debug('Custom on_error handler must be a callable, falling back to default') if on_error_handler
+            DEFAULT_ON_ERROR.call(span, e)
+          end
           raise e
         ensure
           span.finish unless span.nil?
@@ -325,18 +337,18 @@ module Datadog
     end
 
     # Return the current active span or +nil+.
-    def active_span
-      call_context.current_span
+    def active_span(key = nil)
+      call_context(key).current_span
     end
 
     # Return the current active root span or +nil+.
-    def active_root_span
-      call_context.current_root_span
+    def active_root_span(key = nil)
+      call_context(key).current_root_span
     end
 
     # Return a CorrelationIdentifier for active span
-    def active_correlation
-      Datadog::Correlation.identifier_from_context(call_context)
+    def active_correlation(key = nil)
+      Datadog::Correlation.identifier_from_context(call_context(key))
     end
 
     # Send the trace to the writer to enqueue the spans list in the agent

data/lib/ddtrace/transport/http.rb

@@ -10,6 +10,7 @@ require 'ddtrace/transport/http/api'
 require 'ddtrace/transport/http/adapters/net'
 require 'ddtrace/transport/http/adapters/test'
 require 'ddtrace/transport/http/adapters/unix_socket'
+require 'uri'
 
 module Datadog
   module Transport
@@ -75,13 +76,27 @@ module Datadog
       end
 
       def default_hostname
+        return default_url.hostname if default_url
+
         ENV.fetch(Datadog::Ext::Transport::HTTP::ENV_DEFAULT_HOST, Datadog::Ext::Transport::HTTP::DEFAULT_HOST)
       end
 
       def default_port
+        return default_url.port if default_url
+
         ENV.fetch(Datadog::Ext::Transport::HTTP::ENV_DEFAULT_PORT, Datadog::Ext::Transport::HTTP::DEFAULT_PORT).to_i
       end
 
+      def default_url
+        url_env = ENV.fetch(Datadog::Ext::Transport::HTTP::ENV_DEFAULT_URL, nil)
+
+        if url_env
+          uri_parsed = URI.parse(url_env)
+
+          uri_parsed if %w[http https].include?(uri_parsed.scheme)
+        end
+      end
+
       # Add adapters to registry
       Builder::REGISTRY.set(Adapters::Net, :net_http)
       Builder::REGISTRY.set(Adapters::Test, :test)

data/lib/ddtrace/transport/http/adapters/net.rb

@@ -20,8 +20,14 @@ module Datadog
           end
 
           def open
-            # Open connection
-            ::Net::HTTP.start(hostname, port, open_timeout: timeout, read_timeout: timeout) do |http|
+            # DEV Initializing +Net::HTTP+ directly help us avoid expensive
+            # options processing done in +Net::HTTP.start+:
+            # https://github.com/ruby/ruby/blob/b2d96abb42abbe2e01f010ffc9ac51f0f9a50002/lib/net/http.rb#L614-L618
+            req = ::Net::HTTP.new(hostname, port, nil)
+
+            req.open_timeout = req.read_timeout = timeout
+
+            req.start do |http|
               yield(http)
             end
           end

data/lib/ddtrace/transport/http/adapters/test.rb

@@ -33,6 +33,8 @@ module Datadog
             @status = status
           end
 
+          def url; end
+
           # Response for test adapter
           class Response
             include Datadog::Transport::Response

data/lib/ddtrace/transport/http/statistics.rb

@@ -18,11 +18,24 @@ module Datadog
               # Add status code tag to api.responses metric
               if metrics.key?(:api_responses)
                 (metrics[:api_responses].options[:tags] ||= []).tap do |tags|
-                  tags << "status_code:#{response.code}"
+                  tags << metrics_tag_value(response.code)
                 end
               end
             end
           end
+
+          private
+
+          # The most common status code on a healthy tracer
+          STATUS_CODE_200 = 'status_code:200'.freeze
+
+          def metrics_tag_value(status_code)
+            if status_code == 200
+              STATUS_CODE_200 # DEV Saves string concatenation/creation for common case
+            else
+              "status_code:#{status_code}"
+            end
+          end
         end
       end
     end

data/lib/ddtrace/transport/traces.rb

@@ -57,7 +57,12 @@ module Datadog
         # @return [Enumerable[Array[Bytes,Integer]]] list of encoded chunks: each containing a byte array and
         #   number of traces
         def encode_in_chunks(traces)
-          encoded_traces = traces.map { |t| encode_one(t) }.reject(&:nil?)
+          encoded_traces = if traces.respond_to?(:filter_map)
+                             # DEV Supported since Ruby 2.7, saves an intermediate object creation
+                             traces.filter_map { |t| encode_one(t) }
+                           else
+                             traces.map { |t| encode_one(t) }.reject(&:nil?)
+                           end
 
           Datadog::Chunker.chunk_by_size(encoded_traces, max_size).map do |chunk|
             [encoder.join(chunk), chunk.size]
@@ -86,7 +91,7 @@ module Datadog
         module_function
 
         def encode_trace(encoder, trace)
-          encoder.encode(trace.map(&:to_hash))
+          encoder.encode(trace)
         end
       end
 

data/lib/ddtrace/utils.rb

@@ -1,32 +1,31 @@
 require 'ddtrace/utils/database'
+require 'ddtrace/utils/forking'
 
 module Datadog
   # Utils contains low-level utilities, typically to provide pseudo-random trace IDs.
   module Utils
-    STRING_PLACEHOLDER = ''.encode(::Encoding::UTF_8).freeze
+    extend Utils::Forking
+
+    EMPTY_STRING = ''.encode(::Encoding::UTF_8).freeze
     # We use a custom random number generator because we want no interference
     # with the default one. Using the default prng, we could break code that
     # would rely on srand/rand sequences.
 
     # Return a span id
     def self.next_id
-      reset! if was_forked?
-
-      @rnd.rand(Datadog::Span::MAX_ID)
+      after_fork! { reset! }
+      id_rng.rand(Datadog::Span::RUBY_MAX_ID)
     end
 
-    def self.reset!
-      @pid = Process.pid
-      @rnd = Random.new
+    def self.id_rng
+      @id_rng ||= Random.new
     end
 
-    def self.was_forked?
-      Process.pid != @pid
+    def self.reset!
+      @id_rng = Random.new
     end
 
-    private_class_method :reset!, :was_forked?
-
-    reset!
+    private_class_method :id_rng, :reset!
 
     def self.truncate(value, size, omission = '...'.freeze)
       string = value.to_s
@@ -53,13 +52,17 @@ module Datadog
         str.encode('UTF-8', 'binary', invalid: :replace, undef: :replace, replace: '')
       elsif str.encoding == ::Encoding::UTF_8
         str
+      elsif str.empty?
+        # DEV Optimization as `nil.to_s` is a very common source for an empty string,
+        # DEV but it comes encoded as US_ASCII.
+        EMPTY_STRING
       else
         str.encode(::Encoding::UTF_8)
       end
     rescue => e
       Datadog.logger.debug("Error encoding string in UTF-8: #{e}")
 
-      options.fetch(:placeholder, STRING_PLACEHOLDER)
+      options.fetch(:placeholder, EMPTY_STRING)
     end
   end
 end

data/lib/ddtrace/utils/forking.rb

@@ -0,0 +1,52 @@
+module Datadog
+  module Utils
+    # Helper methods for managing forking behavior
+    module Forking
+      def self.included(base)
+        base.send(:prepend, ClassExtensions) if base.is_a?(Class)
+      end
+
+      def self.extended(base)
+        # Explicitly update PID here because there's a case where
+        # the code path that lazily updates the PID may not be exercised
+        # until after a fork occurs, thus causing the event to be missed.
+        # By eagerly setting this, we avoid this scenario.
+        base.update_fork_pid!
+      end
+
+      def after_fork!
+        if forked?
+          yield
+          update_fork_pid!
+          true
+        else
+          false
+        end
+      end
+
+      def forked?
+        Process.pid != fork_pid
+      end
+
+      def update_fork_pid!
+        @fork_pid = Process.pid
+      end
+
+      def fork_pid
+        @fork_pid ||= Process.pid
+      end
+
+      # Adds additional functionality for Classes that implement Forking
+      module ClassExtensions
+        # Addresses an edge case where forking before invoking #update_fork_pid! on the
+        # object will cause forking to not be detected in the fork when it should have.
+        #
+        # This wrapper prevents this by initializing the fork PID when the object is created.
+        def initialize(*args, &block)
+          super
+          update_fork_pid!
+        end
+      end
+    end
+  end
+end

data/lib/ddtrace/version.rb

@@ -1,7 +1,7 @@
 module Datadog
   module VERSION
     MAJOR = 0
-    MINOR = 38
+    MINOR = 43
     PATCH = 0
     PRE = nil
 

data/lib/ddtrace/workers/async.rb

@@ -42,7 +42,7 @@ module Datadog
         end
 
         def run_async?
-          @run_async = false unless instance_variable_defined?(:@run_async)
+          return false unless instance_variable_defined?(:@run_async)
           @run_async == true
         end
 
@@ -55,7 +55,7 @@ module Datadog
         end
 
         def error?
-          @error = nil unless instance_variable_defined?(:@error)
+          return false unless instance_variable_defined?(:@error)
           !@error.nil?
         end
 

data/lib/ddtrace/workers/loop.rb

@@ -33,7 +33,7 @@ module Datadog
       end
 
       def run_loop?
-        @run_loop = false unless instance_variable_defined?(:@run_loop)
+        return false unless instance_variable_defined?(:@run_loop)
         @run_loop == true
       end
 

data/lib/ddtrace/workers/polling.rb

@@ -34,7 +34,7 @@ module Datadog
       end
 
       def enabled?
-        @enabled = true unless instance_variable_defined?(:@enabled)
+        return true unless instance_variable_defined?(:@enabled)
         @enabled
       end
 

data/lib/ddtrace/writer.rb

@@ -42,13 +42,22 @@ module Datadog
 
       # one worker for traces
       @worker = nil
+
+      # Once stopped, this writer instance cannot be restarted.
+      # This allow for graceful shutdown, while preventing
+      # the host application from inadvertently start new
+      # threads during shutdown.
+      @stopped = false
     end
 
     def start
       @mutex_after_fork.synchronize do
+        return false if @stopped
+
         pid = Process.pid
         return if @worker && pid == @pid
         @pid = pid
+
         start_worker
         true
       end
@@ -67,14 +76,23 @@ module Datadog
       @worker.start
     end
 
+    # Gracefully shuts down this writer.
+    #
+    # Once stopped methods calls won't fail, but
+    # no internal work will be performed.
+    #
+    # It is not possible to restart a stopped writer instance.
     def stop
       @mutex_after_fork.synchronize { stop_worker }
     end
 
     def stop_worker
+      @stopped = true
+
       return if @worker.nil?
       @worker.stop
       @worker = nil
+
       true
     end
 
@@ -136,7 +154,7 @@ module Datadog
 
       if worker_local
         worker_local.enqueue_trace(trace)
-      else
+      elsif !@stopped
         Datadog.logger.debug('Writer either failed to start or was stopped before #write could complete')
       end
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ddtrace
 version: !ruby/object:Gem::Version
-  version: 0.38.0
+  version: 0.43.0
 platform: ruby
 authors:
 - Datadog, Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-07-21 00:00:00.000000000 Z
+date: 2020-11-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: msgpack
@@ -52,6 +52,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.4.1
+- !ruby/object:Gem::Dependency
+  name: concurrent-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -333,19 +347,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 0.4.9.2
 - !ruby/object:Gem::Dependency
-  name: warning
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1'
+        version: '0.17'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1'
+        version: '0.17'
 description: |
   ddtrace is Datadog’s tracing client for Ruby. It is used to trace requests
   as they flow across web servers, databases and microservices so that developers
@@ -369,10 +383,13 @@ files:
 - ".dockerignore"
 - ".env"
 - ".github/CODEOWNERS"
+- ".github/workflows/add-milestone-to-pull-requests.yml"
+- ".github/workflows/create-next-milestone.yml"
 - ".gitignore"
 - ".gitlab-ci.yml"
 - ".rspec"
 - ".rubocop.yml"
+- ".simplecov"
 - ".yardopts"
 - Appraisals
 - CHANGELOG.md
@@ -486,6 +503,12 @@ files:
 - lib/ddtrace/contrib/configuration/resolver.rb
 - lib/ddtrace/contrib/configuration/resolvers/pattern_resolver.rb
 - lib/ddtrace/contrib/configuration/settings.rb
+- lib/ddtrace/contrib/cucumber/configuration/settings.rb
+- lib/ddtrace/contrib/cucumber/ext.rb
+- lib/ddtrace/contrib/cucumber/formatter.rb
+- lib/ddtrace/contrib/cucumber/instrumentation.rb
+- lib/ddtrace/contrib/cucumber/integration.rb
+- lib/ddtrace/contrib/cucumber/patcher.rb
 - lib/ddtrace/contrib/dalli/configuration/settings.rb
 - lib/ddtrace/contrib/dalli/ext.rb
 - lib/ddtrace/contrib/dalli/instrumentation.rb
@@ -588,10 +611,16 @@ files:
 - lib/ddtrace/contrib/presto/instrumentation.rb
 - lib/ddtrace/contrib/presto/integration.rb
 - lib/ddtrace/contrib/presto/patcher.rb
+- lib/ddtrace/contrib/que/configuration/settings.rb
+- lib/ddtrace/contrib/que/ext.rb
+- lib/ddtrace/contrib/que/integration.rb
+- lib/ddtrace/contrib/que/patcher.rb
+- lib/ddtrace/contrib/que/tracer.rb
 - lib/ddtrace/contrib/racecar/configuration/settings.rb
 - lib/ddtrace/contrib/racecar/event.rb
 - lib/ddtrace/contrib/racecar/events.rb
 - lib/ddtrace/contrib/racecar/events/batch.rb
+- lib/ddtrace/contrib/racecar/events/consume.rb
 - lib/ddtrace/contrib/racecar/events/message.rb
 - lib/ddtrace/contrib/racecar/ext.rb
 - lib/ddtrace/contrib/racecar/integration.rb
@@ -606,6 +635,7 @@ files:
 - lib/ddtrace/contrib/rails/ext.rb
 - lib/ddtrace/contrib/rails/framework.rb
 - lib/ddtrace/contrib/rails/integration.rb
+- lib/ddtrace/contrib/rails/log_injection.rb
 - lib/ddtrace/contrib/rails/middlewares.rb
 - lib/ddtrace/contrib/rails/patcher.rb
 - lib/ddtrace/contrib/rails/railtie.rb
@@ -635,6 +665,12 @@ files:
 - lib/ddtrace/contrib/rest_client/integration.rb
 - lib/ddtrace/contrib/rest_client/patcher.rb
 - lib/ddtrace/contrib/rest_client/request_patch.rb
+- lib/ddtrace/contrib/rspec/configuration/settings.rb
+- lib/ddtrace/contrib/rspec/example.rb
+- lib/ddtrace/contrib/rspec/example_group.rb
+- lib/ddtrace/contrib/rspec/ext.rb
+- lib/ddtrace/contrib/rspec/integration.rb
+- lib/ddtrace/contrib/rspec/patcher.rb
 - lib/ddtrace/contrib/sequel/configuration/settings.rb
 - lib/ddtrace/contrib/sequel/database.rb
 - lib/ddtrace/contrib/sequel/dataset.rb
@@ -662,6 +698,12 @@ files:
 - lib/ddtrace/contrib/sinatra/patcher.rb
 - lib/ddtrace/contrib/sinatra/tracer.rb
 - lib/ddtrace/contrib/sinatra/tracer_middleware.rb
+- lib/ddtrace/contrib/sneakers/configuration/settings.rb
+- lib/ddtrace/contrib/sneakers/ext.rb
+- lib/ddtrace/contrib/sneakers/integration.rb
+- lib/ddtrace/contrib/sneakers/patcher.rb
+- lib/ddtrace/contrib/sneakers/tracer.rb
+- lib/ddtrace/contrib/status_code_matcher.rb
 - lib/ddtrace/contrib/sucker_punch/configuration/settings.rb
 - lib/ddtrace/contrib/sucker_punch/exception_handler.rb
 - lib/ddtrace/contrib/sucker_punch/ext.rb
@@ -682,13 +724,16 @@ files:
 - lib/ddtrace/event.rb
 - lib/ddtrace/ext/analytics.rb
 - lib/ddtrace/ext/app_types.rb
+- lib/ddtrace/ext/ci.rb
 - lib/ddtrace/ext/correlation.rb
 - lib/ddtrace/ext/diagnostics.rb
 - lib/ddtrace/ext/distributed.rb
 - lib/ddtrace/ext/environment.rb
 - lib/ddtrace/ext/errors.rb
 - lib/ddtrace/ext/forced_tracing.rb
+- lib/ddtrace/ext/git.rb
 - lib/ddtrace/ext/http.rb
+- lib/ddtrace/ext/integration.rb
 - lib/ddtrace/ext/manual_tracing.rb
 - lib/ddtrace/ext/metrics.rb
 - lib/ddtrace/ext/net.rb
@@ -696,6 +741,7 @@ files:
 - lib/ddtrace/ext/runtime.rb
 - lib/ddtrace/ext/sampling.rb
 - lib/ddtrace/ext/sql.rb
+- lib/ddtrace/ext/test.rb
 - lib/ddtrace/ext/transport.rb
 - lib/ddtrace/forced_tracing.rb
 - lib/ddtrace/logger.rb
@@ -774,6 +820,7 @@ files:
 - lib/ddtrace/transport/traces.rb
 - lib/ddtrace/utils.rb
 - lib/ddtrace/utils/database.rb
+- lib/ddtrace/utils/forking.rb
 - lib/ddtrace/utils/time.rb
 - lib/ddtrace/vendor/active_record/connection_specification.rb
 - lib/ddtrace/version.rb
@@ -808,7 +855,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 2.0.0
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.6.2
+rubygems_version: 2.2.5
 signing_key: 
 specification_version: 4
 summary: Datadog tracing code for your Ruby applications