honeykiq 1.0.0 → 1.1.0.pre

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d5da094ed5b07d9c5b4c514370e14e641c4d88d7cd65d80afab77d3e18d5b0f1
-  data.tar.gz: 4abbc53f3905305b7322d4441cdbbf72f9a707fe525a84c27ccf5c79a1d0ff80
+  metadata.gz: 52c98d7685025080d69c27b4639144cbb78c1f5405a3fb440652e3836252557c
+  data.tar.gz: 1d792568a79281e6f41f3a92e4d3e060ba73b473e0d0baa3195befdafaf55438
 SHA512:
-  metadata.gz: 9c6421a534757c3fbe8b6a59bf6b58fcfd95b12ee3b7ee927ceb58915ccce96bb13f04f8bb4de7f8dbb6569ddcfd9de710c42d00e1a618906b37586b5b2f6735
-  data.tar.gz: 176758798b49ba340ea658f0b82e2c2cdf57fd1d19d5ab14bccdabe939c9d5bc3eacea0d8c4e7093434435129231cbf830262f07bb56aa4e66762c8f80fe4486
+  metadata.gz: 3a4fbae5b7c9c60678ce677be5388f5887691e577f3a219a4280b533330e8fec03c689c8de0856b75c781dbad3181ee9c0469af79e09ee72dce9a8b25770f177
+  data.tar.gz: 6f26f2a3b1e836f800be3f2fca13a9da1199875551b3c717c0297dcda5e2f7e51a8a0a6518a40a2e664bff256d2e8d51a06574563a6f401a3f70023fd585808f

data/.circleci/config.yml

@@ -1,5 +1,5 @@
 ruby: &ruby
-  image: carwow/ruby-ci:2.5.3
+  image: carwow/ruby-ci:2.6
 
 version: 2
 

data/Gemfile.lock

@@ -1,84 +1,94 @@
 PATH
   remote: .
   specs:
-    honeykiq (1.0.0)
+    honeykiq (1.1.0.pre)
       sidekiq
 
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.5.2)
-      public_suffix (>= 2.0.2, < 4.0)
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
     ast (2.4.0)
-    carwow_rubocop (2.1.1)
-      rubocop (~> 0.58)
-      rubocop-rspec (~> 1.28)
+    carwow_rubocop (3.2.2)
+      rubocop (>= 0.78)
+      rubocop-performance
+      rubocop-rspec
     coderay (1.1.2)
     connection_pool (2.2.2)
     diff-lcs (1.3)
-    domain_name (0.5.20180417)
+    domain_name (0.5.20190701)
       unf (>= 0.0.5, < 1.0.0)
-    http (3.3.0)
+    ffi (1.12.2)
+    ffi-compiler (1.0.1)
+      ffi (>= 1.0.0)
+      rake
+    honeycomb-beeline (2.0.0)
+      libhoney (~> 1.14, >= 1.14.2)
+    http (4.4.1)
       addressable (~> 2.3)
       http-cookie (~> 1.0)
-      http-form_data (~> 2.0)
-      http_parser.rb (~> 0.6.0)
+      http-form_data (~> 2.2)
+      http-parser (~> 1.2.0)
     http-cookie (1.0.3)
       domain_name (~> 0.5)
-    http-form_data (2.1.1)
-    http_parser.rb (0.6.0)
-    jaro_winkler (1.5.1)
-    libhoney (1.11.0)
+    http-form_data (2.3.0)
+    http-parser (1.2.1)
+      ffi-compiler (>= 1.0, < 2.0)
+    jaro_winkler (1.5.4)
+    libhoney (1.14.4)
       addressable (~> 2.0)
-      http (>= 2.0, < 4.0)
-    method_source (0.9.2)
-    parallel (1.12.1)
-    parser (2.5.3.0)
+      http (>= 2.0, < 5.0)
+    method_source (1.0.0)
+    parallel (1.19.1)
+    parser (2.7.1.2)
       ast (~> 2.4.0)
-    powerpack (0.1.2)
-    pry (0.12.2)
-      coderay (~> 1.1.0)
-      method_source (~> 0.9.0)
-    public_suffix (3.0.3)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    public_suffix (4.0.5)
     rack (2.2.2)
     rack-protection (2.0.8.1)
       rack
     rainbow (3.0.0)
     rake (13.0.1)
-    redis (4.1.3)
-    rspec (3.8.0)
-      rspec-core (~> 3.8.0)
-      rspec-expectations (~> 3.8.0)
-      rspec-mocks (~> 3.8.0)
-    rspec-core (3.8.0)
-      rspec-support (~> 3.8.0)
-    rspec-expectations (3.8.2)
+    redis (4.1.4)
+    rexml (3.2.4)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-mocks (3.8.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-support (3.8.0)
-    rubocop (0.61.1)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+    rubocop (0.82.0)
       jaro_winkler (~> 1.5.1)
       parallel (~> 1.10)
-      parser (>= 2.5, != 2.5.1.1)
-      powerpack (~> 0.1)
+      parser (>= 2.7.0.1)
       rainbow (>= 2.2.2, < 4.0)
+      rexml
       ruby-progressbar (~> 1.7)
-      unicode-display_width (~> 1.4.0)
-    rubocop-rspec (1.30.1)
-      rubocop (>= 0.60.0)
-    ruby-progressbar (1.10.0)
-    sidekiq (6.0.5)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-performance (1.5.2)
+      rubocop (>= 0.71.0)
+    rubocop-rspec (1.39.0)
+      rubocop (>= 0.68.1)
+    ruby-progressbar (1.10.1)
+    sidekiq (6.0.7)
       connection_pool (>= 2.2.2)
       rack (~> 2.0)
       rack-protection (>= 2.0.0)
       redis (>= 4.1.0)
     unf (0.1.4)
       unf_ext
-    unf_ext (0.0.7.5)
-    unicode-display_width (1.4.0)
+    unf_ext (0.0.7.7)
+    unicode-display_width (1.7.0)
 
 PLATFORMS
   ruby
@@ -86,11 +96,11 @@ PLATFORMS
 DEPENDENCIES
   bundler
   carwow_rubocop
+  honeycomb-beeline
   honeykiq!
-  libhoney
   pry
   rake
   rspec
 
 BUNDLED WITH
-   1.17.2
+   2.1.4

data/README.md

@@ -2,7 +2,8 @@
 
 Sidekiq → Honeycomb 🐝
 
-Send [Sidekiq](https://sidekiq.org)-related events to [Honeycomb](https://www.honeycomb.io).
+Send [Sidekiq](https://sidekiq.org)-related events to
+[Honeycomb](https://www.honeycomb.io).
 
 ## Installation
 
@@ -24,11 +25,25 @@ The library provides two use cases:
 
 ### Honeykiq::ServerMiddleware
 
-Add Honeykiq to your Sidekiq server middleware chain, and pass a [`Libhoney::Client`][libhoney] as shown below. It will send an event to Honeycomb once a job finishes or fails.  Have a look at [server_middleware.rb] to see what kind of information we send.
+Add Honeykiq to your Sidekiq server middleware chain. It will send an event to
+Honeycomb once a job finishes or fails. Have a look at [server_middleware.rb]
+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
+Honeycomb.configure do |config|
+  config.writekey = ENV.fetch('HONEYCOMB_WRITE_KEY')
+  config.dataset = ENV.fetch('HONEYCOMB_DATASET')
+end
+Sidekiq.configure_server do |config|
+  config.server_middleware do |chain|
+    chain.add Honeykiq::ServerMiddleware
+  end
+end
+
+# Or pass the libhoney client to the middleware
 Sidekiq.configure_server do |config|
   config.server_middleware do |chain|
     chain.add Honeykiq::ServerMiddleware,
@@ -40,7 +55,10 @@ Sidekiq.configure_server do |config|
 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 your own hash. The contents will be serialized into individual items in the event:
+You can add your own data or functions to the Honeycomb event by subclassing
+`Honeykiq::ServerMiddleware`, and overriding the the `extra_fields` method with
+your own hash. The contents will be serialized into individual items in the
+event:
 
 ```ruby
 class MyServerMiddleware < Honeykiq::ServerMiddleware
@@ -58,13 +76,23 @@ Sidekiq.configure_server do |config|
     ...
 ```
 
-**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.
+**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.
 
 ### Honeykiq::PeriodicReporter
 
-The periodic reporter should be scheduled to report every few seconds, depending on your use case. Every time the `#report` method is called it will send a total of `1 + P + Q` events to Honeycomb where `P` and `Q` are the number of processes and queues respectively.
+The periodic reporter should be scheduled to report every few seconds,
+depending on your use case. Every time the `#report` method is called it will
+send a total of `1 + P + Q` events to Honeycomb where `P` and `Q` are the
+number of processes and queues respectively.
 
-It sends three types of events: `instance`, `process`, and `queue`. Have a look at [periodic_reporter.rb] to see what kind of information we send for each type.
+It sends three types of events: `instance`, `process`, and `queue`. Have a look
+at [periodic_reporter.rb] to see what kind of information we send for each
+type.
 
 [periodic_reporter.rb]: https://github.com/carwow/honeykiq/blob/master/lib/honeykiq/periodic_reporter.rb
 
@@ -110,5 +138,4 @@ Please report bugs in a [new issue](https://github.com/carwow/honeykiq/issues/ne
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
 
-[libhoney]: https://github.com/honeycombio/libhoney-rb
 [clockwork]: https://github.com/Rykian/clockwork

data/honeykiq.gemspec

@@ -28,7 +28,7 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'carwow_rubocop'
-  spec.add_development_dependency 'libhoney'
+  spec.add_development_dependency 'honeycomb-beeline'
   spec.add_development_dependency 'pry'
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rspec'

data/lib/honeykiq/server_middleware.rb

@@ -3,20 +3,20 @@ require 'sidekiq/api'
 module Honeykiq
   class ServerMiddleware
     def initialize(options = {})
-      @honey_client = options.fetch(:honey_client)
+      @honey_client = options[:honey_client]
     end
 
     def call(_worker, msg, queue_name)
-      event = @honey_client.event
+      job = Sidekiq::Job.new(msg, queue_name)
 
-      call_event(event, msg, queue_name) { yield }
-    rescue StandardError => error
-      event&.add_field(:'job.status', 'failed')
-      event&.add(error_info(error))
-      raise
-    ensure
-      event&.add(extra_fields)
-      event&.send
+      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)
+      end
     end
 
     def extra_fields
@@ -25,16 +25,28 @@ module Honeykiq
 
     private
 
-    def call_event(event, msg, queue_name)
-      event.add(default_fields(msg, queue_name))
-      duration_ms(event) { yield }
+    def start_span(name:)
+      if @honey_client
+        @honey_client.event.tap do |event|
+          duration_ms(event) { yield event }
+        ensure
+          event.send
+        end
+      else
+        Honeycomb.start_span(name: name) { |event| yield event }
+      end
+    end
+
+    def call_with_event(event, job, queue_name)
+      event.add(default_fields(job, queue_name))
+      yield
       event.add_field(:'job.status', 'finished')
     end
 
-    def default_fields(msg, queue_name)
+    def default_fields(job, queue_name)
       {
         type: :job,
-        **job_fields(Sidekiq::Job.new(msg, queue_name)),
+        **job_fields(job),
         **queue_fields(Sidekiq::Queue.new(queue_name)),
         'meta.thread_id': Thread.current.object_id
       }
@@ -66,8 +78,16 @@ module Honeykiq
       event.add_field(:duration_ms, duration * 1000)
     end
 
-    def error_info(error)
-      { 'error.class': error.class.name, 'error.message': error.message }
+    def on_error(event, error)
+      return unless event
+
+      event.add_field(:'job.status', 'failed')
+      return unless @honey_client
+
+      event.add(
+        'error.class': error.class.name,
+        'error.message': error.message
+      )
     end
   end
 end

data/lib/honeykiq/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: honeykiq
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0.pre
 platform: ruby
 authors:
 - carwow Developers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-09 00:00:00.000000000 Z
+date: 2020-05-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sidekiq
@@ -53,7 +53,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: libhoney
+  name: honeycomb-beeline
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -148,12 +148,11 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: "Sidekiq → Honeycomb \U0001F41D"