libhoney 1.7.0 → 1.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ab4842399534d125e9b6a5efeacca99e6a6a49f07caef2c71e0ac70430e13830
-  data.tar.gz: e497f15c36c2856e8c26bd7ac3ea814e1262d1d42e96ceb462fed7d6a5f143cd
+  metadata.gz: d74e33b8302fc833dd35b082d3737fa7fdab5778619ebe32847f5a15f422e49b
+  data.tar.gz: 6312eef683fe6d91daad288b75d0066dea4bf24ba19748fd57c0d720438c2e6d
 SHA512:
-  metadata.gz: 99449aa5c26539244ec71bc27e5fca1de59119171d3ac0f06d35bcaf5c8207fe82ffde7c6e0bd9bfa7bad7bb1539098669b3da09a6b61fffc9cafb1ed6de977d
-  data.tar.gz: 504dc7078f44dc2065ff2f020547aca89c58d0c3c1d3d6c4ed9d9aeb3a6dbd336c94442b54f487d336eded810485f5231a97351ac82ae200bb64b5cd6a8682bf
+  metadata.gz: 7de2ddd45d25a2678d2c0d7d3ae8bf951bb68f395373fdc4beffc95f0ae83e28f802a71970eda66ef39eee8398710e1c4365d84c3009f898d70df3b57d9fe4ad
+  data.tar.gz: 61dff7d76a2da82da52e5c4d0f94314393a34039c647008b6238e2c544007e7454479241320e7bde40cebe6fdbe08e7fb38453b0fd6e1515c32b33fe4d47c62b

data/lib/libhoney/client.rb

@@ -3,6 +3,8 @@ 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.
 class Class
   def builder_attr_accessor(*args)
@@ -38,8 +40,8 @@ module Libhoney
   #   honey.close
   #
   # Arguments:
-  # * *writekey* is the key to use the Honeycomb service
-  # * *dataset* is the dataset to write into
+  # * *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
@@ -49,15 +51,15 @@ module Libhoney
   class Client
     # Instantiates libhoney and prepares it to send events to Honeycomb.
     #
-    # @param writekey [String] the write key from your honeycomb team
-    # @param dataset [String] the dataset you want
+    # @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 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
-    def initialize(writekey: '',
-                   dataset: '',
+    def initialize(writekey: nil,
+                   dataset: nil,
                    sample_rate: 1,
                    api_host: 'https://api.honeycomb.io/',
                    user_agent_addition: nil,
@@ -79,6 +81,18 @@ module Libhoney
       @builder.sample_rate = sample_rate
       @builder.api_host = api_host
 
+      @tx = transmission
+      if !@tx && !(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.
+        warn "#{self.class.name}: no #{writekey ? 'dataset' : 'writekey'} configured, disabling sending events"
+        @tx = NullTransmissionClient.new
+      end
+
       @user_agent_addition = user_agent_addition
 
       @block_on_send = block_on_send
@@ -88,7 +102,6 @@ module Libhoney
       @max_concurrent_batches = max_concurrent_batches
       @pending_work_capacity = pending_work_capacity
       @responses = SizedQueue.new(2 * @pending_work_capacity)
-      @tx = transmission
       @lock = Mutex.new
 
       self

data/lib/libhoney/log_client.rb

@@ -1,4 +1,5 @@
 require 'libhoney/client'
+require 'libhoney/log_transmission'
 
 module Libhoney
 

data/lib/libhoney/null_client.rb

@@ -0,0 +1,22 @@
+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.
+  #
+  # This class is intended as a fallback for callers that wanted to instantiate
+  # a regular Client but had insufficient config to do so (e.g. missing
+  # writekey).
+  #
+  # @api private
+  class NullClient < Client
+    def initialize(*args, **kwargs)
+      super(*args,
+            transmission: NullTransmissionClient.new,
+            **kwargs)
+    end
+  end
+
+end

data/lib/libhoney/null_transmission.rb

@@ -0,0 +1,13 @@
+module Libhoney
+  # A no-op version of TransmissionClient that silently drops events (without
+  # sending them to Honeycomb, or anywhere else for that matter).
+  #
+  # @api private
+  class NullTransmissionClient
+    def add(event)
+    end
+
+    def close(drain)
+    end
+  end
+end

data/lib/libhoney/test_client.rb

@@ -1,4 +1,5 @@
 require 'libhoney/client'
+require 'libhoney/mock_transmission'
 
 module Libhoney
 

data/lib/libhoney/version.rb

@@ -1,3 +1,3 @@
 module Libhoney
-  VERSION = "1.7.0"
+  VERSION = "1.8.1"
 end

data/lib/libhoney.rb

@@ -1,9 +1,8 @@
 require 'libhoney/client'
 require 'libhoney/log_client'
+require 'libhoney/null_client'
 require 'libhoney/test_client'
 require 'libhoney/version'
 require 'libhoney/builder'
 require 'libhoney/response'
 require 'libhoney/transmission'
-require 'libhoney/log_transmission'
-require 'libhoney/mock_transmission'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: libhoney
 version: !ruby/object:Gem::Version
-  version: 1.7.0
+  version: 1.8.1
 platform: ruby
 authors:
 - The Honeycomb.io Team
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-05-09 00:00:00.000000000 Z
+date: 2018-05-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -144,6 +144,8 @@ files:
 - lib/libhoney/log_client.rb
 - lib/libhoney/log_transmission.rb
 - lib/libhoney/mock_transmission.rb
+- lib/libhoney/null_client.rb
+- lib/libhoney/null_transmission.rb
 - lib/libhoney/response.rb
 - lib/libhoney/test_client.rb
 - lib/libhoney/transmission.rb
@@ -169,7 +171,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
 summary: send data to Honeycomb