honeykiq 1.1.0.pre → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 52c98d7685025080d69c27b4639144cbb78c1f5405a3fb440652e3836252557c
-  data.tar.gz: 1d792568a79281e6f41f3a92e4d3e060ba73b473e0d0baa3195befdafaf55438
+  metadata.gz: 29a3d18dbdcd28d505474e7066089b0bbde7b9db3faa0b994fbc0e54fa412dc2
+  data.tar.gz: b31189efcefaabde05722510097b1ad746c92f542f4e749993c94d775223af9e
 SHA512:
-  metadata.gz: 3a4fbae5b7c9c60678ce677be5388f5887691e577f3a219a4280b533330e8fec03c689c8de0856b75c781dbad3181ee9c0469af79e09ee72dce9a8b25770f177
-  data.tar.gz: 6f26f2a3b1e836f800be3f2fca13a9da1199875551b3c717c0297dcda5e2f7e51a8a0a6518a40a2e664bff256d2e8d51a06574563a6f401a3f70023fd585808f
+  metadata.gz: '0495bb5f2d2ba5f2848e4dbe8a58c4d8d97c7c905bca2d33b2692a33ac33ad56ec49ff0368a52f0bbc8265ea971e356a49237bd8aa006efcbc40245110362667'
+  data.tar.gz: 7c702869ffdcc5bedcad9145c3d9979a63d96fa8540b01140272ee743d5b825839ace3dfe478fc2f2b7762ea31050b69001720f8d4dd790d82e47e44f7031730

data/CHANGELOG.md

