libhoney 1.11.0 → 1.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dd29a10e412de6aef7a21988cdf51e253dbfdfa4e3c53a7161f617b27dbcc81a
-  data.tar.gz: 25c577fcda6470dd420a292a08cec6632e18889ac1a0ac3bc82c166258860216
+  metadata.gz: aaff0cc763c16bc795c21403f744d3a5e6773d2503c338d9f161fc1d0ef01341
+  data.tar.gz: e4f44b656d422207f25441c867519118f1f4557718c0c12e25f198e4871052b5
 SHA512:
-  metadata.gz: 85133ade7a0a6cb208ed0912a6a001fe79d0f8e6c35b7d084512e7e57ac47df94f9181e8428df535f620f9bc4ad9333582c945a5aa72f8e9a0de35a976ce7460
-  data.tar.gz: bf7c51ec4d23ae23aaed304c670aed2b08c0f7d51f6c8c7a6c139161f20d70e5c5691b143f00dbc8af5c3b6b075e894a9836e9316e4fce0e7f592527a74b11e7
+  metadata.gz: 17701619551ad22950ffe421c9a98a4546e00ea8447ee52b22c19d21af9adc342951eed7ee0046c0ca8459d63ffc90ff64cb3759e003971681bb3b567debd9fe
+  data.tar.gz: c701b48807d76fcef732eaa47e7059ef71cfeaa40693bc039b094968b12407f26d9f6647d3f204a4c2feeed551ca07840c9a1d0850b8ab755eeeb0fdff3675b7

data/README.md

@@ -7,9 +7,7 @@ Requires Ruby 2.2 or greater.
 - [Usage and Examples](https://docs.honeycomb.io/sdk/ruby/)
 - [API Reference](https://www.rubydoc.info/gems/libhoney)
 
-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 automatic instrumentation of Ruby on Rails, check out our [Rails integration](https://github.com/honeycombio/honeycomb-rails).
+For tracing support and automatic instrumentation of Rails, Sinatra, Rack, ActiveRecord, and other frameworks, check out our [Beeline for Ruby](https://github.com/honeycombio/beeline-ruby).
 
 ## Contributions
 

data/example/factorial.rb

@@ -30,49 +30,43 @@ def run_factorial(low, high, libh_builder)
   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
+                                dataset: dataset)
 
 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'))
+    loop do
+      response = libhoney.responses.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 "      #{response.error.class}: #{response.error}" if response.error
+      puts
     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
+    puts "#{e.class} in response reader thread: #{e}"
   end
 end
 
-read_responses(responses)
+# 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

data/lib/libhoney/client.rb

@@ -29,38 +29,47 @@ end
 module Libhoney
   ##
   # This is a library to allow you to send events to Honeycomb from within your
-  # ruby application.
+  # Ruby application.
   #
-  # Example:
+  # @example Send a simple event
   #   require 'libhoney'
-  #   honey = Libhoney.new(writekey, dataset, url, sample_rate, num_workers)
-  #   event = honey.event
-  #   event.add({'pglatency' => 100})
-  #   honey.send(event)
-  #   <repeat creating and sending events until your program is finished>
+  #   honey = Libhoney.new(writekey, dataset, sample_rate)
+  #
+  #   evt = honey.event
+  #   evt.add(pglatency: 100)
+  #   honey.send(evt)
+  #
+  #   # repeat creating and sending events until your program is finished
+  #
   #   honey.close
   #
-  # Arguments:
-  # * *writekey* is the key to use the Honeycomb service (required)
-  # * *dataset* is the dataset to write into (required)
-  # * *sample_rate* is how many samples you want to keep.  IE:  1 means you want 1 out of 1 samples kept, or all of them.  10 means you want 1 out of 10 samples kept.  And so on.
-  # * *url* is the url to connect to Honeycomb
-  # * *num_workers* is the number of threads working on the queue of events you are generating
+  # @example Override the default timestamp on an event
+  #   one_hour_ago = Time.now - 3600
   #
-  # Note that by default, the max queue size is 1000.  If the queue gets bigger than that, we start dropping events.
+  #   evt = libhoney.event
+  #   evt.add_fields(useful_fields)
+  #   evt.timestamp = one_hour_ago
+  #   evt.send
   #
   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)
-    # @param dataset [String] the dataset you want (required)
-    # @param sample_rate [Fixnum] cause libhoney to send 1 out of sampleRate events.  overrides the libhoney instance's value.
-    # @param api_host [String] the base url to send events to
+    # @param writekey [String] the Honeycomb API key with which to authenticate
+    #   this request (required)
+    # @param dataset [String] the Honeycomb dataset into which to send events (required)
+    # @param sample_rate [Fixnum] cause +libhoney+ to send 1 out of +sample_rate+ events.
+    #   overrides the libhoney instance's value.  (e.g. setting this to +10+ will result in
+    #   a 1-in-10 chance of it being successfully emitted to Honeycomb, and the
+    #   Honeycomb query engine will interpret it as representative of 10 events)
+    # @param api_host [String] defaults to +API_HOST+, override to change the
+    #   destination for these Honeycomb events.
     # @param transmission [Object] transport used to actually send events. If nil (the default), will be lazily initialized with a {TransmissionClient} on first event send.
     # @param block_on_send [Boolean] if more than pending_work_capacity events are written, block sending further events
     # @param block_on_responses [Boolean] if true, block if there is no thread reading from the response queue
+    # @param pending_work_capacity [Fixnum] defaults to 1000. If the queue of
+    #   pending events exceeds 1000, this client will start dropping events.
     def initialize(writekey: nil,
                    dataset: nil,
                    sample_rate: 1,
@@ -205,14 +214,14 @@ module Libhoney
     def send_event(event)
       @lock.synchronize do
         transmission_client_params = {
-          max_batch_size:         @max_batch_size,
-          send_frequency:         @send_frequency,
+          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
+          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)

data/lib/libhoney/event.rb

@@ -1,11 +1,44 @@
 module Libhoney
-  ##
   # This is the event object that you can fill up with data.
+  #
+  # @example Override the default timestamp on an event
+  #   evt = libhoney.event
+  #   evt.add_fields(useful_fields)
+  #   evt.timestamp = Time.now
+  #   evt.send
+  #
   class Event
-    attr_accessor :writekey, :dataset, :sample_rate, :api_host
-    attr_accessor :timestamp, :metadata
+    # @return [String] the Honeycomb API key with which to authenticate this
+    #   request
+    attr_accessor :writekey
 
-    # @return [Hash<String=>any>] the fields in this event
+    # @return [String] the Honeycomb dataset this event is destined for
+    #   (defaults to the +Builder+'s +dataset+, which in turn defaults to the
+    #   +Client+'s +dataset+)
+    attr_accessor :dataset
+
+    # @return [Fixnum] Set this attribute to indicate that it represents
+    #   +sample_rate+ number of events (e.g. setting this to +10+ will result in
+    #   a 1-in-10 chance of it being successfully emitted to Honeycomb, and the
+    #   Honeycomb query engine will interpret it as representative of 10 events)
+    attr_accessor :sample_rate
+
+    # @return [String] Set this attribute in order to override the destination
+    #   of these Honeycomb events (defaults to +Client::API_HOST+).
+    attr_accessor :api_host
+
+    # @return [Object] Set this attribute to any +Object+ you might need to
+    #   identify this Event as it is returned to the responses queue (e.g. tag
+    #   an Event with an internal ID in order to retry something specific on
+    #   failure).
+    attr_accessor :metadata
+
+    # @return [Time] Set this attribute in order to override the timestamp
+    #   associated with the event (defaults to the +Time.now+ at +Event+
+    #   creation)
+    attr_accessor :timestamp
+
+    # @return [Hash<String=>any>] the fields added to this event
     attr_reader :data
 
     # @api private
@@ -71,7 +104,7 @@ module Libhoney
       self
     end
 
-    # sends this event to honeycomb
+    # sends this event to Honeycomb
     #
     # @return [self] this event.
     def send
@@ -84,7 +117,7 @@ module Libhoney
       send_presampled
     end
 
-    # sends a presampled event to honeycomb
+    # sends a presampled event to Honeycomb
     #
     # @return [self] this event.
     def send_presampled

data/lib/libhoney/transmission.rb

@@ -48,7 +48,7 @@ module Libhoney
         h[api_host] = HTTP.timeout(connect: @send_timeout, write: @send_timeout, read: @send_timeout)
                           .persistent(api_host)
                           .headers(
-                            'User-Agent'   => @user_agent,
+                            'User-Agent' => @user_agent,
                             'Content-Type' => 'application/json'
                           )
       end
@@ -67,9 +67,9 @@ module Libhoney
           resp = http.post(url,
                            json: event.data,
                            headers: {
-                             'X-Honeycomb-Team'       => event.writekey,
+                             'X-Honeycomb-Team' => event.writekey,
                              'X-Honeycomb-SampleRate' => event.sample_rate,
-                             'X-Event-Time'           => event.timestamp.iso8601(3)
+                             'X-Event-Time' => event.timestamp.iso8601(3)
                            })
 
           # "You must consume response before sending next request via persistent connection"

data/lib/libhoney/version.rb

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

data/libhoney.gemspec

@@ -23,7 +23,7 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = '>= 2.2.0'
 
   spec.add_development_dependency 'bump', '~> 0.5'
-  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'minitest', '~> 5.0'
   spec.add_development_dependency 'rake', '~> 12.3'
   spec.add_development_dependency 'rubocop'
@@ -31,5 +31,5 @@ Gem::Specification.new do |spec|
   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'
+  spec.add_dependency 'http', '>= 2.0', '< 5.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: libhoney
 version: !ruby/object:Gem::Version
-  version: 1.11.0
+  version: 1.12.0
 platform: ruby
 authors:
 - The Honeycomb.io Team
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-10-09 00:00:00.000000000 Z
+date: 2019-02-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bump
@@ -28,16 +28,16 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -145,7 +145,7 @@ dependencies:
         version: '2.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -155,7 +155,7 @@ dependencies:
         version: '2.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '5.0'
 description: Ruby gem for sending data to Honeycomb
 email: support@honeycomb.io
 executables: []
@@ -206,8 +206,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 3.0.2
 signing_key: 
 specification_version: 4
 summary: send data to Honeycomb