sidekiq-cronitor 3.6.0 → 3.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d6373d1623a7c00d0e260437399f5ec1574db09700d9e212e1a51960a5efdbca
-  data.tar.gz: 6843e645b9cbd23edf564d8b95af27d8a7deea2247bb451b08ed862d018e0e63
+  metadata.gz: 58670e7c63fcd04abfa27f9e5e0e0ad717e3a630eb8e5d00f8ba8420eec6e5e2
+  data.tar.gz: 859ef82c42ff3053ff10d5a1d20a8f8d35e471326ebcc067a6eed6a02832d856
 SHA512:
-  metadata.gz: c45f495adaa7f83d80db7da49c7ae8d89b6999a6259653543de2a57dd543751f09f8c6d5ec2002df143db86ebad3732d3d60c2ea85a7739be2205fff6ec9c2e1
-  data.tar.gz: 2dd6b470ee157a2ee44a7207138623e5b43e39a3f7d7454aa6c0d8dcfa89cd4741d80b4aecad8d04e7586f5ae573775992d67afb70e5fa4dd5a0fa7e044adaec
+  metadata.gz: a7f3979bea1da06b7e8f30de736485f26867d4c10ebcf456e8c0e376764d689e77d00e7b7672830fa79abfec163fd9f27405d13100601bc0717d2b3bc13f38c1
+  data.tar.gz: e6b23c396b7e27c0ad88bf12125b7da3c813b22c720df44e9c28ea173a89d435c633245f4b40e362b5a3419c521832ba063b65f7688686e59f21a3a9704c31c2

data/README.md

@@ -1,9 +1,8 @@
 # Sidekiq Cronitor
 
