ddtrace 0.35.0 → 0.38.0

data/lib/ddtrace/environment.rb

@@ -6,7 +6,11 @@ module Datadog
     # Defines helper methods for environment
     module Helpers
       def env_to_bool(var, default = nil)
-        ENV.key?(var) ? ENV[var].to_s.downcase == 'true' : default
+        ENV.key?(var) ? ENV[var].to_s.strip.downcase == 'true' : default
+      end
+
+      def env_to_int(var, default = nil)
+        ENV.key?(var) ? ENV[var].to_i : default
       end
 
       def env_to_float(var, default = nil)

data/lib/ddtrace/ext/diagnostics.rb

@@ -1,6 +1,8 @@
 module Datadog
   module Ext
     module Diagnostics
+      DD_TRACE_STARTUP_LOGS = 'DD_TRACE_STARTUP_LOGS'.freeze
+
       # Health
       module Health
         # Metrics

data/lib/ddtrace/ext/environment.rb

@@ -1,8 +1,10 @@
 module Datadog
   module Ext
     module Environment
+      ENV_API_KEY = 'DD_API_KEY'.freeze
       ENV_ENVIRONMENT = 'DD_ENV'.freeze
       ENV_SERVICE = 'DD_SERVICE'.freeze
+      ENV_SITE = 'DD_SITE'.freeze
       ENV_TAGS = 'DD_TAGS'.freeze
       ENV_VERSION = 'DD_VERSION'.freeze
 

data/lib/ddtrace/pin.rb

@@ -12,26 +12,36 @@ module Datadog
       obj.datadog_pin
     end
 
-    attr_reader :service_name
     attr_accessor :app
-    attr_accessor :tags
     attr_accessor :app_type
-    attr_accessor :name
-    attr_accessor :tracer
     attr_accessor :config
+    attr_accessor :name
+    attr_accessor :service_name
+    attr_accessor :tags
+    attr_reader :tracer
+    attr_accessor :writer
+
+    alias service= service_name=
+    alias service service_name
 
     def initialize(service_name, options = {})
+      deprecation_warning unless options[:tracer].is_a?(Proc) || options[:tracer].nil?
+
       @app = options[:app]
-      @tags = options[:tags]
       @app_type = options[:app_type]
-      @name = nil # this would rarely be overriden as it's really span-specific
-      @tracer = options[:tracer] || Datadog.tracer
       @config = options[:config]
-      self.service_name = service_name
+      @name = nil # this would rarely be overriden as it's really span-specific
+      @service_name = service_name
+      @tags = options[:tags]
+      @tracer = options[:tracer]
+    end
+
+    def tracer
+      @tracer.is_a?(Proc) ? @tracer.call : (@tracer || Datadog.tracer)
     end
 
     def enabled?
-      return @tracer.enabled if @tracer
+      return tracer.enabled if tracer
       false
     end
 
@@ -56,15 +66,29 @@ module Datadog
       obj.datadog_pin = self
     end
 
-    def service_name=(name)
-      @service_name = name
+    def to_s
+      "Pin(service:#{service},app:#{app},app_type:#{app_type},name:#{name})"
     end
 
-    alias service= service_name=
-    alias service service_name
+    private
 
-    def to_s
-      "Pin(service:#{service},app:#{app},app_type:#{app_type},name:#{name})"
+    DEPRECATION_WARNING = %(
+      Explicitly providing a tracer instance is DEPRECATED.
+      It's recommended to not provide an explicit tracer instance
+      and let Datadog::Pin resolve the correct tracer internally.
+      ).freeze
+
+    def deprecation_warning
+      log_deprecation_warning('Datadog::Pin.new')
+    end
+
+    include Datadog::Patcher
+
+    def log_deprecation_warning(method_name)
+      # Only log each deprecation warning once (safeguard against log spam)
+      do_once(method_name) do
+        Datadog.logger.warn("#{method_name}:#{DEPRECATION_WARNING}")
+      end
     end
   end
 

data/lib/ddtrace/pipeline/span_filter.rb

@@ -10,12 +10,22 @@ module Datadog
         @criteria = filter || block
       end
 
+      # Note: this SpanFilter implementation only handles traces in which child spans appear
+      # after parent spans in the trace array. If in the future child spans can be before
+      # parent spans, then the code below will need to be updated.
       def call(trace)
-        black_list = trace.select(&method(:drop_it?))
-
-        clean_trace(black_list, trace) while black_list.any?
-
-        trace
+        deleted = Set.new
+
+        trace.delete_if do |span|
+          if deleted.include?(span.parent)
+            deleted << span
+            true
+          else
+            drop = drop_it?(span)
+            deleted << span if drop
+            drop
+          end
+        end
       end
 
       private
@@ -23,16 +33,6 @@ module Datadog
       def drop_it?(span)
         @criteria.call(span) rescue false
       end
-
-      def clean_trace(black_list, trace)
-        current = black_list.shift
-
-        trace.delete(current)
-
-        trace.each do |span|
-          black_list << span if span.parent == current
-        end
-      end
     end
   end
 end

data/lib/ddtrace/sampler.rb

@@ -193,6 +193,8 @@ module Datadog
   class PrioritySampler
     extend Forwardable
 
+    attr_reader :pre_sampler, :priority_sampler
+
     SAMPLE_RATE_METRIC_KEY = '_sample_rate'.freeze
 
     def initialize(opts = {})

data/lib/ddtrace/span.rb

@@ -107,6 +107,16 @@ module Datadog
       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)

data/lib/ddtrace/tracer.rb

@@ -212,8 +212,8 @@ module Datadog
         # child span
         span.parent = parent # sets service, trace_id, parent_id, sampled
       end
-      @tags.each { |k, v| span.set_tag(k, v) } unless @tags.empty?
-      tags.each { |k, v| span.set_tag(k, v) } unless tags.empty?
+      span.set_tags(@tags) unless @tags.empty?
+      span.set_tags(tags) unless tags.empty?
       span.start_time = start_time
 
       # this could at some point be optional (start_active_span vs start_manual_span)
@@ -255,9 +255,11 @@ module Datadog
     # * +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
+      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
@@ -269,11 +271,16 @@ module Datadog
         begin
           begin
             span = start_span(name, options)
-          # rubocop:disable Lint/UselessAssignment
           rescue StandardError => e
-            Datadog.logger.debug('Failed to start span: #{e}')
+            Datadog.logger.debug("Failed to start span: #{e}")
           ensure
-            return_value = yield(span)
+            # 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,
@@ -314,7 +321,7 @@ module Datadog
     def record_context(context)
       trace = @context_flush.consume!(context)
 
-      write(trace) if trace && !trace.empty?
+      write(trace) if @enabled && trace && !trace.empty?
     end
 
     # Return the current active span or +nil+.
@@ -335,7 +342,7 @@ module Datadog
     # Send the trace to the writer to enqueue the spans list in the agent
     # sending queue.
     def write(trace)
-      return if @writer.nil? || !@enabled
+      return if @writer.nil?
 
       if Datadog.configuration.diagnostics.debug
         Datadog.logger.debug("Writing #{trace.length} spans (enabled: #{@enabled})")

data/lib/ddtrace/transport/http/adapters/net.rb

@@ -47,6 +47,10 @@ module Datadog
             Response.new(http_response)
           end
 
+          def url
+            "http://#{hostname}:#{port}?timeout=#{timeout}"
+          end
+
           # Raised when called with an unknown HTTP method
           class UnknownHTTPMethod < StandardError
             attr_reader :verb
@@ -104,6 +108,10 @@ module Datadog
               return super if http_response.nil?
               code.between?(500, 599)
             end
+
+            def inspect
+              "#{super}, http_response:#{http_response}"
+            end
           end
         end
       end

data/lib/ddtrace/transport/http/adapters/test.rb

@@ -69,6 +69,10 @@ module Datadog
             def server_error?
               code.between?(500, 599)
             end
+
+            def inspect
+              "#{super}, code:#{code}"
+            end
           end
         end
       end

data/lib/ddtrace/transport/http/adapters/unix_socket.rb

@@ -31,6 +31,10 @@ module Datadog
             end
           end
 
+          def url
+            "http+unix://#{filepath}?timeout=#{timeout}"
+          end
+
           # Re-implements Net:HTTP with underlying Unix socket
           class HTTP < ::Net::HTTP
             DEFAULT_TIMEOUT = 1

