libhoney 1.10.1 → 1.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 701a19cd4bde8de2dfa4a6f3ab46e9a2b6aa08df13e1cecb7b7b0fccb0fe7d4a
-  data.tar.gz: 8179e03fb6b2711abda9dfb26ffffe6d3e8c5fae600fe917301a02cc5fe6fb39
+  metadata.gz: dd29a10e412de6aef7a21988cdf51e253dbfdfa4e3c53a7161f617b27dbcc81a
+  data.tar.gz: 25c577fcda6470dd420a292a08cec6632e18889ac1a0ac3bc82c166258860216
 SHA512:
-  metadata.gz: 0175476abe1c2bfc530964fd3f5750fadbfc97df3661214975dc5ac2cfe033eace5c575a81c59cb5b977f3ed51cd4f802bba43e468c2fa297700904f5f0226ef
-  data.tar.gz: eea06aab450dc777b1598c23ecda377fbd888423419406568fb66a7b005609028b3f58582d887eb23f1e871b659e1eb8afd6d6355b1c1d82fcf85ef5a2f3d135
+  metadata.gz: 85133ade7a0a6cb208ed0912a6a001fe79d0f8e6c35b7d084512e7e57ac47df94f9181e8428df535f620f9bc4ad9333582c945a5aa72f8e9a0de35a976ce7460
+  data.tar.gz: bf7c51ec4d23ae23aaed304c670aed2b08c0f7d51f6c8c7a6c139161f20d70e5c5691b143f00dbc8af5c3b6b075e894a9836e9316e4fce0e7f592527a74b11e7

data/.rubocop.yml

