datadog 2.12.0 → 2.22.0

data/lib/datadog/tracing/metadata/metastruct_tagging.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require_relative 'metastruct'
+
+module Datadog
+  module Tracing
+    module Metadata
+      # Adds data storage for the `meta_struct` field.
+      #
+      # This field is used to send more complex data like an array of objects
+      # in MessagePack format to the agent, and has no size limitations.
+      #
+      # The agent fully supports meta_struct from version v7.35.0 (April 2022).
+      #
+      # On versions older than v7.35.0, sending traces containing meta_struct
+      # has no unexpected side-effects; traces are sent to the backend as expected,
+      # while the meta_struct field is stripped.
+      module MetastructTagging
+        # Set the given key / value tag pair on the metastruct.
+        #
+        # A valid example is:
+        #
+        #   span.set_metastruct_tag('_dd.stack', [])
+        def set_metastruct_tag(key, value)
+          metastruct[key] = value
+        end
+
+        # Return the metastruct tag value for the given key,
+        # returns nil if the key doesn't exist.
+        def get_metastruct_tag(key)
+          metastruct[key]
+        end
+
+        private
+
+        def metastruct
+          @metastruct ||= Metastruct.new
+        end
+      end
+    end
+  end
+end

data/lib/datadog/tracing/metadata/tagging.rb

@@ -51,7 +51,7 @@ module Datadog
             # Encode strings in UTF-8 to facilitate downstream serialization
             meta[Core::Utils.utf8_encode(key)] = Core::Utils.utf8_encode(value)
           end
-        rescue StandardError => e
+        rescue => e
           Datadog.logger.debug("Unable to set the tag #{key}, ignoring it. Caused by: #{e}")
         end
 
@@ -80,10 +80,10 @@ module Datadog
         end
 
         # Convenient interface for setting a single tag.
-        alias []= set_tag
+        alias_method :[]=, :set_tag
 
         # Convenient interface for getting a single tag.
-        alias [] get_tag
+        alias_method :[], :get_tag
 
         # Return the metric with the given key, nil if it doesn't exist.
         def get_metric(key)
@@ -101,7 +101,7 @@ module Datadog
 
           # Encode strings in UTF-8 to facilitate downstream serialization
           metrics[Core::Utils.utf8_encode(key)] = value
-        rescue StandardError => e
+        rescue => e
           Datadog.logger.debug("Unable to set the metric #{key}, ignoring it. Caused by: #{e}")
         end
 

data/lib/datadog/tracing/metadata.rb

@@ -2,6 +2,7 @@
 
 require_relative 'metadata/analytics'
 require_relative 'metadata/tagging'
+require_relative 'metadata/metastruct_tagging'
 require_relative 'metadata/errors'
 
 module Datadog
@@ -10,6 +11,7 @@ module Datadog
     module Metadata
       def self.included(base)
         base.include(Metadata::Tagging)
+        base.include(Metadata::MetastructTagging)
         base.include(Metadata::Errors)
 
         # Additional extensions

data/lib/datadog/tracing/pipeline/span_filter.rb

@@ -38,7 +38,9 @@ module Datadog
         private
 
         def drop_it?(span)
-          @operation.call(span) rescue false
+          @operation.call(span)
+        rescue
+          false
         end
       end
     end

data/lib/datadog/tracing/pipeline/span_processor.rb

@@ -28,7 +28,9 @@ module Datadog
         # @!visibility private
         def call(trace)
           trace.spans.each do |span|
-            @operation.call(span) rescue next
+            @operation.call(span)
+          rescue
+            next
           end
 
           trace

data/lib/datadog/tracing/pipeline.rb

@@ -47,7 +47,7 @@ module Datadog
           next nil if current_trace.nil? || current_trace.empty?
 
           process_result = processor.call(current_trace)
-          process_result && process_result.empty? ? nil : process_result
+          (process_result && process_result.empty?) ? nil : process_result
         end
       rescue => e
         Datadog.logger.debug(

data/lib/datadog/tracing/sampling/ext.rb

@@ -47,8 +47,6 @@ module Datadog
           MANUAL = '-4'
           # Formerly AppSec.
           ASM = '-5'
-          # Single Span Sampled.
-          SPAN_SAMPLING_RATE = '-8'
           # Dynamically configured rule, explicitly created by the user.
           REMOTE_USER_RULE = '-11'
           # Dynamically configured  rule, automatically generated by Datadog.

data/lib/datadog/tracing/sampling/rate_sampler.rb

@@ -9,6 +9,7 @@ module Datadog
       # {Datadog::Tracing::Sampling::RateSampler} is based on a sample rate.
       class RateSampler < Sampler
         KNUTH_FACTOR = 1111111111111111111
+        UINT64_MODULO = (1 << 64)
 
         # Initialize a {Datadog::Tracing::Sampling::RateSampler}.
         # This sampler keeps a random subset of the traces. Its main purpose is to
@@ -39,7 +40,7 @@ module Datadog
         end
 
         def sample?(trace)
-          ((trace.id * KNUTH_FACTOR) % Tracing::Utils::EXTERNAL_MAX_ID) <= @sampling_id_threshold
+          ((trace.id * KNUTH_FACTOR) % UINT64_MODULO) <= @sampling_id_threshold
         end
 
         def sample!(trace)

data/lib/datadog/tracing/sampling/rule_sampler.rb

@@ -30,26 +30,26 @@ module Datadog
           default_sampler: nil
         )
           @rules = if default_sample_rate && !default_sampler
-                     # Add to the end of the rule list a rule always matches any trace
-                     rules << SimpleRule.new(sample_rate: default_sample_rate)
-                   else
-                     rules
-                   end
+            # Add to the end of the rule list a rule always matches any trace
+            rules << SimpleRule.new(sample_rate: default_sample_rate)
+          else
+            rules
+          end
           @rate_limiter = if rate_limiter
-                            rate_limiter
-                          elsif rate_limit
-                            Core::TokenBucket.new(rate_limit)
-                          else
-                            Core::UnlimitedLimiter.new
-                          end
+            rate_limiter
+          elsif rate_limit
+            Core::TokenBucket.new(rate_limit)
+          else
+            Core::UnlimitedLimiter.new
+          end
           @default_sampler = if default_sampler
-                               default_sampler
-                             elsif default_sample_rate
-                               nil
-                             else
-                               # TODO: Simplify .tags access, as `Tracer#tags` can't be arbitrarily changed anymore
-                               RateByServiceSampler.new(1.0, env: -> { Tracing.send(:tracer).tags['env'] })
-                             end
+            default_sampler
+          elsif default_sample_rate
+            nil
+          else
+            # TODO: Simplify .tags access, as `Tracer#tags` can't be arbitrarily changed anymore
+            RateByServiceSampler.new(1.0, env: -> { Tracing.send(:tracer).tags['env'] })
+          end
         end
 
         def self.parse(rules, rate_limit, default_sample_rate)
@@ -130,17 +130,17 @@ module Datadog
             set_limiter_metrics(trace, rate_limiter.effective_rate)
 
             provenance = case rule.provenance
-                         when Rule::PROVENANCE_REMOTE_USER
-                           Ext::Decision::REMOTE_USER_RULE
-                         when Rule::PROVENANCE_REMOTE_DYNAMIC
-                           Ext::Decision::REMOTE_DYNAMIC_RULE
-                         else
-                           Ext::Decision::TRACE_SAMPLING_RULE
-                         end
+            when Rule::PROVENANCE_REMOTE_USER
+              Ext::Decision::REMOTE_USER_RULE
+            when Rule::PROVENANCE_REMOTE_DYNAMIC
+              Ext::Decision::REMOTE_DYNAMIC_RULE
+            else
+              Ext::Decision::TRACE_SAMPLING_RULE
+            end
 
             trace.set_tag(Tracing::Metadata::Ext::Distributed::TAG_DECISION_MAKER, provenance)
           end
-        rescue StandardError => e
+        rescue => e
           Datadog.logger.error(
             "Rule sampling failed. Cause: #{e.class.name} #{e.message} Source: #{Array(e.backtrace).first}"
           )
@@ -153,10 +153,10 @@ module Datadog
         # was responsible for the sampling decision.
         def set_priority(trace, sampled)
           trace.sampling_priority = if sampled
-                                      Sampling::Ext::Priority::USER_KEEP
-                                    else
-                                      Sampling::Ext::Priority::USER_REJECT
-                                    end
+            Sampling::Ext::Priority::USER_KEEP
+          else
+            Sampling::Ext::Priority::USER_REJECT
+          end
         end
 
         def set_rule_metrics(trace, sample_rate)

data/lib/datadog/tracing/sampling/span/rule.rb

@@ -24,7 +24,6 @@ module Datadog
             sample_rate: Span::Ext::DEFAULT_SAMPLE_RATE,
             rate_limit: Span::Ext::DEFAULT_MAX_PER_SECOND
           )
-
             @matcher = matcher
             @sample_rate = sample_rate
             @rate_limit = rate_limit

data/lib/datadog/tracing/sampling/span/rule_parser.rb

@@ -28,7 +28,7 @@ module Datadog
                 list = JSON.parse(rules)
               rescue => e
                 Datadog.logger.warn(
-                  "Error parsing Span Sampling Rules `#{rules.inspect}`: "\
+                  "Error parsing Span Sampling Rules `#{rules.inspect}`: " \
                   "#{e.class.name} #{e.message} at #{Array(e.backtrace).first}"
                 )
                 return nil

data/lib/datadog/tracing/sampling/span/sampler.rb

@@ -58,13 +58,6 @@ module Datadog
 
               next if decision == :not_matched # Iterate until we find a matching decision
 
-              if decision == :kept
-                trace_op.set_tag(
-                  Metadata::Ext::Distributed::TAG_DECISION_MAKER,
-                  Sampling::Ext::Decision::SPAN_SAMPLING_RATE
-                )
-              end
-
               break # Found either a `kept` or `rejected` decision
             end
 

data/lib/datadog/tracing/span.rb

@@ -33,6 +33,9 @@ module Datadog
         :status,
         :trace_id
 
+      attr_reader \
+        :metastruct
+
       attr_writer \
         :duration
 
@@ -54,6 +57,7 @@ module Datadog
         id: nil,
         meta: nil,
         metrics: nil,
+        metastruct: nil,
         parent_id: 0,
         resource: name,
         service: nil,
@@ -76,6 +80,7 @@ module Datadog
 
         @meta = meta || {}
         @metrics = metrics || {}
+        @metastruct = metastruct || {}
         @status = status || 0
 
         # start_time and end_time track wall clock. In Ruby, wall clock
@@ -108,7 +113,7 @@ module Datadog
       def stopped?
         !@end_time.nil?
       end
-      alias :finished? :stopped?
+      alias_method :finished?, :stopped?
 
       def duration
         return @duration if @duration
@@ -144,6 +149,7 @@ module Datadog
           error: @status,
           meta: @meta,
           metrics: @metrics,
+          meta_struct: @metastruct.to_h,
           name: @name,
           parent_id: @parent_id,
           resource: @resource,
@@ -185,12 +191,15 @@ module Datadog
               q.text "#{key} => #{value}"
             end
           end
-          q.group(2, 'Metrics: [', ']') do
+          q.group(2, 'Metrics: [', "]\n") do
             q.breakable
             q.seplist @metrics.each do |key, value|
               q.text "#{key} => #{value}"
             end
           end
+          q.group(2, 'Metastruct: [', ']') do
+            metastruct.pretty_print(q)
+          end
         end
       end
 

data/lib/datadog/tracing/span_event.rb

@@ -33,7 +33,7 @@ module Datadog
 
         # 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
+        @time_unix_nano = time_unix_nano || (Core::Utils::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
@@ -41,7 +41,7 @@ module Datadog
       # 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 = {'name' => @name, 'time_unix_nano' => @time_unix_nano}
         h['attributes'] = @attributes unless @attributes.empty?
         h
       end
@@ -51,15 +51,15 @@ module Datadog
       # 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 }
+        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
+            {type: ARRAY_TYPE, array_value: {values: value.map { |v| serialize_native_attribute(v) }}}
+          else
+            serialize_native_attribute(value)
+          end
         end
 
         h['attributes'] = attr unless @attributes.empty?
@@ -144,13 +144,13 @@ module Datadog
       def serialize_native_attribute(value)
         case value
         when String
-          { type: STRING_TYPE, string_value: value }
+          {type: STRING_TYPE, string_value: value}
         when TrueClass, FalseClass
-          { type: BOOLEAN_TYPE, bool_value: value }
+          {type: BOOLEAN_TYPE, bool_value: value}
         when Integer
-          { type: INTEGER_TYPE, int_value: value }
+          {type: INTEGER_TYPE, int_value: value}
         when Float
-          { type: DOUBLE_TYPE, double_value: value }
+          {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}."

data/lib/datadog/tracing/span_link.rb

@@ -47,15 +47,15 @@ module Datadog
         @span_id = digest.span_id
         @trace_id = digest.trace_id
         @trace_flags = if digest.trace_sampling_priority.nil?
-                         nil
-                       elsif digest.trace_sampling_priority > 0
-                         1
-                       else
-                         0
-                       end
-        @trace_state = digest.trace_state && digest.trace_state.dup
+          nil
+        elsif digest.trace_sampling_priority > 0
+          1
+        else
+          0
+        end
+        @trace_state = digest.trace_state&.dup
         @dropped_attributes = 0
-        @attributes = (attributes && attributes.dup) || {}
+        @attributes = attributes&.dup || {}
       end
 
       def to_hash
@@ -81,10 +81,10 @@ module Datadog
         # If traceflags set, the high bit (bit 31) should be set to 1 (uint32).
         # This helps us distinguish between when the sample decision is zero or not set
         h[:flags] = if @trace_flags.nil?
-                      0
-                    else
-                      @trace_flags | (1 << 31)
-                    end
+          0
+        else
+          @trace_flags | (1 << 31)
+        end
         h
       end
     end