data/lib/ddtrace/transport/response.rb

@@ -29,6 +29,13 @@ module Datadog
       def internal_error?
         nil
       end
+
+      def inspect
+        "#{self.class} ok?:#{ok?} unsupported?:#{unsupported?}, " \
+        "not_found?:#{not_found?}, client_error?:#{client_error?}, " \
+        "server_error?:#{server_error?}, internal_error?:#{internal_error?}, " \
+        "payload:#{payload}"
+      end
     end
 
     # A generic error response for internal errors
@@ -44,6 +51,10 @@ module Datadog
       def internal_error?
         true
       end
+
+      def inspect
+        "#{super}, error_type:#{error.class} error:#{error}"
+      end
     end
   end
 end

data/lib/ddtrace/version.rb

@@ -1,7 +1,7 @@
 module Datadog
   module VERSION
     MAJOR = 0
-    MINOR = 35
+    MINOR = 38
     PATCH = 0
     PRE = nil
 

data/lib/ddtrace/workers/trace_writer.rb

@@ -72,6 +72,9 @@ module Datadog
         end
       end
 
+      # TODO: Register `Datadog::Diagnostics::EnvironmentLogger.log!`
+      # TODO: as a flush_completed subscriber when the `TraceWriter`
+      # TODO: instantiation code is implemented.
       def flush_completed
         @flush_completed ||= FlushCompleted.new
       end

data/lib/ddtrace/writer.rb

@@ -7,6 +7,7 @@ require 'ddtrace/transport/http'
 require 'ddtrace/transport/io'
 require 'ddtrace/encoding'
 require 'ddtrace/workers'
+require 'ddtrace/diagnostics/environment_logger'
 
 module Datadog
   # Processor that sends traces and metadata to the agent
@@ -43,9 +44,18 @@ module Datadog
       @worker = nil
     end
 
-    # spawns a worker for spans; they share the same transport which is thread-safe
     def start
