datadog 2.8.0 → 2.9.0

data/lib/datadog/tracing/contrib/action_view/integration.rb

@@ -4,7 +4,7 @@ require_relative 'configuration/settings'
 require_relative 'patcher'
 require_relative '../integration'
 require_relative '../rails/ext'
-require_relative '../rails/utils'
+require_relative '../../../core/contrib/rails/utils'
 
 module Datadog
   module Tracing
@@ -18,6 +18,9 @@ module Datadog
 
           # @public_api Changing the integration name or integration options can cause breaking changes
           register_as :action_view, auto_patch: false
+          def self.gem_name
+            'actionview'
+          end
 
           def self.version
             # ActionView is its own gem in Rails 4.1+
@@ -41,7 +44,7 @@ module Datadog
           # enabled by rails integration so should only auto instrument
           # if detected that it is being used without rails
           def auto_instrument?
-            !Contrib::Rails::Utils.railtie_supported?
+            !Core::Contrib::Rails::Utils.railtie_supported?
           end
 
           def new_configuration

data/lib/datadog/tracing/contrib/active_job/integration.rb

@@ -3,7 +3,7 @@
 require_relative 'configuration/settings'
 require_relative 'patcher'
 require_relative '../integration'
-require_relative '../rails/utils'
+require_relative '../../../core/contrib/rails/utils'
 
 module Datadog
   module Tracing
@@ -17,6 +17,9 @@ module Datadog
 
           # @public_api Changing the integration name or integration options can cause breaking changes
           register_as :active_job, auto_patch: false
+          def self.gem_name
+            'activejob'
+          end
 
           def self.version
             Gem.loaded_specs['activejob'] && Gem.loaded_specs['activejob'].version
@@ -33,7 +36,7 @@ module Datadog
           # enabled by rails integration so should only auto instrument
           # if detected that it is being used without rails
           def auto_instrument?
-            !Contrib::Rails::Utils.railtie_supported?
+            !Core::Contrib::Rails::Utils.railtie_supported?
           end
 
           def new_configuration

data/lib/datadog/tracing/contrib/active_record/integration.rb

@@ -7,7 +7,7 @@ require_relative 'patcher'
 require_relative '../component'
 require_relative '../integration'
 require_relative '../rails/ext'
-require_relative '../rails/utils'
+require_relative '../../../core/contrib/rails/utils'
 
 module Datadog
   module Tracing
@@ -22,6 +22,10 @@ module Datadog
           # @public_api Changing the integration name or integration options can cause breaking changes
           register_as :active_record, auto_patch: false
 
+          def self.gem_name
+            'activerecord'
+          end
+
           def self.version
             Gem.loaded_specs['activerecord'] && Gem.loaded_specs['activerecord'].version
           end
@@ -37,7 +41,7 @@ module Datadog
           # enabled by rails integration so should only auto instrument
           # if detected that it is being used without rails
           def auto_instrument?
-            !Contrib::Rails::Utils.railtie_supported?
+            !Core::Contrib::Rails::Utils.railtie_supported?
           end
 
           def new_configuration

data/lib/datadog/tracing/contrib/active_support/cache/events/cache.rb

@@ -81,7 +81,9 @@ module Datadog
 
                 span.set_tag('EVENT', event)
 
-                set_cache_key(span, key, mapping[:multi_key])
+                if Datadog.configuration.tracing[:active_support][:cache_key].enabled
+                  set_cache_key(span, key, mapping[:multi_key])
+                end
               rescue StandardError => e
                 Datadog.logger.error(e.message)
                 Datadog::Core::Telemetry::Logger.report(e)

data/lib/datadog/tracing/contrib/active_support/cache/instrumentation.rb

@@ -3,6 +3,7 @@
 require_relative '../../../../core/utils'
 require_relative '../../../metadata/ext'
 require_relative '../ext'
+require_relative 'event'
 
 module Datadog
   module Tracing
@@ -58,7 +59,8 @@ module Datadog
                 end
 
                 span.set_tag(Ext::TAG_CACHE_BACKEND, store) if store
-                set_cache_key(span, key, multi_key)
+
+                set_cache_key(span, key, multi_key) if Datadog.configuration.tracing[:active_support][:cache_key].enabled
 
                 yield
               end

data/lib/datadog/tracing/contrib/active_support/configuration/settings.rb

@@ -39,6 +39,16 @@ module Datadog
                 )
               end
             end
+
+            # grouped "cache_key.*" settings
+            settings :cache_key do
+              # enable or disabling the inclusion of the cache_key in the span
+              option :enabled do |o|
+                # cache_key.enabled
+                o.type :bool
+                o.default true
+              end
+            end
           end
         end
       end

data/lib/datadog/tracing/contrib/active_support/integration.rb

@@ -5,7 +5,7 @@ require_relative 'configuration/settings'
 require_relative 'patcher'
 require_relative 'cache/redis'
 require_relative '../rails/ext'
-require_relative '../rails/utils'
+require_relative '../../../core/contrib/rails/utils'
 
 module Datadog
   module Tracing
@@ -19,6 +19,9 @@ module Datadog
 
           # @public_api Changing the integration name or integration options can cause breaking changes
           register_as :active_support, auto_patch: false
+          def self.gem_name
+            'activesupport'
+          end
 
           def self.version
             Gem.loaded_specs['activesupport'] && Gem.loaded_specs['activesupport'].version
@@ -35,7 +38,7 @@ module Datadog
           # enabled by rails integration so should only auto instrument
           # if detected that it is being used without rails
           def auto_instrument?
-            !Contrib::Rails::Utils.railtie_supported?
+            !Core::Contrib::Rails::Utils.railtie_supported?
           end
 
           def new_configuration

data/lib/datadog/tracing/contrib/auto_instrument.rb

@@ -9,10 +9,10 @@ module Datadog
     module Contrib
       # Auto-activate instrumentation
       def self.auto_instrument!
-        require_relative 'rails/utils'
+        require_relative '../../core/contrib/rails/utils'
 
         # Defer to Rails if this is a Rails application
-        if Datadog::Tracing::Contrib::Rails::Utils.railtie_supported?
+        if Datadog::Core::Contrib::Rails::Utils.railtie_supported?
           require_relative 'rails/auto_instrument_railtie'
         else
           AutoInstrument.patch_all!

data/lib/datadog/tracing/contrib/aws/integration.rb

@@ -16,6 +16,9 @@ module Datadog
 
           # @public_api Changing the integration name or integration options can cause breaking changes
           register_as :aws, auto_patch: true
+          def self.gem_name
+            'aws-sdk-core'
+          end
 
           def self.version
             if Gem.loaded_specs['aws-sdk']

data/lib/datadog/tracing/contrib/concurrent_ruby/integration.rb

@@ -16,6 +16,9 @@ module Datadog
 
           # @public_api Changing the integration name or integration options can cause breaking changes
           register_as :concurrent_ruby
+          def self.gem_name
+            'concurrent-ruby'
+          end
 
           def self.version
             Gem.loaded_specs['concurrent-ruby'] && Gem.loaded_specs['concurrent-ruby'].version

data/lib/datadog/tracing/contrib/httprb/integration.rb

@@ -17,6 +17,9 @@ module Datadog
 
           # @public_api Changing the integration name or integration options can cause breaking changes
           register_as :httprb
+          def self.gem_name
+            'http'
+          end
 
           def self.version
             Gem.loaded_specs['http'] && Gem.loaded_specs['http'].version

data/lib/datadog/tracing/contrib/kafka/integration.rb

@@ -16,6 +16,9 @@ module Datadog
 
           # @public_api Changing the integration name or integration options can cause breaking changes
           register_as :kafka, auto_patch: false
+          def self.gem_name
+            'ruby-kafka'
+          end
 
           def self.version
             Gem.loaded_specs['ruby-kafka'] && Gem.loaded_specs['ruby-kafka'].version

data/lib/datadog/tracing/contrib/mongodb/integration.rb

@@ -17,6 +17,9 @@ module Datadog
 
           # @public_api Changing the integration name or integration options can cause breaking changes
           register_as :mongo, auto_patch: true
+          def self.gem_name
+            'mongo'
+          end
 
           def self.version
             Gem.loaded_specs['mongo'] && Gem.loaded_specs['mongo'].version

data/lib/datadog/tracing/contrib/opensearch/integration.rb

@@ -16,6 +16,9 @@ module Datadog
 
           # @public_api Changing the integration name or integration options can cause breaking changes
           register_as :opensearch, auto_patch: true
+          def self.gem_name
+            'opensearch-ruby'
+          end
 
           def self.version
             Gem.loaded_specs['opensearch-ruby'] \

data/lib/datadog/tracing/contrib/presto/integration.rb

@@ -16,6 +16,9 @@ module Datadog
 
           # @public_api Changing the integration name or integration options can cause breaking changes
           register_as :presto
+          def self.gem_name
+            'presto-client'
+          end
 
           def self.version
             Gem.loaded_specs['presto-client'] && Gem.loaded_specs['presto-client'].version

data/lib/datadog/tracing/contrib/rack/integration.rb

@@ -3,7 +3,7 @@
 require_relative '../integration'
 require_relative 'configuration/settings'
 require_relative 'patcher'
-require_relative '../rails/utils'
+require_relative '../../../core/contrib/rails/utils'
 
 module Datadog
   module Tracing
@@ -33,7 +33,7 @@ module Datadog
           # enabled by rails integration so should only auto instrument
           # if detected that it is being used without rails
           def auto_instrument?
-            !Contrib::Rails::Utils.railtie_supported?
+            !Core::Contrib::Rails::Utils.railtie_supported?
           end
 
           def new_configuration

data/lib/datadog/tracing/contrib/rails/framework.rb

@@ -9,7 +9,7 @@ require_relative '../active_support/integration'
 require_relative '../grape/endpoint'
 require_relative '../lograge/integration'
 require_relative 'ext'
-require_relative 'utils'
+require_relative '../../../core/contrib/rails/utils'
 require_relative '../semantic_logger/integration'
 
 module Datadog
@@ -41,7 +41,7 @@ module Datadog
               # being executed, but here we know better, get it from Rails config.
               # Don't set this if service has been explicitly provided by the user.
               if datadog_config.service_without_fallback.nil?
-                datadog_config.service = rails_config[:service_name] || Utils.app_name
+                datadog_config.service = rails_config[:service_name] || Core::Contrib::Rails::Utils.app_name
               end
 
               activate_rack!(datadog_config, rails_config)

data/lib/datadog/tracing/contrib/rails/patcher.rb

@@ -6,7 +6,7 @@ require_relative 'framework'
 require_relative 'log_injection'
 require_relative 'middlewares'
 require_relative 'runner'
-require_relative 'utils'
+require_relative '../../../core/contrib/rails/utils'
 require_relative '../semantic_logger/patcher'
 
 module Datadog

data/lib/datadog/tracing/contrib/rest_client/integration.rb

@@ -16,6 +16,9 @@ module Datadog
 
           # @public_api Changing the integration name or integration options can cause breaking changes
           register_as :rest_client
+          def self.gem_name
+            'rest-client'
+          end
 
           def self.version
             Gem.loaded_specs['rest-client'] && Gem.loaded_specs['rest-client'].version

data/lib/datadog/tracing/span.rb

@@ -112,7 +112,10 @@ module Datadog
 
       def duration
         return @duration if @duration
-        return @end_time - @start_time if @start_time && @end_time
+
+        start_time = @start_time
+        end_time = @end_time
+        end_time - start_time if start_time && end_time
       end
 
       def set_error(e)
@@ -135,6 +138,8 @@ module Datadog
       # TODO: Change this to reflect attributes when serialization
       # isn't handled by this method.
       def to_hash
+        @meta['events'] = @events.map(&:to_hash).to_json unless @events.empty?
+
         h = {
           error: @status,
           meta: @meta,
@@ -154,8 +159,6 @@ module Datadog
           h[:duration] = duration_nano
         end
 
-        h[:meta]['events'] = @events.map(&:to_hash).to_json unless @events.empty?
-
         h
       end
 
@@ -196,12 +199,17 @@ module Datadog
       # Used for serialization
       # @return [Integer] in nanoseconds since Epoch
       def start_time_nano
-        @start_time.to_i * 1000000000 + @start_time.nsec
+        return unless (start_time = @start_time)
+
+        start_time.to_i * 1000000000 + start_time.nsec
       end
 
       # Used for serialization
       # @return [Integer] in nanoseconds since Epoch
       def duration_nano
+        duration = self.duration
+        return unless duration
+
         (duration * 1e9).to_i
       end
 

data/lib/datadog/tracing/span_event.rb

@@ -19,23 +19,143 @@ module Datadog
       #   @return [Integer]
       attr_reader :time_unix_nano
 
+      # TODO: Accept {Time} as the time_unix_nano parameter, possibly in addition to the current nano integer.
       def initialize(
         name,
         attributes: nil,
         time_unix_nano: nil
       )
         @name = name
-        @attributes = attributes || {}
+
+        @attributes = attributes.dup || {}
+        validate_attributes!(@attributes)
+        @attributes.transform_keys!(&:to_s)
+
         # OpenTelemetry SDK stores span event timestamps in nanoseconds (not seconds).
         # We will do the same here to avoid unnecessary conversions and inconsistencies.
         @time_unix_nano = time_unix_nano || (Time.now.to_r * 1_000_000_000).to_i
       end
 
+      # Converts the span event into a hash to be used by with the span tag serialization
+      # (`span.set_tag('events) = [event.to_hash]`). This serialization format has the drawback
+      # of being limiting span events to the size limit of a span tag.
+      # All Datadog agents support this format.
       def to_hash
-        h = { name: @name, time_unix_nano: @time_unix_nano }
-        h[:attributes] = attributes unless @attributes.empty?
+        h = { 'name' => @name, 'time_unix_nano' => @time_unix_nano }
+        h['attributes'] = @attributes unless @attributes.empty?
+        h
+      end
+
+      # Converts the span event into a hash to be used by the MessagePack serialization as a
+      # top-level span field (span.span_events = [event.to_native_format]).
+      # This serialization format removes the serialization limitations of the `span.set_tag('events)` approach,
+      # but is only supported by newer version of the Datadog agent.
+      def to_native_format
+        h = { 'name' => @name, 'time_unix_nano' => @time_unix_nano }
+
+        attr = {}
+        @attributes.each do |key, value|
+          attr[key] = if value.is_a?(Array)
+                        { type: ARRAY_TYPE, array_value: value.map { |v| serialize_native_attribute(v) } }
+                      else
+                        serialize_native_attribute(value)
+                      end
+        end
+
+        h['attributes'] = attr unless @attributes.empty?
+
         h
       end
+
+      private
+
+      MIN_INT64_SIGNED = -2**63
+      MAX_INT64_SIGNED = 2 << 63 - 1
+
+      # Checks the attributes hash to ensure it only contains serializable values.
+      # Invalid values are removed from the hash.
+      def validate_attributes!(attributes)
+        attributes.select! do |key, value|
+          case value
+          when Array
+            next true if value.empty?
+
+            first = value.first
+            case first
+            when String, Integer, Float
+              first_type = first.class
+              if value.all? { |v| v.is_a?(first_type) }
+                value.all? { |v| validate_scalar_attribute!(key, v) }
+              else
+                Datadog.logger.warn("Attribute #{key} array must be homogenous: #{value}.")
+                false
+              end
+            when TrueClass, FalseClass
+              if value.all? { |v| v.is_a?(TrueClass) || v.is_a?(FalseClass) }
+                value.all? { |v| validate_scalar_attribute!(key, v) }
+              else
+                Datadog.logger.warn("Attribute #{key} array must be homogenous: #{value}.")
+                false
+              end
+            else
+              Datadog.logger.warn("Attribute #{key} must be a string, number, or boolean: #{value}.")
+              false
+            end
+          when String, Numeric, TrueClass, FalseClass
+            validate_scalar_attribute!(key, value)
+          else
+            Datadog.logger.warn("Attribute #{key} must be a string, number, boolean, or array: #{value}.")
+            false
+          end
+        end
+      end
+
+      def validate_scalar_attribute!(key, value)
+        case value
+        when String, TrueClass, FalseClass
+          true
+        when Integer
+          # Cannot be larger than signed 64-bit integer
+          if value < MIN_INT64_SIGNED || value > MAX_INT64_SIGNED
+            Datadog.logger.warn("Attribute #{key} must be within the range of a signed 64-bit integer: #{value}.")
+            false
+          else
+            true
+          end
+        when Float
+          # Has to be finite
+          return true if value.finite?
+
+          Datadog.logger.warn("Attribute #{key} must be a finite number: #{value}.")
+          false
+        else
+          Datadog.logger.warn("Attribute #{key} must be a string, number, or boolean: #{value}.")
+          false
+        end
+      end
+
+      STRING_TYPE = 0
+      BOOLEAN_TYPE = 1
+      INTEGER_TYPE = 2
+      DOUBLE_TYPE = 3
+      ARRAY_TYPE = 4
+
+      # Serializes individual scalar attributes into the native format.
+      def serialize_native_attribute(value)
+        case value
+        when String
+          { type: STRING_TYPE, string_value: value }
+        when TrueClass, FalseClass
+          { type: BOOLEAN_TYPE, bool_value: value }
+        when Integer
+          { type: INTEGER_TYPE, int_value: value }
+        when Float
+          { type: DOUBLE_TYPE, double_value: value }
+        else
+          # This is technically unreachable due to the validation in #initialize.
+          raise ArgumentError, "Attribute must be a string, number, or boolean: #{value}."
+        end
+      end
     end
   end
 end

data/lib/datadog/tracing/span_operation.rb

@@ -11,6 +11,8 @@ require_relative 'event'
 require_relative 'metadata'
 require_relative 'metadata/ext'
 require_relative 'span'
+require_relative 'span_event'
+require_relative 'span_link'
 require_relative 'utils'
 
 module Datadog
@@ -197,6 +199,9 @@ module Datadog
       end
 
       # Mark the span stopped at the current time
+      #
+      # steep:ignore:start
+      # Steep issue fixed in https://github.com/soutaro/steep/pull/1467
       def stop(stop_time = nil)
         # A span should not be stopped twice. Note that this is not thread-safe,
         # stop is called from multiple threads, a given span might be stopped
@@ -219,6 +224,7 @@ module Datadog
 
         self
       end
+      # steep:ignore:end
 
       # Return whether the duration is started or not
       def started?

data/lib/datadog/tracing/transport/serializable_trace.rb

@@ -12,8 +12,11 @@ module Datadog
         attr_reader \
           :trace
 
-        def initialize(trace)
+        # @param trace [Datadog::Trace] the trace to serialize
+        # @param native_events_supported [Boolean] whether the agent supports span events as a top-level field
+        def initialize(trace, native_events_supported = false)
           @trace = trace
+          @native_events_supported = native_events_supported
         end
 
         # MessagePack serializer interface. Making this object
@@ -26,13 +29,13 @@ module Datadog
         # @param packer [MessagePack::Packer] serialization buffer, can be +nil+ with JRuby
         def to_msgpack(packer = nil)
           # As of 1.3.3, JRuby implementation doesn't pass an existing packer
-          trace.spans.map { |s| SerializableSpan.new(s) }.to_msgpack(packer)
+          trace.spans.map { |s| SerializableSpan.new(s, @native_events_supported) }.to_msgpack(packer)
         end
 
         # JSON serializer interface.
         # Used by older version of the transport.
         def to_json(*args)
-          trace.spans.map { |s| SerializableSpan.new(s).to_hash }.to_json(*args)
+          trace.spans.map { |s| SerializableSpan.new(s, @native_events_supported).to_hash }.to_json(*args)
         end
       end
 
@@ -41,9 +44,12 @@ module Datadog
         attr_reader \
           :span
 
-        def initialize(span)
+        # @param span [Datadog::Span] the span to serialize
+        # @param native_events_supported [Boolean] whether the agent supports span events as a top-level field
+        def initialize(span, native_events_supported)
           @span = span
           @trace_id = Tracing::Utils::TraceId.to_low_order(span.trace_id)
+          @native_events_supported = native_events_supported
         end
 
         # MessagePack serializer interface. Making this object
@@ -55,11 +61,14 @@ module Datadog
         #
         # @param packer [MessagePack::Packer] serialization buffer, can be +nil+ with JRuby
         # rubocop:disable Metrics/AbcSize
+        # rubocop:disable Metrics/MethodLength
         def to_msgpack(packer = nil)
           packer ||= MessagePack::Packer.new
 
           number_of_elements_to_write = 11
 
+          number_of_elements_to_write += 1 if span.events.any? && @native_events_supported
+
           if span.stopped?
             packer.write_map_header(number_of_elements_to_write + 2) # Set header with how many elements in the map
 
@@ -72,8 +81,16 @@ module Datadog
             packer.write_map_header(number_of_elements_to_write) # Set header with how many elements in the map
           end
 
-          # serialize span events as meta tags
-          span.set_tag('events', span.events.map(&:to_hash).to_json) if span.events.any?
+          if span.events.any?
+            if @native_events_supported
+              # Use top-level field for native events
+              packer.write('span_events')
+              packer.write(span.events.map(&:to_native_format))
+            else
+              # Serialize span events as meta tags
+              span.set_tag('events', span.events.map(&:to_hash).to_json)
+            end
+          end
 
           # DEV: We use strings as keys here, instead of symbols, as
           # DEV: MessagePack will ultimately convert them to strings.
@@ -103,6 +120,7 @@ module Datadog
           packer
         end
         # rubocop:enable Metrics/AbcSize
+        # rubocop:enable Metrics/MethodLength
 
         # JSON serializer interface.
         # Used by older version of the transport.

data/lib/datadog/version.rb

@@ -3,7 +3,7 @@
 module Datadog
   module VERSION
     MAJOR = 2
-    MINOR = 8
+    MINOR = 9
     PATCH = 0
     PRE = nil
     BUILD = nil