-[Cronitor](https://cronitor.io/) provides dead simple monitoring for cron jobs, daemons, queue workers, websites, APIs, and anything else that can send or receive an HTTP request. The Cronitor Sidekiq library provides a drop in integration for monitoring any Sidekiq Job.
-
+![Tests](https://github.com/cronitorio/cronitor-sidekiq/workflows/Tests/badge.svg)
 
-#### NOTE: Version 3.0.0 changes the integration method from 2.x.x - you now add  middleware in the Sidekiq initializer. This significantly reduces the integration overhead, however it is a BREAKING CHANGE.  Existing users who would like to migrate to version 3.x.x should [contact support](mailto:support@cronitor.io) for assistance with the migration.
+[Cronitor](https://cronitor.io/) provides dead simple monitoring for cron jobs, daemons, queue workers, websites, APIs, and anything else that can send or receive an HTTP request. The Cronitor Sidekiq library provides a drop in integration for monitoring any Sidekiq Job.
 
 ## Installation
 
@@ -16,7 +15,7 @@ gem 'sidekiq-cronitor'
 
 And then bundle:
 
-```
+```sh
 bundle
 ```
 
@@ -39,7 +38,6 @@ Cronitor.api_key = 'api_key_123'
 Cronitor.environment = 'development' #default: 'production'
 ```
 
-
 Monitor jobs by registering `Sidekiq::Cronitor::ServerMiddleware` server [middleware](https://www.rubydoc.info/github/mperham/sidekiq/Sidekiq/Middleware) (most people do this in the Sidekiq initializer).
 
 ```ruby
@@ -50,7 +48,6 @@ Sidekiq.configure_server do |config|
 end
 ```
 
-
 Once the server middleware is registered, Cronitor will send [telemetry events](https://cronitor.io/docs/teleme) 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.
 
 Optional: You can specify the monitor key directly using `sidekiq_options`:
@@ -65,6 +62,8 @@ class MyJob
 end
 ```
 
+### Enable/Disable
+
 To disable Cronitor for a specific job you can set the following option:
 
 ```ruby
@@ -77,7 +76,33 @@ class MyJob
 end
 ```
 
+To disable Cronitor for all jobs, and selectively enable it, you can set the following option:
+
+```sh
+export CRONITOR_AUTO_DISCOVER_SIDEKIQ='false'
+```
+
+or
+
+```ruby
+require 'cronitor'
+Cronitor.auto_discover_sidekiq = false
+```
+
+then enable the jobs you want to report to Cronitor:
+
+```ruby
+class MyJob
+  include Sidekiq::Job
+  sidekiq_options cronitor_enabled: true
+
+  def perform
+  end
+end
+```
+
 ## Periodic/Scheduled Jobs
+
 If you are using Sidekiq Enterprise to run [Periodic Jobs](https://github.com/mperham/sidekiq/wiki/Ent-Periodic-Jobs) or are using the popular [sidekiq-scheduler](https://github.com/moove-it/sidekiq-scheduler) gem, you can sync the schedules of those jobs with a single command.
 
 ```ruby
@@ -86,7 +111,6 @@ Sidekiq::Cronitor::PeriodicJobs.sync_schedule!
 Sidekiq::Cronitor::SidekiqScheduler.sync_schedule!
 ```
 
-
 ## 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.
@@ -95,7 +119,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/cronitorio/cronitor-sidekiq/pulls. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at <https://github.com/cronitorio/cronitor-sidekiq/pulls>. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 ## License
 

data/lib/sidekiq/cronitor/periodic_jobs.rb

@@ -6,7 +6,11 @@ module Sidekiq::Cronitor
       monitors_payload = []
       loops = Sidekiq::Periodic::LoopSet.new
       loops.each do |lop|
-        next if fetch_option(lop, 'cronitor_disabled')
+        if fetch_option(lop, 'cronitor_enabled')
+          next unless fetch_option(lop, 'cronitor_enabled', Cronitor.auto_discover_sidekiq)
+        else
+          next if fetch_option(lop, 'cronitor_disabled', !Cronitor.auto_discover_sidekiq)
+        end
 
         monitors_payload << {
           key: fetch_option(lop, 'cronitor_key') || lop.klass.to_s,
@@ -25,9 +29,9 @@ module Sidekiq::Cronitor
       Sidekiq.logger.error("[cronitor] error during #{name}.#{__method__}: #{e}")
     end
 
-    def self.fetch_option(lop, key)
-      lop.options.fetch(key, nil) ||
-        lop.klass.constantize.sidekiq_options.fetch(key, nil)
+    def self.fetch_option(lop, key, default = nil)
+      lop.options.fetch(key, default) ||
+        lop.klass.constantize.sidekiq_options.fetch(key, default)
     end
   end
 end

data/lib/sidekiq/cronitor/sidekiq_scheduler.rb

@@ -12,7 +12,12 @@ module Sidekiq::Cronitor
         # just in case an explicit job key has been set
         job_klass = Object.const_get(v['class'])
         job_key = job_klass.sidekiq_options.fetch('cronitor_key', v['class'])
-        next if job_klass.sidekiq_options.fetch('cronitor_disabled', false)
+
+        if job_klass.sidekiq_options['cronitor_enabled']
+          next unless job_klass.sidekiq_options.fetch('cronitor_enabled', Cronitor.auto_discover_sidekiq)
+        else
+          next if job_klass.sidekiq_options.fetch('cronitor_disabled', !Cronitor.auto_discover_sidekiq)
+        end
 
         monitors_payload << { key: job_key.to_s, schedule: schedule, platform: 'sidekiq', type: 'job' }
       end

data/lib/sidekiq/cronitor/version.rb

@@ -1,5 +1,5 @@
 module Sidekiq
   module Cronitor
-    VERSION = '3.6.0'
+    VERSION = '3.7.0'
   end
 end

data/lib/sidekiq/cronitor.rb

@@ -27,16 +27,16 @@ module Sidekiq::Cronitor
     end
 
     private
+
     def cronitor(worker)
       Cronitor::Monitor.new(job_key(worker))
     end
 
     def cronitor_disabled?(worker)
-      disabled = worker.class.sidekiq_options.fetch("cronitor_disabled", nil)
-      if disabled.nil?
-        options(worker).fetch(:disabled, false)
+      if worker.class.sidekiq_options["cronitor_enabled"]
+        !worker.class.sidekiq_options.fetch("cronitor_enabled", Cronitor.auto_discover_sidekiq)
       else
-        !!disabled
+        worker.class.sidekiq_options.fetch("cronitor_disabled", options(worker).fetch(:disabled, !Cronitor.auto_discover_sidekiq))
       end
     end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-cronitor
 version: !ruby/object:Gem::Version
-  version: 3.6.0
+  version: 3.7.0
 platform: ruby
 authors:
 - Zeke Gabrielse
@@ -11,7 +11,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-02-01 00:00:00.000000000 Z
+date: 2023-03-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sidekiq
@@ -33,14 +33,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '5.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '5.1'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement