honeykiq 1.1.0.pre → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 52c98d7685025080d69c27b4639144cbb78c1f5405a3fb440652e3836252557c
-  data.tar.gz: 1d792568a79281e6f41f3a92e4d3e060ba73b473e0d0baa3195befdafaf55438
+  metadata.gz: b58704c1073bcabb4c4604e1b2859fe2c5e12441ff9a6147a04ba91b81502a51
+  data.tar.gz: 996f68a12ea08d129d1f824301b8b555222ce1627eb31bfd9061f0310c0b2a15
 SHA512:
-  metadata.gz: 3a4fbae5b7c9c60678ce677be5388f5887691e577f3a219a4280b533330e8fec03c689c8de0856b75c781dbad3181ee9c0469af79e09ee72dce9a8b25770f177
-  data.tar.gz: 6f26f2a3b1e836f800be3f2fca13a9da1199875551b3c717c0297dcda5e2f7e51a8a0a6518a40a2e664bff256d2e8d51a06574563a6f401a3f70023fd585808f
+  metadata.gz: 4ea76eb835772915a56f91f9441369f5d1cdfa5ab8c08782116e3a9d7ce65737fb4c4ce83ad4130708993b5c0a5ae03c51aaba756525249139b1752176231652
+  data.tar.gz: 59a504ebcf7c30ddb427717bd4f92a1a77f4d412ff6a0cf48c2380fbc5e2f86a7d9b8e36589a2f234bd9101f1c11fce5de4481a27fdce87ee71f364ac3a0a8d6

data/.circleci/config.yml

@@ -1,54 +1,23 @@
-ruby: &ruby
-  image: carwow/ruby-ci:2.6
-
-version: 2
+version: 2.1
 
 jobs:
-  bundle:
-    working_directory: ~/honeykiq
+  test:
+    parameters:
+      ruby:
+        type: string
     docker:
-      - *ruby
+      - image: 'cimg/ruby:<< parameters.ruby >>'
     steps:
       - checkout
-      - restore_cache:
-          keys:
-            - bundle-{{ checksum "Gemfile.lock" }}
-            - bundle-
-      - run: |
-          bundle config --local path vendor/bundle &&
-          bundle check || bundle install --jobs=4 --retry=3
-      - save_cache:
-          key: bundle-{{ checksum "Gemfile.lock" }}
-          paths: [~/honeykiq/vendor/bundle]
-      - persist_to_workspace:
-          root: '~'
-          paths: [honeykiq]
-
-  rubocop:
-    working_directory: ~/honeykiq
-    docker:
-      - *ruby
-    steps:
-      - attach_workspace:
-          at: '~'
-      - run: bundle exec rubocop
-
-  tests:
-    working_directory: ~/honeykiq
-    docker:
-      - *ruby
-    steps:
-      - attach_workspace:
-          at: '~'
-      - run: |
-          bundle exec rspec
+      - run: bundle install
+      - run: bundle exec rspec
+      - run: bundle exec standardrb
 
 workflows:
   version: 2
-  build:
+  test:
     jobs:
-      - bundle
-      - rubocop:
-          requires: [bundle]
-      - tests:
-          requires: [bundle]
+      - test:
+          matrix:
+            parameters:
+              ruby: ["2.7", "2.6"]

data/.gitignore

@@ -4,8 +4,7 @@
 /coverage/
 /doc/
 /pkg/
+/spec/examples.txt
 /spec/reports/
 /tmp/
-
-# rspec failure tracking
-.rspec_status
+/Gemfile.lock

data/CHANGELOG.md

@@ -5,6 +5,32 @@ 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.4.0]
+### Added
+- Support for `:child_trace` mode (#19)
+
+### Fixed
+- Support sidekiq v6.2.2 (#23)
+- Link events respect beeline sampling (#17)
+  WARNING: This is technically a breaking change since it now sends
+  `meta.annotation_type` field instead of `meta.span_type` for the link event,
+  but `meta.span_type` is deprecated for annotation events since it already has
+  another use case which the beeline uses. I believe no one is actually using
+  link events anyway. If you run into problems and need help, open an issue.
+
+## [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
@@ -28,7 +54,10 @@ 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.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

data/Gemfile

@@ -1,4 +1,4 @@
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
 # Specify your gem's dependencies in honeykiq.gemspec
 gemspec

data/README.md

@@ -15,14 +15,67 @@ 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.write_key = ENV.fetch('HONEYCOMB_WRITE_KEY')
+  config.dataset = ENV.fetch('HONEYCOMB_DATASET')
+end
+
+# Add the middleware to Sidekiq chain
+Sidekiq.configure_client do |config|
+  config.client_middleware do |chain|
+    chain.add Honeykiq::ClientMiddleware
+  end
+end
+
+# Also add it to the server client chain
+Sidekiq.configure_server do |config|
+  # Configure the server client, used when a worker enqueues a job itself.
+  config.client_middleware do |chain|
+    chain.add Honeykiq::ClientMiddleware
+  end
+
+  # Configure ServerMiddleware with a tracing mode
+  config.server_middleware do |chain|
+    # tracing_mode: options are nil (default), :child, :child_trace, :link
+    #
+    # - nil (default) starts a span and trace when the job executes.
+    #
+    # - :child starts a span as a child of the enqueuing trace,
+    #   requires ClientMiddleware to be configured when enqueuing the job.
+    #
+    # - :child_trace (experimental) starts a span and a trace
+    #   with trace.parent_id set to the enqueuing trace id,
+    #   requires ClientMiddleware to be configured when enqueuing the job.
+    #
+    # - :link (experimental) starts a span and trace
+    #   with a link event that points to the enqueuing trace,
+    #   requires ClientMiddleware to be configured when enqueuing the job.
+    #   https://docs.honeycomb.io/getting-data-in/tracing/send-trace-data/#links
+    chain.add Honeykiq::ServerMiddleware, tracing_mode: :child
+  end
+end
+```
+
 ### Honeykiq::ServerMiddleware
 
 Add Honeykiq to your Sidekiq server middleware chain. It will send an event to
@@ -32,11 +85,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.write_key = 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,8 +102,8 @@ end
 Sidekiq.configure_server do |config|
   config.server_middleware do |chain|
     chain.add Honeykiq::ServerMiddleware,
-      honey_client: Libhoney::Client.new(
-        writekey: ENV.fetch('HONEYCOMB_WRITE_KEY'),
+      libhoney: Libhoney::Client.new(
+        write_key: ENV.fetch('HONEYCOMB_WRITE_KEY'),
         dataset: ENV.fetch('HONEYCOMB_DATASET')
       )
   end
@@ -56,13 +111,13 @@ 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:
 
 ```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 }
@@ -72,16 +127,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,44 +153,38 @@ 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.write_key = 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
 
-[Pull requests](https://github.com/carwow/honeykiq/pulls) are very welcome! Don't forget to add yourself to [CONTRIBUTORS.txt].
+[Pull requests] are very welcome!
 
-Please report bugs in a [new issue](https://github.com/carwow/honeykiq/issues/new).
+Please report bugs in a [new issue].
 
-[CONTRIBUTORS.txt]: https://github.com/carwow/honeykiq/blob/master/CONTRIBUTORS.txt
+Everyone is expected to follow the [code of conduct].
 
-## License
+[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
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+## License
 
-[clockwork]: https://github.com/Rykian/clockwork
+The gem is available as open source under the terms of the
+[MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -1,6 +1,7 @@
-require 'bundler/gem_tasks'
-require 'rspec/core/rake_task'
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require "standard/rake"
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: [:spec, :standard]

data/honeykiq.gemspec

@@ -1,35 +1,27 @@
-lib = File.expand_path('lib', __dir__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'honeykiq/version'
+require_relative "lib/honeykiq/version"
 
 Gem::Specification.new do |spec|
-  spec.name          = 'honeykiq'
-  spec.version       = Honeykiq::VERSION
-  spec.authors       = ['carwow Developers']
-  spec.email         = ['developers@carwow.co.uk']
-  spec.summary       = 'Sidekiq → Honeycomb 🐝'
-  spec.description   = 'Send Sidekiq related events to Honeycomb.'
-  spec.homepage      = 'https://github.com/carwow/honeykiq'
-  spec.license       = 'MIT'
+  spec.name = "honeykiq"
+  spec.version = Honeykiq::VERSION
+  spec.authors = ["carwow Developers"]
+  spec.email = ["developers@carwow.co.uk"]
+  spec.summary = "Sidekiq → Honeycomb 🐝"
+  spec.description = "Send Sidekiq related events to Honeycomb."
+  spec.homepage = "https://github.com/carwow/honeykiq"
+  spec.license = "MIT"
 
-  if spec.respond_to?(:metadata)
-    spec.metadata['allowed_push_host'] = 'https://rubygems.org'
-  else
-    raise 'RubyGems 2.0 or newer is required to protect against ' \
-      'public gem pushes.'
-  end
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
 
   spec.files = Dir.chdir(File.expand_path(__dir__)) do
-    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(spec|example)/}) }
   end
-  spec.require_paths = ['lib']
+  spec.require_paths = ["lib"]
 
-  spec.add_dependency 'sidekiq'
+  spec.add_dependency "sidekiq", "~> 6.2.2"
 
-  spec.add_development_dependency 'bundler'
-  spec.add_development_dependency 'carwow_rubocop'
-  spec.add_development_dependency 'honeycomb-beeline'
-  spec.add_development_dependency 'pry'
-  spec.add_development_dependency 'rake'
-  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency "honeycomb-beeline", "~> 2.6"
+  spec.add_development_dependency "pry", "~> 0.14"
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "rspec", "~> 3.10"
+  spec.add_development_dependency "standard", "~> 0.13"
 end

data/lib/honeykiq/beeline_span.rb

@@ -0,0 +1,59 @@
+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)
+      when :child_trace then child_trace(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 link_to_enqueuing_trace(current, serialized_trace)
+      return unless serialized_trace
+
+      trace_id, parent_span_id, = TraceParser.parse(serialized_trace)
+
+      Honeycomb.start_span(
+        name: "link",
+        'trace.link.trace_id': trace_id,
+        'trace.link.span_id': parent_span_id,
+        'meta.annotation_type': "link",
+        'trace.parent_id': current.id,
+        'trace.trace_id': current.trace.id
+      ).send
+    end
+
+    def child_span(name, serialized_trace, &block)
+      Honeycomb.start_span(name: name, serialized_trace: serialized_trace, &block)
+    end
+
+    def child_trace(name, serialized_trace, &block)
+      parent_trace_id, = TraceParser.parse(serialized_trace)
+
+      Honeycomb.start_span(name: name, 'parent.trace_id': parent_trace_id, &block)
+    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

@@ -1,9 +1,9 @@
-require 'sidekiq/api'
+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,
@@ -42,33 +42,33 @@ module Honeykiq
       redis_info = fetch_redis_info
 
       {
-        'redis.connections': redis_info['connected_clients'].to_i,
-        'redis.memory_used': redis_info['used_memory'].to_i
+        'redis.connections': redis_info["connected_clients"].to_i,
+        'redis.memory_used': redis_info["used_memory"].to_i
       }
     end
 
     def fetch_redis_info
       Sidekiq.redis do |redis|
-        redis.pipelined do
+        redis.pipelined {
           redis.info :clients
           redis.info :memory
-        end.reduce(&:merge)
+        }.reduce(&:merge)
       end
     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'],
-        'process.concurrency': process['concurrency'],
-        'process.busy': process['busy'],
+        'meta.dyno': process["hostname"],
+        'meta.process_id': process["pid"],
+        'process.concurrency': process["concurrency"],
+        'process.busy': process["busy"],
         **(extra&.call(:process, process) || {})
       ).send
     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

@@ -1,53 +1,53 @@
-require 'sidekiq/api'
+require "sidekiq/api"
 
 module Honeykiq
   class ServerMiddleware
-    def initialize(options = {})
-      @honey_client = options[: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)
-      job = Sidekiq::Job.new(msg, 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)
+      job = Sidekiq::JobRecord.new(msg, queue_name)
+      queue = Sidekiq::Queue.new(queue_name)
+
+      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 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
+    attr_reader :libhoney, :tracing_mode
+
+    def libhoney?
+      !!libhoney
     end
 
-    def call_with_event(event, job, queue_name)
-      event.add(default_fields(job, queue_name))
+    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')
+      event.add_field(:'job.status', "finished")
+    rescue => error
+      on_error(event, error)
+      raise
+    ensure
+      event.add(call_extra_fields(job))
     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
@@ -55,11 +55,11 @@ module Honeykiq
     def job_fields(job)
       {
         'job.class': job.display_class,
-        'job.attempt_number': (job['retry_count'].to_i.nonzero? || 0) + 1,
+        'job.attempt_number': (job["retry_count"].to_i.nonzero? || 0) + 1,
         'job.id': job.jid,
         'job.arguments_bytes': job.args.to_json.bytesize,
         'job.latency_sec': job.latency,
-        'job.batch_id': job['bid']
+        'job.batch_id': job["bid"]
       }.compact
     end
 
@@ -70,24 +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)
-    end
-
     def on_error(event, error)
       return unless event
 
-      event.add_field(:'job.status', 'failed')
-      return unless @honey_client
+      event.add_field(:'job.status', "failed")
+      return unless libhoney?
 
       event.add(
         'error.class': error.class.name,
         'error.message': error.message
       )
     end
+
+    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 = '1.1.0.pre'.freeze
+  VERSION = "1.4.0".freeze
 end

data/lib/honeykiq.rb

@@ -1,5 +1,8 @@
 module Honeykiq
-  autoload :Version, 'honeykiq/version'
-  autoload :PeriodicReporter, 'honeykiq/periodic_reporter'
-  autoload :ServerMiddleware, 'honeykiq/server_middleware'
+  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

metadata

@@ -1,113 +1,99 @@
 --- !ruby/object:Gem::Specification
 name: honeykiq
 version: !ruby/object:Gem::Version
-  version: 1.1.0.pre
+  version: 1.4.0
 platform: ruby
 authors:
 - carwow Developers
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-05-10 00:00:00.000000000 Z
+date: 2021-08-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sidekiq
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 6.2.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 6.2.2
 - !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: carwow_rubocop
+  name: honeycomb-beeline
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.6'
 - !ruby/object:Gem::Dependency
-  name: honeycomb-beeline
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.14'
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.10'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: standard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.13'
 description: Send Sidekiq related events to Honeycomb.
 email:
 - developers@carwow.co.uk
@@ -118,17 +104,17 @@ files:
 - ".circleci/config.yml"
 - ".gitignore"
 - ".rspec"
-- ".rubocop.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
-- CONTRIBUTORS.txt
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
 - 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
@@ -137,7 +123,7 @@ licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -148,12 +134,12 @@ 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: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: "Sidekiq → Honeycomb \U0001F41D"
 test_files: []

data/.rubocop.yml

@@ -1,3 +0,0 @@
-inherit_gem:
-  carwow_rubocop:
-    - default.yml

data/CONTRIBUTORS.txt

@@ -1,3 +0,0 @@
-Pedro Chambino <pedro.chambino@carwow.co.uk>
-Dan Rees-Jones <dan.reesjones@carwow.co.uk>
-Christian Gregg <christian.gregg@carwow.co.uk>

data/Gemfile.lock

@@ -1,106 +0,0 @@
-PATH
-  remote: .
-  specs:
-    honeykiq (1.1.0.pre)
-      sidekiq
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    addressable (2.7.0)
-      public_suffix (>= 2.0.2, < 5.0)
-    ast (2.4.0)
-    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.20190701)
-      unf (>= 0.0.5, < 1.0.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.2)
-      http-parser (~> 1.2.0)
-    http-cookie (1.0.3)
-      domain_name (~> 0.5)
-    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, < 5.0)
-    method_source (1.0.0)
-    parallel (1.19.1)
-    parser (2.7.1.2)
-      ast (~> 2.4.0)
-    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.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.9.0)
-    rspec-mocks (3.9.1)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-support (3.9.3)
-    rubocop (0.82.0)
-      jaro_winkler (~> 1.5.1)
-      parallel (~> 1.10)
-      parser (>= 2.7.0.1)
-      rainbow (>= 2.2.2, < 4.0)
-      rexml
-      ruby-progressbar (~> 1.7)
-      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.7)
-    unicode-display_width (1.7.0)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  bundler
-  carwow_rubocop
-  honeycomb-beeline
-  honeykiq!
-  pry
-  rake
-  rspec
-
-BUNDLED WITH
-   2.1.4