ddtrace 0.40.0 → 0.50.0

data/lib/ddtrace/sync_writer.rb

@@ -1,11 +1,18 @@
 require 'ddtrace/ext/net'
 require 'ddtrace/runtime/socket'
 require 'ddtrace/runtime/metrics'
+require 'ddtrace/utils/only_once'
 
 module Datadog
   # SyncWriter flushes both services and traces synchronously
   # DEV: To be replaced by Datadog::Workers::TraceWriter.
+  #
+  # Note: If you're wondering if this class is used at all, since there are no other references to it on the codebase,
+  # the separate `datadog-lambda` uses it as of February 2021:
+  # <https://github.com/DataDog/datadog-lambda-rb/blob/c15f0f0916c90123416dc44e7d6800ef4a7cfdbf/lib/datadog/lambda.rb#L38>
   class SyncWriter
+    DEPRECATION_WARN_ONLY_ONCE = Datadog::Utils::OnlyOnce.new
+
     attr_reader \
       :priority_sampler,
       :transport
@@ -13,7 +20,8 @@ module Datadog
     def initialize(options = {})
       @transport = options.fetch(:transport) do
         transport_options = options.fetch(:transport_options, {})
-        Transport::HTTP.default(transport_options)
+        transport_options[:agent_settings] = options[:agent_settings] if options.key?(:agent_settings)
+        Transport::HTTP.default(**transport_options)
       end
 
       @priority_sampler = options.fetch(:priority_sampler, nil)
@@ -21,17 +29,15 @@ module Datadog
 
     def write(trace, services = nil)
       unless services.nil?
-        Datadog::Patcher.do_once('SyncWriter#write') do
+        DEPRECATION_WARN_ONLY_ONCE.run do
           Datadog.logger.warn(%(
             write: Writing services has been deprecated and no longer need to be provided.
-            write(traces, services) can be updted to write(traces)
+            write(traces, services) can be updated to write(traces)
           ))
         end
       end
 
-      perform_concurrently(
-        proc { flush_trace(trace) }
-      )
+      flush_trace(trace)
     rescue => e
       Datadog.logger.debug(e)
     end
@@ -44,13 +50,10 @@ module Datadog
 
     private
 
-    def perform_concurrently(*tasks)
-      tasks.map { |task| Thread.new(&task) }.each(&:join)
-    end
-
     def flush_trace(trace)
       processed_traces = Pipeline.process!([trace])
       return if processed_traces.empty?
+
       inject_hostname!(processed_traces.first) if Datadog.configuration.report_hostname
       transport.send_traces(processed_traces)
     end
@@ -58,9 +61,7 @@ module Datadog
     def inject_hostname!(trace)
       unless trace.first.nil?
         hostname = Datadog::Runtime::Socket.hostname
-        unless hostname.nil? || hostname.empty?
-          trace.first.set_tag(Ext::NET::TAG_HOSTNAME, hostname)
-        end
+        trace.first.set_tag(Ext::NET::TAG_HOSTNAME, hostname) unless hostname.nil? || hostname.empty?
       end
     end
   end

data/lib/ddtrace/tasks/exec.rb

@@ -0,0 +1,48 @@
+module Datadog
+  module Tasks
+    # Wraps command with Datadog tracing
+    class Exec
+      attr_reader :args
+
+      def initialize(args)
+        @args = args
+      end
+
+      def run
+        set_rubyopt!
+        exec_with_error_handling(args)
+      end
+
+      def rubyopts
+        [
+          '-rddtrace/profiling/preload'
+        ]
+      end
+
+      private
+
+      def set_rubyopt!
+        if ENV.key?('RUBYOPT')
+          ENV['RUBYOPT'] += " #{rubyopts.join(' ')}"
+        else
+          ENV['RUBYOPT'] = rubyopts.join(' ')
+        end
+      end
+
+      # If there's an error here, rather than throwing a cryptic stack trace, let's instead have clearer messages, and
+      # follow the same status codes as the shell uses
+      # See also:
+      # * https://www.gnu.org/software/bash/manual/html_node/Exit-Status.html
+      # * https://github.com/rubygems/rubygems/blob/dd93966cac224532035deda533cba2685dfa30cc/bundler/lib/bundler/cli/exec.rb#L45
+      def exec_with_error_handling(args)
+        Kernel.exec(*args)
+      rescue Errno::ENOENT => e
+        Kernel.warn "ddtracerb exec failed: #{e.message} (command was '#{args.join(' ')}')"
+        Kernel.exit 127
+      rescue Errno::EACCES, Errno::ENOEXEC => e
+        Kernel.warn "ddtracerb exec failed: #{e.message} (command was '#{args.join(' ')}')"
+        Kernel.exit 126
+      end
+    end
+  end
+end

data/lib/ddtrace/tasks/help.rb

