ddtrace 0.45.0 → 0.52.0

data/lib/ddtrace/opentracer/carrier.rb

@@ -1,3 +1,4 @@
+# typed: strict
 module Datadog
   module OpenTracer
     class Carrier < ::OpenTracing::Carrier

data/lib/ddtrace/opentracer/distributed_headers.rb

@@ -1,3 +1,4 @@
+# typed: true
 require 'ddtrace/span'
 require 'ddtrace/ext/distributed'
 
@@ -29,8 +30,10 @@ module Datadog
         # It's important to make a difference between no header,
         # and a header defined to zero.
         return unless hdr
+
         value = hdr.to_i
         return if value < 0
+
         value
       end
 
@@ -45,6 +48,7 @@ module Datadog
       def id(header)
         value = @carrier[header].to_i
         return if value.zero? || value >= Datadog::Span::EXTERNAL_MAX_ID
+
         value < 0 ? value + 0x1_0000_0000_0000_0000 : value
       end
     end

data/lib/ddtrace/opentracer/global_tracer.rb

@@ -1,3 +1,4 @@
+# typed: true
 module Datadog
   module OpenTracer
     # Patch for OpenTracing module

data/lib/ddtrace/opentracer/propagator.rb

@@ -1,3 +1,4 @@
+# typed: false
 module Datadog
   module OpenTracer
     # OpenTracing propagator for Datadog::OpenTracer::Tracer

data/lib/ddtrace/opentracer/rack_propagator.rb

@@ -1,3 +1,4 @@
+# typed: true
 require 'ddtrace/propagation/http_propagator'
 
 module Datadog

data/lib/ddtrace/opentracer/scope.rb

@@ -1,3 +1,4 @@
+# typed: true
 module Datadog
   module OpenTracer
     # OpenTracing adapter for scope

data/lib/ddtrace/opentracer/scope_manager.rb

@@ -1,3 +1,4 @@
+# typed: strict
 module Datadog
   module OpenTracer
     class ScopeManager < ::OpenTracing::ScopeManager

data/lib/ddtrace/opentracer/span.rb

@@ -1,3 +1,4 @@
+# typed: true
 module Datadog
   module OpenTracer
     # OpenTracing adapter for Datadog::Span
@@ -73,9 +74,7 @@ module Datadog
         super # Log deprecation warning
 
         # If the fields specify an error
-        if fields.key?(:'error.object')
-          datadog_span.set_error(fields[:'error.object'])
-        end
+        datadog_span.set_error(fields[:'error.object']) if fields.key?(:'error.object')
       end
 
       # Add a log entry to this span
@@ -83,9 +82,7 @@ module Datadog
       # @param fields [Hash] Additional information to log
       def log_kv(timestamp: Time.now, **fields)
         # If the fields specify an error
-        if fields.key?(:'error.object')
-          datadog_span.set_error(fields[:'error.object'])
-        end
+        datadog_span.set_error(fields[:'error.object']) if fields.key?(:'error.object')
       end
 
       # Finish the {Span}

data/lib/ddtrace/opentracer/span_context.rb

@@ -1,3 +1,4 @@
+# typed: true
 module Datadog
   module OpenTracer
     # OpenTracing adapter for SpanContext

data/lib/ddtrace/opentracer/span_context_factory.rb

@@ -1,3 +1,4 @@
+# typed: true
 module Datadog
   module OpenTracer
     # Creates new Datadog::OpenTracer::SpanContext

data/lib/ddtrace/opentracer/text_map_propagator.rb

@@ -1,3 +1,4 @@
+# typed: true
 require 'ddtrace/ext/distributed'
 
 module Datadog

data/lib/ddtrace/opentracer/thread_local_scope.rb

@@ -1,3 +1,4 @@
+# typed: true
 module Datadog
   module OpenTracer
     # OpenTracing adapter for thread local scopes
@@ -22,6 +23,7 @@ module Datadog
       # undefined behavior.
       def close
         return unless equal?(manager.active)
+
         span.finish if finish_on_close
         manager.send(:set_scope, @previous_scope)
       end

data/lib/ddtrace/opentracer/thread_local_scope_manager.rb

@@ -1,3 +1,4 @@
+# typed: true
 module Datadog
   module OpenTracer
     # OpenTracing adapter for thread local scope management

data/lib/ddtrace/opentracer/tracer.rb

@@ -1,3 +1,4 @@
+# typed: true
 require 'ddtrace/tracer'
 
 module Datadog

data/lib/ddtrace/opentracer.rb

