ddtrace 0.51.1 → 0.54.2

data/lib/datadog/ci/test.rb

@@ -1,3 +1,4 @@
+# typed: true
 # frozen_string_literal: true
 
 require 'ddtrace/contrib/analytics'
@@ -37,10 +38,14 @@ module Datadog
         span.context.origin = Ext::Test::CONTEXT_ORIGIN if span.context
         Datadog::Contrib::Analytics.set_measured(span)
         span.set_tag(Ext::Test::TAG_SPAN_KIND, Ext::AppTypes::TEST)
-        Ext::Environment.tags(ENV).each { |k, v| span.set_tag(k, v) }
+
+        # Set environment tags
+        @environment_tags ||= Ext::Environment.tags(ENV)
+        @environment_tags.each { |k, v| span.set_tag(k, v) }
 
         # Set contextual tags
         span.set_tag(Ext::Test::TAG_FRAMEWORK, tags[:framework]) if tags[:framework]
+        span.set_tag(Ext::Test::TAG_FRAMEWORK_VERSION, tags[:framework_version]) if tags[:framework_version]
         span.set_tag(Ext::Test::TAG_NAME, tags[:test_name]) if tags[:test_name]
         span.set_tag(Ext::Test::TAG_SUITE, tags[:test_suite]) if tags[:test_suite]
         span.set_tag(Ext::Test::TAG_TYPE, tags[:test_type]) if tags[:test_type]

data/lib/datadog/ci.rb

@@ -1,3 +1,4 @@
+# typed: strict
 require 'ddtrace'
 
 module Datadog

data/lib/datadog/contrib.rb

@@ -0,0 +1,71 @@
+# typed: true
+require 'ddtrace/contrib/registry'
+
+module Datadog
+  module Contrib
+    # Registry is a global, declarative repository of all available integrations.
+    #
+    # Integrations should register themselves with the registry as early as
+    # possible as the initial tracer configuration can only activate integrations
+    # if they have already been registered.
+    #
+    # Despite that, integrations *can* be appended to the registry at any point
+    # of the program execution. Newly appended integrations can then be
+    # activated during tracer reconfiguration.
+    #
+    # The registry does not depend on runtime configuration and registered integrations
+    # must execute correctly after successive configuration changes.
+    # The registered integrations themselves can depend on the stateful configuration
+    # of the tracer.
+    #
+    # `Datadog.registry` is a helper accessor to this constant, but it's only available
+    # after the tracer has complete initialization. Use `Datadog::Contrib::REGISTRY` instead
+    # of `Datadog.registry` when you code might be called during tracer initialization.
+    REGISTRY = Registry.new
+  end
+end
+
+require 'ddtrace/contrib/action_cable/integration'
+require 'ddtrace/contrib/action_mailer/integration'
+require 'ddtrace/contrib/action_pack/integration'
+require 'ddtrace/contrib/action_view/integration'
+require 'ddtrace/contrib/active_model_serializers/integration'
+require 'ddtrace/contrib/active_job/integration'
+require 'ddtrace/contrib/active_record/integration'
+require 'ddtrace/contrib/active_support/integration'
+require 'ddtrace/contrib/aws/integration'
+require 'ddtrace/contrib/concurrent_ruby/integration'
+require 'ddtrace/contrib/dalli/integration'
+require 'ddtrace/contrib/delayed_job/integration'
+require 'ddtrace/contrib/elasticsearch/integration'
+require 'ddtrace/contrib/ethon/integration'
+require 'ddtrace/contrib/excon/integration'
+require 'ddtrace/contrib/faraday/integration'
+require 'ddtrace/contrib/grape/integration'
+require 'ddtrace/contrib/graphql/integration'
+require 'ddtrace/contrib/grpc/integration'
+require 'ddtrace/contrib/http/integration'
+require 'ddtrace/contrib/httpclient/integration'
+require 'ddtrace/contrib/httprb/integration'
+require 'ddtrace/contrib/integration'
+require 'ddtrace/contrib/kafka/integration'
+require 'ddtrace/contrib/lograge/integration'
+require 'ddtrace/contrib/mongodb/integration'
+require 'ddtrace/contrib/mysql2/integration'
+require 'ddtrace/contrib/presto/integration'
+require 'ddtrace/contrib/qless/integration'
+require 'ddtrace/contrib/que/integration'
+require 'ddtrace/contrib/racecar/integration'
+require 'ddtrace/contrib/rack/integration'
+require 'ddtrace/contrib/rails/integration'
+require 'ddtrace/contrib/rake/integration'
+require 'ddtrace/contrib/redis/integration'
+require 'ddtrace/contrib/resque/integration'
+require 'ddtrace/contrib/rest_client/integration'
+require 'ddtrace/contrib/semantic_logger/integration'
+require 'ddtrace/contrib/sequel/integration'
+require 'ddtrace/contrib/shoryuken/integration'
+require 'ddtrace/contrib/sidekiq/integration'
+require 'ddtrace/contrib/sinatra/integration'
+require 'ddtrace/contrib/sneakers/integration'
+require 'ddtrace/contrib/sucker_punch/integration'

