datadog 2.38.0 → 2.39.0

data/lib/datadog/tracing/distributed/b3_multi.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-require_relative 'helpers'
-require_relative '../trace_digest'
-require_relative '../utils'
+require_relative "helpers"
+require_relative "../trace_digest"
+require_relative "../utils"
 
 module Datadog
   module Tracing
@@ -10,9 +10,9 @@ module Datadog
       # B3 multi header-style trace propagation.
       # @see https://github.com/openzipkin/b3-propagation#multiple-headers
       class B3Multi
-        B3_TRACE_ID_KEY = 'x-b3-traceid'
-        B3_SPAN_ID_KEY = 'x-b3-spanid'
-        B3_SAMPLED_KEY = 'x-b3-sampled'
+        B3_TRACE_ID_KEY = "x-b3-traceid"
+        B3_SPAN_ID_KEY = "x-b3-spanid"
+        B3_SAMPLED_KEY = "x-b3-sampled"
 
         def initialize(
           fetcher:,
@@ -30,8 +30,8 @@ module Datadog
           return if digest.nil?
 
           # DEV: We need these to be hex encoded
-          data[@trace_id_key] = format('%032x', digest.trace_id)
-          data[@span_id_key] = format('%016x', digest.span_id || 0) # # Fall back to zero (invalid) if not present
+          data[@trace_id_key] = format("%032x", digest.trace_id)
+          data[@span_id_key] = format("%016x", digest.span_id || 0) # # Fall back to zero (invalid) if not present
 
           if digest.trace_sampling_priority
             sampling_priority = Helpers.clamp_sampling_priority(

data/lib/datadog/tracing/distributed/b3_single.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require_relative 'helpers'
-require_relative '../trace_digest'
+require_relative "helpers"
+require_relative "../trace_digest"
 
 module Datadog
   module Tracing
@@ -15,7 +15,7 @@ module Datadog
       #
       # @see https://github.com/openzipkin/b3-propagation#single-header
       class B3Single
-        B3_SINGLE_HEADER_KEY = 'b3'
+        B3_SINGLE_HEADER_KEY = "b3"
 
         def initialize(fetcher:, key: B3_SINGLE_HEADER_KEY)
           @key = key
@@ -47,7 +47,7 @@ module Datadog
 
           return unless value
 
-          parts = value.split('-')
+          parts = value.split("-")
           trace_id = Helpers.parse_hex_id(parts[0]) unless parts.empty?
           # Return early if this propagation is not valid
           return if trace_id.nil? || trace_id <= 0 || trace_id > Tracing::Utils::TraceId::MAX

data/lib/datadog/tracing/distributed/baggage.rb

@@ -1,12 +1,12 @@
 # frozen_string_literal: true
 
-require_relative '../ext'
-require_relative '../metadata/ext'
-require_relative '../trace_digest'
-require_relative 'datadog_tags_codec'
-require_relative '../utils'
-require_relative 'helpers'
-require 'uri'
+require_relative "../ext"
+require_relative "../metadata/ext"
+require_relative "../trace_digest"
+require_relative "datadog_tags_codec"
+require_relative "../utils"
+require_relative "helpers"
+require "uri"
 
 module Datadog
   module Tracing
@@ -15,10 +15,10 @@ module Datadog
       # The baggage header is propagated through `baggage`.
       # @see https://www.w3.org/TR/baggage/
       class Baggage
-        BAGGAGE_KEY = 'baggage'
+        BAGGAGE_KEY = "baggage"
         DD_TRACE_BAGGAGE_MAX_ITEMS = 64
         DD_TRACE_BAGGAGE_MAX_BYTES = 8192
-        BAGGAGE_TAG_KEYS_MATCH_ALL = ['*'].freeze
+        BAGGAGE_TAG_KEYS_MATCH_ALL = ["*"].freeze
         SAFE_CHARACTERS_KEY = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789$!#&'*+-.^_`|~"
         SAFE_CHARACTERS_VALUE = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789$!#&'()*+-./:<>?@[]^_`{|}~"
 
@@ -43,9 +43,9 @@ module Datadog
               ::Datadog.logger.warn("Baggage item limit (#{DD_TRACE_BAGGAGE_MAX_ITEMS}) exceeded, dropping excess items")
               # Record telemetry for item count truncation
               record_telemetry_metric(
-                'context_header.truncated',
+                "context_header.truncated",
                 1,
-                {'header_style' => 'baggage', 'truncation_reason' => 'baggage_item_count_exceeded'}
+                {"header_style" => "baggage", "truncation_reason" => "baggage_item_count_exceeded"}
               )
               baggage_items = baggage_items.first(DD_TRACE_BAGGAGE_MAX_ITEMS)
             end
@@ -60,9 +60,9 @@ module Datadog
                 ::Datadog.logger.warn("Baggage header size (#{DD_TRACE_BAGGAGE_MAX_BYTES}) exceeded, dropping excess items")
                 # Record telemetry for byte count truncation
                 record_telemetry_metric(
-                  'context_header.truncated',
+                  "context_header.truncated",
                   1,
-                  {'header_style' => 'baggage', 'truncation_reason' => 'baggage_byte_count_exceeded'}
+                  {"header_style" => "baggage", "truncation_reason" => "baggage_byte_count_exceeded"}
                 )
                 break # stop adding items when size limit is reached
               end
@@ -73,10 +73,10 @@ module Datadog
             # edge case where a single item is too large
             return if encoded_items.empty?
 
-            data[@baggage_key] = encoded_items.join(',')
+            data[@baggage_key] = encoded_items.join(",")
 
             # Record telemetry for successful injection
-            record_telemetry_metric('context_header_style.injected', 1, {'header_style' => 'baggage'})
+            record_telemetry_metric("context_header_style.injected", 1, {"header_style" => "baggage"})
           rescue => e
             ::Datadog.logger.warn("Failed to encode and inject baggage header: #{e.class}: #{e.message}")
           end
@@ -95,7 +95,7 @@ module Datadog
 
           # Record telemetry for successful extraction only if baggage is not empty
           unless baggage.empty?
-            record_telemetry_metric('context_header_style.extracted', 1, {'header_style' => 'baggage'})
+            record_telemetry_metric("context_header_style.extracted", 1, {"header_style" => "baggage"})
           end
 
           TraceDigest.new(
@@ -110,7 +110,7 @@ module Datadog
           # Strip whitespace and URL-encode the item
           result = URI.encode_www_form_component(item.strip)
           # Replace '+' with '%20' for space encoding consistency with W3C spec
-          result = result.gsub('+', '%20')
+          result = result.gsub("+", "%20")
           # Selectively decode percent-encoded characters that are considered "safe" in W3C Baggage spec
           result.gsub(/%[0-9A-F]{2}/) do |encoded|
             if encoded.size >= 3 && encoded[1..2] =~ /\A[0-9A-F]{2}\z/
@@ -118,7 +118,7 @@ module Datadog
               next encoded unless hex_str && !hex_str.empty?
 
               # Convert hex representation back to character
-              char = [hex_str.hex].pack('C')
+              char = [hex_str.hex].pack("C")
               # Keep the character as-is if it's in the safe character set, otherwise keep it encoded
               safe_characters.include?(char) ? char : encoded
             else
@@ -145,12 +145,12 @@ module Datadog
           # the typical Rack path is unaffected; only UTF-8-tagged-but-actually-invalid
           # input (e.g. headers re-encoded upstream) is short-circuited here.
           unless baggage_header.valid_encoding?
-            record_telemetry_metric('context_header_style.malformed', 1, {'header_style' => 'baggage'})
+            record_telemetry_metric("context_header_style.malformed", 1, {"header_style" => "baggage"})
             return {}
           end
 
           if baggage_header.bytesize > DD_TRACE_BAGGAGE_MAX_BYTES
-            record_telemetry_metric('context_header.truncated', 1, {'header_style' => 'baggage', 'truncation_reason' => 'baggage_byte_count_exceeded'})
+            record_telemetry_metric("context_header.truncated", 1, {"header_style" => "baggage", "truncation_reason" => "baggage_byte_count_exceeded"})
 
             # We MUST NOT propagate partial entries, but we SHOULD try
             # to parse as much of the baggage as possible:
@@ -158,7 +158,7 @@ module Datadog
 
             # We parse 1 byte over the limit to detect if the last entry
             # is a partial entry (toss) or ends exactly at the limit (keep).
-            remove_last_entry = baggage_header.byteslice(DD_TRACE_BAGGAGE_MAX_BYTES, 1) != ','
+            remove_last_entry = baggage_header.byteslice(DD_TRACE_BAGGAGE_MAX_BYTES, 1) != ","
 
             # To ensure we don't have a trailing partial UTF-8 codepoint, we keep one extra byte
             # and safely remove it with `#chop`.
@@ -171,10 +171,10 @@ module Datadog
           baggage = {}
           # DEV: To avoid unnecessary eager string allocation, replace with
           # DEV: `split(',') { |s| ... }` when Ruby 2.5 is no longer supported.
-          baggages = baggage_header.split(',', DD_TRACE_BAGGAGE_MAX_ITEMS + 1) # Stop splitting if we've reached max size
+          baggages = baggage_header.split(",", DD_TRACE_BAGGAGE_MAX_ITEMS + 1) # Stop splitting if we've reached max size
           baggages.each_with_index do |key_value, index|
             if index >= DD_TRACE_BAGGAGE_MAX_ITEMS
-              record_telemetry_metric('context_header.truncated', 1, {'header_style' => 'baggage', 'truncation_reason' => 'baggage_item_count_exceeded'})
+              record_telemetry_metric("context_header.truncated", 1, {"header_style" => "baggage", "truncation_reason" => "baggage_item_count_exceeded"})
               break
             end
 
@@ -184,11 +184,11 @@ module Datadog
             # Empty items are skipped
             next if key_value.strip.empty?
 
-            key, value = key_value.split('=', 2)
+            key, value = key_value.split("=", 2)
             # If baggage is malformed, return an empty hash
             if key.nil? || value.nil?
               # Record telemetry for malformed header
-              record_telemetry_metric('context_header_style.malformed', 1, {'header_style' => 'baggage'})
+              record_telemetry_metric("context_header_style.malformed", 1, {"header_style" => "baggage"})
               return {}
             end
 
@@ -199,13 +199,13 @@ module Datadog
               # `URI.decode_www_form_component` raises on malformed percent encoding
               # (e.g. `%XX`, lone `%`). Treat as malformed rather than letting it
               # propagate to `Propagation#extract`'s caller.
-              record_telemetry_metric('context_header_style.malformed', 1, {'header_style' => 'baggage'})
+              record_telemetry_metric("context_header_style.malformed", 1, {"header_style" => "baggage"})
               return {}
             end
 
             if key.empty? || value.empty?
               # Record telemetry for malformed header
-              record_telemetry_metric('context_header_style.malformed', 1, {'header_style' => 'baggage'})
+              record_telemetry_metric("context_header_style.malformed", 1, {"header_style" => "baggage"})
               return {}
             end
 

data/lib/datadog/tracing/distributed/datadog.rb

@@ -1,25 +1,25 @@
 # frozen_string_literal: true
 
-require_relative '../metadata/ext'
-require_relative '../trace_digest'
-require_relative 'datadog_tags_codec'
-require_relative '../utils'
-require_relative 'helpers'
+require_relative "../metadata/ext"
+require_relative "../trace_digest"
+require_relative "datadog_tags_codec"
+require_relative "../utils"
+require_relative "helpers"
 
 module Datadog
   module Tracing
     module Distributed
       # Datadog-style trace propagation.
       class Datadog
-        TRACE_ID_KEY = 'x-datadog-trace-id'
-        PARENT_ID_KEY = 'x-datadog-parent-id'
-        SAMPLING_PRIORITY_KEY = 'x-datadog-sampling-priority'
-        ORIGIN_KEY = 'x-datadog-origin'
+        TRACE_ID_KEY = "x-datadog-trace-id"
+        PARENT_ID_KEY = "x-datadog-parent-id"
+        SAMPLING_PRIORITY_KEY = "x-datadog-sampling-priority"
+        ORIGIN_KEY = "x-datadog-origin"
         # Distributed trace-level tags
-        TAGS_KEY = 'x-datadog-tags'
+        TAGS_KEY = "x-datadog-tags"
 
         # Prefix used by all Datadog-specific distributed tags
-        TAGS_PREFIX = 'x-datadog-'
+        TAGS_PREFIX = "x-datadog-"
 
         def initialize(
           fetcher:,
@@ -108,7 +108,7 @@ module Datadog
 
           return tags if high_order == 0
 
-          tags.merge(Tracing::Metadata::Ext::Distributed::TAG_TID => format('%016x', high_order))
+          tags.merge(Tracing::Metadata::Ext::Distributed::TAG_TID => format("%016x", high_order))
         end
 
         # Side effect: Remove high order 64 bit hex-encoded `tid` tag from distributed tags
@@ -127,15 +127,15 @@ module Datadog
         # DEV: This means errors cannot be reported if there's not active span.
         # DEV: Ideally, we'd have a dedicated error reporting stream for all of datadog.
         def inject_tags!(tags, data)
-          return set_tags_propagation_error(reason: 'disabled') if tags_disabled?
+          return set_tags_propagation_error(reason: "disabled") if tags_disabled?
 
           encoded_tags = DatadogTagsCodec.encode(tags)
 
-          return set_tags_propagation_error(reason: 'inject_max_size') if tags_too_large?(encoded_tags, scenario: 'inject')
+          return set_tags_propagation_error(reason: "inject_max_size") if tags_too_large?(encoded_tags, scenario: "inject")
 
           data[@tags_key] = encoded_tags
         rescue => e
-          set_tags_propagation_error(reason: 'encoding_error')
+          set_tags_propagation_error(reason: "encoding_error")
           ::Datadog.logger.warn(
             "Failed to inject x-datadog-tags: #{e.class}: #{e.message} at #{Array(e.backtrace).first}"
           )
@@ -152,8 +152,8 @@ module Datadog
           tags = fetcher[@tags_key]
 
           return if !tags || tags.empty?
-          return set_tags_propagation_error(reason: 'disabled') if tags_disabled?
-          return set_tags_propagation_error(reason: 'extract_max_size') if tags_too_large?(tags, scenario: 'extract')
+          return set_tags_propagation_error(reason: "disabled") if tags_disabled?
+          return set_tags_propagation_error(reason: "extract_max_size") if tags_too_large?(tags, scenario: "extract")
 
           tags_hash = DatadogTagsCodec.decode(tags)
           # Only extract keys with the expected Datadog prefix
@@ -162,7 +162,7 @@ module Datadog
           end
           tags_hash
         rescue => e
-          set_tags_propagation_error(reason: 'decoding_error')
+          set_tags_propagation_error(reason: "decoding_error")
           ::Datadog.logger.warn(
             "Failed to extract x-datadog-tags: #{e.class}: #{e.message} at #{Array(e.backtrace).first}"
           )
@@ -171,7 +171,7 @@ module Datadog
 
         def set_tags_propagation_error(reason:)
           active_trace = Tracing.active_trace
-          active_trace&.set_tag('_dd.propagation_error', reason)
+          active_trace&.set_tag("_dd.propagation_error", reason)
           nil
         end
 
@@ -188,14 +188,14 @@ module Datadog
           ::Datadog.logger.warn(
             "Failed to #{scenario} x-datadog-tags: tags are too large for configured limit (bytesize:#{size} >= " \
               "limit:#{max_length}). This limit can be configured " \
-              'through the DD_TRACE_X_DATADOG_TAGS_MAX_LENGTH environment variable.'
+              "through the DD_TRACE_X_DATADOG_TAGS_MAX_LENGTH environment variable."
           )
 
           true
         end
 
         # We want to exclude tags that we don't want to propagate downstream.
-        EXCLUDED_TAG = '_dd.p.upstream_services'
+        EXCLUDED_TAG = "_dd.p.upstream_services"
         private_constant :EXCLUDED_TAG
       end
     end

data/lib/datadog/tracing/distributed/datadog_tags_codec.rb

@@ -26,7 +26,7 @@ module Datadog
             raise EncodingError, "Invalid value `#{value}` for key `#{key}`" unless VALID_VALUE_CHARS.match?(value)
 
             "#{key}=#{value.strip}"
-          end.join(',')
+          end.join(",")
         rescue => e
           raise EncodingError, "Error encoding tags `#{tags}`: `#{e.class}: #{e.message}`"
         end
@@ -37,8 +37,8 @@ module Datadog
         # @return [Hash<String,String>] decoded input as a hash of strings
         # @raise [DecodingError] if string does not conform to the `x-datadog-tags` format
         def self.decode(string)
-          result = (string.split(',').map do |raw_tag|
-            raw_tag.split('=', 2).tap do |raw_key, raw_value|
+          result = (string.split(",").map do |raw_tag|
+            raw_tag.split("=", 2).tap do |raw_key, raw_value|
               key = raw_key.to_s
               value = raw_value.to_s
 

data/lib/datadog/tracing/distributed/fetcher.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative 'helpers'
+require_relative "helpers"
 
 module Datadog
   module Tracing

data/lib/datadog/tracing/distributed/helpers.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require_relative '../sampling/ext'
-require_relative '../utils'
+require_relative "../sampling/ext"
+require_relative "../utils"
 
 module Datadog
   module Tracing
@@ -47,7 +47,7 @@ module Datadog
           #      for us so we want to make sure the comparision will work as expected
           # DEV: regex, remove all leading zeros up until we find the last 0 in the string
           #      or we find the first non-zero, this allows `'0000' -> '0'` and `'00001' -> '1'`
-          value = value.sub(/^0*(?=(0$)|[^0])/, '')
+          value = value.sub(/^0*(?=(0$)|[^0])/, "")
 
           # Convert value to an integer
           # DEV: Ruby `.to_i` will return `0` if a number could not be parsed

data/lib/datadog/tracing/distributed/propagation.rb

@@ -1,11 +1,11 @@
 # frozen_string_literal: true
 
-require_relative '../configuration/ext'
-require_relative '../trace_digest'
-require_relative '../trace_operation'
-require_relative '../span_link'
-require_relative '../../core/telemetry/logger'
-require_relative 'baggage'
+require_relative "../configuration/ext"
+require_relative "../trace_digest"
+require_relative "../trace_operation"
+require_relative "../span_link"
+require_relative "../../core/telemetry/logger"
+require_relative "baggage"
 
 module Datadog
   module Tracing
@@ -62,13 +62,13 @@ module Datadog
         # @return [nil] in case of unrecoverable errors, see `Datadog.logger` output for details.
         def inject!(digest, data)
           if digest.nil?
-            ::Datadog.logger.debug('Cannot inject distributed trace data: digest is nil.')
+            ::Datadog.logger.debug("Cannot inject distributed trace data: digest is nil.")
             return nil
           end
 
           digest = digest.to_digest if digest.respond_to?(:to_digest)
           if digest.trace_id.nil? && digest.baggage.nil?
-            ::Datadog.logger.debug('Cannot inject distributed trace data: digest.trace_id and digest.baggage are both nil.')
+            ::Datadog.logger.debug("Cannot inject distributed trace data: digest.trace_id and digest.baggage are both nil.")
             return nil
           end
 
@@ -166,11 +166,11 @@ module Datadog
           link = SpanLink.new(
             extracted_trace_digest,
             attributes: {
-              'reason' => 'propagation_behavior_extract',
-              'context_headers' => extracted_style_name,
+              "reason" => "propagation_behavior_extract",
+              "context_headers" => extracted_style_name,
             }
           )
-          baggage_tags = extracted_trace_digest.trace_distributed_tags&.select { |k, _| k.start_with?('baggage.') }
+          baggage_tags = extracted_trace_digest.trace_distributed_tags&.select { |k, _| k.start_with?("baggage.") }
           baggage_tags = nil if baggage_tags&.empty?
           TraceDigest.new(
             span_links: [link],
@@ -210,7 +210,7 @@ module Datadog
             tracecontext_tags[Tracing::Metadata::Ext::Distributed::TAG_DD_PARENT_ID]
           elsif dd_propagator && (dd_digest = dd_propagator.extract(headers))
             # if p value is not present in tracestate, use the parent id from the datadog headers
-            format('%016x', dd_digest.span_id)
+            format("%016x", dd_digest.span_id)
           end
         end
       end