@@ -1,40 +1,22 @@
-module Datadog
-  # Namespace for ddtrace OpenTracing implementation
-  module OpenTracer
-    module_function
+# typed: strict
+require 'opentracing'
+require 'opentracing/carrier'
+require 'ddtrace'
+require 'ddtrace/opentracer/carrier'
+require 'ddtrace/opentracer/tracer'
+require 'ddtrace/opentracer/span'
+require 'ddtrace/opentracer/span_context'
+require 'ddtrace/opentracer/span_context_factory'
+require 'ddtrace/opentracer/scope'
+require 'ddtrace/opentracer/scope_manager'
+require 'ddtrace/opentracer/thread_local_scope'
+require 'ddtrace/opentracer/thread_local_scope_manager'
+require 'ddtrace/opentracer/distributed_headers'
+require 'ddtrace/opentracer/propagator'
+require 'ddtrace/opentracer/text_map_propagator'
+require 'ddtrace/opentracer/binary_propagator'
+require 'ddtrace/opentracer/rack_propagator'
+require 'ddtrace/opentracer/global_tracer'
 
-    def supported?
-      Gem::Version.new(RUBY_VERSION) >= Gem::Version.new('2.1')
-    end
-
-    def load_opentracer
-      require 'opentracing'
-      require 'opentracing/carrier'
-      require 'ddtrace'
-      require 'ddtrace/opentracer/carrier'
-      require 'ddtrace/opentracer/tracer'
-      require 'ddtrace/opentracer/span'
-      require 'ddtrace/opentracer/span_context'
-      require 'ddtrace/opentracer/span_context_factory'
-      require 'ddtrace/opentracer/scope'
-      require 'ddtrace/opentracer/scope_manager'
-      require 'ddtrace/opentracer/thread_local_scope'
-      require 'ddtrace/opentracer/thread_local_scope_manager'
-      require 'ddtrace/opentracer/distributed_headers'
-      require 'ddtrace/opentracer/propagator'
-      require 'ddtrace/opentracer/text_map_propagator'
-      require 'ddtrace/opentracer/binary_propagator'
-      require 'ddtrace/opentracer/rack_propagator'
-      require 'ddtrace/opentracer/global_tracer'
-
-      # Modify the OpenTracing module functions
-      OpenTracing.module_eval do
-        class << self
-          prepend Datadog::OpenTracer::GlobalTracer
-        end
-      end
-    end
-
-    load_opentracer if supported?
-  end
-end
+# Modify the OpenTracing module functions
+::OpenTracing.singleton_class.prepend(Datadog::OpenTracer::GlobalTracer)

data/lib/ddtrace/patcher.rb

@@ -1,9 +1,24 @@
+# typed: false
+require 'ddtrace/utils/only_once'
+
 module Datadog
-  # Defines some useful patching methods for integrations
+  # Deprecated: This module should no longer be included. It's only being kept around for backwards compatibility
+  # concerns regarding customer usage.
   module Patcher
+    INCLUDED_WARN_ONLY_ONCE = Datadog::Utils::OnlyOnce.new
+    DO_ONCE_USAGE_WARN_ONLY_ONCE = Datadog::Utils::OnlyOnce.new
+
     def self.included(base)
-      base.send(:extend, CommonMethods)
-      base.send(:include, CommonMethods)
+      INCLUDED_WARN_ONLY_ONCE.run do
+        Datadog.logger.warn(
+          'Including Datadog::Patcher is deprecated. ' \
+          'For the #do_once behavior, use Datadog::Utils::OnlyOnce instead. ' \
+          'For the #without_warnings behavior, use Datadog::Patcher.without_warnings { ... } as a module function.'
+        )
+      end
+
+      base.extend(CommonMethods)
+      base.include(CommonMethods)
     end
 
     # Defines some common methods for patching, that can be used
@@ -22,11 +37,13 @@ module Datadog
       end
 
       def do_once(key = nil, options = {})
+        DO_ONCE_USAGE_WARN_ONLY_ONCE.run do
+          Datadog.logger.warn('Datadog::Patcher#do_once is deprecated. Use Datadog::Utils::OnlyOnce instead.')
+        end
+
         # If already done, don't do again
         @done_once ||= Hash.new { |h, k| h[k] = {} }
-        if @done_once.key?(key) && @done_once[key].key?(options[:for])
-          return @done_once[key][options[:for]]
-        end
+        return @done_once[key][options[:for]] if @done_once.key?(key) && @done_once[key].key?(options[:for])
 
         # Otherwise 'do'
         yield.tap do
@@ -36,7 +53,12 @@ module Datadog
       end
 
       def done?(key, options = {})
+        DO_ONCE_USAGE_WARN_ONLY_ONCE.run do
+          Datadog.logger.warn('Datadog::Patcher#done? is deprecated. Use Datadog::Utils::OnlyOnce instead.')
+        end
+
         return false unless instance_variable_defined?(:@done_once)
+
         !@done_once.nil? && @done_once.key?(key) && @done_once[key].key?(options[:for])
       end
     end

data/lib/ddtrace/pin.rb

@@ -1,4 +1,6 @@
+# typed: true
 require 'ddtrace/patcher'
+require 'ddtrace/utils/only_once'
 
 # \Datadog global namespace that includes all tracing functionality for Tracer and Span classes.
 module Datadog