data/lib/datadog/core/environment/cgroup.rb

@@ -1,3 +1,4 @@
+# typed: true
 require 'datadog/core/environment/ext'
 
 module Datadog
@@ -8,6 +9,8 @@ module Datadog
       # about the current Linux container identity.
       # @see https://man7.org/linux/man-pages/man7/cgroups.7.html
       module Cgroup
+        include Kernel # Ensure that kernel methods are always available (https://sorbet.org/docs/error-reference#7003)
+
         LINE_REGEX = /^(\d+):([^:]*):(.+)$/.freeze
 
         Descriptor = Struct.new(
@@ -31,7 +34,7 @@ module Datadog
                 end
               end
             rescue StandardError => e
-              Datadog.logger.error("Error while parsing cgroup. Cause: #{e.message} Location: #{e.backtrace.first}")
+              Datadog.logger.error("Error while parsing cgroup. Cause: #{e.message} Location: #{Array(e.backtrace).first}")
             end
           end
         end

data/lib/datadog/core/environment/class_count.rb

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

data/lib/datadog/core/environment/container.rb

@@ -1,3 +1,4 @@
+# typed: true
 require 'datadog/core/environment/cgroup'
 
 module Datadog
@@ -5,13 +6,15 @@ module Datadog
     module Environment
       # For container environments
       module Container
+        include Kernel # Ensure that kernel methods are always available (https://sorbet.org/docs/error-reference#7003)
+
         UUID_PATTERN = '[0-9a-f]{8}[-_]?[0-9a-f]{4}[-_]?[0-9a-f]{4}[-_]?[0-9a-f]{4}[-_]?[0-9a-f]{12}'.freeze
         CONTAINER_PATTERN = '[0-9a-f]{64}'.freeze
 
         PLATFORM_REGEX = /(?<platform>.*?)(?:.slice)?$/.freeze
         POD_REGEX = /(?<pod>(pod)?#{UUID_PATTERN})(?:.slice)?$/.freeze
         CONTAINER_REGEX = /(?<container>#{UUID_PATTERN}|#{CONTAINER_PATTERN})(?:.scope)?$/.freeze
-        FARGATE_14_CONTAINER_REGEX = /(?<container>[0-9a-f]{32}-[0-9]{10})/.freeze
+        FARGATE_14_CONTAINER_REGEX = /(?<container>[0-9a-f]{32}-[0-9]{1,10})/.freeze
 
         Descriptor = Struct.new(
           :platform,
@@ -59,7 +62,7 @@ module Datadog
                                 || parts[-1][FARGATE_14_CONTAINER_REGEX, :container]
                 else
                   if (container_id = parts[-1][CONTAINER_REGEX, :container])
-                    task_uid = parts[-2][POD_REGEX, :pod]
+                    task_uid = parts[-2][POD_REGEX, :pod] || parts[1][POD_REGEX, :pod]
                   else
                     container_id = parts[-1][FARGATE_14_CONTAINER_REGEX, :container]
                   end
@@ -77,7 +80,7 @@ module Datadog
               end
             rescue StandardError => e
               Datadog.logger.error(
-                "Error while parsing container info. Cause: #{e.message} Location: #{e.backtrace.first}"
+                "Error while parsing container info. Cause: #{e.message} Location: #{Array(e.backtrace).first}"
               )
             end
           end

data/lib/datadog/core/environment/ext.rb

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

data/lib/datadog/core/environment/gc.rb

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

data/lib/datadog/core/environment/identity.rb

@@ -1,3 +1,4 @@
+# typed: false
 require 'securerandom'
 require 'datadog/core/environment/ext'
 require 'ddtrace/utils/forking'

data/lib/datadog/core/environment/socket.rb

@@ -1,3 +1,4 @@
+# typed: true
 require 'socket'
 
 module Datadog

data/lib/datadog/core/environment/thread_count.rb

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

data/lib/datadog/core/environment/variable_helpers.rb

@@ -1,9 +1,12 @@
+# typed: false
 module Datadog
   module Core
     # Namespace for handling application environment
     module Environment
       # Defines helper methods for environment
       module VariableHelpers
+        extend self
+
         def env_to_bool(var, default = nil)
           var = decode_array(var)
           var && ENV.key?(var) ? ENV[var].to_s.strip.downcase == 'true' : default

data/lib/datadog/core/environment/vm_cache.rb

@@ -0,0 +1,46 @@
+# typed: true
+module Datadog
+  module Core
+    module Environment
+      # Reports Ruby VM cache performance statistics.
+      # This currently encompasses cache invalidation counters and is CRuby-specific.
+      #
+      # JRuby emulates some CRuby global cache statistics, but they are synthetic and don't
+      # provide actionable performance information in the same way CRuby does.
+      # @see https://github.com/jruby/jruby/issues/4384#issuecomment-267069314
+      #
+      # TruffleRuby does not have a global runtime cache invalidation cache.
+      # @see http://archive.today/2021.09.10-205702/https://medium.com/graalvm/precise-method-and-constant-invalidation-in-truffleruby-4dd56c6bac1a
+      module VMCache
+        module_function
+
+        # Global constant cache "generation" counter.
+        #
+        # Whenever a constant creation busts the global constant cache
+        # this value is incremented. This has a measurable performance impact
+        # and thus show be avoided after application warm up.
+        def global_constant_state
+          ::RubyVM.stat[:global_constant_state]
+        end
+
+        # Global method cache "generation" counter.
+        #
+        # Whenever a method creation busts the global method cache
+        # this value is incremented. This has a measurable performance impact
+        # and thus show be avoided after application warm up.
+        #
+        # Since Ruby 3.0, the method class is kept on a per-class basis,
+        # largely mitigating global method cache busting. `global_method_state`
+        # is thus not available since Ruby 3.0.
+        # @see https://bugs.ruby-lang.org/issues/16614
+        def global_method_state
+          ::RubyVM.stat[:global_method_state]
+        end
+
+        def available?
+          defined?(::RubyVM) && ::RubyVM.respond_to?(:stat)
+        end
+      end
+    end
+  end
+end

data/lib/ddtrace/analytics.rb

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

data/lib/ddtrace/auto_instrument.rb

@@ -1,3 +1,4 @@
+# typed: strict
 require 'ddtrace'
 
 Datadog.add_auto_instrument

data/lib/ddtrace/auto_instrument_base.rb

@@ -1,3 +1,4 @@
+# typed: true
 module Datadog
   # base methods stubbed for adding auto instrument extensions
   module AutoInstrumentBase

data/lib/ddtrace/buffer.rb

@@ -1,5 +1,5 @@
+# typed: true
 require 'ddtrace/diagnostics/health'
-require 'datadog/core/environment/object_space'
 
 # Trace buffer that accumulates traces for a consumer.
 # Consumption can happen from a different thread.
@@ -14,7 +14,11 @@ module Datadog
     end
 
     # Add a new ``item`` in the local queue. This method doesn't block the execution
-    # even if the buffer is full. In that case, a random item is discarded.
+    # even if the buffer is full.
+    #
+    # When the buffer is full, we try to ensure that we are fairly sampling newly
+    # pushed traces by randomly inserting them into the buffer slots. This discards
+    # old traces randomly while trying to ensure that recent traces are still captured.
     def push(item)
       return if closed?
 
@@ -64,7 +68,7 @@ module Datadog
 
     protected
 
-    # Segment items into two distinct segments: underflow and overflow.
+    # Segment items into two segments: underflow and overflow.
     # Underflow are items that will fit into buffer.
     # Overflow are items that will exceed capacity, after underflow is added.
     # Returns each array, and nil if there is no underflow/overflow.
@@ -176,9 +180,6 @@ module Datadog
   # Buffer that stores objects, has a maximum size, and
   # can be safely used concurrently with CRuby.
   #
-  # Under extreme concurrency scenarios, this class can exceed
-  # its +max_size+ by up to 4%.
-  #
   # Because singular +Array+ operations are thread-safe in CRuby,
   # we can implement the trace buffer without an explicit lock,
   # while making the compromise of allowing the buffer to go
@@ -187,7 +188,6 @@ module Datadog
   # On the following scenario:
   # * 4.5 million spans/second.
   # * Pushed into a single CRubyTraceBuffer from 1000 threads.
-  # The buffer can exceed its maximum size by no more than 4%.
   #
   # This implementation allocates less memory and is faster
   # than {Datadog::ThreadSafeBuffer}.
@@ -195,24 +195,38 @@ module Datadog
   # @see spec/ddtrace/benchmark/buffer_benchmark_spec.rb Buffer benchmarks
   # @see https://github.com/ruby-concurrency/concurrent-ruby/blob/c1114a0c6891d9634f019f1f9fe58dcae8658964/lib/concurrent-ruby/concurrent/array.rb#L23-L27
   class CRubyBuffer < Buffer
+    # A very large number to allow us to effectively
+    # drop all items when invoking `slice!(i, FIXNUM_MAX)`.
+    FIXNUM_MAX = (1 << 62) - 1
+
     # Add a new ``trace`` in the local queue. This method doesn't block the execution
     # even if the buffer is full. In that case, a random trace is discarded.
     def replace!(item)
-      # we should replace a random trace with the new one
-      replace_index = rand(@items.size)
-      replaced_trace = @items.delete_at(replace_index)
-      @items << item
-
-      # We might have deleted an element right when the buffer
-      # was drained, thus +replaced_trace+ will be +nil+.
-      # In that case, nothing was replaced, and this method
-      # performed a simple insertion into the buffer.
-      replaced_trace
+      # Ensure buffer stays within +max_size+ items.
+      # This can happen when there's concurrent modification
+      # between a call the check in `full?` and the `add!` call in
+      # `full? ? replace!(item) : add!(item)`.
+      #
+      # We can still have `@items.size > @max_size` for a short period of
+      # time, but we will always try to correct it here.
+      #
+      # `slice!` is performed before `delete_at` & `<<` to avoid always
+      # removing the item that was just inserted.
+      #
+      # DEV: `slice!` with two integer arguments is ~10% faster than
+      # `slice!` with a {Range} argument.
+      @items.slice!(@max_size, FIXNUM_MAX)
+
+      # We should replace a random trace with the new one
+      replace_index = rand(@max_size)
+      @items[replace_index] = item
     end
   end
 
   # Health metrics for trace buffers.
   module MeasuredBuffer
+    include Kernel # Ensure that kernel methods are always available (https://sorbet.org/docs/error-reference#7003)
+
     def initialize(*_)
       super
 
@@ -259,7 +273,7 @@ module Datadog
 
       @buffer_spans += trace.length
     rescue StandardError => e
-      Datadog.logger.debug("Failed to measure queue accept. Cause: #{e.message} Source: #{e.backtrace.first}")
+      Datadog.logger.debug("Failed to measure queue accept. Cause: #{e.message} Source: #{Array(e.backtrace).first}")
     end
 
     def measure_drop(trace)
@@ -267,7 +281,7 @@ module Datadog
 
       @buffer_spans -= trace.length
     rescue StandardError => e
-      Datadog.logger.debug("Failed to measure queue drop. Cause: #{e.message} Source: #{e.backtrace.first}")
+      Datadog.logger.debug("Failed to measure queue drop. Cause: #{e.message} Source: #{Array(e.backtrace).first}")
     end
 
     def measure_pop(traces)
@@ -290,7 +304,7 @@ module Datadog
       @buffer_dropped = 0
       @buffer_spans = 0
     rescue StandardError => e
-      Datadog.logger.debug("Failed to measure queue. Cause: #{e.message} Source: #{e.backtrace.first}")
+      Datadog.logger.debug("Failed to measure queue. Cause: #{e.message} Source: #{Array(e.backtrace).first}")
     end
   end
 

data/lib/ddtrace/chunker.rb

@@ -1,3 +1,4 @@
+# typed: false
 require 'json'
 require 'msgpack'