libhoney 1.6.0 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dbbdf54cf6c6f49316a2599197b3418c20a65d171c49c7bb2e3be25fc98fb7e7
-  data.tar.gz: 765269d8c9a3d028469ae41904934f879f72a33ebe137f65f61448979a149dac
+  metadata.gz: ab4842399534d125e9b6a5efeacca99e6a6a49f07caef2c71e0ac70430e13830
+  data.tar.gz: e497f15c36c2856e8c26bd7ac3ea814e1262d1d42e96ceb462fed7d6a5f143cd
 SHA512:
-  metadata.gz: c9a32d01167fa4e618c75c563ea225ba33df1a70bb0bc26a86f3bdf41f874ffa6335e1686875bc887408e13c4742bd2b0a67e1f24d53730e89756d29620060d1
-  data.tar.gz: f110fe871e6fb626590d57fde6b138b03d0236c8ef828bf2b9991220d92d58f2b67c0f4de1a452d8944ecbf3f6917892ecd1425a0377dc367d488cc75c62d996
+  metadata.gz: 99449aa5c26539244ec71bc27e5fca1de59119171d3ac0f06d35bcaf5c8207fe82ffde7c6e0bd9bfa7bad7bb1539098669b3da09a6b61fffc9cafb1ed6de977d
+  data.tar.gz: 504dc7078f44dc2065ff2f020547aca89c58d0c3c1d3d6c4ed9d9aeb3a6dbd336c94442b54f487d336eded810485f5231a97351ac82ae200bb64b5cd6a8682bf

data/README.md

@@ -61,6 +61,27 @@ Check out the documentation for [`Libhoney::Client`](http://www.rubydoc.info/gem
 
 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

data/lib/libhoney/client.rb

@@ -210,27 +210,4 @@ module Libhoney
       rand(1..sample_rate) != 1
     end
   end
-
-  # A client with the network stubbed out for testing purposes. Does not
-  # actually send any events to Honeycomb; instead, records events for later
-  # inspection.
-  #
-  # @note This class is intended for use in tests, for example if you want to
-  #       verify what events your instrumented code is sending. Use in
-  #       production is not recommended.
-  class TestClient < Client
-    def initialize(*args, **kwargs)
-      super(*args, transmission: MockTransmissionClient.new, **kwargs)
-    end
-
-    # @return [Array<Event>] the recorded events
-    def events
-      @tx.events
-    end
-
-    # Discards the recorded events
-    def reset
-      @tx.reset
-    end
-  end
 end

data/lib/libhoney/log_client.rb

@@ -0,0 +1,20 @@
+require 'libhoney/client'
+
+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.
+  #
+  # @note This class is intended for use in development, for example if you want
+  #       to verify what events your instrumented code is sending. Use in
+  #       production is not recommended.
+  class LogClient < Client
+    def initialize(*args, output: ::STDERR, verbose: false, **kwargs)
+      super(*args,
+            transmission: LogTransmissionClient.new(output: output, verbose: verbose),
+            **kwargs)
+    end
+  end
+
+end

data/lib/libhoney/log_transmission.rb

@@ -0,0 +1,34 @@
+require 'json'
+
+module Libhoney
+  # For debugging use: a mock version of TransmissionClient that simply prints
+  # events to stderr or a file for inspection (and does not send them to
+  # Honeycomb, or perform any network activity).
+  #
+  # @note This class is intended for use in development, for example if you want
+  #       to verify what events your instrumented code is sending. Use in
+  #       production is not recommended.
+  class LogTransmissionClient
+    def initialize(output:, verbose: false)
+      @output = output
+      @verbose = verbose
+    end
+
+    # Prints an event
+    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
+        @output.print("#{metadata} | ")
+      end
+      @output.puts(event.data.to_json)
+    end
+
+    # Flushes the output (but does not close it)
+    def close(drain)
+      @output.flush
+    end
+  end
+end

data/lib/libhoney/test_client.rb

@@ -0,0 +1,28 @@
+require 'libhoney/client'
+
+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.
+  #
+  # @note This class is intended for use in tests, for example if you want to
+  #       verify what events your instrumented code is sending. Use in
+  #       production is not recommended.
+  class TestClient < Client
+    def initialize(*args, **kwargs)
+      super(*args, transmission: MockTransmissionClient.new, **kwargs)
+    end
+
+    # @return [Array<Event>] the recorded events
+    def events
+      @tx.events
+    end
+
+    # Discards the recorded events
+    def reset
+      @tx.reset
+    end
+  end
+
+end

data/lib/libhoney/version.rb

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

data/lib/libhoney.rb

@@ -1,6 +1,9 @@
 require 'libhoney/client'
+require 'libhoney/log_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.6.0
+  version: 1.7.0
 platform: ruby
 authors:
 - The Honeycomb.io Team
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-04-19 00:00:00.000000000 Z
+date: 2018-05-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -141,8 +141,11 @@ files:
 - lib/libhoney/builder.rb
 - lib/libhoney/client.rb
 - lib/libhoney/event.rb
+- lib/libhoney/log_client.rb
+- lib/libhoney/log_transmission.rb
 - lib/libhoney/mock_transmission.rb
 - lib/libhoney/response.rb
+- lib/libhoney/test_client.rb
 - lib/libhoney/transmission.rb
 - lib/libhoney/version.rb
 - libhoney.gemspec