honeycomb-beeline 2.2.0 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 861b65eb2d7ef9f82cad990b966247465eebb0eac7ec4fa6d668491d979e9eee
-  data.tar.gz: 2e1b7ef3a15d2b2be27a4593eafabe399331909df925724abc3978cc47aed01c
+  metadata.gz: 0606efad889f46b53eaa00c4a4c2f0e134641ce9a2427f65cc79eaf138a840be
+  data.tar.gz: 95449860c9a30558bdb512b498f93fe0d00beca14b89582555e0cf2479316f74
 SHA512:
-  metadata.gz: b50cd4118393ff03349894bb4942bb166baafb51fdf587b76a5e8f1b34411d2a49c8698cc9bb8f28746211143f93bf88e5fc23de13479acbd526383f7065410d
-  data.tar.gz: f123f2ad239e1f72874199999d08a8b3137b318f1d92d9a295b3bfdb4d17d8097c3577ebca666e7b26d0d9d5940fe6b6db2ec92f9028dfbffa1740898e43281c
+  metadata.gz: 0cf79345b6b669d4e07d02035840f7ba05bb508c9185259c7d308afd7cf18cb9d44c5c1592b04e445cf025037756a9c8512bfd436ea2e4c1f52884db9a08dbe7
+  data.tar.gz: 7e73b0970480db0173ef147102da4ea9511e920457feea7178b1b4fd03905b4929c3581d01ec050586241028b7ec7921df5b90d466c882ea57d97ca69c58d5dd

data/.editorconfig

@@ -0,0 +1,12 @@
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.md]
+indent_size = 4
+trim_trailing_whitespace = true

data/.rubocop.yml

@@ -32,6 +32,12 @@ Metrics/LineLength:
 Metrics/ParameterLists:
   Max: 6
 
+Style/AccessModifierDeclarations:
+  Exclude:
+    - lib/honeycomb/propagation/aws.rb
+    - lib/honeycomb/propagation/w3c.rb
+    - lib/honeycomb/propagation/honeycomb.rb
+
 Style/FrozenStringLiteralComment:
   EnforcedStyle: always
   Exclude:

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    honeycomb-beeline (2.2.0)
+    honeycomb-beeline (2.3.0)
       libhoney (~> 1.14, >= 1.14.2)
 
 GEM

data/README.md

@@ -25,6 +25,13 @@ Built in instrumentation for:
 - Sequel
 - Sinatra
 
+## Testing
+Find `rspec` test files in the `spec` directory.
+
+To run tests on gem-specific instrumentations or across various dependency versions, use [appraisal](https://github.com/thoughtbot/appraisal) (further instructions in the readme for that gem). Find gem sets in the `Appraisals` config.
+
+To run a specific file: `bundle exec appraisal <gem set> rspec <path/to/file>`
+
 ## Get in touch
 
 Please reach out to [support@honeycomb.io](mailto:support@honeycomb.io) or ping

data/lib/honeycomb/beeline/version.rb

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

data/lib/honeycomb/client.rb

@@ -35,6 +35,8 @@ module Honeycomb
       @additional_trace_options = {
         presend_hook: configuration.presend_hook,
         sample_hook: configuration.sample_hook,
+        parser_hook: configuration.http_trace_parser_hook,
+        propagation_hook: configuration.http_trace_propagation_hook,
       }
 
       configuration.after_initialize(self)

data/lib/honeycomb/configuration.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require "socket"
+require "honeycomb/propagation/honeycomb"
 
 module Honeycomb
   # Used to configure the Honeycomb client
@@ -60,5 +61,27 @@ module Honeycomb
         @sample_hook
       end
     end
+
+    def http_trace_parser_hook(&hook)
+      if block_given?
+        @http_trace_parser_hook = hook
+      elsif @http_trace_parser_hook
+        @http_trace_parser_hook
+      else
+        # by default we try to parse incoming honeycomb traces
+        HoneycombPropagation::UnmarshalTraceContext.method(:parse_rack_env)
+      end
+    end
+
+    def http_trace_propagation_hook(&hook)
+      if block_given?
+        @http_trace_propagation_hook = hook
+      elsif @http_trace_propagation_hook
+        @http_trace_propagation_hook
+      else
+        # by default we send outgoing honeycomb trace headers
+        HoneycombPropagation::MarshalTraceContext.method(:parse_faraday_env)
+      end
+    end
   end
 end

data/lib/honeycomb/integrations/faraday.rb

@@ -22,7 +22,9 @@ module Honeycomb
         span.add_field "meta.package", "faraday"
         span.add_field "meta.package_version", ::Faraday::VERSION
 
-        env.request_headers["X-Honeycomb-Trace"] = span.to_trace_header
+        if (headers = span.trace_headers(env)).is_a?(Hash)
+          env.request_headers.merge!(headers)
+        end
 
         @app.call(env).tap do |response|
           span.add_field "response.status_code", response.status

data/lib/honeycomb/integrations/rack.rb

@@ -32,8 +32,10 @@ module Honeycomb
 
     def call(env)
       req = ::Rack::Request.new(env)
-      hny = env["HTTP_X_HONEYCOMB_TRACE"]
-      client.start_span(name: "http_request", serialized_trace: hny) do |span|
+      client.start_span(
+        name: "http_request",
+        serialized_trace: env,
+      ) do |span|
         add_field = lambda do |key, value|
           unless value.nil? || (value.respond_to?(:empty?) && value.empty?)
             span.add_field(key, value)

data/lib/honeycomb/propagation/aws.rb

@@ -43,6 +43,9 @@ module Honeycomb
 
         [trace_id, parent_span_id, trace_fields]
       end
+
+      module_function :parse, :get_fields
+      public :parse
     end
 
     # Serialize trace headers
@@ -61,6 +64,22 @@ module Honeycomb
         ]
         "#{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

@@ -9,6 +9,10 @@ module Honeycomb
   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)
@@ -49,6 +53,9 @@ module Honeycomb
 
         [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
@@ -64,6 +71,26 @@ module Honeycomb
         ]
         "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

@@ -8,6 +8,10 @@ module Honeycomb
       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)
@@ -38,6 +42,9 @@ module Honeycomb
 
         [trace_id, parent_span_id]
       end
+
+      module_function :parse_rack_env, :parse, :parse_v1
+      public :parse
     end
 
     # Serialize trace headers
@@ -50,6 +57,23 @@ module Honeycomb
 
         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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: honeycomb-beeline
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 2.3.0
 platform: ruby
 authors:
 - Martin Holman
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-09-02 00:00:00.000000000 Z
+date: 2020-11-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: libhoney
@@ -236,6 +236,7 @@ files:
 - ".circleci/bundler_version.sh"
 - ".circleci/config.yml"
 - ".circleci/setup-rubygems.sh"
+- ".editorconfig"
 - ".github/CODEOWNERS"
 - ".gitignore"
 - ".overcommit.yml"
@@ -274,6 +275,7 @@ files:
 - lib/honeycomb/integrations/warden.rb
 - lib/honeycomb/propagation.rb
 - lib/honeycomb/propagation/aws.rb
+- lib/honeycomb/propagation/context.rb
 - lib/honeycomb/propagation/honeycomb.rb
 - lib/honeycomb/propagation/w3c.rb
 - lib/honeycomb/rollup_fields.rb