honeycomb-beeline 2.0.0 → 2.3.0

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/.github/CODEOWNERS

@@ -0,0 +1,5 @@
+# Code owners file.
+# This file controls who is tagged for review for any given pull request.
+
+# For anything not explicitly taken by someone else:
+* @honeycombio/integrations-team @martin308

data/.rubocop.yml

@@ -29,6 +29,15 @@ Metrics/LineLength:
   Exclude:
     - spec/support/event_data_shared_examples.rb
 
+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,24 +1,27 @@
 PATH
   remote: .
   specs:
-    honeycomb-beeline (2.0.0)
+    honeycomb-beeline (2.3.0)
       libhoney (~> 1.14, >= 1.14.2)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.6.0)
-      public_suffix (>= 2.0.2, < 4.0)
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
     ansi (1.5.0)
     appraisal (2.2.0)
       bundler
       rake
       thor (>= 0.14.0)
     ast (2.4.0)
-    bump (0.8.0)
-    byebug (11.0.1)
+    bump (0.9.0)
+    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)
@@ -26,12 +29,12 @@ GEM
     docile (1.3.2)
     domain_name (0.5.20190701)
       unf (>= 0.0.5, < 1.0.0)
-    ffi (1.11.1)
+    ffi (1.12.2)
     ffi-compiler (1.0.1)
       ffi (>= 1.0.0)
       rake
-    hashdiff (0.4.0)
-    http (4.3.0)
+    hashdiff (1.0.1)
+    http (4.4.1)
       addressable (~> 2.3)
       http-cookie (~> 1.0)
       http-form_data (~> 2.2)
@@ -41,41 +44,41 @@ GEM
     http-form_data (2.3.0)
     http-parser (1.2.1)
       ffi-compiler (>= 1.0, < 2.0)
-    iniparse (1.4.4)
-    jaro_winkler (1.5.3)
-    json (2.2.0)
-    libhoney (1.14.4)
+    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)
     method_source (0.9.2)
     overcommit (0.46.0)
       childprocess (~> 0.6, >= 0.6.3)
       iniparse (~> 1.4)
-    parallel (1.17.0)
-    parser (2.6.3.0)
+    parallel (1.19.1)
+    parser (2.7.1.2)
       ast (~> 2.4.0)
     pry (0.12.2)
       coderay (~> 1.1.0)
       method_source (~> 0.9.0)
-    pry-byebug (3.7.0)
-      byebug (~> 11.0)
+    pry-byebug (3.6.0)
+      byebug (~> 10.0)
       pry (~> 0.10)
-    public_suffix (3.1.1)
+    public_suffix (4.0.4)
     rainbow (3.0.0)
     rake (13.0.1)
-    rspec (3.8.0)
-      rspec-core (~> 3.8.0)
-      rspec-expectations (~> 3.8.0)
-      rspec-mocks (~> 3.8.0)
-    rspec-core (3.8.1)
-      rspec-support (~> 3.8.0)
-    rspec-expectations (3.8.4)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-mocks (3.8.1)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-support (3.8.2)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
     rubocop (0.68.1)
       jaro_winkler (~> 1.5.1)
       parallel (~> 1.10)
@@ -87,23 +90,22 @@ GEM
       rubocop (>= 0.68.0)
     ruby-progressbar (1.10.1)
     safe_yaml (1.0.5)
-    simplecov (0.16.1)
+    simplecov (0.18.5)
       docile (~> 1.1)
-      json (>= 1.8, < 3)
-      simplecov-html (~> 0.10.0)
-    simplecov-console (0.5.0)
+      simplecov-html (~> 0.11)
+    simplecov-console (0.7.2)
       ansi
       simplecov
       terminal-table
-    simplecov-html (0.10.2)
+    simplecov-html (0.12.2)
     terminal-table (1.8.0)
       unicode-display_width (~> 1.1, >= 1.1.1)
-    thor (0.20.3)
+    thor (1.0.1)
     unf (0.1.4)
       unf_ext
-    unf_ext (0.0.7.6)
+    unf_ext (0.0.7.7)
     unicode-display_width (1.5.0)
-    webmock (3.6.0)
+    webmock (3.8.3)
       addressable (>= 2.3.6)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
@@ -115,9 +117,11 @@ DEPENDENCIES
   appraisal
   bump
   bundler
+  codecov
   honeycomb-beeline!
   overcommit (~> 0.46.0)
