ddtrace 0.38.0

data/lib/ddtrace/sampling.rb

@@ -0,0 +1,2 @@
+require 'ddtrace/sampling/rule'
+require 'ddtrace/sampling/rule_sampler'

data/lib/ddtrace/sampling/matcher.rb

@@ -0,0 +1,57 @@
+module Datadog
+  module Sampling
+    # Checks if a span conforms to a matching criteria.
+    class Matcher
+      # Returns `true` if the span should conforms to this rule, `false` otherwise
+      #
+      # @abstract
+      # @param [Span] span
+      # @return [Boolean]
+      def match?(span)
+        raise NotImplementedError
+      end
+    end
+
+    # A \Matcher that supports matching a span by
+    # operation name and/or service name.
+    class SimpleMatcher < Matcher
+      # Returns `true` for case equality (===) with any object
+      MATCH_ALL = Class.new do
+        # DEV: A class that implements `#===` is ~20% faster than
+        # DEV: a `Proc` that always returns `true`.
+        def ===(other)
+          true
+        end
+      end.new
+
+      attr_reader :name, :service
+
+      # @param name [String,Regexp,Proc] Matcher for case equality (===) with the span name, defaults to always match
+      # @param service [String,Regexp,Proc] Matcher for case equality (===) with the service name, defaults to always match
+      def initialize(name: MATCH_ALL, service: MATCH_ALL)
+        @name = name
+        @service = service
+      end
+
+      def match?(span)
+        name === span.name && service === span.service
+      end
+    end
+
+    # A \Matcher that allows for arbitrary span matching
+    # based on the return value of a provided block.
+    class ProcMatcher < Matcher
+      attr_reader :block
+
+      # @yield [name, service] Provides span name and service to the block
+      # @yieldreturn [Boolean] Whether the span conforms to this matcher
+      def initialize(&block)
+        @block = block
+      end
+
+      def match?(span)
+        block.call(span.name, span.service)
+      end
+    end
+  end
+end

data/lib/ddtrace/sampling/rate_limiter.rb

@@ -0,0 +1,127 @@
+require 'ddtrace/utils/time'
+
+module Datadog
+  module Sampling
+    # Checks for rate limiting on a resource.
+    class RateLimiter
+      # Checks if resource of specified size can be
+      # conforms with the current limit.
+      #
+      # Implementations of this method are not guaranteed
+      # to be side-effect free.
+      #
+      # @return [Boolean] whether a resource conforms with the current limit
+      def allow?(size); end
+
+      # The effective rate limiting ratio based on
+      # recent calls to `allow?`.
+      #
+      # @return [Float] recent allowance ratio
+      def effective_rate; end
+    end
+
+    # Implementation of the Token Bucket metering algorithm
+    # for rate limiting.
+    #
+    # @see https://en.wikipedia.org/wiki/Token_bucket Token bucket
+    class TokenBucket < RateLimiter
+      attr_reader :rate, :max_tokens
+
+      # @param rate [Numeric] Allowance rate, in units per second
+      #  if rate is negative, always allow
+      #  if rate is zero, never allow
+      # @param max_tokens [Numeric] Limit of available tokens
+      def initialize(rate, max_tokens = rate)
+        @rate = rate
+        @max_tokens = max_tokens
+
+        @tokens = max_tokens
+        @total_messages = 0
+        @conforming_messages = 0
+        @last_refill = Utils::Time.get_time
+      end
+
+      # Checks if a message of provided +size+
+      # conforms with the current bucket limit.
+      #
+      # 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.
+      #
+      # @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
+      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 effective_rate
+        return 0.0 if @rate.zero?
+        return 1.0 if @rate < 0 || @total_messages.zero?
+
+        @conforming_messages.to_f / @total_messages
+      end
+
+      # @return [Numeric] number of tokens currently available
+      def available_tokens
+        @tokens
+      end
+
+      private
+
+      def refill_since_last_message
+        now = Utils::Time.get_time
+        elapsed = now - @last_refill
+
+        refill_tokens(@rate * elapsed)
+
+        @last_refill = now
+      end
+
+      def refill_tokens(size)
+        @tokens += size
+        @tokens = @max_tokens if @tokens > @max_tokens
+      end
+
+      def increment_total_count
+        @total_messages += 1
+      end
+
+      def increment_conforming_count
+        @conforming_messages += 1
+      end
+    end
+
+    # \RateLimiter that accepts all resources,
+    # with no limits.
+    class UnlimitedLimiter < RateLimiter
+      # @return [Boolean] always +true+
+      def allow?(_)
+        true
+      end
+
+      # @return [Float] always 100%
+      def effective_rate
+        1.0
+      end
+    end
+  end
+end

data/lib/ddtrace/sampling/rule.rb

@@ -0,0 +1,61 @@
+require 'forwardable'
+
+require 'ddtrace/sampling/matcher'
+require 'ddtrace/sampler'
+
+module Datadog
+  module Sampling
+    # Sampling rule that dictates if a span matches
+    # a specific criteria and what sampling strategy to
+    # apply in case of a positive match.
+    class Rule
+      extend Forwardable
+
+      attr_reader :matcher, :sampler
+
+      # @param [Matcher] matcher A matcher to verify span conformity against
+      # @param [Sampler] sampler A sampler to be consulted on a positive match
+      def initialize(matcher, sampler)
+        @matcher = matcher
+        @sampler = sampler
+      end
+
+      # Evaluates if the provided `span` conforms to the `matcher`.
+      #
+      # @param [Span] span
+      # @return [Boolean] whether this rules applies to the span
+      # @return [NilClass] if the matcher fails errs during evaluation
+      def match?(span)
+        @matcher.match?(span)
+      rescue => e
+        Datadog.logger.error("Matcher failed. Cause: #{e.message} Source: #{e.backtrace.first}")
+        nil
+      end
+
+      def_delegators :@sampler, :sample?, :sample_rate
+    end
+
+    # A \Rule that matches a span based on
+    # operation name and/or service name and
+    # applies a fixed sampling to matching spans.
+    class SimpleRule < Rule
+      # @param name [String,Regexp,Proc] Matcher for case equality (===) with the span name, defaults to always match
+      # @param service [String,Regexp,Proc] Matcher for case equality (===) with the service name, defaults to always match
+      # @param sample_rate [Float] Sampling rate between +[0,1]+
+      def initialize(name: SimpleMatcher::MATCH_ALL, service: SimpleMatcher::MATCH_ALL, sample_rate: 1.0)
+        # 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.
+        sampler = Datadog::RateSampler.new
+        sampler.sample_rate = sample_rate
+
+        super(SimpleMatcher.new(name: name, service: service), sampler)
+      end
+    end
+  end
+end

data/lib/ddtrace/sampling/rule_sampler.rb

@@ -0,0 +1,125 @@
+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
+
+      AGENT_RATE_METRIC_KEY = '_dd.agent_psr'.freeze
+
+      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: Datadog.configuration.sampling.rate_limit,
+                     rate_limiter: nil,
+                     default_sample_rate: Datadog.configuration.sampling.default_rate,
+                     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
+                             RateByServiceSampler.new(1.0, env: -> { Datadog.tracer.tags[:env] })
+                           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) do |s|
+          @default_sampler.sample!(s).tap do
+            # We want to make sure the span is tagged with the agent-derived
+            # service rate. Retrieve this from the rate by service sampler.
+            # Only do this if it was set by a RateByServiceSampler.
+            if @default_sampler.is_a?(RateByServiceSampler)
+              s.set_metric(AGENT_RATE_METRIC_KEY, @default_sampler.sample_rate(span))
+            end
+          end
+        end
+
+        sampled.tap do
+          span.sampled = sampled
+        end
+      end
+
+      def update(*args)
+        return false unless @default_sampler.respond_to?(:update)
+        @default_sampler.update(*args)
+      end
+
+      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.logger.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

@@ -0,0 +1,307 @@
+require 'time'
+require 'thread'
+
+require 'ddtrace/utils'
+require 'ddtrace/ext/errors'
+require 'ddtrace/ext/priority'
+require 'ddtrace/environment'
+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.
+  # Each span consists of a start time and a duration. For example, a span can describe the time
+  # spent on a distributed call on a separate machine, or the time spent in a small component
+  # within a larger operation. Spans can be nested within each other, and in those instances
+  # will have a parent-child relationship.
+  #
+  # rubocop:disable Metrics/ClassLength
+  class Span
+    prepend Analytics::Span
+    prepend ForcedTracing::Span
+
+    # The max value for a \Span identifier.
+    # Span and trace identifiers should be strictly positive and strictly inferior to this limit.
+    #
+    # Limited to 63-bit positive integers, as some other languages might be limited to this,
+    # and IDs need to be easy to port across various languages and platforms.
+    MAX_ID = 2**63
+
+    # While we only generate 63-bit integers due to limitations in other languages, we support
+    # parsing 64-bit integers for distributed tracing since an upstream system may generate one
+    EXTERNAL_MAX_ID = 2**64
+
+    # This limit is for numeric tags because uint64 could end up rounded.
+    NUMERIC_TAG_SIZE_RANGE = (-2**53..2**53)
+
+    attr_accessor :name, :service, :resource, :span_type,
+                  :start_time, :end_time,
+                  :span_id, :trace_id, :parent_id,
+                  :status, :sampled,
+                  :tracer, :context
+
+    attr_reader :parent
+    # Create a new span linked to the given tracer. Call the \Tracer method <tt>start_span()</tt>
+    # and then <tt>finish()</tt> once the tracer operation is over.
+    #
+    # * +service+: the service name for this span
+    # * +resource+: the resource this span refers, or +name+ if it's missing
+    # * +span_type+: the type of the span (such as +http+, +db+ and so on)
+    # * +parent_id+: the identifier of the parent span
+    # * +trace_id+: the identifier of the root span for this trace
+    # * +context+: the context of the span
+    def initialize(tracer, name, options = {})
+      @tracer = tracer
+
+      @name = name
+      @service = options.fetch(:service, nil)
+      @resource = options.fetch(:resource, name)
+      @span_type = options.fetch(:span_type, nil)
+
+      @span_id = Datadog::Utils.next_id
+      @parent_id = options.fetch(:parent_id, 0)
+      @trace_id = options.fetch(:trace_id, Datadog::Utils.next_id)
+
+      @context = options.fetch(:context, nil)
+
+      @meta = {}
+      @metrics = {}
+      @status = 0
+
+      @parent = nil
+      @sampled = true
+
+      @start_time = nil # set by Tracer.start_span
+      @end_time = nil # set by Span.finish
+
+      @allocation_count_start = now_allocations
+      @allocation_count_finish = @allocation_count_start
+    end
+
+    # Set the given key / value tag pair on the span. Keys and values
+    # must be strings. A valid example is:
+    #
+    #   span.set_tag('http.method', request.method)
+    def set_tag(key, value = nil)
+      # Keys must be unique between tags and metrics
+      @metrics.delete(key)
+
+      # Ensure `http.status_code` is always a string so it is added to
+      #   @meta instead of @metrics
+      # DEV: This is necessary because the agent looks to `meta['http.status_code']` for
+      #   tagging necessary metrics
+      value = value.to_s if key == Ext::HTTP::STATUS_CODE
+
+      # NOTE: Adding numeric tags as metrics is stop-gap support
+      #       for numeric typed tags. Eventually they will become
+      #       tags again.
+      # Any numeric that is not an integer greater than max size is logged as a metric.
+      # Everything else gets logged as a tag.
+      if value.is_a?(Numeric) && !(value.is_a?(Integer) && !NUMERIC_TAG_SIZE_RANGE.cover?(value))
+        set_metric(key, value)
+      else
+        @meta[key] = value.to_s
+      end
+    rescue StandardError => e
+      Datadog.logger.debug("Unable to set the tag #{key}, ignoring it. Caused by: #{e}")
+    end
+
+    # Sets tags from given hash, for each key in hash it sets the tag with that key
+    # and associated value from the hash. It is shortcut for `set_tag`. Keys and values
+    # of the hash must be strings. Note that nested hashes are not supported.
+    # A valid example is:
+    #
+    #   span.set_tags({ "http.method" => "GET", "user.id" => "234" })
+    def set_tags(tags)
+      tags.each { |k, v| set_tag(k, v) }
+    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] || @metrics[key]
+    end
+
+    # This method sets a tag with a floating point value for the given key. It acts
+    # like `set_tag()` and it simply add a tag without further processing.
+    def set_metric(key, value)
+      # Keys must be unique between tags and metrics
+      @meta.delete(key)
+
+      # enforce that the value is a floating point number
+      value = Float(value)
+      @metrics[key] = value
+    rescue StandardError => e
+      Datadog.logger.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] || @meta[key]
+    end
+
+    # Mark the span with the given error.
+    def set_error(e)
+      e = Error.build_from(e)
+
+      @status = Ext::Errors::STATUS
+      set_tag(Ext::Errors::TYPE, e.type) unless e.type.empty?
+      set_tag(Ext::Errors::MSG, e.message) unless e.message.empty?
+      set_tag(Ext::Errors::STACK, e.backtrace) unless e.backtrace.empty?
+    end
+
+    # Mark the span finished at the current time and submit it.
+    def finish(finish_time = nil)
+      # A span should not be finished twice. Note that this is not thread-safe,
+      # finish is called from multiple threads, a given span might be finished
+      # several times. Again, one should not do this, so this test is more a
+      # fallback to avoid very bad things and protect you in most common cases.
+      return if finished?
+
+      @allocation_count_finish = now_allocations
+
+      # Provide a default start_time if unset, but this should have been set by start_span.
+      # Using now here causes 0-duration spans, still, this is expected, as we never
+      # explicitely say when it started.
+      @start_time ||= Time.now.utc
+
+      @end_time = finish_time.nil? ? Time.now.utc : finish_time # finish this
+
+      # Finish does not really do anything if the span is not bound to a tracer and a context.
+      return self if @tracer.nil? || @context.nil?
+
+      # spans without a service would be dropped, so here we provide a default.
+      # This should really never happen with integrations in contrib, as a default
+      # service is always set. It's only for custom instrumentation.
+      @service ||= (@tracer && @tracer.default_service)
+
+      begin
+        @context.close_span(self)
+        @tracer.record(self)
+      rescue StandardError => e
+        Datadog.logger.debug("error recording finished trace: #{e}")
+        Datadog.health_metrics.error_span_finish(1, tags: ["error:#{e.class.name}"])
+      end
+      self
+    end
+
+    # Return whether the span is finished or not.
+    def finished?
+      !@end_time.nil?
+    end
+
+    # Return a string representation of the span.
+    def to_s
+      "Span(name:#{@name},sid:#{@span_id},tid:#{@trace_id},pid:#{@parent_id})"
+    end
+
+    # DEPRECATED: remove this function in the next release, replaced by ``parent=``
+    def set_parent(parent)
+      self.parent = parent
+    end
+
+    # Set this span's parent, inheriting any properties not explicitly set.
+    # If the parent is nil, set the span zero values.
+    def parent=(parent)
+      @parent = parent
+
+      if parent.nil?
+        @trace_id = @span_id
+        @parent_id = 0
+      else
+        @trace_id = parent.trace_id
+        @parent_id = parent.span_id
+        @service ||= parent.service
+        @sampled = parent.sampled
+      end
+    end
+
+    def allocations
+      @allocation_count_finish - @allocation_count_start
+    end
+
+    # Return the hash representation of the current span.
+    def to_hash
+      h = {
+        span_id: @span_id,
+        parent_id: @parent_id,
+        trace_id: @trace_id,
+        name: @name,
+        service: @service,
+        resource: @resource,
+        type: @span_type,
+        meta: @meta,
+        metrics: @metrics,
+        allocations: allocations,
+        error: @status
+      }
+
+      if !@start_time.nil? && !@end_time.nil?
+        h[:start] = (@start_time.to_f * 1e9).to_i
+        h[:duration] = ((@end_time - @start_time) * 1e9).to_i
+      end
+
+      h
+    end
+
+    # Return a human readable version of the span
+    def pretty_print(q)
+      start_time = (@start_time.to_f * 1e9).to_i rescue '-'
+      end_time = (@end_time.to_f * 1e9).to_i rescue '-'
+      duration = ((@end_time - @start_time) * 1e9).to_i rescue 0
+      q.group 0 do
+        q.breakable
+        q.text "Name: #{@name}\n"
+        q.text "Span ID: #{@span_id}\n"
+        q.text "Parent ID: #{@parent_id}\n"
+        q.text "Trace ID: #{@trace_id}\n"
+        q.text "Type: #{@span_type}\n"
+        q.text "Service: #{@service}\n"
+        q.text "Resource: #{@resource}\n"
+        q.text "Error: #{@status}\n"
+        q.text "Start: #{start_time}\n"
+        q.text "End: #{end_time}\n"
+        q.text "Duration: #{duration}\n"
+        q.text "Allocations: #{allocations}\n"
+        q.group(2, 'Tags: [', "]\n") do
+          q.breakable
+          q.seplist @meta.each do |key, value|
+            q.text "#{key} => #{value}"
+          end
+        end
+        q.group(2, 'Metrics: [', ']') do
+          q.breakable
+          q.seplist @metrics.each do |key, value|
+            q.text "#{key} => #{value}"
+          end
+        end
+      end
+    end
+
+    private
+
+    if defined?(JRUBY_VERSION) || Gem::Version.new(RUBY_VERSION) < Gem::Version.new(VERSION::MINIMUM_RUBY_VERSION)
+      def now_allocations
+        0
+      end
+    elsif Gem::Version.new(RUBY_VERSION) < Gem::Version.new('2.2.0')
+      def now_allocations
+        GC.stat.fetch(:total_allocated_object)
+      end
+    else
+      def now_allocations
+        GC.stat(:total_allocated_objects)
+      end
+    end
+  end
+end