@@ -0,0 +1,26 @@
+inherit_from: .rubocop_todo.yml
+
+AllCops:
+  TargetRubyVersion: 2.2
+
+Style/Documentation:
+  Enabled: false
+
+Lint/RescueException:
+  Exclude:
+    - 'lib/libhoney/transmission.rb'
+
+Metrics/ClassLength:
+  Exclude:
+    - test/*
+
+Metrics/MethodLength:
+  Max: 25
+  Exclude:
+    - lib/libhoney/transmission.rb
+
+Metrics/LineLength:
+  Max: 115
+  Exclude:
+    - lib/libhoney/client.rb
+    - lib/libhoney/builder.rb

data/.rubocop_todo.yml

@@ -0,0 +1,36 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2018-09-24 20:37:04 -0700 using RuboCop version 0.59.2.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 3
+Lint/HandleExceptions:
+  Exclude:
+    - 'lib/libhoney/client.rb'
+    - 'lib/libhoney/transmission.rb'
+
+# Offense count: 7
+Metrics/AbcSize:
+  Max: 35
+
+# Offense count: 1
+# Configuration parameters: CountComments, ExcludedMethods.
+# ExcludedMethods: refine
+Metrics/BlockLength:
+  Max: 27
+
+# Offense count: 2
+Metrics/CyclomaticComplexity:
+  Max: 8
+
+# Offense count: 2
+# Configuration parameters: CountKeywordArgs.
+Metrics/ParameterLists:
+  Max: 12
+
+# Offense count: 1
+Metrics/PerceivedComplexity:
+  Max: 8

data/.travis.yml

@@ -4,6 +4,9 @@ rvm:
   - 2.3
   - 2.4
   - 2.5
+script:
+  - bundle exec rake rubocop
+  - bundle exec rake test
 deploy:
   provider: rubygems
   api_key:

data/CONTRIBUTORS

@@ -9,3 +9,4 @@ Ben Hartshorne <ben@honeycomb.io>
 Eben Freeman <eben@honeycomb.io>
 Ryan King <ryan@theryanking.com>
 Paul Sadauskas <psadauskas@gmail.com>
+Shane Becker <veganstraightedge@gmail.com>

data/README.md

@@ -1,116 +1,15 @@
 # libhoney [![Build Status](https://travis-ci.org/honeycombio/libhoney-rb.svg?branch=master)](https://travis-ci.org/honeycombio/libhoney-rb) [![Gem Version](https://badge.fury.io/rb/libhoney.svg)](https://badge.fury.io/rb/libhoney)
 
-Ruby gem for sending events to [Honeycomb](https://honeycomb.io). (For more information, see the [documentation](https://honeycomb.io/docs/) and [Ruby SDK guide](https://honeycomb.io/docs/connect/ruby).)
+Ruby gem for sending events to [Honeycomb](https://www.honeycomb.io), a service for debugging your software in production.
 
-## Installation
+Requires Ruby 2.2 or greater.
 
-To install the stable release:
+- [Usage and Examples](https://docs.honeycomb.io/sdk/ruby/)
+- [API Reference](https://www.rubydoc.info/gems/libhoney)
 
-```
-gem install libhoney
-```
-
-or add `libhoney` to your `Gemfile`:
-
-```ruby
-gem 'libhoney'
-
-# or, to follow the bleeding edge:
-# gem 'libhoney', git: 'https://github.com/honeycombio/libhoney-rb.git'
-```
-
-This gem has some native dependencies, so if you see an error along the lines of "Failed to build gem native extension", you may need to install the Ruby development headers and a C++ compiler. e.g. on Ubuntu:
-
-```
-sudo apt-get install build-essential ruby-dev
-```
-
-Note that `libhoney` requires Ruby 2.2 or greater.
-
-
-## Documentation
-
-An API reference is available at [rubydoc.info/gems/libhoney](http://www.rubydoc.info/gems/libhoney).
-
-## Example Usage
-
-Honeycomb can calculate all sorts of statistics, so send the values you care about and let us crunch the averages, percentiles, lower/upper bounds, cardinality -- whatever you want -- for you.
-
-```ruby
-require 'libhoney'
-
-# Create a client instance
-honeycomb = Libhoney::Client.new(
-  # Use an environment variable to set your write key with something like
-  # `writekey: ENV['HONEYCOMB_WRITEKEY']`,
-  writekey: 'YOUR_WRITE_KEY',
-  dataset:  'honeycomb-ruby-example'
-)
-
-honeycomb.send_now({
-  duration_ms:    153.12,
-  method:         'get',
-  hostname:       'appserver15',
-  payload_length: 27
-})
-
-# Call close to flush any pending calls to Honeycomb
-honeycomb.close
-```
-
-Check out the documentation for [`Libhoney::Client`](http://www.rubydoc.info/gems/libhoney/Libhoney/Client) for more detailed API documentation.
-
-You can find a more complete example demonstrating usage in [`example/fact.rb`](example/fact.rb)
-
-## Debugging instrumentation
-
-If you've instrumented your code to send events to Honeycomb, you may want to
-verify that you're sending the events you expected at the right time with the
-desired fields. To support this use case, `libhoney` provides a
-[`LogClient`](http://www.rubydoc.info/gems/libhoney/Libhoney/LogClient) that
-outputs events to standard error, which you can swap in for the usual `Client`.
-Example usage:
-
-```ruby
-honeycomb = Libhoney::LogClient.new
-
-my_app = MyApp.new(..., honeycomb, ...)
-my_app.do_stuff
-
-# should output events to standard error
-```
-
-Note that this will disable sending events to Honeycomb, so you'll want to
-revert this change once you've verified that the events are coming through
-appropriately.
-
-## Testing instrumented code
-
-Once you've instrumented your code to send events to Honeycomb, you may want to
-consider writing tests that verify your code is producing the events you expect,
-annotating them with the right information, etc. That way, if your code changes
-and breaks the instrumentation, you'll find out straight away, instead of at 3am
-when you need that data available for debugging!
-
-To support this use case, `libhoney` provides a
-[`TestClient`](http://www.rubydoc.info/gems/libhoney/Libhoney/TestClient) which
-you can swap in for the usual `Client`. Example usage:
-
-```ruby
-fakehoney = Libhoney::TestClient.new
-
-my_app = MyApp.new(..., fakehoney, ...)
-my_app.do_stuff
-
-expect(fakehoney.events.size).to eq 3
-
-first_event = fakehoney.events[0]
-expect(first_event.data['hovercraft_contents']).to eq 'Eels'
-```
+For tracing support and automatic instrumentation of Sinatra, Rack, ActiveRecord, and other frameworks, check out our [Beeline for Ruby](https://github.com/honeycombio/beeline-ruby).
 
-For more detail see the docs for
-[`TestClient`](http://www.rubydoc.info/gems/libhoney/Libhoney/TestClient) and
-[`Event`](http://www.rubydoc.info/gems/libhoney/Libhoney/Event).
+For automatic instrumentation of Ruby on Rails, check out our [Rails integration](https://github.com/honeycombio/honeycomb-rails).
 
 ## Contributions
 

data/Rakefile

@@ -1,24 +1,27 @@
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'
 require 'yard'
 
-require "rake/testtask"
+require 'rake/testtask'
 Rake::TestTask.new(:test) do |t|
   t.libs << 'test'
-  t.libs << "lib"
+  t.libs << 'lib'
   t.test_files = FileList['test/**/*_test.rb']
 end
 
 YARD::Rake::YardocTask.new(:doc)
 
-require "yardstick/rake/measurement"
+require 'yardstick/rake/measurement'
 Yardstick::Rake::Measurement.new do |measurement|
-  measurement.output = "measurement/report.txt"
+  measurement.output = 'measurement/report.txt'
 end
 
-require "yardstick/rake/verify"
+require 'yardstick/rake/verify'
 Yardstick::Rake::Verify.new do |verify|
   verify.require_exact_threshold = false
   verify.threshold = 55
 end
 
-task :default => :test
+require 'rubocop/rake_task'
+RuboCop::RakeTask.new
+
+task default: %i[rubocop test]

data/example/factorial.rb