@@ -5,6 +5,11 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
+
+## [1.1.0]
+### Added
+- Honeycomb beeline support (#9)
+
 ## [1.0.0]
 ### Added
 - CODE_OF_CONDUCT.md
@@ -28,7 +33,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Removed
 - `Honeykiq.periodic_reporter`. (Use `Honeykiq::PeriodicReporter.new` instead.)
 
-[Unreleased]: https://github.com/carwow/honeykiq/compare/v1.0.0...HEAD
+[Unreleased]: https://github.com/carwow/honeykiq/compare/v1.1.0...HEAD
+[1.1.0]: https://github.com/carwow/honeykiq/compare/v1.0.0...v1.1.0
 [1.0.0]: https://github.com/carwow/honeykiq/compare/v0.3.1...v1.0.0
 [0.3.1]: https://github.com/carwow/honeykiq/compare/v0.3.0...v0.3.1
 [0.3.0]: https://github.com/carwow/honeykiq/compare/v0.2.0...v0.3.0

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    honeykiq (1.1.0.pre)
+    honeykiq (1.1.0)
       sidekiq
 
 GEM

data/README.md

@@ -32,11 +32,13 @@ to see what kind of information it sends.
 [server_middleware.rb]: https://github.com/carwow/honeykiq/blob/master/lib/honeykiq/server_middleware.rb
 
 ```ruby
-# Configure Honeycomb and add the middleware to Sidekiq chain
+# Configure Honeycomb beeline
 Honeycomb.configure do |config|
   config.writekey = ENV.fetch('HONEYCOMB_WRITE_KEY')
   config.dataset = ENV.fetch('HONEYCOMB_DATASET')
 end
+
+# Add the middleware to Sidekiq chain
 Sidekiq.configure_server do |config|
   config.server_middleware do |chain|
     chain.add Honeykiq::ServerMiddleware
@@ -47,7 +49,7 @@ end
 Sidekiq.configure_server do |config|
   config.server_middleware do |chain|
     chain.add Honeykiq::ServerMiddleware,
-      honey_client: Libhoney::Client.new(
+      libhoney: Libhoney::Client.new(
         writekey: ENV.fetch('HONEYCOMB_WRITE_KEY'),
         dataset: ENV.fetch('HONEYCOMB_DATASET')
       )
@@ -56,7 +58,7 @@ end
 ```
 
 You can add your own data or functions to the Honeycomb event by subclassing
-`Honeykiq::ServerMiddleware`, and overriding the the `extra_fields` method with
+`Honeykiq::ServerMiddleware`, and overriding the `extra_fields` method with
 your own hash. The contents will be serialized into individual items in the
 event:
 
@@ -72,16 +74,16 @@ end
 
 Sidekiq.configure_server do |config|
   config.server_middleware do |chain|
-    chain.add MyServerMiddleware, honey_client: ...
-    ...
+    chain.add MyServerMiddleware
+  end
+end
 ```
 
 **Note:** If you have long running jobs, an event is only sent to Honeycomb
 when the job finishes. Therefore, it may appear as though no jobs are currently
 running.  Additionally, if the process receives a `SIGKILL` then no event is
 sent about that job, and the job may keep retrying without appearing in
-Honeycomb. The `PeriodicReporter` should help with this, but we are thinking of
-a nicer approach.
+Honeycomb. The `PeriodicReporter` provides visibility for these cases.
 
 ### Honeykiq::PeriodicReporter
 
@@ -98,37 +100,27 @@ type.
 
 A setup using [clockwork] to report every 30 seconds would look like this:
 
-
 ```ruby
+require 'honeycomb-beeline'
 require 'clockwork'
-require 'libhoney'
 require 'honeykiq'
 
-module Clockwork
-  every(30, 'Honeykiq', thread: true) { SidekiqHealth.report }
+Honeycomb.configure do |config|
+  config.writekey = ENV.fetch('HONEYCOMB_WRITE_KEY')
+  config.dataset = ENV.fetch('HONEYCOMB_DATASET')
 end
 
-module SidekiqHealth
-  def self.report
-    reporter.report
-  end
-
-  def self.reporter
-    @reporter ||= Honeykiq::PeriodicReporter.new(honey_client: honey_client)
-  end
-
-  def self.honey_client
-    Libhoney::Client.new(
-      writekey: ENV.fetch('HONEYCOMB_WRITE_KEY'),
-      dataset: ENV.fetch('HONEYCOMB_DATASET')
-    )
+module Clockwork
+  every(30, 'Honeykiq::PeriodicReporter') do
+    Honeykiq::PeriodicReporter.new.report
   end
 end
 ```
 
 ## Contributing
 
-[Pull requests](https://github.com/carwow/honeykiq/pulls) are very welcome! Don't forget to add yourself to [CONTRIBUTORS.txt].
+[Pull requests](https://github.com/carwow/honeykiq/pulls) are very welcome!
+Don't forget to add yourself to [CONTRIBUTORS.txt].
 
 Please report bugs in a [new issue](https://github.com/carwow/honeykiq/issues/new).
 
@@ -136,6 +128,7 @@ Please report bugs in a [new issue](https://github.com/carwow/honeykiq/issues/ne
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+The gem is available as open source under the terms of the
+[MIT License](https://opensource.org/licenses/MIT).
 
 [clockwork]: https://github.com/Rykian/clockwork

data/lib/honeykiq/periodic_reporter.rb

@@ -2,8 +2,8 @@ require 'sidekiq/api'
 
 module Honeykiq
   class PeriodicReporter
-    def initialize(honey_client:)
-      @honey_client = honey_client
+    def initialize(libhoney: nil, honey_client: nil)
+      @libhoney = libhoney || honey_client || Honeycomb.libhoney
     end
 
     def report(&extra)
@@ -14,10 +14,10 @@ module Honeykiq
 
     private
 
-    attr_reader :honey_client
+    attr_reader :libhoney
 
     def send_instance_event(&extra)
-      honey_client.event.add(
+      libhoney.event.add(
         type: :instance,
         **instance_stats,
         **redis_stats,
@@ -57,7 +57,7 @@ module Honeykiq
     end
 
     def send_process_event(process, &extra)
-      honey_client.event.add(
+      libhoney.event.add(
         type: :process,
         'meta.dyno': process['hostname'],
         'meta.process_id': process['pid'],
@@ -68,7 +68,7 @@ module Honeykiq
     end
 
     def send_queue_event(queue, &extra)
-      honey_client.event.add(
+      libhoney.event.add(
         type: :queue,
         'queue.name': queue.name,
         'queue.latency_sec': queue.latency.to_f,

data/lib/honeykiq/server_middleware.rb

@@ -2,20 +2,16 @@ require 'sidekiq/api'
 
 module Honeykiq
   class ServerMiddleware
-    def initialize(options = {})
-      @honey_client = options[:honey_client]
+    def initialize(libhoney: nil, honey_client: nil)
+      @libhoney = libhoney || honey_client
     end
 
     def call(_worker, msg, queue_name)
       job = Sidekiq::Job.new(msg, queue_name)
+      queue = Sidekiq::Queue.new(queue_name)
 
       start_span(name: job.display_class) do |event|
-        call_with_event(event, job, queue_name) { yield }
-      rescue StandardError => error
-        on_error(event, error)
-        raise
-      ensure
-        event&.add(extra_fields)
+        call_with_event(event, job, queue) { yield }
       end
     end
 
@@ -25,9 +21,15 @@ module Honeykiq
 
     private
 
+    attr_reader :libhoney
+
+    def libhoney?
+      !!libhoney
+    end
+
     def start_span(name:)
-      if @honey_client
-        @honey_client.event.tap do |event|
+      if libhoney?
+        libhoney.event.tap do |event|
           duration_ms(event) { yield event }
         ensure
           event.send
@@ -37,17 +39,22 @@ module Honeykiq
       end
     end
 
-    def call_with_event(event, job, queue_name)
-      event.add(default_fields(job, queue_name))
+    def call_with_event(event, job, queue)
+      event.add(default_fields(job, queue))
       yield
       event.add_field(:'job.status', 'finished')
+    rescue StandardError => error
+      on_error(event, error)
+      raise
+    ensure
+      event.add(extra_fields)
     end
 
-    def default_fields(job, queue_name)
+    def default_fields(job, queue)
       {
         type: :job,
         **job_fields(job),
-        **queue_fields(Sidekiq::Queue.new(queue_name)),
+        **queue_fields(queue),
         'meta.thread_id': Thread.current.object_id
       }
     end
@@ -82,7 +89,7 @@ module Honeykiq
       return unless event
 
       event.add_field(:'job.status', 'failed')
-      return unless @honey_client
+      return unless libhoney?
 
       event.add(
         'error.class': error.class.name,

data/lib/honeykiq/version.rb

@@ -1,3 +1,3 @@
 module Honeykiq
-  VERSION = '1.1.0.pre'.freeze
+  VERSION = '1.1.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: honeykiq
 version: !ruby/object:Gem::Version
-  version: 1.1.0.pre
+  version: 1.1.0
 platform: ruby
 authors:
 - carwow Developers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-10 00:00:00.000000000 Z
+date: 2020-05-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sidekiq
@@ -148,9 +148,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.1.2
 signing_key: