honeycomb-beeline 2.1.2 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7f19c4aff5f79d28bb532e24562c1070a1e4f6b2ee86d627e114a4fad388539f
-  data.tar.gz: f4a64e080f22e85e32e3e75b8655c8bd7e126ef67d6b928a69089df3ee57f4cf
+  metadata.gz: 861b65eb2d7ef9f82cad990b966247465eebb0eac7ec4fa6d668491d979e9eee
+  data.tar.gz: 2e1b7ef3a15d2b2be27a4593eafabe399331909df925724abc3978cc47aed01c
 SHA512:
-  metadata.gz: 8d6289b4ad7b7e1e82520925f59096761be2adff0c028a503676b692039138d3c0501df71b9a2fe6b2687fe592cc5abdcc6447476553bf0ca73eb630e7f9a43f
-  data.tar.gz: cf4f69a76786874d9e1e0cc2ef016365412613e9113913b863d0c7240e0cc034e8aa528ffc17cf54c95886ebc1cf6010a986a419ea59cfd4c82a45c3ec054224
+  metadata.gz: b50cd4118393ff03349894bb4942bb166baafb51fdf587b76a5e8f1b34411d2a49c8698cc9bb8f28746211143f93bf88e5fc23de13479acbd526383f7065410d
+  data.tar.gz: f123f2ad239e1f72874199999d08a8b3137b318f1d92d9a295b3bfdb4d17d8097c3577ebca666e7b26d0d9d5940fe6b6db2ec92f9028dfbffa1740898e43281c

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    honeycomb-beeline (2.1.2)
+    honeycomb-beeline (2.2.0)
       libhoney (~> 1.14, >= 1.14.2)
 
 GEM
@@ -19,6 +19,9 @@ GEM
     byebug (10.0.2)
     childprocess (0.9.0)
       ffi (~> 1.0, >= 1.0.11)
+    codecov (0.2.8)
+      json
+      simplecov
     coderay (1.1.2)
     crack (0.4.3)
       safe_yaml (~> 1.0.0)
@@ -43,6 +46,7 @@ GEM
       ffi-compiler (>= 1.0, < 2.0)
     iniparse (1.5.0)
     jaro_winkler (1.5.4)
+    json (2.3.1)
     libhoney (1.14.5)
       addressable (~> 2.0)
       http (>= 2.0, < 5.0)
@@ -113,6 +117,7 @@ DEPENDENCIES
   appraisal
   bump
   bundler
+  codecov
   honeycomb-beeline!
   overcommit (~> 0.46.0)
   pry (< 0.13.0)

data/README.md

@@ -2,6 +2,7 @@
 
 [![Build Status](https://circleci.com/gh/honeycombio/beeline-ruby.svg?style=svg)](https://circleci.com/gh/honeycombio/beeline-ruby)
 [![Gem Version](https://badge.fury.io/rb/honeycomb-beeline.svg)](https://badge.fury.io/rb/honeycomb-beeline)
+[![codecov](https://codecov.io/gh/honeycombio/beeline-ruby/branch/main/graph/badge.svg)](https://codecov.io/gh/honeycombio/beeline-ruby)
 
 This package makes it easy to instrument your Ruby web app to send useful events to [Honeycomb](https://www.honeycomb.io), a service for debugging your software in production.
 - [Usage and Examples](https://docs.honeycomb.io/getting-data-in/beelines/ruby-beeline/)

data/honeycomb-beeline.gemspec

@@ -42,6 +42,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "appraisal"
   spec.add_development_dependency "bump"
   spec.add_development_dependency "bundler"
+  spec.add_development_dependency "codecov"
   spec.add_development_dependency "overcommit", "~> 0.46.0"
   spec.add_development_dependency "pry", "< 0.13.0"
   spec.add_development_dependency "pry-byebug", "~> 3.6.0"

data/lib/honeycomb/beeline/version.rb

@@ -3,7 +3,7 @@
 module Honeycomb
   module Beeline
     NAME = "honeycomb-beeline".freeze
-    VERSION = "2.1.2".freeze
+    VERSION = "2.2.0".freeze
     USER_AGENT_SUFFIX = "#{NAME}/#{VERSION}".freeze
   end
 end

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,66 @@
+# 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
+    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
+    end
+  end
+end

data/lib/honeycomb/propagation/honeycomb.rb

@@ -0,0 +1,69 @@
+# 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(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
+    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
+    end
+  end
+end

data/lib/honeycomb/propagation/w3c.rb

@@ -0,0 +1,55 @@
+# 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(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
+    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
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: honeycomb-beeline
 version: !ruby/object:Gem::Version
-  version: 2.1.2
+  version: 2.2.0
 platform: ruby
 authors:
 - Martin Holman
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-08-26 00:00:00.000000000 Z
+date: 2020-09-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: libhoney
@@ -72,6 +72,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: codecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: overcommit
   requirement: !ruby/object:Gem::Requirement
@@ -259,6 +273,9 @@ files:
 - lib/honeycomb/integrations/sinatra.rb
 - lib/honeycomb/integrations/warden.rb
 - lib/honeycomb/propagation.rb
+- lib/honeycomb/propagation/aws.rb
+- lib/honeycomb/propagation/honeycomb.rb
+- lib/honeycomb/propagation/w3c.rb
 - lib/honeycomb/rollup_fields.rb
 - lib/honeycomb/span.rb
 - lib/honeycomb/trace.rb