ddtrace 0.42.0 → 0.43.0

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,12 @@
+module Datadog
+  module Ext
+    # Defines constants for Git tags
+    module Git
+      TAG_BRANCH = 'git.branch'.freeze
+      TAG_COMMIT_SHA = 'git.commit.sha'.freeze
+      TAG_DEPRECATED_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/runtime.rb

@@ -10,6 +10,7 @@ module Datadog
       RUBY_ENGINE =  ::RUBY_ENGINE # e.g. 'ruby', 'jruby', 'truffleruby'
       TRACER_VERSION = Datadog::VERSION::STRING
 
+      TAG_ID = 'runtime-id'.freeze
       TAG_LANG = 'language'.freeze
 
       # Metrics

data/lib/ddtrace/ext/test.rb

@@ -0,0 +1,24 @@
+module Datadog
+  module Ext
+    # Defines constants for test tags
+    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
+    end
+  end
+end

data/lib/ddtrace/runtime/identity.rb

@@ -1,22 +1,21 @@
 require 'securerandom'
 require 'ddtrace/ext/runtime'
+require 'ddtrace/utils/forking'
 
 module Datadog
   module Runtime
     # For runtime identity
     module Identity
+      extend Datadog::Utils::Forking
+
       module_function
 
       # Retrieves number of classes from runtime
       def id
-        @pid ||= Process.pid
         @id ||= SecureRandom.uuid
 
         # Check if runtime has changed, e.g. forked.
-        if Process.pid != @pid
-          @pid = Process.pid
-          @id = SecureRandom.uuid
-        end
+        after_fork! { @id = SecureRandom.uuid }
 
         @id
       end

data/lib/ddtrace/sampling/rate_limiter.rb

@@ -38,6 +38,10 @@ module Datadog
         @tokens = max_tokens
         @total_messages = 0
         @conforming_messages = 0
+        @prev_conforming_messages = nil
+        @prev_total_messages = nil
+        @current_window = nil
+
         @last_refill = Utils::Time.get_time
       end
 
@@ -47,28 +51,17 @@ module Datadog
       # If it does, return +true+ and remove +size+
       # tokens from the bucket.
       # If it does not, return +false+ without affecting
-      # the tokens form the bucket.
+      # the tokens from the bucket.
       #
       # @return [Boolean] +true+ if message conforms with current bucket limit
       def allow?(size)
-        return false if @rate.zero?
-        return true if @rate < 0
-
-        refill_since_last_message
-
-        increment_total_count
-
-        return false if @tokens < size
-
-        increment_conforming_count
-
-        @tokens -= size
-
-        true
+        allowed = should_allow?(size)
+        update_rate_counts(allowed)
+        allowed
       end
 
       # Ratio of 'conformance' per 'total messages' checked
-      # on this bucket.
+      # averaged for the past 2 buckets
       #
       # Returns +1.0+ when no messages have been checked yet.
       #
@@ -77,6 +70,20 @@ module Datadog
         return 0.0 if @rate.zero?
         return 1.0 if @rate < 0 || @total_messages.zero?
 
+        return current_window_rate if @prev_conforming_messages.nil? || @prev_total_messages.nil?
+
+        (@conforming_messages.to_f + @prev_conforming_messages.to_f) / (@total_messages + @prev_total_messages)
+      end
+
+      # Ratio of 'conformance' per 'total messages' checked
+      # on this bucket
+      #
+      # Returns +1.0+ when no messages have been checked yet.
+      #
+      # @return [Float] Conformance ratio, between +[0,1]+
+      def current_window_rate
+        return 1.0 if @total_messages.zero?
+
         @conforming_messages.to_f / @total_messages
       end
 
@@ -91,6 +98,8 @@ module Datadog
         now = Utils::Time.get_time
         elapsed = now - @last_refill
 
+        # Update the number of available tokens, but ensure we do not exceed the max
+        # we return the min of tokens + rate*elapsed, or max tokens
         refill_tokens(@rate * elapsed)
 
         @last_refill = now
@@ -108,6 +117,46 @@ module Datadog
       def increment_conforming_count
         @conforming_messages += 1
       end
+
+      def should_allow?(size)
+        # rate limit of 0 blocks everything
+        return false if @rate.zero?
+
+        # negative rate limit disables rate limiting
+        return true if @rate < 0
+
+        refill_since_last_message
+
+        # if tokens < 1 we don't allow?
+        return false if @tokens < size
+
+        @tokens -= size
+
+        true
+      end
+
+      # Sets and Updates the past two 1 second windows for which
+      # the rate limiter must compute it's rate over and updates
+      # the total count, and conforming message count if +allowed+
+      def update_rate_counts(allowed)
+        now = Utils::Time.get_time
+
+        # No tokens have been seen yet, start a new window
+        if @current_window.nil?
+          @current_window = now
+        # If more than 1 second has past since last window, reset
+        elsif now - @current_window >= 1
+          @prev_conforming_messages = @conforming_messages
+          @prev_total_messages = @total_messages
+          @conforming_messages = 0
+          @total_messages = 0
+          @current_window = now
+        end
+
+        increment_conforming_count if allowed
+
+        increment_total_count
+      end
     end
 
     # \RateLimiter that accepts all resources,

data/lib/ddtrace/tracer.rb

@@ -7,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'
@@ -201,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
@@ -287,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?

data/lib/ddtrace/utils.rb

@@ -1,8 +1,11 @@
 require 'ddtrace/utils/database'
+require 'ddtrace/utils/forking'
 
 module Datadog
   # Utils contains low-level utilities, typically to provide pseudo-random trace IDs.
   module Utils
+    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
@@ -10,23 +13,19 @@ module Datadog
 
     # Return a span id
     def self.next_id
-      reset! if was_forked?
-
-      @rnd.rand(Datadog::Span::RUBY_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

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 = 42
+    MINOR = 43
     PATCH = 0
     PRE = nil
 

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.42.0
+  version: 0.43.0
 platform: ruby
 authors:
 - Datadog, Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-10-21 00:00:00.000000000 Z
+date: 2020-11-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: msgpack
@@ -122,20 +122,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.1'
-- !ruby/object:Gem::Dependency
-  name: ruby-prof
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.4'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.4'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -374,20 +360,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.17'
-- !ruby/object:Gem::Dependency
-  name: warning
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1'
 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
@@ -411,6 +383,8 @@ files:
 - ".dockerignore"
 - ".env"
 - ".github/CODEOWNERS"
+- ".github/workflows/add-milestone-to-pull-requests.yml"
+- ".github/workflows/create-next-milestone.yml"
 - ".gitignore"
 - ".gitlab-ci.yml"
 - ".rspec"
@@ -529,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
@@ -685,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
@@ -717,6 +703,7 @@ files:
 - 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
@@ -737,12 +724,14 @@ 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
@@ -752,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
@@ -830,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
@@ -863,7 +854,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 2.0.0
 requirements: []
-rubygems_version: 3.0.3
+rubyforge_project: 
+rubygems_version: 2.2.5
 signing_key: 
 specification_version: 4
 summary: Datadog tracing code for your Ruby applications