ddtrace 0.53.0 → 1.0.0.beta1

data/lib/ddtrace/tracer.rb

@@ -1,449 +0,0 @@
-# typed: true
-require 'logger'
-require 'pathname'
-
-require 'ddtrace/ext/environment'
-require 'ddtrace/span'
-require 'ddtrace/context'
-require 'ddtrace/logger'
-require 'ddtrace/writer'
-require 'datadog/core/environment/identity'
-require 'ddtrace/sampler'
-require 'ddtrace/sampling'
-require 'ddtrace/correlation'
-require 'ddtrace/event'
-require 'ddtrace/utils/only_once'
-
-# \Datadog global namespace that includes all tracing functionality for Tracer and Span classes.
-module Datadog
-  # A \Tracer keeps track of the time spent by an application processing a single operation. For
-  # example, a trace can be used to track the entire time spent processing a complicated web request.
-  # Even though the request may require multiple resources and machines to handle the request, all
-  # of these function calls and sub-requests would be encapsulated within a single trace.
-  # rubocop:disable Metrics/ClassLength
-  class Tracer
-    SERVICES_DEPRECATION_WARN_ONLY_ONCE = Datadog::Utils::OnlyOnce.new
-    SET_SERVICE_INFO_DEPRECATION_WARN_ONLY_ONCE = Datadog::Utils::OnlyOnce.new
-
-    attr_reader :sampler, :tags, :provider, :context_flush
-    attr_accessor :enabled, :writer
-    attr_writer :default_service
-
-    ALLOWED_SPAN_OPTIONS = [:service, :resource, :span_type].freeze
-    DEFAULT_ON_ERROR = proc { |span, error| span.set_error(error) unless span.nil? }
-
-    def services
-      SERVICES_DEPRECATION_WARN_ONLY_ONCE.run do
-        Datadog.logger.warn('services: Usage of Tracer.services has been deprecated')
-      end
-
-      {}
-    end
-
-    # Shorthand that calls the `shutdown!` method of a registered worker.
-    # It's useful to ensure that the Trace Buffer is properly flushed before
-    # shutting down the application.
-    #
-    # For instance:
-    #
-    #   tracer.trace('operation_name', service='rake_tasks') do |span|
-    #     span.set_tag('task.name', 'script')
-    #   end
-    #
-    #   tracer.shutdown!
-    #
-    def shutdown!
-      return unless @enabled
-
-      @writer.stop unless @writer.nil?
-    end
-
-    # Return the current active \Context for this traced execution. This method is
-    # automatically called when calling Tracer.trace or Tracer.start_span,
-    # but it can be used in the application code during manual instrumentation.
-    #
-    # This method makes use of a \ContextProvider that is automatically set during the tracer
-    # initialization, or while using a library instrumentation.
-    def call_context(key = nil)
-      @provider.context(key)
-    end
-
-    # Initialize a new \Tracer used to create, sample and submit spans that measure the
-    # time of sections of code. Available +options+ are:
-    #
-    # * +enabled+: set if the tracer submits or not spans to the local agent. It's enabled
-    #   by default.
-    def initialize(options = {})
-      # Configurable options
-      @context_flush = if options[:context_flush]
-                         options[:context_flush]
-                       elsif options[:partial_flush]
-                         Datadog::ContextFlush::Partial.new(options)
-                       else
-                         Datadog::ContextFlush::Finished.new
-                       end
-
-      @default_service = options[:default_service]
-      @enabled = options.fetch(:enabled, true)
-      @provider = options[:context_provider] || Datadog::DefaultContextProvider.new
-      @sampler = options.fetch(:sampler, Datadog::AllSampler.new)
-      @tags = options.fetch(:tags, {})
-      @writer = options.fetch(:writer) { Datadog::Writer.new }
-
-      # Instance variables
-      @mutex = Mutex.new
-
-      # Enable priority sampling by default
-      activate_priority_sampling!(@sampler)
-    end
-
-    # Updates the current \Tracer instance, so that the tracer can be configured after the
-    # initialization. Available +options+ are:
-    #
-    # * +enabled+: set if the tracer submits or not spans to the trace agent
-    # * +hostname+: change the location of the trace agent
-    # * +port+: change the port of the trace agent
-    # * +partial_flush+: enable partial trace flushing
-    #
-    # For instance, if the trace agent runs in a different location, just:
-    #
-    #   tracer.configure(hostname: 'agent.service.consul', port: '8777')
-    #
-    def configure(options = {})
-      enabled = options.fetch(:enabled, nil)
-
-      # Those are rare "power-user" options.
-      sampler = options.fetch(:sampler, nil)
-
-      @enabled = enabled unless enabled.nil?
-      @sampler = sampler unless sampler.nil?
-
-      configure_writer(options)
-
-      if options.key?(:context_flush) || options.key?(:partial_flush)
-        @context_flush = if options[:context_flush]
-                           options[:context_flush]
-                         elsif options[:partial_flush]
-                           Datadog::ContextFlush::Partial.new(options)
-                         else
-                           Datadog::ContextFlush::Finished.new
-                         end
-      end
-    end
-
-    # Set the information about the given service. A valid example is:
-    #
-    #   tracer.set_service_info('web-application', 'rails', 'web')
-    #
-    # set_service_info is deprecated, no service information needs to be tracked
-    def set_service_info(service, app, app_type)
-      SET_SERVICE_INFO_DEPRECATION_WARN_ONLY_ONCE.run do
-        Datadog.logger.warn(%(
-          set_service_info: Usage of set_service_info has been deprecated,
-          service information no longer needs to be reported to the trace agent.
-        ))
-      end
-    end
-
-    # A default value for service. One should really override this one
-    # for non-root spans which have a parent. However, root spans without
-    # a service would be invalid and rejected.
-    def default_service
-      @default_service ||= Datadog::Ext::Environment::FALLBACK_SERVICE_NAME
-    end
-
-    # Set the given key / value tag pair at the tracer level. These tags will be
-    # appended to each span created by the tracer. Keys and values must be strings.
-    # A valid example is:
-    #
-    #   tracer.set_tags('env' => 'prod', 'component' => 'core')
-    def set_tags(tags)
-      string_tags = tags.collect { |k, v| [k.to_s, v] }.to_h
-      @tags = @tags.merge(string_tags)
-    end
-
-    # Guess context and parent from child_of entry.
-    def guess_context_and_parent(child_of)
-      # call_context should not be in this code path, as start_span
-      # should never try and pick an existing context, but only get
-      # it from the parameters passed to it (child_of)
-      return [Datadog::Context.new, nil] unless child_of
-
-      return [child_of, child_of.current_span] if child_of.is_a?(Context)
-
-      [child_of.context, child_of]
-    end
-
-    # Return a span that will trace an operation called \name. This method allows
-    # parenting passing \child_of as an option. If it's missing, the newly created span is a
-    # root span. Available options are:
-    #
-    # * +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)
-    # * +child_of+: a \Span or a \Context instance representing the parent for this span.
-    # * +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[:start_time]
-      tags = options.fetch(:tags, {})
-
-      span_options = options.select do |k, _v|
-        # Filter options, we want no side effects with unexpected args.
-        ALLOWED_SPAN_OPTIONS.include?(k)
-      end
-
-      ctx, parent = guess_context_and_parent(options[:child_of])
-      span_options[:context] = ctx unless ctx.nil?
-
-      span = Span.new(self, name, span_options)
-      if parent.nil?
-        # root span
-        @sampler.sample!(span)
-        span.set_tag(Datadog::Ext::Runtime::TAG_PID, Process.pid)
-        span.set_tag(Datadog::Ext::Runtime::TAG_ID, Datadog::Core::Environment::Identity.id)
-
-        if ctx && ctx.trace_id
-          span.trace_id = ctx.trace_id
-          span.parent_id = ctx.span_id unless ctx.span_id.nil?
-        end
-      else
-        # 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(start_time)
-
-      # this could at some point be optional (start_active_span vs start_manual_span)
-      ctx.add_span(span) unless ctx.nil?
-
-      span
-    end
-
-    # Return a +span+ that will trace an operation called +name+. You could trace your code
-    # using a <tt>do-block</tt> like:
-    #
-    #   tracer.trace('web.request') do |span|
-    #     span.service = 'my-web-site'
-    #     span.resource = '/'
-    #     span.set_tag('http.method', request.request_method)
-    #     do_something()
-    #   end
-    #
-    # The <tt>tracer.trace()</tt> method can also be used without a block in this way:
-    #
-    #   span = tracer.trace('web.request', service: 'my-web-site')
-    #   do_something()
-    #   span.finish()
-    #
-    # Remember that in this case, calling <tt>span.finish()</tt> is mandatory.
-    #
-    # When a Trace is started, <tt>trace()</tt> will store the created span; subsequent spans will
-    # become it's children and will inherit some properties:
-    #
-    #   parent = tracer.trace('parent')     # has no parent span
-    #   child  = tracer.trace('child')      # is a child of 'parent'
-    #   child.finish()
-    #   parent.finish()
-    #   parent2 = tracer.trace('parent2')   # has no parent span
-    #   parent2.finish()
-    #
-    # Available options are:
-    #
-    # * +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)
-    # * +child_of+: a \Span or a \Context instance representing the parent for this span.
-    #   If not set, defaults to Tracer.call_context
-    # * +tags+: extra tags which should be added to the span.
-    def trace(name, options = {})
-      options[:child_of] ||= call_context
-
-      # call the finish only if a block is given; this ensures
-      # that a call to tracer.trace() without a block, returns
-      # a span that should be manually finished.
-      if block_given?
-        span = nil
-        return_value = nil
-
-        begin
-          begin
-            span = start_span(name, options)
-          rescue StandardError => e
-            Datadog.logger.debug("Failed to start span: #{e}")
-          ensure
-            # We should yield to the provided block when possible, as this
-            # block is application code that we don't want to hinder. We call:
-            # * `yield(span)` during normal execution.
-            # * `yield(nil)` if `start_span` fails with a runtime error.
-            # * We don't yield during a fatal error, as the application is likely trying to
-            #   end its execution (either due to a system error or graceful shutdown).
-            return_value = yield(span) if span || e.is_a?(StandardError)
-          end
-        # rubocop:disable Lint/RescueException
-        # Here we really want to catch *any* exception, not only StandardError,
-        # as we really have no clue of what is in the block,
-        # 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
-          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?
-        end
-
-        return_value
-      else
-        start_span(name, options)
-      end
-    end
-
-    def trace_completed
-      @trace_completed ||= TraceCompleted.new
-    end
-
-    # Record the given +context+. For compatibility with previous versions,
-    # +context+ can also be a span. It is similar to the +child_of+ argument,
-    # method will figure out what to do, submitting a +span+ for recording
-    # is like trying to record its +context+.
-    def record(context)
-      context = context.context if context.is_a?(Datadog::Span)
-      return if context.nil?
-
-      record_context(context)
-    end
-
-    # Consume trace from +context+, according to +@context_flush+
-    # criteria.
-    #
-    # \ContextFlush#consume! can return nil or an empty list if the
-    # trace is not available to flush or if the trace has not been
-    # chosen to be sampled.
-    def record_context(context)
-      trace = @context_flush.consume!(context)
-
-      write(trace) if @enabled && trace && !trace.empty?
-    end
-
-    # Return the current active span or +nil+.
-    def active_span(key = nil)
-      call_context(key).current_span
-    end
-
-    # Return the current active root span or +nil+.
-    def active_root_span(key = nil)
-      call_context(key).current_root_span
-    end
-
-    # Return a CorrelationIdentifier for active span
-    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
-    # sending queue.
-    def write(trace)
-      return if @writer.nil?
-
-      if Datadog.configuration.diagnostics.debug
-        Datadog.logger.debug("Writing #{trace.length} spans (enabled: #{@enabled})")
-        str = String.new('')
-        PP.pp(trace, str)
-        Datadog.logger.debug(str)
-      end
-
-      @writer.write(trace)
-      trace_completed.publish(trace)
-    end
-
-    # Triggered whenever a trace is completed
-    class TraceCompleted < Datadog::Event
-      def initialize
-        super(:trace_completed)
-      end
-
-      # NOTE: Ignore Rubocop rule. This definition allows for
-      #       description of and constraints on arguments.
-      # rubocop:disable Lint/UselessMethodDefinition
-      def publish(trace)
-        super(trace)
-      end
-      # rubocop:enable Lint/UselessMethodDefinition
-    end
-
-    # TODO: Move this kind of configuration building out of the tracer.
-    #       Tracer should not have this kind of knowledge of writer.
-    def configure_writer(options = {})
-      sampler = options.fetch(:sampler, nil)
-      priority_sampling = options.fetch(:priority_sampling, nil)
-      writer = options.fetch(:writer, nil)
-      agent_settings = options.fetch(:agent_settings, nil)
-
-      # Compile writer options
-      writer_options = options.fetch(:writer_options, {}).dup
-
-      # Re-build the sampler and writer if priority sampling is enabled,
-      # but neither are configured. Verify the sampler isn't already a
-      # priority sampler too, so we don't wrap one with another.
-      if options.key?(:writer)
-        if writer.priority_sampler.nil?
-          deactivate_priority_sampling!(sampler)
-        else
-          activate_priority_sampling!(writer.priority_sampler)
-        end
-      elsif priority_sampling != false && !@sampler.is_a?(PrioritySampler)
-        writer_options[:priority_sampler] = activate_priority_sampling!(@sampler)
-      elsif priority_sampling == false
-        deactivate_priority_sampling!(sampler)
-      elsif @sampler.is_a?(PrioritySampler)
-        # Make sure to add sampler to options if transport is rebuilt.
-        writer_options[:priority_sampler] = @sampler
-      end
-
-      writer_options[:agent_settings] = agent_settings if agent_settings
-
-      # Make sure old writer is shut down before throwing away.
-      # Don't want additional threads running...
-      @writer.stop unless writer.nil?
-
-      @writer = writer || Writer.new(writer_options)
-    end
-
-    def activate_priority_sampling!(base_sampler = nil)
-      @sampler = if base_sampler.is_a?(PrioritySampler)
-                   base_sampler
-                 else
-                   PrioritySampler.new(
-                     base_sampler: base_sampler,
-                     post_sampler: Sampling::RuleSampler.new
-                   )
-                 end
-    end
-
-    def deactivate_priority_sampling!(base_sampler = nil)
-      @sampler = base_sampler || Datadog::AllSampler.new if @sampler.is_a?(PrioritySampler)
-    end
-
-    private \
-      :activate_priority_sampling!,
-      :configure_writer,
-      :deactivate_priority_sampling!,
-      :guess_context_and_parent,
-      :record_context,
-      :write
-  end
-end

