ddtrace 0.29.1 → 0.30.0

data/lib/ddtrace/sampling/rule_sampler.rb

@@ -0,0 +1,111 @@
+require 'forwardable'
+
+require 'ddtrace/ext/priority'
+
+require 'ddtrace/ext/sampling'
+require 'ddtrace/sampler'
+require 'ddtrace/sampling/rate_limiter'
+
+module Datadog
+  module Sampling
+    # Span {Sampler} that applies a set of {Rule}s to decide
+    # on sampling outcome. Then, a rate limiter is applied.
+    #
+    # If a span does not conform to any rules, a default
+    # sampling strategy is applied.
+    class RuleSampler
+      extend Forwardable
+
+      attr_reader :rules, :rate_limiter, :default_sampler
+
+      # @param rules [Array<Rule>] ordered list of rules to be applied to a span
+      # @param rate_limit [Float] number of traces per second, defaults to 100
+      # @param rate_limiter [RateLimiter] limiter applied after rule matching
+      # @param default_sample_rate [Float] fallback sample rate when no rules apply to a span,
+      #   between +[0,1]+, defaults to +1+
+      # @param default_sampler [Sample] fallback strategy when no rules apply to a span
+      def initialize(rules = [],
+                     rate_limit: nil,
+                     rate_limiter: nil,
+                     default_sample_rate: nil,
+                     default_sampler: nil)
+
+        @rules = rules
+
+        @rate_limiter = if rate_limiter
+                          rate_limiter
+                        elsif rate_limit
+                          Datadog::Sampling::TokenBucket.new(rate_limit)
+                        else
+                          Datadog::Sampling::UnlimitedLimiter.new
+                        end
+
+        @default_sampler = if default_sampler
+                             default_sampler
+                           elsif default_sample_rate
+                             # We want to allow 0.0 to drop all traces, but \RateSampler
+                             # considers 0.0 an invalid rate and falls back to 100% sampling.
+                             #
+                             # We address that here by not setting the rate in the constructor,
+                             # but using the setter method.
+                             #
+                             # We don't want to make this change directly to \RateSampler
+                             # because it breaks its current contract to existing users.
+                             Datadog::RateSampler.new.tap { |s| s.sample_rate = default_sample_rate }
+                           else
+                             Datadog::AllSampler.new
+                           end
+      end
+
+      # /RuleSampler's components (it's rate limiter, for example) are
+      # not be guaranteed to be size-effect free.
+      # It is not possible to guarantee that a call to {#sample?} will
+      # return the same result as a successive call to {#sample!} with the same span.
+      #
+      # Use {#sample!} instead
+      def sample?(_span)
+        raise 'RuleSampler cannot be evaluated without side-effects'
+      end
+
+      def sample!(span)
+        sampled = sample_span(span) { |s| @default_sampler.sample!(s) }
+
+        sampled.tap do
+          span.sampled = sampled
+        end
+      end
+
+      def_delegators :@default_sampler, :update
+
+      private
+
+      def sample_span(span)
+        rule = @rules.find { |r| r.match?(span) }
+
+        return yield(span) if rule.nil?
+
+        sampled = rule.sample?(span)
+        sample_rate = rule.sample_rate(span)
+
+        set_rule_metrics(span, sample_rate)
+
+        return false unless sampled
+
+        rate_limiter.allow?(1).tap do
+          set_limiter_metrics(span, rate_limiter.effective_rate)
+        end
+      rescue StandardError => e
+        Datadog::Tracer.log.error("Rule sampling failed. Cause: #{e.message} Source: #{e.backtrace.first}")
+        yield(span)
+      end
+
+      def set_rule_metrics(span, sample_rate)
+        span.set_metric(Ext::Sampling::RULE_SAMPLE_RATE, sample_rate)
+      end
+
+      def set_limiter_metrics(span, limiter_rate)
+        span.set_metric(Ext::Sampling::RATE_LIMITER_RATE, limiter_rate)
+      end
+    end
+  end
+end

data/lib/ddtrace/span.rb

@@ -6,6 +6,7 @@ require 'ddtrace/ext/errors'
 require 'ddtrace/ext/priority'
 require 'ddtrace/analytics'
 require 'ddtrace/forced_tracing'
