honeycomb-beeline 1.0.0.pre.alpha1 → 1.0.0.pre.beta

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0b983a1c5b4b52a3163efeee003c8084c18a7c13c19882f295a907c2cedfca67
-  data.tar.gz: 1f7f2bde288e4020442b60501b99f055b7d9d6eb076aa5f458e5a298f783f337
+  metadata.gz: 51f069ff2b73a6b141dab639c08f4ddfe5cf7fa8292fd4e6a09bc550564b6092
+  data.tar.gz: 458d5f1636b41b3e2aaafde0eb6067f3d7de78298772b317f818d6f305c7b7a0
 SHA512:
-  metadata.gz: ae48345d9bc3348a91b05de67b006c2844e1a9480c32ad835eeda5afe795d873013f7212b5cfe087504e84ac91fb323bb69eaf38dfb57c77df6ad2fcbfef9769
-  data.tar.gz: 13ad83ca06195d0699b36b0e931eb2ba1a0fbd1aa0efe7f22c303ce04cf8b414994b5db6ff852ad3d83519bf11f5aff785083bd8b8c83c8b211a7592f6019429
+  metadata.gz: 0267a0f92727c4ff77801ccee578f754ca00e7e0a3c7162f170adabaff53bf63de933c9dcdd714d057bb62af55f784dddd9c01c39a4f8f5a4e657e8e53e67bd3
+  data.tar.gz: afdcf6a30a34d1610a7c6baf5d747fb46b1deb486f86764cf413d340603a02e0e6e029f4a89548c806a29747ee53e1162b49aa5304c138d460eae1fe2e076aa8

data/.rubocop.yml

@@ -4,6 +4,7 @@ AllCops:
   TargetRubyVersion: 2.2
   Exclude:
     - "examples/**/*"
+    - "vendor/**/*"
 
 Style/StringLiterals:
   EnforcedStyle: double_quotes
@@ -14,7 +15,10 @@ Metrics/BlockLength:
     - spec/**/*.rb
 
 Metrics/AbcSize:
-  Max: 40
+  Max: 50
+
+Metrics/ClassLength:
+  Max: 200
 
 Metrics/MethodLength:
   Max: 25

data/.ruby-version

@@ -1 +1 @@
-2.5.3
+2.6.3

data/.travis.yml

@@ -5,6 +5,7 @@ rvm:
   - 2.3
   - 2.4
   - 2.5
+  - 2.6
 gemfile:
   - gemfiles/faraday.gemfile
   - gemfiles/sequel4.gemfile
@@ -19,6 +20,7 @@ gemfile:
   - gemfiles/rails_6rc1.gemfile
 script: bundle exec rake test
 before_install:
+  - gem update bundler
   - ./bundler_version.sh
 matrix:
   exclude:
@@ -26,17 +28,27 @@ matrix:
       gemfile: gemfiles/rails_41.gemfile
     - rvm: 2.5
       gemfile: gemfiles/rails_41.gemfile
+    - rvm: 2.6
+      gemfile: gemfiles/rails_41.gemfile
     - rvm: 2.2
       gemfile: gemfiles/rails_6rc1.gemfile
     - rvm: 2.3
       gemfile: gemfiles/rails_6rc1.gemfile
     - rvm: 2.4
       gemfile: gemfiles/rails_6rc1.gemfile
+stages:
+  - lint
+  - test
+  - deploy
 jobs:
   include:
+    - stage: lint
+      script: bundle exec rake rubocop
+      rvm: 2.6
+      gemfile: Gemfile
     - stage: deploy
       script: skip
-      rvm: 2.5
+      rvm: 2.6
       gemfile: Gemfile
       deploy:
         provider: rubygems

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    honeycomb-beeline (1.0.0.pre.alpha1)
+    honeycomb-beeline (1.0.0.pre.beta)
       libhoney (~> 1.8)
 
 GEM
@@ -24,7 +24,7 @@ GEM
       safe_yaml (~> 1.0.0)
     diff-lcs (1.3)
     docile (1.3.2)
-    domain_name (0.5.20180417)
+    domain_name (0.5.20190701)
       unf (>= 0.0.5, < 1.0.0)
     ffi (1.11.1)
     hashdiff (0.4.0)

data/bundler_version.sh

@@ -1,12 +1,9 @@
 #!/usr/bin/env bash
 
-set -uex
+set -ux
 
 if [[ "$BUNDLE_GEMFILE" =~ (rails_41.gemfile|rails_42.gemfile)$ ]]; then
-  if [[ "$TRAVIS_RUBY_VERSION" =~ ^(2.3)$ ]]; then
-    gem uninstall -v '>= 2' -i $(rvm gemdir) -ax bundler
-  elif [[ "$TRAVIS_RUBY_VERSION" =~ ^(2.4|2.5)$ ]]; then
-    gem uninstall -v '>= 2' -i $(rvm gemdir)@global -ax bundler
-  fi
+  gem uninstall -v '>= 2' -i $(rvm gemdir) -ax bundler
+  gem uninstall -v '>= 2' -i $(rvm gemdir)@global -ax bundler
   gem install bundler -v '< 2'
 fi

data/honeycomb-beeline.gemspec

@@ -13,7 +13,7 @@ Gem::Specification.new do |spec|
   spec.summary       = "Instrument your Ruby apps with Honeycomb"
   spec.homepage      = "https://honeycomb.io"
 
-  spec.license = 'Apache-2.0'
+  spec.license = "Apache-2.0"
 
   spec.required_ruby_version = ">= 2.2.0"
 

data/lib/honeycomb-beeline.rb

@@ -1,33 +1,40 @@
 # frozen_string_literal: true
 
+require "forwardable"
 require "libhoney"
-
 require "honeycomb/beeline/version"
 require "honeycomb/client"
 require "honeycomb/trace"
 
 # main module
 module Honeycomb
+  INTEGRATIONS = %i[
+    active_support
+    faraday
+    rack
+    rails
+    rake
+    sequel
+    sinatra
+  ].freeze
+
   class << self
+    extend Forwardable
     attr_reader :client
 
+    def_delegators :@client, :start_span, :add_field, :add_field_to_trace
+
     def configure
       Configuration.new.tap do |config|
         yield config
-        @client = Honeycomb::Client.new(client: config.client,
-                                        service_name: config.service_name)
-        config.after_initialize(@client)
+        @client = Honeycomb::Client.new(configuration: config)
       end
 
       @client
     end
 
-    def start_span(name:, &block)
-      client.start_span(name: name, &block)
-    end
-
     def load_integrations
-      %i[faraday rack sinatra rails sequel active_support].each do |integration|
+      INTEGRATIONS.each do |integration|
         begin
           require "honeycomb/integrations/#{integration}"
         rescue LoadError
@@ -35,40 +42,6 @@ module Honeycomb
       end
     end
   end
-
-  # Used to configure the Honeycomb client
-  class Configuration
-    attr_accessor :write_key,
-                  :dataset,
-                  :api_host
-
-    attr_writer :service_name, :client
-
-    def initialize
-      @write_key = ENV["HONEYCOMB_WRITEKEY"]
-      @dataset = ENV["HONEYCOMB_DATASET"]
-      @service_name = ENV["HONEYCOMB_SERVICE"]
-      @client = nil
-    end
-
-    def service_name
-      @service_name || dataset
-    end
-
-    def client
-      options = {}.tap do |o|
-        o[:writekey] = write_key
-        o[:dataset] = dataset
-        api_host && o[:api_host] = api_host
-      end
-
-      @client || Libhoney::Client.new(options)
-    end
-
-    def after_initialize(client)
-      super(client) if defined?(super)
-    end
-  end
 end
 
 Honeycomb.load_integrations unless ENV["HONEYCOMB_DISABLE_AUTOCONFIGURE"]

data/lib/honeycomb/beeline/version.rb

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

data/lib/honeycomb/client.rb

@@ -1,29 +1,33 @@
 # frozen_string_literal: true
 
-require "socket"
-require "forwardable"
 require "honeycomb/beeline/version"
+require "honeycomb/configuration"
 require "honeycomb/context"
 
 module Honeycomb
   # The Honeycomb Beeline client
   class Client
-    extend Forwardable
-
-    def initialize(client:, service_name: nil)
+    def initialize(configuration:)
+      @client = configuration.client
       # attempt to set the user_agent_addition, this will only work if the
       # client has not sent an event prior to being passed in here. This should
       # be most cases
-      client.instance_variable_set(:@user_agent_addition,
-                                   Honeycomb::Beeline::USER_AGENT_SUFFIX)
-      client.add_field "meta.beeline_version", Honeycomb::Beeline::VERSION
-      client.add_field "meta.local_hostname", host_name
+      @client.instance_variable_set(:@user_agent_addition,
+                                    Honeycomb::Beeline::USER_AGENT_SUFFIX)
+      @client.add_field "meta.beeline_version", Honeycomb::Beeline::VERSION
+      @client.add_field "meta.local_hostname", configuration.host_name
 
       # maybe make `service_name` a required parameter
-      client.add_field "service_name", service_name
-      @client = client
+      @client.add_field "service_name", configuration.service_name
       @context = Context.new
 
+      @additional_trace_options = {
+        presend_hook: configuration.presend_hook,
+        sample_hook: configuration.sample_hook,
+      }
+
+      configuration.after_initialize(self)
+
       at_exit do
         client.close
       end
@@ -33,7 +37,8 @@ module Honeycomb
       if context.current_trace.nil?
         Trace.new(serialized_trace: serialized_trace,
                   builder: client.builder,
-                  context: context)
+                  context: context,
+                  **@additional_trace_options)
       else
         context.current_span.create_child
       end
@@ -70,10 +75,5 @@ module Honeycomb
     private
 
     attr_reader :client, :context
-
-    def host_name
-      # Send the heroku dyno name instead of hostname if available
-      ENV["DYNO"] || Socket.gethostname
-    end
   end
 end

data/lib/honeycomb/configuration.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+require "socket"
+
+module Honeycomb
+  # Used to configure the Honeycomb client
+  class Configuration
+    attr_accessor :write_key,
+                  :dataset,
+                  :api_host
+
+    attr_writer :service_name, :client, :host_name
+
+    def initialize
+      @write_key = ENV["HONEYCOMB_WRITEKEY"]
+      @dataset = ENV["HONEYCOMB_DATASET"]
+      @service_name = ENV["HONEYCOMB_SERVICE"]
+      @client = nil
+    end
+
+    def service_name
+      @service_name || dataset
+    end
+
+    def client
+      options = {}.tap do |o|
+        o[:writekey] = write_key
+        o[:dataset] = dataset
+        api_host && o[:api_host] = api_host
+      end
+
+      @client || Libhoney::Client.new(options)
+    end
+
+    def after_initialize(client)
+      super(client) if defined?(super)
+    end
+
+    def host_name
+      # Send the heroku dyno name instead of hostname if available
+      @host_name || ENV["DYNO"] || Socket.gethostname
+    end
+
+    def presend_hook(&hook)
+      if block_given?
+        @presend_hook = hook
+      else
+        @presend_hook
+      end
+    end
+
+    def sample_hook(&hook)
+      if block_given?
+        @sample_hook = hook
+      else
+        @sample_hook
+      end
+    end
+  end
+end

data/lib/honeycomb/deterministic_sampler.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require "digest"
+
+module Honeycomb
+  ##
+  # Provides a should_sample method which can be used for deterministic
+  # sampling
+  #
+  module DeterministicSampler
+    MAX_INT32 = 2**32 - 1
+
+    def should_sample(rate, value)
+      return true if rate == 1
+
+      upper_bound = MAX_INT32 / rate
+      digest = Digest::SHA1.digest(value)[0, 4]
+      value = digest.unpack("I!>").first
+      value <= upper_bound
+    end
+  end
+end

data/lib/honeycomb/integrations/rails.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require "rails"
+require "rails/railtie"
 require "honeycomb/integrations/active_support"
 require "honeycomb/integrations/rack"
 
