sidekiq-cronitor 3.0.0 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cab38f6cd486339c23ce89d495d8fd320536ad475385c77f2f28f08ddc78a47b
-  data.tar.gz: ecee9682b2caf0b6becfa83354a5be5275c192f57ab09e1c2da2368ce2aa85f1
+  metadata.gz: 826cb62a159a1c7f33af2cdabe5f56edfb2debaef6d73f9541f61106a8f77e0a
+  data.tar.gz: e459ad13e7723388db7c4448c192edb426de1454a2b22a28ec3441917bc17fdc
 SHA512:
-  metadata.gz: fcbd75ca1e900e2a409d281c2fbad43e6fd76e6c03778c2b87df92cf50160573e96fd437a06f5db1b95e6c7e7c53ec9e3af9dfdce486bef9da517b7f08c07a25
-  data.tar.gz: 9b61ae50868b37b951c444090180ab4b8e0ce680185c61291f6eb16ae71a4138de89cf97d785a330c58948917cc287578526a9b2cb3c78a2b5a2fa779c4b6d8f
+  metadata.gz: b3f6e392551e1118f5db63a7057fa61b4aa0efb060fa9eb2b598f8afc6ad5c268e68c614dad8dfbf168b128a2139fae26fc6e5835754826f35dd6ea361c9e50a
+  data.tar.gz: 58046cc6213e103480928fb4bcc908a5cdc3b4848881aeba4d54af956690f98081b66bf8e492127205e643a62a9396283dd7d0a6d1cf364698fe04c947b0d731

data/README.md

@@ -53,14 +53,12 @@ end
 
 When this job is invoked, Cronitor will send telemetry pings with a `key` matching the name of your job class (`MyJob` in the example below). If no monitor exists it will create one on the first event. You can configure rules at a later time via the Cronitor dashboard, API, or [YAML config](https://github.com/cronitorio/cronitor-ruby#configuring-monitors) file.
 
-If you want to specify the Cronitor key directly (not required) you can do so using `sidekiq_options`:
+Optional: You can specify the monitor key directly using `sidekiq_options`:
 
 ```ruby
 class MyJob
   include Sidekiq::Job
-
-  # note that 'key' should be set with a symbol as the key in the hash
-  sidekiq_options cronitor: { key: 'abc123' }
+  sidekiq_options cronitor_key: 'abc123'
 
   def perform
   end
@@ -72,16 +70,31 @@ To disable Cronitor for a specific job you can set the following option:
 
 ```ruby
 class MyJob
-  include Sidekiq::MyJob
-
-  # note that 'disabled' should be set with a symbol as the key in the hash
-  sidekiq_options cronitor: { disabled: true }
+  include Sidekiq::Job
+  sidekiq_options cronitor_disabled: true
 
   def perform
   end
 end
 ```
 
+## Disabling For Some Jobs
+If you have an entire group or category of jobs you wish to disable monitoring on, it's easiest to create a base class with that option set and then have all your jobs inherit from that base class.
+
+```ruby
+  class UnmonitoredJob
+    include Sidekiq::Job
+    sidekiq_options cronitor_disabled: true
+  end
+
+  class NoInstrumentationJob < UnmonitoredJob
+    def perform
+    end
+  end
+```
+
+Note: Do NOT set a cronitor_key option on your base class or all your inherited jobs will report under the same job in Cronitor.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/sidekiq/cronitor/version.rb

@@ -1,5 +1,5 @@
 module Sidekiq
   module Cronitor
-    VERSION = '3.0.0'
+    VERSION = '3.1.0'
   end
 end

data/lib/sidekiq/cronitor.rb

@@ -24,15 +24,23 @@ module Sidekiq::Cronitor
     end
 
     def cronitor_disabled?(worker)
-      options(worker).fetch(:disabled, false)
+      disabled = worker.class.sidekiq_options.fetch(:cronitor_disabled, nil)
+      if disabled.nil?
+        options(worker).fetch(:disabled, false)
+      else
+        !!disabled
+      end
     end
 
     def job_key(worker)
+      worker.class.sidekiq_options.fetch(:cronitor_key, nil) ||
       options(worker).fetch(:key, worker.class.name)
     end
 
     def options(worker)
-      opts = worker.class.sidekiq_options.fetch('cronitor', {})
+      # eventually we will delete this method of passing options
+      # ultimately we want all cronitor options to be top level keys
+      opts = worker.class.sidekiq_options.fetch(:cronitor, {})
       # symbolize_keys is a rails helper, so only use it if it's defined
       opts = opts.symbolize_keys if opts.respond_to?(:symbolize_keys)
       opts

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-cronitor
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.1.0
 platform: ruby
 authors:
 - Zeke Gabrielse
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-03-08 00:00:00.000000000 Z
+date: 2022-04-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sidekiq