+require 'ddtrace/diagnostics/health'
 
 module Datadog
   # Represents a logical unit of work in the system. Each trace consists of one or more spans.
@@ -84,6 +85,11 @@ module Datadog
       Datadog::Tracer.log.debug("Unable to set the tag #{key}, ignoring it. Caused by: #{e}")
     end
 
+    # This method removes a tag for the given key.
+    def clear_tag(key)
+      @meta.delete(key)
+    end
+
     # Return the tag with the given key, nil if it doesn't exist.
     def get_tag(key)
       @meta[key]
@@ -99,6 +105,11 @@ module Datadog
       Datadog::Tracer.log.debug("Unable to set the metric #{key}, ignoring it. Caused by: #{e}")
     end
 
+    # This method removes a metric for the given key. It acts like {#remove_tag}.
+    def clear_metric(key)
+      @metrics.delete(key)
+    end
+
     # Return the metric with the given key, nil if it doesn't exist.
     def get_metric(key)
       @metrics[key]
@@ -144,6 +155,7 @@ module Datadog
         @tracer.record(self)
       rescue StandardError => e
         Datadog::Tracer.log.debug("error recording finished trace: #{e}")
+        Diagnostics::Health.metrics.error_span_finish(1, tags: ["error:#{e.class.name}"])
       end
       self
     end

data/lib/ddtrace/tracer.rb

@@ -10,6 +10,7 @@ require 'ddtrace/provider'
 require 'ddtrace/logger'
 require 'ddtrace/writer'
 require 'ddtrace/sampler'
+require 'ddtrace/sampling'
 require 'ddtrace/correlation'
 
 # \Datadog global namespace that includes all tracing functionality for Tracer and Span classes.

data/lib/ddtrace/version.rb

@@ -1,8 +1,8 @@
 module Datadog
   module VERSION
     MAJOR = 0
-    MINOR = 29
-    PATCH = 1
+    MINOR = 30
+    PATCH = 0
     PRE = nil
 
     STRING = [MAJOR, MINOR, PATCH, PRE].compact.join('.')

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ddtrace
 version: !ruby/object:Gem::Version
-  version: 0.29.1
+  version: 0.30.0
 platform: ruby
 authors:
 - Datadog, Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-11-26 00:00:00.000000000 Z
+date: 2019-12-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: msgpack
@@ -276,6 +276,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.4.9.2
+- !ruby/object:Gem::Dependency
+  name: warning
+  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'
 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
@@ -341,6 +355,10 @@ files:
 - lib/ddtrace/contrib/action_pack/patcher.rb
 - lib/ddtrace/contrib/action_pack/utils.rb
 - lib/ddtrace/contrib/action_view/configuration/settings.rb
+- lib/ddtrace/contrib/action_view/event.rb
+- lib/ddtrace/contrib/action_view/events.rb
+- lib/ddtrace/contrib/action_view/events/render_partial.rb
+- lib/ddtrace/contrib/action_view/events/render_template.rb
 - lib/ddtrace/contrib/action_view/ext.rb
 - lib/ddtrace/contrib/action_view/instrumentation/partial_renderer.rb
 - lib/ddtrace/contrib/action_view/instrumentation/template_renderer.rb
@@ -565,6 +583,7 @@ files:
 - lib/ddtrace/ext/net.rb
 - lib/ddtrace/ext/priority.rb
 - lib/ddtrace/ext/runtime.rb
+- lib/ddtrace/ext/sampling.rb
 - lib/ddtrace/ext/sql.rb
 - lib/ddtrace/ext/transport.rb
 - lib/ddtrace/forced_tracing.rb
@@ -607,6 +626,11 @@ files:
 - lib/ddtrace/runtime/socket.rb
 - lib/ddtrace/runtime/thread_count.rb
 - lib/ddtrace/sampler.rb
+- lib/ddtrace/sampling.rb
+- lib/ddtrace/sampling/matcher.rb
+- lib/ddtrace/sampling/rate_limiter.rb
+- lib/ddtrace/sampling/rule.rb
+- lib/ddtrace/sampling/rule_sampler.rb
 - lib/ddtrace/span.rb
 - lib/ddtrace/sync_writer.rb
 - lib/ddtrace/tracer.rb
@@ -660,8 +684,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.14
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
 summary: Datadog tracing code for your Ruby applications