@@ -31,7 +31,8 @@ module Honeycomb
 
   # Automatically capture rack requests and create a trace
   class Railtie < ::Rails::Railtie
-    initializer "honeycomb.install_middleware", after: :load_config_initializers do |app|
+    initializer("honeycomb.install_middleware",
+                after: :load_config_initializers) do |app|
       if Honeycomb.client
         # what location should we insert the middleware at?
         app.config.middleware.insert_before(

data/lib/honeycomb/integrations/rake.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require "rake"
+
+Rake::TaskManager.record_task_metadata = true
+
+module Honeycomb
+  module Rake
+    ##
+    # Automatically capture rake tasks and create a trace
+    #
+    module Task
+      def execute(args = nil)
+        return super(args) if honeycomb_client.nil?
+
+        honeycomb_client.start_span(name: "rake.#{name}") do |span|
+          span.add_field("meta.package", "rake")
+          span.add_field("meta.package_version", ::Rake::VERSION)
+          full_comment && span.add_field("rake.description", full_comment)
+          arg_description && span.add_field("rake.arguments", arg_description)
+          super(args)
+        end
+      end
+
+      def honeycomb_client
+        application.honeycomb_client
+      end
+    end
+
+    ##
+    # Provide access to the honeycomb_client for the rake tasks, can be
+    # provided or uses the default global honeycomb client
+    #
+    module Application
+      attr_writer :honeycomb_client
+
+      def honeycomb_client
+        @honeycomb_client || Honeycomb.client
+      end
+    end
+  end
+end
+
+Rake::Application.include(Honeycomb::Rake::Application)
+Rake::Task.prepend(Honeycomb::Rake::Task)

data/lib/honeycomb/propagation.rb

@@ -2,6 +2,7 @@
 
 require "base64"
 require "json"
+require "uri"
 
 module Honeycomb
   # Parse trace headers
@@ -28,7 +29,7 @@ module Honeycomb
         key, value = entry.split("=", 2)
         case key
         when "dataset"
-          dataset = value
+          dataset = URI.decode_www_form_component(value)
         when "trace_id"
           trace_id = value
         when "parent_id"
@@ -52,7 +53,14 @@ module Honeycomb
   module PropagationSerializer
     def to_trace_header
       context = Base64.urlsafe_encode64(JSON.generate(trace.fields)).strip
-      "1;trace_id=#{trace.id},parent_id=#{id},context=#{context}"
+      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

data/lib/honeycomb/rollup_fields.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Honeycomb
+  ##
+  # Functionality for including 'rollup_fields'. Which are fields that can be
+  # tracked numerically and will also be propogated up to an existing trace.
+  #
+  module RollupFields
+    def rollup_fields
+      @rollup_fields ||= Hash.new(0)
+    end
+
+    def add_rollup_field(key, value)
+      return unless value.is_a? Numeric
+
+      respond_to?(:trace) && trace.add_rollup_field(key, value)
+      rollup_fields[key] += value
+    end
+  end
+end

data/lib/honeycomb/span.rb

@@ -1,45 +1,50 @@
 # frozen_string_literal: true
 
+require "securerandom"
 require "forwardable"
 require "honeycomb/propagation"
+require "honeycomb/deterministic_sampler"
+require "honeycomb/rollup_fields"
 
 module Honeycomb
   # Represents a Honeycomb span, which wraps a Honeycomb event and adds specific
   # tracing functionality
   class Span
     include PropagationSerializer
+    include DeterministicSampler
+    include RollupFields
     extend Forwardable
 
     def_delegators :@event, :add_field, :add
+    def_delegator :@trace, :add_field, :add_trace_field
 
     attr_reader :id, :trace
 
     def initialize(trace:,
                    builder:,
                    context:,
-                   parent_id: nil,
-                   is_root: parent_id.nil?)
+                   **options)
       @id = SecureRandom.uuid
       @context = context
       @context.current_span = self
       @builder = builder
       @event = builder.event
       @trace = trace
-      @parent_id = parent_id
-      @is_root = is_root
-      @rollup_fields = Hash.new(0)
       @children = []
       @sent = false
       @started = clock_time