-      @pid = Process.pid
+      @mutex_after_fork.synchronize do
+        pid = Process.pid
+        return if @worker && pid == @pid
+        @pid = pid
+        start_worker
+        true
+      end
+    end
+
+    # spawns a worker for spans; they share the same transport which is thread-safe
+    def start_worker
       @trace_handler = ->(items, transport) { send_spans(items, transport) }
       @worker = Datadog::Workers::AsyncTransport.new(
         transport: @transport,
@@ -57,14 +67,19 @@ module Datadog
       @worker.start
     end
 
-    # stops worker for spans.
     def stop
-      return if worker.nil?
+      @mutex_after_fork.synchronize { stop_worker }
+    end
+
+    def stop_worker
+      return if @worker.nil?
       @worker.stop
       @worker = nil
       true
     end
 
+    private :start_worker, :stop_worker
+
     # flush spans to the trace-agent, handles spans only
     def send_spans(traces, transport)
       return true if traces.empty?
@@ -83,6 +98,8 @@ module Datadog
       # Update priority sampler
       update_priority_sampler(responses.last)
 
+      record_environment_information!(responses)
+
       # Return if server error occurred.
       !responses.find(&:server_error?)
     end
@@ -106,13 +123,7 @@ module Datadog
       #
       # This check ensures that if a process doesn't own the current +Writer+, async workers
       # will be initialized again (but only once for each process).
-      pid = Process.pid
-      if pid != @pid # avoid using Mutex when pids are equal
-        @mutex_after_fork.synchronize do
-          # we should start threads because the worker doesn't own this
-          start if pid != @pid
-        end
-      end
+      start if @worker.nil? || @pid != Process.pid
 
       # TODO: Remove this, and have the tracer pump traces directly to runtime metrics
       #       instead of working through the trace writer.
@@ -121,7 +132,13 @@ module Datadog
         Datadog.runtime_metrics.associate_with_span(trace.first)
       end
 
-      @worker.enqueue_trace(trace)
+      worker_local = @worker
+
+      if worker_local
+        worker_local.enqueue_trace(trace)
+      else
+        Datadog.logger.debug('Writer either failed to start or was stopped before #write could complete')
+      end
     end
 
     # stats returns a dictionary of stats about the writer.
@@ -150,5 +167,9 @@ module Datadog
 
       priority_sampler.update(response.service_rates)
     end
+
+    def record_environment_information!(responses)
+      Diagnostics::EnvironmentLogger.log!(responses)
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ddtrace
 version: !ruby/object:Gem::Version
-  version: 0.35.0
+  version: 0.38.0
 platform: ruby
 authors:
 - Datadog, Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-05-04 00:00:00.000000000 Z
+date: 2020-07-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: msgpack
@@ -122,6 +122,34 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 5.10.1
+- !ruby/object:Gem::Dependency
+  name: minitest-around
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+- !ruby/object:Gem::Dependency
+  name: minitest-stub_any_instance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.0.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.0.2
 - !ruby/object:Gem::Dependency
   name: appraisal
   requirement: !ruby/object:Gem::Requirement
@@ -220,6 +248,48 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 2.4.0
+- !ruby/object:Gem::Dependency
+  name: benchmark-ips
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.8'
+- !ruby/object:Gem::Dependency
+  name: benchmark-memory
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: memory_profiler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
 - !ruby/object:Gem::Dependency
   name: redcarpet
   requirement: !ruby/object:Gem::Requirement
@@ -300,6 +370,7 @@ files:
 - ".env"
 - ".github/CODEOWNERS"
 - ".gitignore"
+- ".gitlab-ci.yml"
 - ".rspec"
 - ".rubocop.yml"
 - ".yardopts"
@@ -475,7 +546,29 @@ files:
 - lib/ddtrace/contrib/http/integration.rb
 - lib/ddtrace/contrib/http/patcher.rb
 - lib/ddtrace/contrib/http_annotation_helper.rb
+- lib/ddtrace/contrib/httprb/configuration/settings.rb
+- lib/ddtrace/contrib/httprb/ext.rb
+- lib/ddtrace/contrib/httprb/instrumentation.rb
+- lib/ddtrace/contrib/httprb/integration.rb
+- lib/ddtrace/contrib/httprb/patcher.rb
 - lib/ddtrace/contrib/integration.rb
+- lib/ddtrace/contrib/kafka/configuration/settings.rb
+- lib/ddtrace/contrib/kafka/consumer_event.rb
+- lib/ddtrace/contrib/kafka/consumer_group_event.rb
+- lib/ddtrace/contrib/kafka/event.rb
+- lib/ddtrace/contrib/kafka/events.rb
+- lib/ddtrace/contrib/kafka/events/connection/request.rb
+- lib/ddtrace/contrib/kafka/events/consumer/process_batch.rb
+- lib/ddtrace/contrib/kafka/events/consumer/process_message.rb
+- lib/ddtrace/contrib/kafka/events/consumer_group/heartbeat.rb
+- lib/ddtrace/contrib/kafka/events/consumer_group/join_group.rb
+- lib/ddtrace/contrib/kafka/events/consumer_group/leave_group.rb
+- lib/ddtrace/contrib/kafka/events/consumer_group/sync_group.rb
+- lib/ddtrace/contrib/kafka/events/produce_operation/send_messages.rb
+- lib/ddtrace/contrib/kafka/events/producer/deliver_messages.rb
+- lib/ddtrace/contrib/kafka/ext.rb
+- lib/ddtrace/contrib/kafka/integration.rb
+- lib/ddtrace/contrib/kafka/patcher.rb
 - lib/ddtrace/contrib/mongodb/configuration/settings.rb
 - lib/ddtrace/contrib/mongodb/ext.rb
 - lib/ddtrace/contrib/mongodb/instrumentation.rb
@@ -576,6 +669,7 @@ files:
 - lib/ddtrace/contrib/sucker_punch/integration.rb
 - lib/ddtrace/contrib/sucker_punch/patcher.rb
 - lib/ddtrace/correlation.rb
+- lib/ddtrace/diagnostics/environment_logger.rb
 - lib/ddtrace/diagnostics/health.rb
 - lib/ddtrace/distributed_tracing/headers/b3.rb
 - lib/ddtrace/distributed_tracing/headers/b3_single.rb
@@ -713,7 +807,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 2.0.0
 requirements: []
-rubygems_version: 3.1.2
+rubyforge_project: 
+rubygems_version: 2.7.6.2
 signing_key: 
 specification_version: 4
 summary: Datadog tracing code for your Ruby applications