@@ -0,0 +1,78 @@
+lib = File.expand_path('../lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'libhoney'
+
+# replace this with yours from https://ui.honeycomb.com/account
+writekey = '7aefa39399a474bd9f414a8e3f8d9691'
+dataset  = 'factorial'
+
+def factorial(number)
+  return -1 * factorial(abs(number)) if number < 0
+  return 1 if number.zero?
+
+  number * factorial(number - 1)
+end
+
+# run factorial. libh_builder comes with some fields already populated
+# (namely, "version", "num_threads", and "range")
+def run_factorial(low, high, libh_builder)
+  (low..high).each do |i|
+    event = libh_builder.event
+    event.metadata = { fn: 'run_factorial', i: i }
+
+    event.with_timer('factorial') do
+      result = factorial(10 + i)
+      event.add_field('retval', result)
+    end
+
+    event.send
+  end
+end
+
+def read_responses(response_queue)
+  loop do
+    response = response_queue.pop
+    break if response.nil?
+
+    puts "Sent: Event with metadata #{response.metadata} in #{response.duration * 1000}ms."
+    puts "Got:  Response code #{response.status_code}"
+    puts
+  end
+end
+
+libhoney = Libhoney::Client.new(writekey: writekey,
+                                dataset:  dataset,
+                                max_concurrent_batches: 1)
+
+responses = libhoney.responses
+
+Thread.new do
+  begin
+    # attach fields to top-level instance
+    libhoney.add_field('version', '3.4.5')
+
+    a_proc = proc { Thread.list.select { |thread| thread.status == 'run' }.count }
+    libhoney.add_dynamic_field('num_threads', a_proc)
+
+    event = libhoney.event
+    event.metadata = { fn: 'work_thread' }
+    event.add_field('start_time', Time.now.iso8601(3))
+    event.with_timer 'run_fact_low_dur_ms' do
+      run_factorial(1, 20, libhoney.builder(range: 'low'))
+    end
+    event.with_timer 'run_fact_high_dur_ms' do
+      run_factorial(31, 40, libhoney.builder(range: 'high'))
+    end
+    event.add_field('end_time', Time.now.iso8601(3))
+    # sends an event with "version", "num_threads", "start_time", "end_time",
+    # "run_fact_low_dur_ms", "run_fact_high_dur_ms"
+    event.send
+
+    libhoney.close
+  rescue StandardError => e
+    puts e
+  end
+end
+
+read_responses(responses)

data/lib/libhoney/builder.rb

@@ -11,21 +11,21 @@ module Libhoney
     def initialize(libhoney, parent_builder, fields = {}, dyn_fields = {})
       @libhoney = libhoney
 
-      @fields = {}
+      @fields     = {}
       @dyn_fields = {}
 
-      if parent_builder != nil
-        @writekey = parent_builder.writekey
-        @dataset = parent_builder.dataset
+      unless parent_builder.nil?
+        @writekey    = parent_builder.writekey
+        @dataset     = parent_builder.dataset
         @sample_rate = parent_builder.sample_rate
-        @api_host = parent_builder.api_host
+        @api_host    = parent_builder.api_host
+
         @fields.merge!(parent_builder.fields)
         @dyn_fields.merge!(parent_builder.dyn_fields)
       end
 
       @fields.merge!(fields)
       @dyn_fields.merge!(dyn_fields)
-      self
     end
 
     # adds a group of field->values to the events created from this builder.
@@ -59,15 +59,23 @@ module Libhoney
     # adds a single field->dynamic value function, which is invoked to supply values when events are created from this builder.
     #
     # @param name [string] the name of the field to add to events.
-    # @param fn [#call] the function called to generate the value for this field.
+    # @param proc [#call] the function called to generate the value for this field.
     # @return [self] this Builder instance.
     # @example
     #   builder.add_dynamic_field("process_heapUsed", Proc.new { Thread.list.select {|thread| thread.status == "run"}.count })
-    def add_dynamic_field(name, fn)
-      @dyn_fields[name] = fn
+    def add_dynamic_field(name, proc)
+      @dyn_fields[name] = proc
     end
 
-    # creates and sends an event, including all builder fields/dyn_fields, as well as anything in the optional data parameter.
+    # @deprecated
+    # Creates and sends an event, including all global builder fields/dyn_fields, as well as anything in the optional data parameter.
+    #
+    # Equivalent to:
+    #   ev = builder.event
+    #   ev.add(data)
+    #   ev.send
+    #
+    # May be removed in a future major release
     #
     # @param data [Hash<String=>any>] optional field->value mapping to add to the event sent.
     # @return [self] this Builder instance
@@ -78,9 +86,9 @@ module Libhoney
     #     :additionalField => value
     #   }
     def send_now(data = {})
-      ev = self.event
+      ev = event
       ev.add(data)
-      ev.send()
+      ev.send
       self
     end
 

data/lib/libhoney/client.rb

@@ -1,26 +1,27 @@
-require 'thread'
 require 'time'
 require 'json'
 require 'http'
 
 require 'libhoney/null_transmission'
 
-# define a few additions that proxy access through Client's builder.  makes Client much tighter.
+# Define a few additions that proxy access through Client's builder. Makes Client much tighter.
 class Class
   def builder_attr_accessor(*args)
     args.each do |arg|
-      self.class_eval("def #{arg};@builder.#{arg};end")
-      self.class_eval("def #{arg}=(val);@builder.#{arg}=val;end")
+      class_eval("def #{arg};@builder.#{arg};end", __FILE__, __LINE__)
+      class_eval("def #{arg}=(val);@builder.#{arg}=val;end", __FILE__, __LINE__)
     end
   end
+
   def builder_attr_reader(*args)
     args.each do |arg|
-      self.class_eval("def #{arg};@builder.#{arg};end")
+      class_eval("def #{arg};@builder.#{arg};end", __FILE__, __LINE__)
     end
   end
+
   def builder_attr_writer(*args)
     args.each do |arg|
-      self.class_eval("def #{arg}=(val);@builder.#{arg}=val;end")
+      class_eval("def #{arg}=(val);@builder.#{arg}=val;end", __FILE__, __LINE__)
     end
   end
 end
@@ -49,6 +50,8 @@ module Libhoney
   # Note that by default, the max queue size is 1000.  If the queue gets bigger than that, we start dropping events.
   #
   class Client
+    API_HOST = 'https://api.honeycomb.io/'.freeze
+
     # Instantiates libhoney and prepares it to send events to Honeycomb.
     #
     # @param writekey [String] the write key from your honeycomb team (required)
@@ -61,7 +64,7 @@ module Libhoney
     def initialize(writekey: nil,
                    dataset: nil,
                    sample_rate: 1,
-                   api_host: 'https://api.honeycomb.io/',
+                   api_host: API_HOST,
                    user_agent_addition: nil,
                    transmission: nil,
                    block_on_send: false,
@@ -71,40 +74,41 @@ module Libhoney
                    max_concurrent_batches: 10,
                    pending_work_capacity: 1000)
       # check for insanity
-      raise Exception.new('libhoney:  max_concurrent_batches must be greater than 0') if max_concurrent_batches < 1
-      raise Exception.new('libhoney:  sample rate must be greater than 0') if sample_rate < 1
+      raise Exception, 'libhoney:  max_concurrent_batches must be greater than 0' if max_concurrent_batches < 1
+      raise Exception, 'libhoney:  sample rate must be greater than 0'            if sample_rate < 1
+
+      unless Gem::Dependency.new('ruby', '~> 2.2').match?('ruby', RUBY_VERSION)
+        raise Exception, 'libhoney:  Ruby versions < 2.2 are not supported'
+      end
 
-      raise Exception.new("libhoney:  Ruby versions < 2.2 are not supported") if !Gem::Dependency.new("ruby", "~> 2.2").match?("ruby", RUBY_VERSION)
       @builder = Builder.new(self, nil)
-      @builder.writekey = writekey
-      @builder.dataset = dataset
+
+      @builder.writekey    = writekey
+      @builder.dataset     = dataset
       @builder.sample_rate = sample_rate
-      @builder.api_host = api_host
+      @builder.api_host    = api_host
 
-      @tx = transmission
-      if !@tx && !(writekey && dataset)
+      @transmission = transmission
+      if !@transmission && !(writekey && dataset)
         # if no writekey or dataset are configured, and we didn't override the
         # transmission (e.g. to a MockTransmissionClient), that's almost
         # certainly a misconfiguration, even though it's possible to override
         # them on a per-event basis. So let's handle the misconfiguration
-        # early rather than potentially throwing thousands of exceptions at
-        # runtime.
+        # early rather than potentially throwing thousands of exceptions at runtime.
         warn "#{self.class.name}: no #{writekey ? 'dataset' : 'writekey'} configured, disabling sending events"
-        @tx = NullTransmissionClient.new
+        @transmission = NullTransmissionClient.new
       end
 
       @user_agent_addition = user_agent_addition
 
-      @block_on_send = block_on_send
-      @block_on_responses = block_on_responses
-      @max_batch_size = max_batch_size
-      @send_frequency = send_frequency
+      @block_on_send          = block_on_send
+      @block_on_responses     = block_on_responses
+      @max_batch_size         = max_batch_size
+      @send_frequency         = send_frequency
       @max_concurrent_batches = max_concurrent_batches
-      @pending_work_capacity = pending_work_capacity
-      @responses = SizedQueue.new(2 * @pending_work_capacity)
-      @lock = Mutex.new
-
-      self
+      @pending_work_capacity  = pending_work_capacity
+      @responses              = SizedQueue.new(2 * @pending_work_capacity)
+      @lock                   = Mutex.new
     end
 
     builder_attr_accessor :writekey, :dataset, :sample_rate, :api_host
@@ -121,11 +125,11 @@ module Libhoney
       @builder.builder(fields, dyn_fields)
     end
 
-    ##
     # Nuke the queue and wait for inflight requests to complete before returning.
     # If you set drain=false, all queued requests will be dropped on the floor.
-    def close(drain=true)
-      return @tx.close(drain) if @tx
+    def close(drain = true)
+      return @transmission.close(drain) if @transmission
+
       0
     end
 
@@ -158,26 +162,34 @@ module Libhoney
     # adds a single field->dynamic value function to the global Builder.
     #
     # @param name [String] name of field to add.
-    # @param fn [#call] function that will be called to generate the value whenever an event is created.
+    # @param proc [#call] function that will be called to generate the value whenever an event is created.
     # @return [self] this libhoney instance.
     # @example
     #   honey.add_dynamic_field("active_threads", Proc.new { Thread.list.select {|thread| thread.status == "run"}.count })
-    def add_dynamic_field(name, fn)
-      @builder.add_dynamic_field(name, fn)
+    def add_dynamic_field(name, proc)
+      @builder.add_dynamic_field(name, proc)
       self
     end
 
-    # creates and sends an event, including all global builder fields/dyn_fields, as well as anything in the optional data parameter.
+    # @deprecated
+    # Creates and sends an event, including all global builder fields/dyn_fields, as well as anything in the optional data parameter.
+    #
+    # Equivalent to:
+    #   ev = builder.event
+    #   ev.add(data)
+    #   ev.send
+    #
+    # May be removed in a future major release
     #
     # @param data [Hash<String=>any>] optional field->value mapping to add to the event sent.
     # @return [self] this libhoney instance.
     # @example empty send_now
-    #   honey.send_now() # sends just the data that has been added via add/add_field/add_dynamic_field.
+    #   honey.send_now # sends just the data that has been added via add/add_field/add_dynamic_field.
     # @example adding data at send-time
     #   honey.send_now {
     #     additionalField: value
     #   }
-    #/
+    # /
     def send_now(data = {})
       @builder.send_now(data)
       self
@@ -191,26 +203,28 @@ module Libhoney
     # @param event [Event] the event to send to honeycomb
     # @api private
     def send_event(event)
-      @lock.synchronize {
-        if !@tx
-          @tx = TransmissionClient.new(:max_batch_size => @max_batch_size,
-                                       :send_frequency => @send_frequency,
-                                       :max_concurrent_batches => @max_concurrent_batches,
-                                       :pending_work_capacity => @pending_work_capacity,
-                                       :responses => @responses,
-                                       :block_on_send => @block_on_send,
-                                       :block_on_responses => @block_on_responses,
-                                       :user_agent_addition => @user_agent_addition)
-        end
-      }
-
-      @tx.add(event)
+      @lock.synchronize do
+        transmission_client_params = {
+          max_batch_size:         @max_batch_size,
+          send_frequency:         @send_frequency,
+          max_concurrent_batches: @max_concurrent_batches,
+          pending_work_capacity:  @pending_work_capacity,
+          responses:              @responses,
+          block_on_send:          @block_on_send,
+          block_on_responses:     @block_on_responses,
+          user_agent_addition:    @user_agent_addition
+        }
+
+        @transmission ||= TransmissionClient.new(transmission_client_params)
+      end
+
+      @transmission.add(event)
     end
 
     # @api private
     def send_dropped_response(event, msg)
-      response = Response.new(:error => msg,
-                              :metadata => event.metadata)
+      response = Response.new(error: msg,
+                              metadata: event.metadata)
       begin
         @responses.enq(response, !@block_on_responses)
       rescue ThreadError

data/lib/libhoney/event.rb

@@ -7,25 +7,22 @@ module Libhoney
 
     # @return [Hash<String=>any>] the fields in this event
     attr_reader :data
-    
+
     # @api private
     # @see Client#event
     # @see Builder#event
     def initialize(libhoney, builder, fields = {}, dyn_fields = {})
-      @libhoney = libhoney
-
-      @writekey = builder.writekey
-      @dataset = builder.dataset
+      @libhoney    = libhoney
+      @writekey    = builder.writekey
+      @dataset     = builder.dataset
       @sample_rate = builder.sample_rate
-      @api_host = builder.api_host
-      @timestamp = Time.now
-      @metadata = nil
+      @api_host    = builder.api_host
+      @timestamp   = Time.now
+      @metadata    = nil
 
-      @data = { }
-      fields.each { |k, v| self.add_field(k, v) }
-      dyn_fields.each { |k, v| self.add_field(k, v.call) }
-      
-      self
+      @data = {}
+      fields.each { |k, v| add_field(k, v) }
+      dyn_fields.each { |k, v| add_field(k, v.call) }
     end
 
     # adds a group of field->values to this event.
@@ -65,33 +62,34 @@ module Libhoney
     #   event.with_timer "task_ms" do
     #     # something time consuming
     #   end
-    def with_timer(name, &block)
-        start = Time.now
-        block.call
-        duration = Time.now - start
-        # report in ms
-        self.add_field(name, duration * 1000)
-        self
+    def with_timer(name)
+      start = Time.now
+      yield
+      duration = Time.now - start
+      # report in ms
+      add_field(name, duration * 1000)
+      self
     end
-    
+
     # sends this event to honeycomb
     #
     # @return [self] this event.
     def send
       # discard if sampling rate says so
-      if @libhoney.should_drop(self.sample_rate)
-        @libhoney.send_dropped_response(self, "event dropped due to sampling")
+      if @libhoney.should_drop(sample_rate)
+        @libhoney.send_dropped_response(self, 'event dropped due to sampling')
         return
       end
 
-      self.send_presampled()
+      send_presampled
     end
 
     # sends a presampled event to honeycomb
     #
     # @return [self] this event.
     def send_presampled
-      raise ArgumentError.new("No metrics added to event. Won't send empty event.")         if self.data.length == 0
+      raise ArgumentError, "No metrics added to event. Won't send empty event." if data.empty?
+
       @libhoney.send_event(self)
       self
     end

data/lib/libhoney/log_client.rb

@@ -2,7 +2,6 @@ require 'libhoney/client'
 require 'libhoney/log_transmission'
 
 module Libhoney
-
   # A client that prints events to stderr or a file for inspection. Does not
   # actually send any events to Honeycomb; instead, records events for later
   # inspection.
@@ -17,5 +16,4 @@ module Libhoney
             **kwargs)
     end
   end
-
 end

data/lib/libhoney/log_transmission.rb

@@ -10,7 +10,7 @@ module Libhoney
   #       production is not recommended.
   class LogTransmissionClient
     def initialize(output:, verbose: false)
-      @output = output
+      @output  = output
       @verbose = verbose
     end
 
@@ -18,16 +18,14 @@ module Libhoney
     def add(event)
       if @verbose
         metadata = "Honeycomb dataset '#{event.dataset}' | #{event.timestamp.iso8601}"
-        if event.sample_rate != 1
-          metadata << " (sample rate: #{event.sample_rate})"
-        end
+        metadata << " (sample rate: #{event.sample_rate})" if event.sample_rate != 1
         @output.print("#{metadata} | ")
       end
       @output.puts(event.data.to_json)
     end
 
     # Flushes the output (but does not close it)
-    def close(drain)
+    def close(_drain)
       @output.flush
     end
   end

data/lib/libhoney/mock_transmission.rb

@@ -20,8 +20,7 @@ module Libhoney
     end
 
     # Does nothing.
-    def close(drain)
-    end
+    def close(drain); end
 
     # Discards the recorded events
     def reset

data/lib/libhoney/null_client.rb

@@ -2,7 +2,6 @@ require 'libhoney/client'
 require 'libhoney/null_transmission'
 
 module Libhoney
-
   # A no-op client that silently drops events. Does not send events to
   # Honeycomb, or to anywhere else for that matter.
   #
@@ -18,5 +17,4 @@ module Libhoney
             **kwargs)
     end
   end
-
 end

data/lib/libhoney/null_transmission.rb

@@ -4,10 +4,8 @@ module Libhoney
   #
   # @api private
   class NullTransmissionClient
-    def add(event)
-    end
+    def add(event); end
 
-    def close(drain)
-    end
+    def close(drain); end
   end
 end

data/lib/libhoney/response.rb

@@ -1,4 +1,3 @@
-
 module Libhoney
   class Response
     attr_accessor :duration, :status_code, :metadata, :error
@@ -7,10 +6,10 @@ module Libhoney
                    status_code: 0,
                    metadata: nil,
                    error: nil)
-      @duration = duration
+      @duration    = duration
       @status_code = status_code
-      @metadata = metadata
-      @error = error
+      @metadata    = metadata
+      @error       = error
     end
   end
 end

data/lib/libhoney/test_client.rb

@@ -2,7 +2,6 @@ require 'libhoney/client'
 require 'libhoney/mock_transmission'
 
 module Libhoney
-
   # A client with the network stubbed out for testing purposes. Does not
   # actually send any events to Honeycomb; instead, records events for later
   # inspection.
@@ -17,13 +16,12 @@ module Libhoney
 
     # @return [Array<Event>] the recorded events
     def events
-      @tx.events
+      @transmission.events
     end
 
     # Discards the recorded events
     def reset
-      @tx.reset
+      @transmission.reset
     end
   end
-
 end

data/lib/libhoney/transmission.rb

@@ -7,31 +7,32 @@ module Libhoney
                    send_frequency: 100,
                    max_concurrent_batches: 10,
                    pending_work_capacity: 1000,
+                   send_timeout: 10,
                    responses: nil,
                    block_on_send: false,
                    block_on_responses: false,
                    user_agent_addition: nil)
 
-      @responses = responses || SizedQueue.new(pending_work_capacity * 2)
-      @block_on_send = block_on_send
-      @block_on_responses = block_on_responses
-      @max_batch_size = max_batch_size
-      @send_frequency = send_frequency
+      @responses              = responses || SizedQueue.new(pending_work_capacity * 2)
+      @block_on_send          = block_on_send
+      @block_on_responses     = block_on_responses
+      @max_batch_size         = max_batch_size
+      @send_frequency         = send_frequency
       @max_concurrent_batches = max_concurrent_batches
-      @pending_work_capacity = pending_work_capacity
-
-      @user_agent = build_user_agent(user_agent_addition).freeze
+      @pending_work_capacity  = pending_work_capacity
+      @send_timeout           = send_timeout
+      @user_agent             = build_user_agent(user_agent_addition).freeze
 
       # use a SizedQueue so the producer will block on adding to the send_queue when @block_on_send is true
       @send_queue = SizedQueue.new(@pending_work_capacity)
-      @threads = []
-      @lock = Mutex.new
+      @threads    = []
+      @lock       = Mutex.new
     end
 
     def add(event)
-      raise ArgumentError, "No APIHost for Honeycomb. Can't send to the Great Unknown." if event.api_host == ""
-      raise ArgumentError, "No WriteKey specified. Can't send event." if event.writekey == ""
-      raise ArgumentError, "No Dataset for Honeycomb. Can't send datasetless." if event.dataset == ""
+      raise ArgumentError, "No APIHost for Honeycomb. Can't send to the Great Unknown." if event.api_host == ''
+      raise ArgumentError, "No WriteKey specified. Can't send event."                   if event.writekey == ''
+      raise ArgumentError, "No Dataset for Honeycomb. Can't send datasetless."          if event.dataset  == ''
 
       begin
         @send_queue.enq(event, !@block_on_send)
@@ -44,43 +45,48 @@ module Libhoney
 
     def send_loop
       http_clients = Hash.new do |h, api_host|
-        h[api_host] = HTTP.persistent(api_host).headers(
-            'User-Agent' => @user_agent,
-            'Content-Type' => 'application/json',
-        )
+        h[api_host] = HTTP.timeout(connect: @send_timeout, write: @send_timeout, read: @send_timeout)
+                          .persistent(api_host)
+                          .headers(
+                            'User-Agent'   => @user_agent,
+                            'Content-Type' => 'application/json'
+                          )
       end
 
       # eat events until we run out
-      loop {
-        e = @send_queue.pop
-        break if e == nil
+      loop do
+        event = @send_queue.pop
+        break if event.nil?
 
         before = Time.now
 
         begin
-          http = http_clients[e.api_host]
+          http = http_clients[event.api_host]
+          url  = '/1/events/' + Addressable::URI.escape(event.dataset.dup)
 
-          resp = http.post('/1/events/'+URI.escape(e.dataset), json: e.data, headers: {
-            'X-Honeycomb-Team' => e.writekey,
-            'X-Honeycomb-SampleRate' => e.sample_rate,
-            'X-Event-Time' => e.timestamp.iso8601(3)
-          })
+          resp = http.post(url,
+                           json: event.data,
+                           headers: {
+                             'X-Honeycomb-Team'       => event.writekey,
+                             'X-Honeycomb-SampleRate' => event.sample_rate,
+                             'X-Event-Time'           => event.timestamp.iso8601(3)
+                           })
 
           # "You must consume response before sending next request via persistent connection"
           # https://github.com/httprb/http/wiki/Persistent-Connections-%28keep-alive%29#note-using-persistent-requests-correctly
           resp.flush
 
-          response = Response.new(:status_code => resp.status)
+          response = Response.new(status_code: resp.status)
         rescue Exception => error
           # catch a broader swath of exceptions than is usually good practice,
           # because this is effectively the top-level exception handler for the
           # sender threads, and we don't want those threads to die (leaving
           # nothing consuming the queue).
-          response = Response.new(:error => error)
+          response = Response.new(error: error)
         ensure
           if response
             response.duration = Time.now - before
-            response.metadata = e.metadata
+            response.metadata = event.metadata
           end
         end
 
@@ -89,10 +95,14 @@ module Libhoney
         rescue ThreadError
           # happens if the queue was full and block_on_send = false.
         end
-      }
+      end
     ensure
       http_clients.each do |_, http|
-        http.close rescue nil
+        begin
+          http.close
+        rescue StandardError
+          nil
+        end
       end
     end
 
@@ -103,9 +113,7 @@ module Libhoney
       # send @threads.length number of nils so each thread will fall out of send_loop
       @threads.length.times { @send_queue << nil }
 
-      @threads.each do |t|
-        t.join
-      end
+      @threads.each(&:join)
       @threads = []
 
       @responses.enq(nil)
@@ -114,6 +122,7 @@ module Libhoney
     end
 
     private
+
     def build_user_agent(user_agent_addition)
       ua = "libhoney-rb/#{VERSION}"
       ua << " #{user_agent_addition}" if user_agent_addition
@@ -121,12 +130,10 @@ module Libhoney
     end
 
     def ensure_threads_running
-      @lock.synchronize {
+      @lock.synchronize do
         @threads.select!(&:alive?)
-        while @threads.length < @max_concurrent_batches
-          @threads << Thread.new { self.send_loop }
-        end
-      }
+        @threads << Thread.new { send_loop } while @threads.length < @max_concurrent_batches
+      end
     end
   end
 end

data/lib/libhoney/version.rb

@@ -1,3 +1,3 @@
 module Libhoney
-  VERSION = "1.10.1"
+  VERSION = '1.11.0'.freeze
 end

data/libhoney.gemspec

@@ -1,34 +1,35 @@
-lib = File.expand_path("../lib", __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "libhoney/version"
+require 'libhoney/version'
 
 Gem::Specification.new do |spec|
   spec.name        = 'libhoney'
   spec.version     = Libhoney::VERSION
 
-  spec.summary     = "send data to Honeycomb"
-  spec.description = "Ruby gem for sending data to Honeycomb"
+  spec.summary     = 'send data to Honeycomb'
+  spec.description = 'Ruby gem for sending data to Honeycomb'
   spec.authors     = ['The Honeycomb.io Team']
   spec.email       = 'support@honeycomb.io'
-  spec.files       = ['lib/libhoney.rb', 'lib/libhoney/version.rb']
   spec.homepage    = 'https://github.com/honeycombio/libhoney-rb'
   spec.license     = 'Apache-2.0'
 
-  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
   end
-  spec.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
   spec.required_ruby_version = '>= 2.2.0'
 
-  spec.add_development_dependency "bundler", "~> 1.7"
-  spec.add_development_dependency "rake", "~> 12.3"
-  spec.add_development_dependency "webmock", "~> 3.4"
-  spec.add_development_dependency "minitest", "~> 5.0"
-  spec.add_development_dependency "yard"
-  spec.add_development_dependency "yardstick", "~> 0.9"
-  spec.add_development_dependency "bump", "~> 0.5"
-  spec.add_dependency "http", ">= 2.0", '< 4.0'
+  spec.add_development_dependency 'bump', '~> 0.5'
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+  spec.add_development_dependency 'rake', '~> 12.3'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'webmock', '~> 3.4'
+  spec.add_development_dependency 'yard'
+  spec.add_development_dependency 'yardstick', '~> 0.9'
+  spec.add_dependency 'addressable', '~> 2.0'
+  spec.add_dependency 'http', '>= 2.0', '< 4.0'
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: libhoney
 version: !ruby/object:Gem::Version
-  version: 1.10.1
+  version: 1.11.0
 platform: ruby
 authors:
 - The Honeycomb.io Team
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-08-31 00:00:00.000000000 Z
+date: 2018-10-09 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: bump
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -24,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -39,33 +67,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '12.3'
 - !ruby/object:Gem::Dependency
-  name: webmock
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '3.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '3.4'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -95,19 +123,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0.9'
 - !ruby/object:Gem::Dependency
-  name: bump
+  name: addressable
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.5'
-  type: :development
+        version: '2.0'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: http
   requirement: !ruby/object:Gem::Requirement
@@ -135,6 +163,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
 - ".travis.yml"
 - CONTRIBUTORS
 - Gemfile
@@ -142,7 +172,7 @@ files:
 - NOTICE
 - README.md
 - Rakefile
-- example/fact.rb
+- example/factorial.rb
 - lib/libhoney.rb
 - lib/libhoney/builder.rb
 - lib/libhoney/client.rb

data/example/fact.rb

@@ -1,62 +0,0 @@
-lib = File.expand_path("../../lib", __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-
-require 'libhoney'
-
-writekey = "7aefa39399a474bd9f414a8e3f8d9691" # replace this with yours from https://ui.honeycomb.com/account
-dataset = "factorial"
-
-
-def factorial(n)
-  return -1 * factorial(abs(n)) if n < 0
-  return 1 if n == 0
-  return n * factorial(n - 1)
-end
-
-# run factorial. libh_builder comes with some fields already populated
-# (namely, "version", "num_threads", and "range")
-def run_fact(low, high, libh_builder)
-  for i in low..high do
-    ev = libh_builder.event
-    ev.metadata = { :fn => "run_fact",
-                    :i => i }
-    ev.with_timer("fact") do
-      res = factorial(10 + i)
-      ev.add_field("retval", res)
-    end
-    ev.send
-  end
-end
-
-def read_responses(resp_queue)
-  while resp = resp_queue.pop()
-    puts "sending event with metadata #{resp.metadata} took #{resp.duration*1000}ms and got response code #{resp.status_code}"
-  end
-end
-    
-
-libhoney = Libhoney::Client.new(:writekey => writekey,
-                                :dataset => dataset,
-                                :max_concurrent_batches => 1)
-
-resps = libhoney.responses()
-Thread.new do
-  begin
-    # attach fields to top-level instance
-    libhoney.add_field("version", "3.4.5")
-    libhoney.add_dynamic_field("num_threads", Proc.new { Thread.list.select {|thread| thread.status == "run"}.count })
-
-    # sends an event with "version", "num_threads", and "status" fields
-    libhoney.send_now({:status => "starting run"})
-    run_fact(1, 20, libhoney.builder({:range => "low"}))
-    run_fact(31, 40, libhoney.builder({:range => "high"}))
-
-    # sends an event with "version", "num_threads", and "status" fields
-    libhoney.send_now({:status => "ending run"})
-    libhoney.close
-  rescue Exception => e
-    puts e
-  end
-end
-
-read_responses(resps)