@@ -0,0 +1,14 @@
+module Datadog
+  module Tasks
+    # Prints help message for usage of `ddtrace`
+    class Help
+      def run
+        puts %(
+Usage: ddtrace [command] [arguments]
+  exec [command]: Executes command with tracing & profiling preloaded.
+  help:           Prints this help message.
+        )
+      end
+    end
+  end
+end

data/lib/ddtrace/tracer.rb

@@ -1,5 +1,3 @@
-require 'pp'
-require 'thread'
 require 'logger'
 require 'pathname'
 
@@ -8,9 +6,12 @@ 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'
+require 'ddtrace/event'
+require 'ddtrace/utils/only_once'
 
 # \Datadog global namespace that includes all tracing functionality for Tracer and Span classes.
 module Datadog
@@ -20,6 +21,9 @@ module Datadog
   # 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
@@ -28,8 +32,7 @@ module Datadog
     DEFAULT_ON_ERROR = proc { |span, error| span.set_error(error) unless span.nil? }
 
     def services
-      # Only log each deprecation warning once (safeguard against log spam)
-      Datadog::Patcher.do_once('Tracer#set_service_info') do
+      SERVICES_DEPRECATION_WARN_ONLY_ONCE.run do
         Datadog.logger.warn('services: Usage of Tracer.services has been deprecated')
       end
 
@@ -60,8 +63,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
@@ -71,7 +74,9 @@ module Datadog
     #   by default.
     def initialize(options = {})
       # Configurable options
-      @context_flush = if options[: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
@@ -82,7 +87,7 @@ module Datadog
       @provider = options.fetch(:context_provider, Datadog::DefaultContextProvider.new)
       @sampler = options.fetch(:sampler, Datadog::AllSampler.new)
       @tags = options.fetch(:tags, {})
-      @writer = options.fetch(:writer, Datadog::Writer.new)
+      @writer = options.fetch(:writer) { Datadog::Writer.new }
 
       # Instance variables
       @mutex = Mutex.new
@@ -115,8 +120,10 @@ module Datadog
 
       configure_writer(options)
 
-      if options.key?(:partial_flush)
-        @context_flush = if options[:partial_flush]
+      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
@@ -130,8 +137,7 @@ module Datadog
     #
     # set_service_info is deprecated, no service information needs to be tracked
     def set_service_info(service, app, app_type)
-      # Only log each deprecation warning once (safeguard against log spam)
-      Datadog::Patcher.do_once('Tracer#set_service_info') do
+      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.
@@ -144,6 +150,7 @@ module Datadog
     # a service would be invalid and rejected.
     def default_service
       return @default_service if instance_variable_defined?(:@default_service) && @default_service
+
       begin
         @default_service = File.basename($PROGRAM_NAME, '.*')
       rescue StandardError => e
@@ -159,7 +166,7 @@ module Datadog
     #
     #   tracer.set_tags('env' => 'prod', 'component' => 'core')
     def set_tags(tags)
-      string_tags = Hash[tags.collect { |k, v| [k.to_s, v] }]
+      string_tags = tags.collect { |k, v| [k.to_s, v] }.to_h
       @tags = @tags.merge(string_tags)
     end
 
@@ -186,8 +193,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 +209,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 +219,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 +296,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?
@@ -301,6 +320,10 @@ module Datadog
       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
@@ -325,18 +348,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
@@ -352,24 +375,34 @@ module Datadog
       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.
-    # rubocop:disable Metrics/PerceivedComplexity
-    # rubocop:disable Metrics/CyclomaticComplexity
-    # rubocop:disable Metrics/MethodLength
     def configure_writer(options = {})
-      hostname = options.fetch(:hostname, nil)
-      port = options.fetch(:port, nil)
       sampler = options.fetch(:sampler, nil)
       priority_sampling = options.fetch(:priority_sampling, nil)
       writer = options.fetch(:writer, nil)
-      transport_options = options.fetch(:transport_options, {}).dup
+      agent_settings = options.fetch(:agent_settings, nil)
 
       # Compile writer options
       writer_options = options.fetch(:writer_options, {}).dup
-      rebuild_writer = !writer_options.empty?
 
       # Re-build the sampler and writer if priority sampling is enabled,
       # but neither are configured. Verify the sampler isn't already a
@@ -382,35 +415,20 @@ module Datadog
         end
       elsif priority_sampling != false && !@sampler.is_a?(PrioritySampler)
         writer_options[:priority_sampler] = activate_priority_sampling!(@sampler)
-        rebuild_writer = true
       elsif priority_sampling == false
         deactivate_priority_sampling!(sampler)
-        rebuild_writer = true
       elsif @sampler.is_a?(PrioritySampler)
         # Make sure to add sampler to options if transport is rebuilt.
         writer_options[:priority_sampler] = @sampler
       end
 
-      # Apply options to transport
-      if transport_options.is_a?(Proc)
-        transport_options = { on_build: transport_options }
-        rebuild_writer = true
-      end
-
-      if hostname || port
-        transport_options[:hostname] = hostname unless hostname.nil?
-        transport_options[:port] = port unless port.nil?
-        rebuild_writer = true
-      end
+      writer_options[:agent_settings] = agent_settings if agent_settings
 
-      writer_options[:transport_options] = transport_options
+      # Make sure old writer is shut down before throwing away.
+      # Don't want additional threads running...
+      @writer.stop unless writer.nil?
 
-      if rebuild_writer || writer
-        # 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
+      @writer = writer || Writer.new(writer_options)
     end
 
     def activate_priority_sampling!(base_sampler = nil)

data/lib/ddtrace/transport/http.rb

@@ -25,11 +25,23 @@ module Datadog
 
       # Builds a new Transport::HTTP::Client with default settings
       # Pass a block to override any settings.
-      def default(options = {})
+      def default(agent_settings: Datadog::Configuration::AgentSettingsResolver::ENVIRONMENT_AGENT_SETTINGS, **options)
         new do |transport|
-          transport.adapter :net_http, default_hostname, default_port
+          transport.adapter(
+            default_adapter,
+            agent_settings.hostname,
+            agent_settings.port,
+            timeout: agent_settings.timeout_seconds,
+            ssl: agent_settings.ssl
+          )
           transport.headers default_headers
 
+          if agent_settings.deprecated_for_removal_transport_configuration_options
+            # The deprecated_for_removal_transport_configuration_options take precedence over any options the caller
+            # specifies
+            options = options.merge(**agent_settings.deprecated_for_removal_transport_configuration_options)
+          end
+
           apis = API.defaults
 
           transport.api API::V4, apis[API::V4], fallback: API::V3, default: true
@@ -38,24 +50,15 @@ module Datadog
 
           # Apply any settings given by options
           unless options.empty?
-            # Change hostname/port
-            if options.key?(:hostname) || options.key?(:port)
-              hostname = options.fetch(:hostname, default_hostname)
-              port = options.fetch(:port, default_port)
-              transport.adapter :net_http, hostname, port
-            end
-
-            # Change default API
             transport.default_api = options[:api_version] if options.key?(:api_version)
-
-            # Add headers
             transport.headers options[:headers] if options.key?(:headers)
+          end
 
-            # Execute on_build callback
-            options[:on_build].call(transport) if options[:on_build].is_a?(Proc)
+          if agent_settings.deprecated_for_removal_transport_configuration_proc
+            agent_settings.deprecated_for_removal_transport_configuration_proc.call(transport)
           end
 
-          # Call block to apply any customization, if provided.
+          # Call block to apply any customization, if provided
           yield(transport) if block_given?
         end
       end
@@ -69,32 +72,39 @@ module Datadog
         }.tap do |headers|
           # Add container ID, if present.
           container_id = Datadog::Runtime::Container.container_id
-          unless container_id.nil?
-            headers[Datadog::Ext::Transport::HTTP::HEADER_CONTAINER_ID] = container_id
-          end
+          headers[Datadog::Ext::Transport::HTTP::HEADER_CONTAINER_ID] = container_id unless container_id.nil?
         end
       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)
+      def default_adapter
+        :net_http
       end
 
-      def default_port
-        return default_url.port if default_url
+      def default_hostname(logger: Datadog.logger)
+        logger.warn(
+          'Deprecated for removal: Using #default_hostname for configuration is deprecated and will ' \
+          'be removed on a future ddtrace release.'
+        )
 
-        ENV.fetch(Datadog::Ext::Transport::HTTP::ENV_DEFAULT_PORT, Datadog::Ext::Transport::HTTP::DEFAULT_PORT).to_i
+        Datadog::Configuration::AgentSettingsResolver::ENVIRONMENT_AGENT_SETTINGS.hostname
       end
 
-      def default_url
-        url_env = ENV.fetch(Datadog::Ext::Transport::HTTP::ENV_DEFAULT_URL, nil)
+      def default_port(logger: Datadog.logger)
+        logger.warn(
+          'Deprecated for removal: Using #default_hostname for configuration is deprecated and will ' \
+          'be removed on a future ddtrace release.'
+        )
+
+        Datadog::Configuration::AgentSettingsResolver::ENVIRONMENT_AGENT_SETTINGS.port
+      end
 
-        if url_env
-          uri_parsed = URI.parse(url_env)
+      def default_url(logger: Datadog.logger)
+        logger.warn(
+          'Deprecated for removal: Using #default_url for configuration is deprecated and will ' \
+          'be removed on a future ddtrace release.'
+        )
 
-          uri_parsed if %w[http https].include?(uri_parsed.scheme)
-        end
+        nil
       end
 
       # Add adapters to registry