@@ -7,19 +9,15 @@ module Datadog
   # This is useful if you wanted to, say, trace two different
   # database clusters.
   class Pin
+    DEPRECATION_WARN_ONLY_ONCE = Datadog::Utils::OnlyOnce.new
+
     def self.get_from(obj)
       return nil unless obj.respond_to? :datadog_pin
+
       obj.datadog_pin
     end
 
-    attr_accessor :app
-    attr_accessor :app_type
-    attr_accessor :config
-    attr_accessor :name
-    attr_accessor :service_name
-    attr_accessor :tags
-    attr_reader :tracer
-    attr_accessor :writer
+    attr_accessor :app, :app_type, :config, :name, :service_name, :tags, :writer
 
     alias service= service_name=
     alias service service_name
@@ -42,6 +40,7 @@ module Datadog
 
     def enabled?
       return tracer.enabled if tracer
+
       false
     end
 
@@ -79,59 +78,8 @@ module Datadog
       ).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
-
-  # Modification to Pin which logs deprecation warnings if accessed.
-  # Will be used by integrations which are phasing out the direct use of #datadog_pin.
-  module DeprecatedPin
-    include Datadog::Patcher
-
-    DEPRECATION_WARNING = %(
-      Use of Datadog::Pin is DEPRECATED.
-      Upgrade to the configuration API using the migration guide here:
-      https://github.com/DataDog/dd-trace-rb/releases/tag/v0.11.0).freeze
-
-    # Raise a deprecation warning when #datadog_pin or #datadog_pin= is accessed.
-    def onto(obj)
-      obj.instance_exec(self) do |pin|
-        @datadog_deprecated_pin = pin
-
-        unless respond_to? :datadog_pin=
-          def datadog_pin=(pin)
-            @datadog_deprecated_pin.log_deprecation_warning('#datadog_pin=')
-            @datadog_pin = pin
-          end
-        end
-
-        unless respond_to? :datadog_pin
-          def datadog_pin
-            @datadog_deprecated_pin.log_deprecation_warning('#datadog_pin')
-            @datadog_pin
-          end
-        end
-
-        # Set instance variable to avoid deprecation warnings
-        @datadog_pin = @datadog_deprecated_pin
-      end
-
-      self
-    end
-
-    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}")
+      DEPRECATION_WARN_ONLY_ONCE.run do
+        Datadog.logger.warn("Datadog::Pin.new:#{DEPRECATION_WARNING}")
       end
     end
   end

data/lib/ddtrace/pipeline/span_filter.rb

@@ -1,3 +1,4 @@
+# typed: true
 module Datadog
   module Pipeline
     # SpanFilter implements a processor that filters entire span subtrees
@@ -10,7 +11,7 @@ module Datadog
         @criteria = filter || block
       end
 
-      # Note: this SpanFilter implementation only handles traces in which child spans appear
+      # 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)

data/lib/ddtrace/pipeline/span_processor.rb

@@ -1,3 +1,4 @@
+# typed: true
 module Datadog
   module Pipeline
     # SpanProcessor

data/lib/ddtrace/pipeline.rb

@@ -1,3 +1,4 @@
+# typed: true
 module Datadog
   # Pipeline
   module Pipeline

data/lib/ddtrace/profiling/backtrace_location.rb

@@ -0,0 +1,33 @@
+# typed: true
+module Datadog
+  module Profiling
+    # Entity class used to represent an entry in a stack trace.
+    # Its fields are a simplified struct version of `Thread::Backtrace::Location`.
+    class BacktraceLocation
+      attr_reader \
+        :base_label,
+        :lineno,
+        :path,
+        :hash
+
+      def initialize(
+        base_label,
+        lineno,
+        path
+      )
+        @base_label = base_label
+        @lineno = lineno
+        @path = path
+        @hash = [base_label, lineno, path].hash
+      end
+
+      def ==(other)
+        hash == other.hash
+      end
+
+      def eql?(other)
+        hash == other.hash
+      end
+    end
+  end
+end

data/lib/ddtrace/profiling/buffer.rb

@@ -0,0 +1,42 @@
+# typed: true
+require 'ddtrace/buffer'
+require 'ddtrace/utils/string_table'
+require 'ddtrace/utils/object_set'
+
+module Datadog
+  module Profiling
+    # Profiling buffer that stores profiling events. The buffer has a maximum size and when
+    # the buffer is full, a random event is discarded. This class is thread-safe.
+    class Buffer < Datadog::ThreadSafeBuffer
+      def initialize(*args)
+        super
+        @caches = {}
+        @string_table = Utils::StringTable.new
+      end
+
+      def cache(cache_name)
+        synchronize do
+          @caches[cache_name] ||= Utils::ObjectSet.new
+        end
+      end
+
+      def string_table
+        synchronize do
+          @string_table
+        end
+      end
+
+      protected
+
+      def drain!
+        items = super
+
+        # Clear caches
+        @caches = {}
+        @string_table = Utils::StringTable.new
+
+        items
+      end
+    end
+  end
+end