Add meta_struct support on traces and spans

Author: vpellan

lib/datadog/tracing/metadata.rb

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

lib/datadog/tracing/metadata/meta_struct.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Datadog
+  module Tracing
+    module Metadata
+      # Adds complex structures tagging behavior through meta_struct
+      # @public_api
+      module MetaStruct
+        def set_meta_struct(meta_struct)
+          self.meta_struct.merge!(meta_struct)
+        end
+
+        protected
+
+        def meta_struct
+          @meta_struct ||= {}
+        end
+      end
+    end
+  end
+end

lib/datadog/tracing/span.rb

@@ -21,6 +21,7 @@ class Span
         :end_time,
         :id,
         :meta,
+        :meta_struct,
         :metrics,
         :name,
         :parent_id,
@@ -53,6 +54,7 @@ def initialize(
         end_time: nil,
         id: nil,
         meta: nil,
+        meta_struct: nil,
         metrics: nil,
         parent_id: 0,
         resource: name,
@@ -75,6 +77,7 @@ def initialize(
         @trace_id = trace_id || Tracing::Utils.next_id
 
         @meta = meta || {}
+        @meta_struct = meta_struct || {}
         @metrics = metrics || {}
         @status = status || 0
 
@@ -144,6 +147,7 @@ def to_hash
           error: @status,
           meta: @meta,
           metrics: @metrics,
+          meta_struct: @meta_struct,
           name: @name,
           parent_id: @parent_id,
           resource: @resource,
@@ -185,12 +189,16 @@ def pretty_print(q)
               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, 'Meta-Struct: [', ']') do
+            q.breakable
+            q.pp meta_struct
+          end
         end
       end
 

lib/datadog/tracing/span_operation.rb

@@ -289,6 +289,7 @@ def to_hash
           id: @id,
           meta: meta,
           metrics: metrics,
+          meta_struct: meta_struct,
           name: @name,
           parent_id: @parent_id,
           resource: @resource,
@@ -328,12 +329,16 @@ def pretty_print(q)
               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, 'Meta-Struct: [', ']') do
+            q.breakable
+            q.pp meta_struct
+          end
         end
       end
 
@@ -456,6 +461,7 @@ def build_span
           id: @id,
           meta: Core::Utils::SafeDup.frozen_or_dup(meta),
           metrics: Core::Utils::SafeDup.frozen_or_dup(metrics),
+          meta_struct: Core::Utils::SafeDup.frozen_or_dup(meta_struct),
           parent_id: @parent_id,
           resource: @resource,
           service: @service,

lib/datadog/tracing/trace_operation.rb

@@ -4,7 +4,7 @@
 require_relative '../core/utils'
 require_relative 'tracer'
 require_relative 'event'
-require_relative 'metadata/tagging'
+require_relative 'metadata'
 require_relative 'sampling/ext'
 require_relative 'span_operation'
 require_relative 'trace_digest'
@@ -25,7 +25,7 @@ module Tracing
     #
     # @public_api
     class TraceOperation
-      include Metadata::Tagging
+      include Metadata
 
       DEFAULT_MAX_LENGTH = 100_000
 
@@ -73,6 +73,7 @@ def initialize(
         profiling_enabled: nil,
         tags: nil,
         metrics: nil,
+        meta_struct: nil,
         trace_state: nil,
         trace_state_unknown_fields: nil,
         remote_parent: false,
@@ -105,6 +106,7 @@ def initialize(
         # Generic tags
         set_tags(tags) if tags
         set_tags(metrics) if metrics
+        set_meta_struct(meta_struct) if meta_struct
 
         # State
         @root_span = nil
@@ -369,6 +371,7 @@ def fork_clone
           trace_state_unknown_fields: (@trace_state_unknown_fields && @trace_state_unknown_fields.dup),
           tags: meta.dup,
           metrics: metrics.dup,
+          meta_struct: meta_struct.dup,
           remote_parent: @remote_parent
         )
       end
@@ -508,6 +511,7 @@ def build_trace(spans, partial = false)
           service: service,
           tags: meta,
           metrics: metrics,
+          meta_struct: meta_struct,
           root_span_id: !partial ? root_span && root_span.id : nil,
           profiling_enabled: @profiling_enabled,
         )

lib/datadog/tracing/trace_segment.rb

@@ -58,6 +58,7 @@ def initialize(
         service: nil,
         tags: nil,
         metrics: nil,
+        meta_struct: nil,
         profiling_enabled: nil
       )
         @id = id
@@ -68,6 +69,7 @@ def initialize(
         # The caller is expected to have done that
         @meta = (tags && tags.dup) || {}
         @metrics = (metrics && metrics.dup) || {}
+        @meta_struct = (meta_struct && meta_struct.dup) || {}
 
         # Set well-known tags, defaulting to getting the values from tags
         @agent_sample_rate = agent_sample_rate || agent_sample_rate_tag
@@ -146,7 +148,8 @@ def high_order_tid
       attr_reader \
         :root_span_id,
         :meta,
-        :metrics
+        :metrics,
+        :meta_struct
 
       private
 

lib/datadog/tracing/transport/serializable_trace.rb

@@ -65,7 +65,7 @@ def initialize(span, native_events_supported)
         def to_msgpack(packer = nil)
           packer ||= MessagePack::Packer.new
 
-          number_of_elements_to_write = 11
+          number_of_elements_to_write = 12
 
           number_of_elements_to_write += 1 if span.events.any? && @native_events_supported
 
@@ -113,6 +113,9 @@ def to_msgpack(packer = nil)
           packer.write(span.meta)
           packer.write('metrics')
           packer.write(span.metrics)
+          packer.write('meta_struct')
+          # We encapsulate the resulting msgpack in a binary msgpack
+          packer.write(span.meta_struct.transform_values(&:to_msgpack))
           packer.write('span_links')
           packer.write(span.links.map(&:to_hash))
           packer.write('error')

lib/datadog/tracing/transport/trace_formatter.rb

@@ -43,6 +43,7 @@ def format!
           # Apply generic trace tags. Any more specific value will be overridden
           # by the subsequent calls below.
           set_trace_tags!
+          set_meta_struct!
 
           set_resource!
 
@@ -89,6 +90,12 @@ def set_trace_tags!
           root_span.set_tags(trace.send(:metrics))
         end
 
+        def set_meta_struct!
+          return if partial?
+
+          root_span.set_meta_struct(trace.send(:meta_struct))
+        end
+
         def tag_agent_sample_rate!
           return unless trace.agent_sample_rate
 

lib/datadog/tracing/transport/traces.rb

@@ -125,6 +125,7 @@ def initialize(apis, default_api)
           end
 
           def send_traces(traces)
+            # object that extends Datadog::Core::Encoding::Encoder (MsgpackEncoder or JSONEncoder)
             encoder = current_api.encoder
             chunker = Datadog::Tracing::Transport::Traces::Chunker.new(encoder)
 

sig/datadog/tracing/metadata.rbs

@@ -3,6 +3,7 @@ module Datadog
     module Metadata
       include Metadata::Tagging
       include Metadata::Errors
+      include Metadata::MetaStruct
       prepend Metadata::Analytics
     end
   end

sig/datadog/tracing/metadata/meta_struct.rbs

@@ -0,0 +1,11 @@
+module Datadog
+  module Tracing
+    module Metadata
+      module MetaStruct
+        def set_meta_struct: (Hash[String, untyped] meta_struct) -> void
+
+        def meta_struct: () -> Hash[String, untyped]
+      end
+    end
+  end
+end

sig/datadog/tracing/span.rbs

@@ -6,13 +6,14 @@ module Datadog
       attr_accessor end_time: (Time | nil)
       attr_accessor id: Integer
       attr_accessor meta: Hash[String, String]
+      attr_accessor meta_struct: Hash[String, untyped]
       attr_accessor metrics: Hash[String, Float]
       attr_accessor name: String
       attr_accessor parent_id: Integer
       attr_accessor resource: String
       attr_accessor service: (String | nil)
-      attr_accessor links: Array[untyped]
-      attr_accessor events: Array[untyped]
+      attr_accessor links: Array[Datadog::Tracing::SpanLink]
+      attr_accessor events: Array[Datadog::Tracing::SpanEvent]
       attr_accessor type: (String | nil)
       attr_accessor start_time: (Time | nil)
       attr_accessor status: Integer
@@ -25,6 +26,7 @@ module Datadog
           ?end_time: (Time | nil),
           ?id: (Integer | nil),
           ?meta: (Hash[String, String] | nil),
+          ?meta_struct: (Hash[String, untyped] | nil),
           ?metrics: (Hash[String, Float] | nil),
           ?parent_id: Integer,
           ?resource: String,
@@ -34,12 +36,15 @@ module Datadog
           ?type: (String | nil),
           ?trace_id: (Integer | nil),
           ?service_entry: (bool | nil),
-          ?links: (Array[untyped] | nil),
-          ?events: (Array[untyped] | nil)
+          ?links: (Array[Datadog::Tracing::SpanLink] | nil),
+          ?events: (Array[Datadog::Tracing::SpanEvent] | nil)
         ) -> void
 
       def started?: -> bool
       def stopped?: -> bool
+
+      alias finished? stopped?
+
       def duration: -> (Float | nil)
       def set_error: (Exception e) -> void
       def ==: (Span other) -> bool

sig/datadog/tracing/trace_operation.rbs

@@ -1,7 +1,7 @@
 module Datadog
   module Tracing
     class TraceOperation
-      include Metadata::Tagging
+      include Metadata
 
       DEFAULT_MAX_LENGTH: ::Integer
 
@@ -23,7 +23,7 @@ module Datadog
       attr_writer sampled: untyped
       attr_writer service: untyped
 
-      def initialize: (?agent_sample_rate: untyped?, ?events: untyped?, ?hostname: untyped?, ?id: untyped?, ?max_length: untyped, ?name: untyped?, ?origin: untyped?, ?parent_span_id: untyped?, ?rate_limiter_rate: untyped?, ?resource: untyped?, ?rule_sample_rate: untyped?, ?sample_rate: untyped?, ?sampled: untyped?, ?sampling_priority: untyped?, ?service: untyped?, ?tags: untyped?, ?metrics: untyped?, ?remote_parent: untyped?) -> void
+      def initialize: (?agent_sample_rate: untyped?, ?events: untyped?, ?hostname: untyped?, ?id: untyped?, ?max_length: untyped, ?name: untyped?, ?origin: untyped?, ?parent_span_id: untyped?, ?rate_limiter_rate: untyped?, ?resource: untyped?, ?rule_sample_rate: untyped?, ?sample_rate: untyped?, ?sampled: untyped?, ?sampling_priority: untyped?, ?service: untyped?, ?tags: untyped?, ?meta_struct: untyped?, ?metrics: untyped?, ?remote_parent: untyped?) -> void
       def full?: () -> untyped
       def finished_span_count: () -> untyped
       def finished?: () -> untyped

sig/datadog/tracing/trace_segment.rbs

@@ -22,7 +22,7 @@ module Datadog
       attr_reader sampling_priority: untyped
       attr_reader service: untyped
 
-      def initialize: (untyped spans, ?agent_sample_rate: untyped?, ?hostname: untyped?, ?id: untyped?, ?lang: untyped?, ?name: untyped?, ?origin: untyped?, ?process_id: untyped?, ?rate_limiter_rate: untyped?, ?resource: untyped?, ?root_span_id: untyped?, ?rule_sample_rate: untyped?, ?runtime_id: untyped?, ?sample_rate: untyped?, ?sampling_priority: untyped?, ?service: untyped?, ?tags: untyped?, ?metrics: untyped?) -> void
+      def initialize: (untyped spans, ?agent_sample_rate: untyped?, ?hostname: untyped?, ?id: untyped?, ?lang: untyped?, ?name: untyped?, ?origin: untyped?, ?process_id: untyped?, ?rate_limiter_rate: untyped?, ?resource: untyped?, ?root_span_id: untyped?, ?rule_sample_rate: untyped?, ?runtime_id: untyped?, ?sample_rate: untyped?, ?sampling_priority: untyped?, ?service: untyped?, ?tags: untyped?, ?metrics: untyped?, ?meta_struct: untyped?) -> void
       def any?: () -> untyped
       def count: () -> untyped
       def empty?: () -> untyped
@@ -36,6 +36,7 @@ module Datadog
       attr_reader root_span_id: untyped
       attr_reader meta: untyped
       attr_reader metrics: untyped
+      attr_reader meta_struct: untyped
 
       private
 

spec/datadog/tracing/span_spec.rb

@@ -243,6 +243,7 @@
         resource: 'my.span',
         type: nil,
         meta: {},
+        meta_struct: {},
         metrics: {},
         span_links: [],
         error: 0

spec/datadog/tracing/transport/serializable_trace_spec.rb

@@ -39,6 +39,7 @@
           'resource',
           'type',
           'meta',
+          'meta_struct',
           'metrics',
           'span_links',
           'error',