honeykiq 0.3.1 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 16005aed68090d9f1ef919f233376ab7ac6a9ae7
-  data.tar.gz: b242a6f8e9332053c571544856fcabaddd047ad6
+SHA256:
+  metadata.gz: dd0cc1127fd3dfa658cb69820e243542bd84e614531405a8b95e4b9110e93bd7
+  data.tar.gz: 5e5d47b4301050821f7977e49da897e3dbd7f9d7312236cddd42dea0b3f29a7c
 SHA512:
-  metadata.gz: 862ab081ebef1a13f837be419e9e7b67156ac65757a1a6058f43520726612cdc8caa2a4b96d1e3d02413bb93f6a05125b78f7f1dd656ac46c23466d7e767dd4c
-  data.tar.gz: c5d46a8feb38c9986d0cb4cfbfb8cf6bd6e2c62dedd33cb82b65e3d80a12e4ddbafa71cca80901ab955499c89b77b53d385f71ea880aa3884caaf860b9d5fd79
+  metadata.gz: 4def9fb593162c5e7246527e50de7538561aad8153b31ecfa12b1182897445c09902b3a67f76cada6bffb4fdd542a10cfa08f8ae39cea73c201f51d86a4b0536
+  data.tar.gz: 03242d018493326a2314fe07c80a15fbaed72c048a300ae7226c9802057886920cccf86d93a6e43cc167fd9d3a2b8794c06863ca175025687b2c185cd3e84c95

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/CHANGELOG.md

@@ -5,6 +5,27 @@ 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.3.0]
+### Added
+- Allow beeline tracing to be configured (#11)
+
+## [1.2.0]
+### Added
+- Allow extra_fields to be invoked with job (#16)
+
+## [1.1.0]
+### Added
+- Honeycomb beeline support (#9)
+
+## [1.0.0]
+### Added
+- CODE_OF_CONDUCT.md
+- CONTRIBUTORS.txt
+
+### Fixed
+- Tidied up README.md
+
 ## [0.3.1]
 ### Fixed
 - Ensure that `Honeykiq::ServerMiddleware#extra_fields` are still included after a job fails
@@ -20,7 +41,11 @@ 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/v0.3.1...HEAD
+[Unreleased]: https://github.com/carwow/honeykiq/compare/v1.2.0...HEAD
+[1.3.0]: https://github.com/carwow/honeykiq/compare/v1.2.0...v1.3.0
+[1.2.0]: https://github.com/carwow/honeykiq/compare/v1.1.0...v1.2.0
+[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
 [0.2.0]: https://github.com/carwow/honeykiq/compare/v0.1.0...v0.2.0

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,70 @@
+# Contributor Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as contributors and
+maintainers pledge to making participation in our project and our community a
+harassment-free experience for everyone, regardless of age, body size, disability,
+ethnicity, gender identity and expression, level of experience, education, socio-economic
+status, nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic address,
+  without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a professional
+    setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable behavior
+and are expected to take appropriate and fair corrective action in response to any
+instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments,
+commits, code, wiki edits, issues, and other contributions that are not aligned to this
+Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors
+that they deem inappropriate, threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces when an
+individual is representing the project or its community. Examples of representing a
+project or community include using an official project e-mail address, posting via an
+official social media account, or acting as an appointed representative at an online or
+offline event. Representation of a project may be further defined and clarified by project
+maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by
+contacting the [project team](developers@carwow.co.uk). All complaints will be reviewed and
+investigated and will result in a response that is deemed necessary and appropriate to the
+circumstances. The project team is obligated to maintain confidentiality with regard to
+the reporter of an incident. Further details of specific enforcement policies may be
+posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good faith may
+face temporary or permanent repercussions as determined by other members of the project's
+leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org

data/Gemfile.lock

@@ -1,84 +1,94 @@
 PATH
   remote: .
   specs:
-    honeykiq (0.3.1)
+    honeykiq (1.3.0)
       sidekiq
 
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.5.2)
-      public_suffix (>= 2.0.2, < 4.0)
-    ast (2.4.0)
-    carwow_rubocop (2.1.1)
-      rubocop (~> 0.58)
-      rubocop-rspec (~> 1.28)
-    coderay (1.1.2)
-    connection_pool (2.2.2)
-    diff-lcs (1.3)
-    domain_name (0.5.20180417)
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    ast (2.4.1)
+    carwow_rubocop (3.3.0)
+      rubocop (>= 0.78)
+      rubocop-performance
+      rubocop-rspec
+    coderay (1.1.3)
+    connection_pool (2.2.3)
+    diff-lcs (1.4.4)
+    domain_name (0.5.20190701)
       unf (>= 0.0.5, < 1.0.0)
-    http (3.3.0)
+    ffi (1.13.1)
+    ffi-compiler (1.0.1)
+      ffi (>= 1.0.0)
+      rake
+    honeycomb-beeline (2.1.1)
+      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)
+    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)
-      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)
-    rack (2.0.8)
-    rack-protection (2.0.8.1)
-      rack
+      http (>= 2.0, < 5.0)
+    method_source (1.0.0)
+    parallel (1.19.2)
+    parser (2.7.1.4)
+      ast (~> 2.4.1)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    public_suffix (4.0.5)
+    rack (2.2.3)
     rainbow (3.0.0)
-    rake (12.3.2)
-    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)
+    rake (13.0.1)
+    redis (4.2.1)
+    regexp_parser (1.7.1)
+    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)
-      jaro_winkler (~> 1.5.1)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+    rubocop (0.88.0)
       parallel (~> 1.10)
-      parser (>= 2.5, != 2.5.1.1)
-      powerpack (~> 0.1)
+      parser (>= 2.7.1.1)
       rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.7)
+      rexml
+      rubocop-ast (>= 0.1.0, < 1.0)
       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.4)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (0.2.0)
+      parser (>= 2.7.0.1)
+    rubocop-performance (1.7.1)
+      rubocop (>= 0.82.0)
+    rubocop-rspec (1.42.0)
+      rubocop (>= 0.87.0)
+    ruby-progressbar (1.10.1)
+    sidekiq (6.1.1)
       connection_pool (>= 2.2.2)
-      rack (>= 2.0.0)
-      rack-protection (>= 2.0.0)
-      redis (>= 4.1.0)
+      rack (~> 2.0)
+      redis (>= 4.2.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,11 +2,12 @@
 
 Sidekiq → Honeycomb 🐝
 
-Send Sidekiq related events to Honeycomb.
+Send [Sidekiq](https://sidekiq.org)-related events to
+[Honeycomb](https://www.honeycomb.io).
 
 ## Installation
 
-Add this line to your application's Gemfile:
+Add this line to your application's `Gemfile`:
 
 ```ruby
 gem 'honeykiq'
@@ -14,27 +15,80 @@ gem 'honeykiq'
 
 ## Usage
 
-The library provides two use cases:
+The library provides three use cases:
 
+- [`Honeykiq::ClientMiddleware`]
 - [`Honeykiq::ServerMiddleware`]
 - [`Honeykiq::PeriodicReporter`]
 
+[`Honeykiq::ClientMiddleware`]: #HoneykiqClientMiddleware
 [`Honeykiq::ServerMiddleware`]: #HoneykiqServerMiddleware
 [`Honeykiq::PeriodicReporter`]: #HoneykiqPeriodicReporter
 
+### Honeykiq::ClientMiddleware
+
+Add Honeykiq to your Sidekiq client middleware chain. It will propagate tracing
+fields when used in combination with `Honeykiq::ServerMiddleware`.
+
+This middleware is **only** configured to work with the `Honeycomb` beeline gem,
+not with a custom `Libhoney` client.
+
+```ruby
+# 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|
+     # tracing_mode: options are :link or :child
+     # - :link will use link events https://docs.honeycomb.io/getting-data-in/tracing/send-trace-data/#links
+     # - :child will use add the job as a span to the enqueing trace
+    chain.add Honeykiq::ServerMiddleware, tracing_mode: :link
+  end
+
+  # Configure the servers client. Used when a worker enqueues a job itself.
+  config.client_middleware do |chain|
+    chain.add Honeykiq::ClientMiddleware
+  end
+end
+
+Sidekiq.configure_client do |config|
+  config.client_middleware do |chain|
+    chain.add Honeykiq::ClientMiddleware
+  end
+end
+```
+
 ### Honeykiq::ServerMiddleware
 
-Add it to Sidekiq server middleware chain and pass a `Libhoney::Client` 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 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
+  end
+end
+
+# Or pass the libhoney client to the middleware
 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')
       )
@@ -42,14 +96,14 @@ Sidekiq.configure_server do |config|
 end
 ```
 
-#### Adding extra data to events
 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. These will be serialized into individual items in the event:
+`Honeykiq::ServerMiddleware`, and overriding the `extra_fields` method with
+your own hash. The contents will be serialized into individual items in the
+event:
 
 ```ruby
 class MyServerMiddleware < Honeykiq::ServerMiddleware
-  def extra_fields
+  def extra_fields(job) # Sidekiq::Job instance
     {
       my_data: 'evaluated and added to the event after the job has finished/errored',
       my_function: -> { Time.now }
@@ -59,63 +113,64 @@ end
 
 Sidekiq.configure_server do |config|
   config.server_middleware do |chain|
-    chain.add MyServerMiddleware, honey_client: ...
-    ...
+    chain.add MyServerMiddleware
+  end
+end
 ```
 
-**Note on long running jobs:** If you have long running jobs an event is only
-sent to Honeycomb when it finishes so it may appear as no jobs are running.
-Also if the process gets a SIGKILL then no event is sent about that job and the
-job may keep retrying and not appear 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` provides visibility for these cases.
 
 ### Honeykiq::PeriodicReporter
 
-The periodic reporter should be scheduled to report every few seconds depending
-on your use case (e.g. 30 seconds). 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
+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
 
-A simple setup using [clockwork] would look like this:
-
-[clockwork]: https://github.com/Rykian/clockwork
+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
 ```
 
+[clockwork]: https://github.com/Rykian/clockwork
+
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/carwow/honeykiq.
+[Pull requests] are very welcome!
+
+Please report bugs in a [new issue].
+
+Everyone is expected to follow the [code of conduct].
+
+[Pull requests]: https://github.com/carwow/honeykiq/pulls
+[new issue]: https://github.com/carwow/honeykiq/issues/new
+[code of conduct]: https://github.com/carwow/honeykiq/tree/master/CODE_OF_CONDUCT.md
 
 ## 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).

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.rb

@@ -2,4 +2,7 @@ module Honeykiq
   autoload :Version, 'honeykiq/version'
   autoload :PeriodicReporter, 'honeykiq/periodic_reporter'
   autoload :ServerMiddleware, 'honeykiq/server_middleware'
+  autoload :ClientMiddleware, 'honeykiq/client_middleware'
+  autoload :BeelineSpan, 'honeykiq/beeline_span'
+  autoload :LibhoneySpan, 'honeykiq/libhoney_span'
 end

data/lib/honeykiq/beeline_span.rb

@@ -0,0 +1,54 @@
+module Honeykiq
+  class BeelineSpan
+    def initialize(tracing_mode)
+      @tracing_mode = tracing_mode
+    end
+
+    def call(name:, serialized_trace:, &block)
+      case tracing_mode
+      when :link  then link_span(name, serialized_trace, &block)
+      when :child then child_span(name, serialized_trace, &block)
+      else
+        Honeycomb.start_span(name: name, &block)
+      end
+    end
+
+    private
+
+    attr_reader :tracing_mode
+
+    def link_span(name, serialized_trace)
+      Honeycomb.start_span(name: name) do |event|
+        link_to_enqueuing_trace(event, serialized_trace)
+
+        yield event
+      end
+    end
+
+    def child_span(name, serialized_trace)
+      Honeycomb.start_span(name: name, serialized_trace: serialized_trace) do |event|
+        yield event
+      end
+    end
+
+    def link_to_enqueuing_trace(current, serialized_trace)
+      return unless serialized_trace
+
+      trace_id, parent_span_id, = TraceParser.parse(serialized_trace)
+
+      Honeycomb.libhoney.event.add(
+        'trace.link.trace_id': trace_id,
+        'trace.link.span_id': parent_span_id,
+        'meta.span_type': 'link',
+        'trace.parent_id': current.id,
+        'trace.trace_id': current.trace.id
+      ).send
+    end
+
+    if defined?(Honeycomb)
+      class TraceParser
+        extend Honeycomb::PropagationParser
+      end
+    end
+  end
+end

data/lib/honeykiq/client_middleware.rb

@@ -0,0 +1,9 @@
+module Honeykiq
+  class ClientMiddleware
+    def call(_, job, _, _)
+      job['serialized_trace'] = Honeycomb.current_span&.to_trace_header
+
+      yield
+    end
+  end
+end

data/lib/honeykiq/libhoney_span.rb

@@ -0,0 +1,37 @@
+module Honeykiq
+  class LibhoneySpan
+    def initialize(libhoney)
+      @libhoney = libhoney
+    end
+
+    def call(*)
+      libhoney.event.tap do |event|
+        duration_ms(event) { yield event }
+      ensure
+        event.send
+      end
+    end
+
+    private
+
+    attr_reader :libhoney
+
+    def duration_ms(event)
+      start_time = now
+      yield
+    ensure
+      duration = now - start_time
+      event.add_field(:duration_ms, duration * 1000)
+    end
+
+    if defined?(Process::CLOCK_MONOTONIC)
+      def now
+        Process.clock_gettime(Process::CLOCK_MONOTONIC)
+      end
+    else
+      def now
+        Time.now
+      end
+    end
+  end
+end

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,40 +2,52 @@ require 'sidekiq/api'
 
 module Honeykiq
   class ServerMiddleware
-    def initialize(options = {})
-      @honey_client = options.fetch(:honey_client)
+    def initialize(libhoney: nil, honey_client: nil, tracing_mode: nil)
+      @libhoney = libhoney || honey_client
+      @tracing_mode = tracing_mode
     end
 
     def call(_worker, msg, queue_name)
-      event = @honey_client.event
+      job = Sidekiq::Job.new(msg, queue_name)
+      queue = Sidekiq::Queue.new(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
+      span_builder.call(name: job.display_class, serialized_trace: msg['serialized_trace']) do |event|
+        call_with_event(event, job, queue) { yield }
+      end
     end
 
-    def extra_fields
+    def extra_fields(_job = nil)
       {}
     end
 
     private
 
-    def call_event(event, msg, queue_name)
-      event.add(default_fields(msg, queue_name))
-      duration_ms(event) { yield }
+    attr_reader :libhoney, :tracing_mode
+
+    def libhoney?
+      !!libhoney
+    end
+
+    def span_builder
+      @span_builder ||= libhoney? ? LibhoneySpan.new(libhoney) : BeelineSpan.new(tracing_mode)
+    end
+
+    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(call_extra_fields(job))
     end
 
-    def default_fields(msg, queue_name)
+    def default_fields(job, queue)
       {
         type: :job,
-        **job_fields(Sidekiq::Job.new(msg, queue_name)),
-        **queue_fields(Sidekiq::Queue.new(queue_name)),
+        **job_fields(job),
+        **queue_fields(queue),
         'meta.thread_id': Thread.current.object_id
       }
     end
@@ -58,16 +70,23 @@ module Honeykiq
       }
     end
 
-    def duration_ms(event)
-      start_time = Time.now
-      yield
-    ensure
-      duration = Time.now - start_time
-      event.add_field(:duration_ms, duration * 1000)
+    def on_error(event, error)
+      return unless event
+
+      event.add_field(:'job.status', 'failed')
+      return unless libhoney?
+
+      event.add(
+        'error.class': error.class.name,
+        'error.message': error.message
+      )
     end
 
-    def error_info(error)
-      { 'error.class': error.class.name, 'error.message': error.message }
+    def call_extra_fields(job)
+      case method(:extra_fields).arity
+      when 0 then extra_fields
+      else extra_fields(job)
+      end
     end
   end
 end

data/lib/honeykiq/version.rb

@@ -1,3 +1,3 @@
 module Honeykiq
-  VERSION = '0.3.1'.freeze
+  VERSION = '1.3.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: honeykiq
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 1.3.0
 platform: ruby
 authors:
 - carwow Developers
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-01-09 00:00:00.000000000 Z
+date: 2020-08-07 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:
     - - ">="
@@ -120,6 +120,7 @@ files:
 - ".rspec"
 - ".rubocop.yml"
 - CHANGELOG.md
+- CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -127,6 +128,9 @@ files:
 - Rakefile
 - honeykiq.gemspec
 - lib/honeykiq.rb
+- lib/honeykiq/beeline_span.rb
+- lib/honeykiq/client_middleware.rb
+- lib/honeykiq/libhoney_span.rb
 - lib/honeykiq/periodic_reporter.rb
 - lib/honeykiq/server_middleware.rb
 - lib/honeykiq/version.rb
@@ -135,7 +139,7 @@ licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -150,9 +154,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.14.1
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
 summary: "Sidekiq → Honeycomb \U0001F41D"
 test_files: []