Module: Datadog::Tracing::Metadata::MetastructTagging

Defined in:

lib/datadog/tracing/metadata/metastruct_tagging.rb

Overview

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.

Instance Method Summary

• #get_metastruct_tag(key) ⇒ Object

  Return the metastruct tag value for the given key, returns nil if the key doesn’t exist.

• #set_metastruct_tag(key, value) ⇒ Object

  Set the given key / value tag pair on the metastruct.

Instance Method Details

#get_metastruct_tag(key) ⇒ Object

Return the metastruct tag value for the given key, returns nil if the key doesn’t exist.

# File 'lib/datadog/tracing/metadata/metastruct_tagging.rb', line 30

def get_metastruct_tag(key)
  metastruct[key]
end

#set_metastruct_tag(key, value) ⇒ Object

Set the given key / value tag pair on the metastruct.

A valid example is:

span.set_metastruct_tag('_dd.stack', [])

# File 'lib/datadog/tracing/metadata/metastruct_tagging.rb', line 24

def set_metastruct_tag(key, value)
  metastruct[key] = value
end