-  pry-byebug
+  pry (< 0.13.0)
+  pry-byebug (~> 3.6.0)
   rake
   rspec (~> 3.0)
   rubocop (< 0.69)

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/)
@@ -24,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/honeycomb-beeline.gemspec

@@ -42,8 +42,10 @@ 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-byebug"
+  spec.add_development_dependency "pry", "< 0.13.0"
+  spec.add_development_dependency "pry-byebug", "~> 3.6.0"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "rubocop", "< 0.69"

data/lib/honeycomb/beeline/version.rb

@@ -3,7 +3,7 @@
 module Honeycomb
   module Beeline
     NAME = "honeycomb-beeline".freeze
-    VERSION = "2.0.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)
@@ -54,24 +56,24 @@ module Honeycomb
         context.current_span.create_child
       end
 
+      current_span = context.current_span
+
       fields.each do |key, value|
-        context.current_span.add_field(key, value)
+        current_span.add_field(key, value)
       end
 
-      context.current_span.add_field("name", name)
-
-      if block_given?
-        begin
-          yield context.current_span
-        rescue StandardError => e
-          context.current_span.add_field("error", e.class.name)
-          context.current_span.add_field("error_detail", e.message)
-          raise e
-        ensure
-          context.current_span.send
-        end
-      else
-        context.current_span
+      current_span.add_field("name", name)
+
+      return current_span unless block_given?
+
+      begin
+        yield current_span
+      rescue StandardError => e
+        current_span.add_field("error", e.class.name)
+        current_span.add_field("error_detail", e.message)
+        raise e
+      ensure
+        current_span.send
       end
     end
 

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
@@ -33,7 +34,7 @@ module Honeycomb
 
       @client ||
         (debug && Libhoney::LogClient.new) ||
-        Libhoney::Client.new(options)
+        Libhoney::Client.new(**options)
     end
 
     def after_initialize(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/active_support.rb

@@ -65,7 +65,7 @@ module Honeycomb
       def finish(name, id, payload)
         return unless (span = spans[id].pop)
 
-        handlers[name].call(name, span, payload)
+        handler_for(name).call(name, span, payload)
 
         span.send
       end
@@ -77,6 +77,16 @@ module Honeycomb
       def spans
         Thread.current[key] ||= Hash.new { |h, id| h[id] = [] }
       end
+
+      def handler_for(name)
+        handlers.fetch(name) do
+          handlers[
+            handlers.keys.detect do |key|
+              key.is_a?(Regexp) && key =~ name
+            end
+          ]
+        end
+      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

@@ -13,7 +13,11 @@ module Honeycomb
       ["HTTP_VERSION", "request.http_version"],
       ["HTTP_HOST", "request.host"],
       ["REMOTE_ADDR", "request.remote_addr"],
+      ["HTTP_X_FORWARDED_FOR", "request.header.x_forwarded_for"],
+      ["HTTP_X_FORWARDED_PROTO", "request.header.x_forwarded_proto"],
+      ["HTTP_X_FORWARDED_PORT", "request.header.x_forwarded_port"],
       ["HTTP_ACCEPT", "request.header.accept"],
+      ["HTTP_ACCEPT_LANGUAGE", "request.header.accept_language"],
       ["CONTENT_TYPE", "request.header.content_type"],
       ["HTTP_USER_AGENT", "request.header.user_agent"],
       ["rack.url_scheme", "request.scheme"],
@@ -28,12 +32,14 @@ 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|
-          next unless value && !value.empty?
-
-          span.add_field(key, value)
+          unless value.nil? || (value.respond_to?(:empty?) && value.empty?)
+            span.add_field(key, value)
+          end
         end
 
         extract_fields(env, RACK_FIELDS, &add_field)

data/lib/honeycomb/integrations/warden.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Honeycomb
-  # Methods for extracing common warden/devise fields from a rack env hash
+  # Methods for extracting common warden/devise fields from a rack env hash
   module Warden
     COMMON_USER_FIELDS = %i[
       email
@@ -24,7 +24,7 @@ module Honeycomb
         key.match(SCOPE_PATTERN)
       end
       warden_scopes = keys.map do |key|
-        key.gsub(SCOPE_PATTERN, "\1")
+        key.gsub(SCOPE_PATTERN, "\\1")
       end
       best_scope = warden_scopes.include?("user") ? "user" : warden_scopes.first
 

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