+      parse_options(**options)
     end
 
-    def add_rollup_field(key, value)
-      trace.add_rollup_field(key, value)
-      rollup_fields[key] += value
-    end
-
-    def add_trace_field(key, value)
-      trace.add_field(key, value)
+    def parse_options(parent_id: nil,
+                      is_root: parent_id.nil?,
+                      sample_hook: nil,
+                      presend_hook: nil,
+                      **_options)
+      @parent_id = parent_id
+      @is_root = is_root
+      @presend_hook = presend_hook
+      @sample_hook = sample_hook
     end
 
     def create_child
@@ -68,12 +73,13 @@ module Honeycomb
 
     private
 
-    attr_reader :rollup_fields,
-                :event,
+    attr_reader :event,
                 :parent_id,
                 :children,
                 :builder,
-                :context
+                :context,
+                :presend_hook,
+                :sample_hook
 
     def sent?
       @sent
@@ -93,7 +99,17 @@ module Honeycomb
       add trace.fields
       span_type == "root" && add(trace.rollup_fields)
       send_children
-      event.send
+      sample = true
+      if sample_hook.nil?
+        sample = should_sample(event.sample_rate, trace.id)
+      else
+        sample, event.sample_rate = sample_hook.call(event.data)
+      end
+
+      if sample
+        presend_hook && presend_hook.call(event.data)
+        event.send_presampled
+      end
       @sent = true
       context.span_sent(self)
     end

data/lib/honeycomb/trace.rb

@@ -4,37 +4,35 @@ require "forwardable"
 require "securerandom"
 require "honeycomb/span"
 require "honeycomb/propagation"
+require "honeycomb/rollup_fields"
 
 module Honeycomb
   # Represents a Honeycomb trace, which groups spans together
   class Trace
     include PropagationParser
+    include RollupFields
     extend Forwardable
 
     def_delegators :@root_span, :send
 
-    attr_reader :id, :fields, :root_span, :rollup_fields
+    attr_reader :id, :fields, :root_span
 
-    def initialize(builder:, context:, serialized_trace: nil)
+    def initialize(builder:, context:, serialized_trace: nil, **options)
       trace_id, parent_span_id, trace_fields, dataset =
         parse serialized_trace
       dataset && builder.dataset = dataset
       @id = trace_id || SecureRandom.uuid
-      @rollup_fields = Hash.new(0)
       @fields = trace_fields || {}
       @root_span = Span.new(trace: self,
                             parent_id: parent_span_id,
                             is_root: true,
                             builder: builder,
-                            context: context)
+                            context: context,
+                            **options)
     end
 
     def add_field(key, value)
       @fields[key] = value
     end
-
-    def add_rollup_field(key, value)
-      @rollup_fields[key] += value
-    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: honeycomb-beeline
 version: !ruby/object:Gem::Version
-  version: 1.0.0.pre.alpha1
+  version: 1.0.0.pre.beta
 platform: ruby
 authors:
 - Martin Holman
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-06-27 00:00:00.000000000 Z
+date: 2019-07-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: libhoney
@@ -221,14 +221,18 @@ files:
 - lib/honeycomb-beeline.rb
 - lib/honeycomb/beeline/version.rb
 - lib/honeycomb/client.rb
+- lib/honeycomb/configuration.rb
 - lib/honeycomb/context.rb
+- lib/honeycomb/deterministic_sampler.rb
 - lib/honeycomb/integrations/active_support.rb
 - lib/honeycomb/integrations/faraday.rb
 - lib/honeycomb/integrations/rack.rb
 - lib/honeycomb/integrations/rails.rb
+- lib/honeycomb/integrations/rake.rb
 - lib/honeycomb/integrations/sequel.rb
 - lib/honeycomb/integrations/sinatra.rb
 - lib/honeycomb/propagation.rb
+- lib/honeycomb/rollup_fields.rb
 - lib/honeycomb/span.rb
 - lib/honeycomb/trace.rb
 - lib/sequel/extensions/honeycomb.rb