honeykiq 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: 44fbbee328df450194663816c3f3cdb196970dfd8be5b9bcb547569255e44513
-  data.tar.gz: cb8fbe2e9ab677c6f2aa360729b23f26de1b0c37a417057c142307850e260da3
+SHA1:
+  metadata.gz: bd68d2d6502122121c482fa34ed093f1d1e8fc55
+  data.tar.gz: c78a51adabd03fff9f7e17b140eaaca58a310cd2
 SHA512:
-  metadata.gz: 0e85c6f494daadd232009dec33a5fe616d058a1a7e69f04bd7fd124b2c96f7cec240cb4fc6a5df0c7a435087de101f7de0adedc13032276d69e2def17d4378bd
-  data.tar.gz: 8d9bcfcdedd91ffa9d26b537e2fa38a44386053a172c67b44029742b795b6341f47568df28096035c6b24f9b12e517e3f88871502694559ba46805cc057a5780
+  metadata.gz: cb767053db59b6e3c568b9dba2059bb00d54c79c9fc6794148d81642a1cfcfee3bb27860a298218c620eaa739351bda563ecd56019eb7af68343381edc48905e
+  data.tar.gz: f2c2a102e62632209fe9e4c120700e53677a167ec1aeb0300cd5f162001c48b181a0f5cb59aea58648b09fcf1f6d134d254b721a34ecd0af6b419e6547a5573c

data/CHANGELOG.md

@@ -6,6 +6,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.3.0]
+### Added
+- `Honeykiq::ServerMiddleware#extra_fields` so you can add custom fields to an event
+
 ## [0.2.0]
 ### Added
 - `Honeykiq::ServerMiddleware` 🙌
@@ -13,5 +17,6 @@ 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/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
+[Unreleased]: https://github.com/carwow/honeykiq/compare/v0.3.0...HEAD
+[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/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    honeykiq (0.2.0)
+    honeykiq (0.3.0)
       sidekiq
 
 GEM
@@ -40,12 +40,12 @@ GEM
       coderay (~> 1.1.0)
       method_source (~> 0.9.0)
     public_suffix (3.0.3)
-    rack (2.0.6)
-    rack-protection (2.0.4)
+    rack (2.0.8)
+    rack-protection (2.0.8.1)
       rack
     rainbow (3.0.0)
     rake (12.3.2)
-    redis (4.0.3)
+    redis (4.1.3)
     rspec (3.8.0)
       rspec-core (~> 3.8.0)
       rspec-expectations (~> 3.8.0)
@@ -70,10 +70,11 @@ GEM
     rubocop-rspec (1.30.1)
       rubocop (>= 0.60.0)
     ruby-progressbar (1.10.0)
-    sidekiq (5.2.3)
-      connection_pool (~> 2.2, >= 2.2.2)
-      rack-protection (>= 1.5.0)
-      redis (>= 3.3.5, < 5)
+    sidekiq (6.0.4)
+      connection_pool (>= 2.2.2)
+      rack (>= 2.0.0)
+      rack-protection (>= 2.0.0)
+      redis (>= 4.1.0)
     unf (0.1.4)
       unf_ext
     unf_ext (0.0.7.5)
@@ -92,4 +93,4 @@ DEPENDENCIES
   rspec
 
 BUNDLED WITH
-   1.17.1
+   1.17.2

data/README.md

@@ -42,6 +42,27 @@ 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:
+
+```ruby
+class MyServerMiddleware < Honeykiq::ServerMiddleware
+  def extra_fields
+    {
+      my_data: 'evaluated and added to the event after the job has finished/errored',
+      my_function: -> { Time.now }
+    }
+  end
+end
+
+Sidekiq.configure_server do |config|
+  config.server_middleware do |chain|
+    chain.add MyServerMiddleware, honey_client: ...
+    ...
+```
+
 **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
@@ -62,7 +83,7 @@ It sends three types of events: instance, process, and queue.  Have a look at
 
 A simple setup using [clockwork] would look like this:
 
-[clockwork]: https://github.com/adamwiggins/clockwork
+[clockwork]: https://github.com/Rykian/clockwork
 
 ```ruby
 require 'clockwork'

data/lib/honeykiq/server_middleware.rb

@@ -7,8 +7,8 @@ module Honeykiq
     end
 
     def call(_worker, msg, queue_name)
-      event = @honey_client.event.add(**all_fields(msg, queue_name))
-      duration_ms(event) { yield }
+      event = @honey_client.event
+      run_with_hooks(event, msg, queue_name) { yield }
       event.add_field(:'job.status', 'finished')
     rescue StandardError => error
       event&.add_field(:'job.status', 'failed')
@@ -18,9 +18,19 @@ module Honeykiq
       event&.send
     end
 
+    def extra_fields
+      {}
+    end
+
     private
 
-    def all_fields(msg, queue_name)
+    def run_with_hooks(event, msg, queue_name)
+      event.add(default_fields(msg, queue_name))
+      duration_ms(event) { yield }
+      event.add(extra_fields)
+    end
+
+    def default_fields(msg, queue_name)
       {
         type: :job,
         **job_fields(Sidekiq::Job.new(msg, queue_name)),

data/lib/honeykiq/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: honeykiq
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - carwow Developers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-12-12 00:00:00.000000000 Z
+date: 2020-01-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sidekiq
@@ -151,7 +151,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 2.6.14.1
 signing_key: 
 specification_version: 4
 summary: "Sidekiq → Honeycomb \U0001F41D"