data/lib/ddtrace/utils/compression.rb

@@ -1,28 +0,0 @@
-# typed: true
-require 'zlib'
-
-module Datadog
-  module Utils
-    # Common database-related utility functions.
-    module Compression
-      module_function
-
-      def gzip(string, level: nil, strategy: nil)
-        sio = StringIO.new
-        sio.binmode
-        gz = Zlib::GzipWriter.new(sio, level, strategy)
-        gz.write(string)
-        gz.close
-        sio.string
-      end
-
-      def gunzip(string, encoding = ::Encoding::ASCII_8BIT)
-        sio = StringIO.new(string)
-        gz = Zlib::GzipReader.new(sio, encoding: encoding)
-        gz.read
-      ensure
-        gz && gz.close
-      end
-    end
-  end
-end

data/lib/ddtrace/utils/database.rb

@@ -1,26 +0,0 @@
-# typed: true
-module Datadog
-  module Utils
-    # Common database-related utility functions.
-    module Database
-      VENDOR_DEFAULT = 'defaultdb'.freeze
-      VENDOR_POSTGRES = 'postgres'.freeze
-      VENDOR_SQLITE = 'sqlite'.freeze
-
-      module_function
-
-      def normalize_vendor(vendor)
-        case vendor
-        when nil
-          VENDOR_DEFAULT
-        when 'postgresql'
-          VENDOR_POSTGRES
-        when 'sqlite3'
-          VENDOR_SQLITE
-        else
-          vendor
-        end
-      end
-    end
-  end
-end

data/lib/ddtrace/utils/forking.rb

@@ -1,53 +0,0 @@
-# typed: false
-module Datadog
-  module Utils
-    # Helper methods for managing forking behavior
-    module Forking
-      def self.included(base)
-        base.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/utils/object_set.rb

@@ -1,40 +0,0 @@
-# typed: true
-require 'ddtrace/utils/sequence'
-
-module Datadog
-  module Utils
-    # Acts as a unique dictionary of objects
-    class ObjectSet
-      # You can provide a block that defines how the key
-      # for this message type is resolved.
-      def initialize(seed = 0, &block)
-        @sequence = Utils::Sequence.new(seed)
-        @items = {}
-        @key_block = block
-      end
-
-      # Submit an array of arguments that define the message.
-      # If they match an existing message, it will return the
-      # matching object. If it doesn't match, it will yield to
-      # the block with the next ID & args given.
-      def fetch(*args)
-        # TODO: Array hashing is **really** expensive, we probably want to get rid of it in the future
-        key = @key_block ? @key_block.call(*args) : args.hash
-        @items[key] ||= yield(@sequence.next, *args)
-      end
-
-      def length
-        @items.length
-      end
-
-      def objects
-        @items.values
-      end
-
-      def freeze
-        super
-        @items.freeze
-      end
-    end
-  end
-end

data/lib/ddtrace/utils/only_once.rb

@@ -1,41 +0,0 @@
-# typed: true
-# frozen_string_literal: true
-
-module Datadog
-  module Utils
-    # Helper class to execute something only once such as not repeating warning logs, and instrumenting classes
-    # only once.
-    #
-    # Thread-safe when used correctly (e.g. be careful of races when lazily initializing instances of this class).
-    #
-    # Note: In its current state, this class is not Ractor-safe.
-    # In https://github.com/DataDog/dd-trace-rb/pull/1398#issuecomment-797378810 we have a discussion of alternatives,
-    # including an alternative implementation that is Ractor-safe once spent.
-    class OnlyOnce
-      def initialize
-        @mutex = Mutex.new
-        @ran_once = false
-      end
-
-      def run
-        @mutex.synchronize do
-          return if @ran_once
-
-          @ran_once = true
-
-          yield
-        end
-      end
-
-      def ran?
-        @mutex.synchronize { @ran_once }
-      end
-
-      private
-
-      def reset_ran_once_state_for_tests
-        @mutex.synchronize { @ran_once = false }
-      end
-    end
-  end
-end

data/lib/ddtrace/utils/sequence.rb

@@ -1,18 +0,0 @@
-# typed: true
-module Datadog
-  module Utils
-    # Generates values from a consistent sequence
-    class Sequence
-      def initialize(seed = 0, &block)
-        @current = seed
-        @next_item = block
-      end
-
-      def next
-        next_item = @next_item ? @next_item.call(@current) : @current
-        @current += 1
-        next_item
-      end
-    end
-  end
-end