honeycomb-beeline 2.1.2 → 2.4.2

data/lib/honeycomb/propagation.rb

@@ -4,63 +4,16 @@ require "base64"
 require "json"
 require "uri"
 
+require "honeycomb/propagation/honeycomb"
+
 module Honeycomb
   # Parse trace headers
   module PropagationParser
-    def parse(serialized_trace)
-      unless serialized_trace.nil?
-        version, payload = serialized_trace.split(";", 2)
-
-        if version == "1"
-          trace_id, parent_span_id, trace_fields, dataset = parse_v1(payload)
-
-          if !trace_id.nil? && !parent_span_id.nil?
-            return [trace_id, parent_span_id, trace_fields, dataset]
-          end
-        end
-      end
-
-      [nil, nil, nil, nil]
-    end
-
-    def parse_v1(payload)
-      trace_id, parent_span_id, trace_fields, dataset = nil
-      payload.split(",").each do |entry|
-        key, value = entry.split("=", 2)
-        case key
-        when "dataset"
-          dataset = URI.decode_www_form_component(value)
-        when "trace_id"
-          trace_id = value
-        when "parent_id"
-          parent_span_id = value
-        when "context"
-          Base64.decode64(value).tap do |json|
-            begin
-              trace_fields = JSON.parse json
-            rescue JSON::ParserError
-              trace_fields = {}
-            end
-          end
-        end
-      end
-
-      [trace_id, parent_span_id, trace_fields, dataset]
-    end
+    include HoneycombPropagation::UnmarshalTraceContext
   end
 
   # Serialize trace headers
   module PropagationSerializer
-    def to_trace_header
-      context = Base64.urlsafe_encode64(JSON.generate(trace.fields)).strip
-      encoded_dataset = URI.encode_www_form_component(builder.dataset)
-      data_to_propogate = [
-        "dataset=#{encoded_dataset}",
-        "trace_id=#{trace.id}",
-        "parent_id=#{id}",
-        "context=#{context}",
-      ]
-      "1;#{data_to_propogate.join(',')}"
-    end
+    include HoneycombPropagation::MarshalTraceContext
   end
 end

data/lib/honeycomb/propagation/aws.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+module Honeycomb
+  # Parsing and propagation for AWS trace headers
+  module AWSPropagation
+    # Parse trace headers
+    module UnmarshalTraceContext
+      def parse(serialized_trace)
+        unless serialized_trace.nil?
+          split = serialized_trace.split(";")
+
+          trace_id, parent_span_id, trace_fields = get_fields(split)
+
+          parent_span_id = trace_id if parent_span_id.nil?
+
+          trace_fields = nil if trace_fields.empty?
+
+          if !trace_id.nil? && !parent_span_id.nil?
+            # return nil for dataset
+            return [trace_id, parent_span_id, trace_fields, nil]
+          end
+        end
+
+        [nil, nil, nil, nil]
+      end
+
+      def get_fields(fields)
+        trace_id, parent_span_id = nil
+        trace_fields = {}
+        fields.each do |entry|
+          key, value = entry.split("=", 2)
+          case key.downcase
+          when "root"
+            trace_id = value
+          when "self"
+            parent_span_id = value
+          when "parent"
+            parent_span_id = value if parent_span_id.nil?
+          else
+            trace_fields[key] = value unless key.empty?
+          end
+        end
+
+        [trace_id, parent_span_id, trace_fields]
+      end
+
+      module_function :parse, :get_fields
+      public :parse
+    end
+
+    # Serialize trace headers
+    module MarshalTraceContext
+      def to_trace_header
+        context = [""]
+        unless trace.fields.keys.nil?
+          trace.fields.keys.each do |key|
+            context.push("#{key}=#{trace.fields[key]}")
+          end
+        end
+
+        data_to_propagate = [
+          "Root=#{trace.id}",
+          "Parent=#{id}",
+        ]
+        "#{data_to_propagate.join(';')}#{context.join(';')}"
+      end
+
+      def self.to_trace_header(propagation_context)
+        context = [""]
+        fields = propagation_context.trace_fields
+        unless fields.keys.nil?
+          fields.keys.each do |key|
+            context.push("#{key}=#{fields[key]}")
+          end
+        end
+
+        data_to_propagate = [
+          "Root=#{propagation_context.trace_id}",
+          "Parent=#{propagation_context.parent_id}",
+        ]
+        "#{data_to_propagate.join(';')}#{context.join(';')}"
+      end
+    end
+  end
+end

data/lib/honeycomb/propagation/context.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Honeycomb
+  module Propagation
+    Context = Struct.new(:trace_id, :parent_id, :trace_fields, :dataset) do
+      def to_array
+        [trace_id, parent_id, trace_fields, dataset]
+      end
+    end
+  end
+end

data/lib/honeycomb/propagation/honeycomb.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+require "base64"
+require "json"
+require "uri"
+
+module Honeycomb
+  # Parsing and propagation for honeycomb trace headers
+  module HoneycombPropagation
+    # Parse trace headers
+    module UnmarshalTraceContext
+      def parse_rack_env(env)
+        parse env["HTTP_X_HONEYCOMB_TRACE"]
+      end
+
+      def parse(serialized_trace)
+        unless serialized_trace.nil?
+          version, payload = serialized_trace.split(";", 2)
+
+          if version == "1"
+            trace_id, parent_span_id, trace_fields, dataset = parse_v1(payload)
+
+            if !trace_id.nil? && !parent_span_id.nil?
+              return [trace_id, parent_span_id, trace_fields, dataset]
+            end
+          end
+        end
+
+        [nil, nil, nil, nil]
+      end
+
+      def parse_v1(payload)
+        trace_id, parent_span_id, trace_fields, dataset = nil
+        payload.split(",").each do |entry|
+          key, value = entry.split("=", 2)
+          case key.downcase
+          when "dataset"
+            dataset = URI.decode_www_form_component(value)
+          when "trace_id"
+            trace_id = value
+          when "parent_id"
+            parent_span_id = value
+          when "context"
+            Base64.decode64(value).tap do |json|
+              begin
+                trace_fields = JSON.parse json
+              rescue JSON::ParserError
+                trace_fields = {}
+              end
+            end
+          end
+        end
+
+        [trace_id, parent_span_id, trace_fields, dataset]
+      end
+
+      module_function :parse_rack_env, :parse, :parse_v1
+      public :parse_rack_env, :parse
+    end
+
+    # Serialize trace headers
+    module MarshalTraceContext
+      def to_trace_header
+        context = Base64.urlsafe_encode64(JSON.generate(trace.fields)).strip
+        encoded_dataset = URI.encode_www_form_component(builder.dataset)
+        data_to_propogate = [
+          "dataset=#{encoded_dataset}",
+          "trace_id=#{trace.id}",
+          "parent_id=#{id}",
+          "context=#{context}",
+        ]
+        "1;#{data_to_propogate.join(',')}"
+      end
+
+      def self.parse_faraday_env(_env, propagation_context)
+        {
+          "X-Honeycomb-Trace" => to_trace_header(propagation_context),
+        }
+      end
+
+      def self.to_trace_header(propagation_context)
+        fields = propagation_context.trace_fields
+        context = Base64.urlsafe_encode64(JSON.generate(fields)).strip
+        dataset = propagation_context.dataset
+        encoded_dataset = URI.encode_www_form_component(dataset)
+        data_to_propogate = [
+          "dataset=#{encoded_dataset}",
+          "trace_id=#{propagation_context.trace_id}",
+          "parent_id=#{propagation_context.parent_id}",
+          "context=#{context}",
+        ]
+        "1;#{data_to_propogate.join(',')}"
+      end
+    end
+  end
+end

data/lib/honeycomb/propagation/w3c.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+module Honeycomb
+  # Parsing and propagation for W3C trace headers
+  module W3CPropagation
+    # Parse trace headers
+    module UnmarshalTraceContext
+      INVALID_TRACE_ID = "00000000000000000000000000000000".freeze
+      INVALID_SPAN_ID = "0000000000000000".freeze
+
+      def parse_rack_env(env)
+        parse env["HTTP_TRACEPARENT"]
+      end
+
+      def parse(serialized_trace)
+        unless serialized_trace.nil?
+          version, payload = serialized_trace.split("-", 2)
+          # version should be 2 hex characters
+          if version =~ /^[A-Fa-f0-9]{2}$/
+            trace_id, parent_span_id = parse_v1(payload)
+
+            if !trace_id.nil? && !parent_span_id.nil?
+              # return nil for dataset
+              return [trace_id, parent_span_id, nil, nil]
+            end
+          end
+        end
+        [nil, nil, nil, nil]
+      end
+
+      def parse_v1(payload)
+        trace_id, parent_span_id, trace_flags = payload.split("-", 3)
+
+        if trace_flags.nil?
+          # if trace_flags is nil, it means a field is missing
+          return [nil, nil]
+        end
+
+        if trace_id == INVALID_TRACE_ID || parent_span_id == INVALID_SPAN_ID
+          return [nil, nil]
+        end
+
+        [trace_id, parent_span_id]
+      end
+
+      module_function :parse_rack_env, :parse, :parse_v1
+      public :parse
+    end
+
+    # Serialize trace headers
+    module MarshalTraceContext
+      def to_trace_header
+        # do not propagate malformed ids
+        if trace.id =~ /^[A-Fa-f0-9]{32}$/ && id =~ /^[A-Fa-f0-9]{16}$/
+          return "00-#{trace.id}-#{id}-01"
+        end
+
+        nil
+      end
+
+      def self.parse_faraday_env(_env, propagation_context)
+        {
+          "traceparent" => to_trace_header(propagation_context),
+        }
+      end
+
+      def self.to_trace_header(propagation_context)
+        trace_id = propagation_context.trace_id
+        parent_id = propagation_context.parent_id
+        # do not propagate malformed ids
+        if trace_id =~ /^[A-Fa-f0-9]{32}$/ && parent_id =~ /^[A-Fa-f0-9]{16}$/
+          return "00-#{trace_id}-#{parent_id}-01"
+        end
+
+        nil
+      end
+    end
+  end
+end

data/lib/honeycomb/span.rb

@@ -3,6 +3,7 @@
 require "forwardable"
 require "securerandom"
 require "honeycomb/propagation"
+require "honeycomb/propagation/context"
 require "honeycomb/deterministic_sampler"
 require "honeycomb/rollup_fields"
 
@@ -34,13 +35,14 @@ module Honeycomb
       @sent = false
       @started = clock_time
       parse_options(**options)
+      parse_hooks(**options)
     end
 
     def parse_options(parent: nil,
                       parent_id: nil,
                       is_root: parent_id.nil?,
-                      sample_hook: nil,
-                      presend_hook: nil,
+                      _sample_hook: nil,
+                      _presend_hook: nil,
                       **_options)
       @parent = parent
       # parent_id should be removed in the next major version bump. It has been
@@ -48,8 +50,15 @@ module Honeycomb
       # compatability
       @parent_id = parent_id
       @is_root = is_root
+    end
+
+    def parse_hooks(sample_hook: nil,
+                    presend_hook: nil,
+                    propagation_hook: nil,
+                    **_options)
       @presend_hook = presend_hook
       @sample_hook = sample_hook
+      @propagation_hook = propagation_hook
     end
 
     def create_child
@@ -59,7 +68,8 @@ module Honeycomb
                      parent: self,
                      parent_id: id,
                      sample_hook: sample_hook,
-                     presend_hook: presend_hook).tap do |c|
+                     presend_hook: presend_hook,
+                     propagation_hook: propagation_hook).tap do |c|
         children << c
       end
     end
@@ -70,6 +80,14 @@ module Honeycomb
       send_internal
     end
 
+    def trace_headers(env)
+      if propagation_hook
+        propagation_hook.call(env, propagation_context)
+      else
+        {}
+      end
+    end
+
     protected
 
     def send_by_parent
@@ -94,7 +112,17 @@ module Honeycomb
                 :builder,
                 :context,
                 :presend_hook,
-                :sample_hook
+                :sample_hook,
+                :propagation_hook
+
+    def propagation_context
+      Honeycomb::Propagation::Context.new(
+        trace.id,
+        id,
+        trace.fields,
+        builder.dataset,
+      )
+    end
 
     def sent?
       @sent

data/lib/honeycomb/trace.rb

@@ -19,7 +19,8 @@ module Honeycomb
 
     def initialize(builder:, context:, serialized_trace: nil, **options)
       trace_id, parent_span_id, trace_fields, dataset =
-        parse serialized_trace
+        internal_parse(serialized_trace: serialized_trace, **options)
+
       dataset && builder.dataset = dataset
       @id = trace_id || generate_trace_id
       @fields = trace_fields || {}
@@ -45,5 +46,17 @@ module Honeycomb
         return id unless id == INVALID_TRACE_ID
       end
     end
+
+    def internal_parse(serialized_trace: nil, parser_hook: nil, **_options)
+      # previously we passed in the header directly as a string for us to parse
+      # now we get passed the rack env to use as an argument to the provided
+      # parser_hook. This preserves the current behaviour and allows us to
+      # move forward with the new behaviour without breaking changes
+      if serialized_trace.is_a?(Hash) && parser_hook
+        parser_hook.call(serialized_trace)
+      else
+        parse serialized_trace
+      end
+    end
   end
 end