honeycomb-beeline 2.8.2 → 2.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 124e1b05ae5609ab32eae6a0340171848bb3bdd8e4291ea082e1da5c706a9eec
-  data.tar.gz: f77c6cc246e8801386f09dee46fae845997aa4b1a9e978ac03d9c5e254ca9d49
+  metadata.gz: 2dd1c8587f1aaa8ca239aa4a526f1be4aea49814f3c92134a9dd59ecdb79f4dc
+  data.tar.gz: cc1e21f4d0e2d5e65d58502196fd74eb862d5890b577f789875b4427c66c2d0f
 SHA512:
-  metadata.gz: dee1ffab32296f88e2f2fff6a53045e390f9dc7cd12a37dc016ed3d3555e022f90de689ce980293ef0b8080dab2ece6fab61056addbe0802a80bc3d0e53918d9
-  data.tar.gz: 7ccccb62ef9ef6b9f93fa9e9aa2178dd028239614955e12409a66e06be9c01579ded06ae6c8a995bb1aaec37a947d24f66ac0a19ea92073eef77eb02b73c63a5
+  metadata.gz: 53765870c5c3d5b2eda2992e472f270412548a0f5f71e5ed36fa005129d9ae831bbb1ad19903797c558909fc9d2e93e42002d0d15fba05756fa4a785064f1eb9
+  data.tar.gz: c3be19aed350b937ff3ec4d9789861f609afc490f16670c370d9a60f263eea4759198ce4a93ec3802cd42948abc87745f1a8b06cd0c56c4f1fcfe8b6a25a31a4

data/.rubocop.yml

@@ -26,6 +26,7 @@ Metrics/MethodLength:
     - lib/generators/honeycomb/honeycomb_generator.rb
 
 Metrics/LineLength:
+  Max: 100
   Exclude:
     - spec/honeycomb/integrations/active_support_spec.rb
     - spec/support/event_data_shared_examples.rb
@@ -71,3 +72,6 @@ Style/AsciiComments:
 
 Style/Alias:
   EnforcedStyle: prefer_alias_method
+
+Style/IfUnlessModifier:
+  Enabled: false

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # beeline-ruby changelog
 
+## 2.9.0 2022-03-23
+
+### Enhancements
+
+- Add Environment and Services support (#196) | [@MikeGoldsmith](https://github.com/MikeGoldsmith)
+
 ## 2.8.2 2022-02-02
 
 ### Maintenance

data/lib/generators/honeycomb/honeycomb_generator.rb

@@ -11,7 +11,7 @@ class HoneycombGenerator < Rails::Generators::Base
 
   argument :write_key, required: true, desc: "required"
 
-  class_option :dataset, type: :string, default: "rails"
+  class_option :service_name, type: :string, default: "rails"
 
   gem "honeycomb-beeline"
 
@@ -22,7 +22,7 @@ class HoneycombGenerator < Rails::Generators::Base
       <<-RUBY.strip_heredoc
         Honeycomb.configure do |config|
           config.write_key = #{write_key.inspect}
-          config.dataset = #{options['dataset'].inspect}
+          config.service_name = #{options['service_name'].inspect}
           config.presend_hook do |fields|
             if fields["name"] == "redis" && fields.has_key?("redis.command")
               # remove potential PII from the redis command

data/lib/honeycomb/beeline/version.rb

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

data/lib/honeycomb/client.rb

@@ -30,8 +30,11 @@ module Honeycomb
 
       # maybe make `service_name` a required parameter
       @libhoney.add_field "service_name", configuration.service_name
+      @libhoney.add_field "service.name", configuration.service_name
       @context = Context.new
 
+      @context.classic = classic_write_key?(configuration.write_key)
+
       @additional_trace_options = {
         presend_hook: configuration.presend_hook,
         sample_hook: configuration.sample_hook,
@@ -125,5 +128,9 @@ module Honeycomb
       span.add_field("error_backtrace_limit", error_backtrace_limit)
       span.add_field("error_backtrace_total_length", exception.backtrace.length)
     end
+
+    def classic_write_key?(write_key)
+      write_key.nil? || write_key.length == 32
+    end
   end
 end

data/lib/honeycomb/configuration.rb

@@ -2,16 +2,16 @@
 
 require "socket"
 require "honeycomb/propagation/default"
+require "honeycomb/propagation/default_modern"
 
 module Honeycomb
   # Used to configure the Honeycomb client
   class Configuration
     attr_accessor :write_key,
-                  :dataset,
                   :api_host,
                   :debug
 
-    attr_writer :service_name, :client, :host_name
+    attr_writer :service_name, :client, :host_name, :dataset
     attr_reader :error_backtrace_limit
 
     def initialize
@@ -23,8 +23,31 @@ module Honeycomb
       @client = nil
     end
 
+    def classic?
+      @write_key.nil? || @write_key.length == 32
+    end
+
     def service_name
-      @service_name || dataset
+      return @service_name if service_name_given?
+      return @dataset if classic?
+
+      "unknown_service:" + $PROGRAM_NAME.split("/").last
+    end
+
+    def dataset
+      return @dataset if classic?
+      return "unknown_service" if service_name.nil?
+
+      stripped_service_name = service_name.strip
+
+      warn("found extra whitespace in service name") if stripped_service_name != service_name
+
+      if stripped_service_name.empty? || stripped_service_name.start_with?("unknown_service")
+        # don't use process name in dataset
+        "unknown_service"
+      else
+        stripped_service_name
+      end
     end
 
     def error_backtrace_limit=(val)
@@ -39,6 +62,7 @@ module Honeycomb
         if debug
           Libhoney::LogClient.new
         else
+          validate_options
           Libhoney::Client.new(**libhoney_client_options)
         end
     end
@@ -73,9 +97,11 @@ module Honeycomb
         @http_trace_parser_hook = hook
       elsif @http_trace_parser_hook
         @http_trace_parser_hook
+      elsif classic?
+        DefaultPropagation::UnmarshalTraceContext.method(:parse_rack_env)
       else
         # by default we try to parse incoming honeycomb traces
-        DefaultPropagation::UnmarshalTraceContext.method(:parse_rack_env)
+        DefaultModernPropagation::UnmarshalTraceContext.method(:parse_rack_env)
       end
     end
 
@@ -84,9 +110,11 @@ module Honeycomb
         @http_trace_propagation_hook = hook
       elsif @http_trace_propagation_hook
         @http_trace_propagation_hook
+      elsif classic?
+        HoneycombPropagation::MarshalTraceContext.method(:parse_faraday_env)
       else
         # by default we send outgoing honeycomb trace headers
-        HoneycombPropagation::MarshalTraceContext.method(:parse_faraday_env)
+        HoneycombModernPropagation::MarshalTraceContext.method(:parse_faraday_env)
       end
     end
 
@@ -102,5 +130,31 @@ module Honeycomb
         options[:api_host] = api_host if api_host
       end
     end
+
+    def validate_options
+      warn("missing write_key") if write_key.nil? || write_key.empty?
+      if classic?
+        validate_options_classic
+      else
+        warn("service_name is unknown, will set to " + service_name) \
+          if service_name.start_with?("unknown_service")
+        warn("dataset will be ignored, sending data to " + service_name) \
+          if dataset_given?
+      end
+    end
+
+    def validate_options_classic
+      warn("empty service_name option") unless service_name_given?
+      warn("empty dataset option") unless dataset_given?
+    end
+
+    def service_name_given?
+      # check the instance variables, not the accessor method
+      @service_name && !@service_name.empty?
+    end
+
+    def dataset_given?
+      @dataset && !@dataset.empty?
+    end
   end
 end

data/lib/honeycomb/context.rb

@@ -3,6 +3,7 @@
 module Honeycomb
   # Stores the current span and trace context
   class Context
+    attr_writer :classic
     def current_trace
       return if current_span.nil?
 
@@ -23,6 +24,10 @@ module Honeycomb
       spans.pop
     end
 
+    def classic?
+      @classic
+    end
+
     private
 
     def spans

data/lib/honeycomb/propagation/default_modern.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require "honeycomb/propagation/honeycomb_modern"
+require "honeycomb/propagation/w3c"
+
+module Honeycomb
+  # Default behavior for handling trace propagation
+  module DefaultModernPropagation
+    # Parse incoming trace headers.
+    #
+    # Checks for and parses Honeycomb's trace header or, if not found,
+    # then checks for and parses W3C trace parent header.
+    module UnmarshalTraceContext
+      def parse_rack_env(env)
+        if env["HTTP_X_HONEYCOMB_TRACE"]
+          HoneycombModernPropagation::UnmarshalTraceContext.parse_rack_env env
+        elsif env["HTTP_TRACEPARENT"]
+          W3CPropagation::UnmarshalTraceContext.parse_rack_env env
+        else
+          [nil, nil, nil, nil]
+        end
+      end
+      # rubocop:disable Style/AccessModifierDeclarations
+      module_function :parse_rack_env
+      public :parse_rack_env
+      # rubocop:enable Style/AccessModifierDeclarations
+    end
+  end
+end

data/lib/honeycomb/propagation/honeycomb_modern.rb

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+require "base64"
+require "json"
+require "uri"
+
+module Honeycomb
+  # Parsing and propagation for honeycomb trace headers
+  module HoneycombModernPropagation
+    # 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 = parse_v1(payload)
+
+            if !trace_id.nil? && !parent_span_id.nil?
+              return [trace_id, parent_span_id, trace_fields, nil]
+            end
+          end
+        end
+
+        [nil, nil, nil, nil]
+      end
+
+      def parse_v1(payload)
+        trace_id, parent_span_id, trace_fields = nil
+        payload.split(",").each do |entry|
+          key, value = entry.split("=", 2)
+          case key.downcase
+          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, nil]
+      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
+        data_to_propogate = [
+          "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
+        data_to_propogate = [
+          "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

@@ -31,12 +31,8 @@ module Honeycomb
       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
+        # if trace_flags is nil, it means a field is missing
+        if trace_flags.nil? || trace_id == INVALID_TRACE_ID || parent_span_id == INVALID_SPAN_ID
           return [nil, nil]
         end
 

data/lib/honeycomb/trace.rb

@@ -9,7 +9,6 @@ require "honeycomb/rollup_fields"
 module Honeycomb
   # Represents a Honeycomb trace, which groups spans together
   class Trace
-    include PropagationParser
     include RollupFields
     extend Forwardable
 
@@ -19,9 +18,14 @@ module Honeycomb
 
     def initialize(builder:, context:, serialized_trace: nil, **options)
       trace_id, parent_span_id, trace_fields, dataset =
-        internal_parse(serialized_trace: serialized_trace, **options)
+        internal_parse(context: context, serialized_trace: serialized_trace, **options)
+
+      # if dataset is not nil,
+      # set trace's builder.dataset = dataset from trace header
+      if context.classic?
+        dataset && builder.dataset = dataset
+      end
 
-      dataset && builder.dataset = dataset
       @id = trace_id || generate_trace_id
       @fields = trace_fields || {}
       @root_span = Span.new(trace: self,
@@ -47,15 +51,17 @@ module Honeycomb
       end
     end
 
-    def internal_parse(serialized_trace: nil, parser_hook: nil, **_options)
+    def internal_parse(context:, 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)
+      elsif context.classic?
+        HoneycombPropagation::UnmarshalTraceContext.parse serialized_trace
       else
-        parse serialized_trace
+        HoneycombModernPropagation::UnmarshalTraceContext.parse serialized_trace
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: honeycomb-beeline
 version: !ruby/object:Gem::Version
-  version: 2.8.2
+  version: 2.9.0
 platform: ruby
 authors:
 - Martin Holman
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-02-02 00:00:00.000000000 Z
+date: 2022-03-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: libhoney
@@ -288,7 +288,9 @@ files:
 - lib/honeycomb/propagation/aws.rb
 - lib/honeycomb/propagation/context.rb
 - lib/honeycomb/propagation/default.rb
+- lib/honeycomb/propagation/default_modern.rb
 - lib/honeycomb/propagation/honeycomb.rb
+- lib/honeycomb/propagation/honeycomb_modern.rb
 - lib/honeycomb/propagation/w3c.rb
 - lib/honeycomb/rollup_fields.rb
 - lib/honeycomb/span.rb