honeykiq 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6fe3d4a4b5312e30b13477915e40534824d4c3822db65051b6e344007d513b04
-  data.tar.gz: 32a1df92ef150b084871b05365699f08c4a40efe92854c72175d1cdd31e5b662
+  metadata.gz: 44fbbee328df450194663816c3f3cdb196970dfd8be5b9bcb547569255e44513
+  data.tar.gz: cb8fbe2e9ab677c6f2aa360729b23f26de1b0c37a417057c142307850e260da3
 SHA512:
-  metadata.gz: c589ef0b5bb7dbcc8a93200fc9e06b3d6ab85bde7ef0bc0ea98c15741f9117fed3c000d876b2acebb0502c5d8f17bd60a40362521ae139bfe919a08efe0a1d74
-  data.tar.gz: 645a9554dd0313970a8e78e80f5d207da4ac2300a280f6f3442df811e743d535a236c57928935012fcea6e9476cd4b960583066de0a1212b3eeff752cee466d5
+  metadata.gz: 0e85c6f494daadd232009dec33a5fe616d058a1a7e69f04bd7fd124b2c96f7cec240cb4fc6a5df0c7a435087de101f7de0adedc13032276d69e2def17d4378bd
+  data.tar.gz: 8d9bcfcdedd91ffa9d26b537e2fa38a44386053a172c67b44029742b795b6341f47568df28096035c6b24f9b12e517e3f88871502694559ba46805cc057a5780

data/CHANGELOG.md

@@ -0,0 +1,17 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+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]
+
+## [0.2.0]
+### Added
+- `Honeykiq::ServerMiddleware` 🙌
+
+### Removed
+- `Honeykiq.periodic_reporter`. (Use `Honeykiq::PeriodicReporter.new` instead.)
+
+[Unreleased]: https://github.com/olivierlacan/keep-a-changelog/compare/v0.2.0...HEAD
+[0.2.0]: https://github.com/olivierlacan/keep-a-changelog/compare/v0.1.0...v0.2.0

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    honeykiq (0.1.0)
+    honeykiq (0.2.0)
       sidekiq
 
 GEM
@@ -13,6 +13,7 @@ GEM
     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)
@@ -30,10 +31,14 @@ GEM
     libhoney (1.11.0)
       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.6)
     rack-protection (2.0.4)
@@ -82,6 +87,7 @@ DEPENDENCIES
   carwow_rubocop
   honeykiq!
   libhoney
+  pry
   rake
   rspec
 

data/README.md

@@ -14,15 +14,49 @@ gem 'honeykiq'
 
 ## Usage
 
-At the moment the library only provides a periodic reporter which should be
-scheduled to report every few seconds depending on your use case.
+The library provides two use cases:
 
-### Periodic Reporter
+- [`Honeykiq::ServerMiddleware`]
+- [`Honeykiq::PeriodicReporter`]
 
-The periodic reporter will send one event with information about the sidekiq
-instance, plus one event per sidekiq process, plus one event per sidekiq queue.
-Have a look at [periodic_reporter.rb] to see what kind of information we send
-for each type.
+[`Honeykiq::ServerMiddleware`]: #HoneykiqServerMiddleware
+[`Honeykiq::PeriodicReporter`]: #HoneykiqPeriodicReporter
+
+### 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.
+
+[server_middleware.rb]: https://github.com/carwow/honeykiq/blob/master/lib/honeykiq/server_middleware.rb
+
+```ruby
+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'),
+        dataset: ENV.fetch('HONEYCOMB_DATASET')
+      )
+  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.
+
+### 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
+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.
 
 [periodic_reporter.rb]: https://github.com/carwow/honeykiq/blob/master/lib/honeykiq/periodic_reporter.rb
 
@@ -45,7 +79,7 @@ module SidekiqHealth
   end
 
   def self.reporter
-    @reporter ||= Honeykiq.periodic_reporter(honey_client: honey_client)
+    @reporter ||= Honeykiq::PeriodicReporter.new(honey_client: honey_client)
   end
 
   def self.honey_client

data/honeykiq.gemspec

@@ -29,6 +29,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 'pry'
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rspec'
 end

data/lib/honeykiq.rb

@@ -1,8 +1,5 @@
 module Honeykiq
   autoload :Version, 'honeykiq/version'
   autoload :PeriodicReporter, 'honeykiq/periodic_reporter'
-
-  def self.periodic_reporter(honey_client:)
-    @reporter = Honeykiq::PeriodicReporter.new(honey_client: honey_client)
-  end
+  autoload :ServerMiddleware, 'honeykiq/server_middleware'
 end

data/lib/honeykiq/periodic_reporter.rb

@@ -4,7 +4,6 @@ module Honeykiq
   class PeriodicReporter
     def initialize(honey_client:)
       @honey_client = honey_client
-      @extra = {}
     end
 
     def report(&extra)

data/lib/honeykiq/server_middleware.rb

@@ -0,0 +1,62 @@
+require 'sidekiq/api'
+
+module Honeykiq
+  class ServerMiddleware
+    def initialize(options = {})
+      @honey_client = options.fetch(:honey_client)
+    end
+
+    def call(_worker, msg, queue_name)
+      event = @honey_client.event.add(**all_fields(msg, queue_name))
+      duration_ms(event) { yield }
+      event.add_field(:'job.status', 'finished')
+    rescue StandardError => error
+      event&.add_field(:'job.status', 'failed')
+      event&.add(error_info(error))
+      raise
+    ensure
+      event&.send
+    end
+
+    private
+
+    def all_fields(msg, queue_name)
+      {
+        type: :job,
+        **job_fields(Sidekiq::Job.new(msg, queue_name)),
+        **queue_fields(Sidekiq::Queue.new(queue_name)),
+        'meta.thread_id': Thread.current.object_id
+      }
+    end
+
+    def job_fields(job)
+      {
+        'job.class': job.display_class,
+        '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']
+      }.compact
+    end
+
+    def queue_fields(queue)
+      {
+        'queue.name': queue.name,
+        'queue.size': queue.size
+      }
+    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 error_info(error)
+      { 'error.class': error.class.name, 'error.message': error.message }
+    end
+  end
+end

data/lib/honeykiq/version.rb

@@ -1,3 +1,3 @@
 module Honeykiq
-  VERSION = '0.1.0'.freeze
+  VERSION = '0.2.0'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: honeykiq
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - carwow Developers
@@ -66,6 +66,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: rake
   requirement: !ruby/object:Gem::Requirement
@@ -105,6 +119,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -113,6 +128,7 @@ files:
 - honeykiq.gemspec
 - lib/honeykiq.rb
 - lib/honeykiq/periodic_reporter.rb
+- lib/honeykiq/server_middleware.rb
 - lib/honeykiq/version.rb
 homepage: https://github.com/carwow/honeykiq
 licenses: