honeykiq 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0707fda7ab02e35cece97138ce692a99aa4e94b4fdbd29e146f2a12c0e15c2e0
-  data.tar.gz: '0686f052a0cb97ea83f4621e079ea610a43ce3e9771f1155cdb36a962c9132e1'
+  metadata.gz: dd0cc1127fd3dfa658cb69820e243542bd84e614531405a8b95e4b9110e93bd7
+  data.tar.gz: 5e5d47b4301050821f7977e49da897e3dbd7f9d7312236cddd42dea0b3f29a7c
 SHA512:
-  metadata.gz: 071fb39ceafad14abc0f3dd9200cef6c6f1459d4c3f0b389b534ed110bf3c81e89d9800774ad6f06899fe598c89011253d2efccaf385d025ceff4690c36e404d
-  data.tar.gz: 001a4165c484889b3eba3755cf98d301c4bd6dc1a1a5274eb85ac05d5cfd49361080cb5ebb0c5723b77afb3d638dfef82d7c49cc940a9cf86c5f26a82016e3ff
+  metadata.gz: 4def9fb593162c5e7246527e50de7538561aad8153b31ecfa12b1182897445c09902b3a67f76cada6bffb4fdd542a10cfa08f8ae39cea73c201f51d86a4b0536
+  data.tar.gz: 03242d018493326a2314fe07c80a15fbaed72c048a300ae7226c9802057886920cccf86d93a6e43cc167fd9d3a2b8794c06863ca175025687b2c185cd3e84c95

data/CHANGELOG.md

@@ -6,6 +6,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [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)
@@ -38,6 +42,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - `Honeykiq.periodic_reporter`. (Use `Honeykiq::PeriodicReporter.new` instead.)
 
 [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

data/Gemfile.lock

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

data/README.md

@@ -15,14 +15,53 @@ 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 Honeykiq to your Sidekiq server middleware chain. It will send an event to

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

@@ -2,15 +2,16 @@ require 'sidekiq/api'
 
 module Honeykiq
   class ServerMiddleware
-    def initialize(libhoney: nil, honey_client: nil)
+    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)
       queue = Sidekiq::Queue.new(queue_name)
 
-      start_span(name: job.display_class) do |event|
+      span_builder.call(name: job.display_class, serialized_trace: msg['serialized_trace']) do |event|
         call_with_event(event, job, queue) { yield }
       end
     end
@@ -21,22 +22,14 @@ module Honeykiq
 
     private
 
-    attr_reader :libhoney
+    attr_reader :libhoney, :tracing_mode
 
     def libhoney?
       !!libhoney
     end
 
-    def start_span(name:)
-      if libhoney?
-        libhoney.event.tap do |event|
-          duration_ms(event) { yield event }
-        ensure
-          event.send
-        end
-      else
-        Honeycomb.start_span(name: name) { |event| yield event }
-      end
+    def span_builder
+      @span_builder ||= libhoney? ? LibhoneySpan.new(libhoney) : BeelineSpan.new(tracing_mode)
     end
 
     def call_with_event(event, job, queue)
@@ -77,14 +70,6 @@ module Honeykiq
       }
     end
 
-    def duration_ms(event)
-      start_time = now
-      yield
-    ensure
-      duration = now - start_time
-      event.add_field(:duration_ms, duration * 1000)
-    end
-
     def on_error(event, error)
       return unless event
 
@@ -103,15 +88,5 @@ module Honeykiq
       else extra_fields(job)
       end
     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/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: honeykiq
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - carwow Developers
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-07-29 00:00:00.000000000 Z
+date: 2020-08-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sidekiq
@@ -128,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