sidekiq-cronitor 3.1.1 → 3.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7fdd6b7a4900b0b4325bdecbb6774f71748e20d81aa44969b4687e6ee833e4b2
-  data.tar.gz: f61d0a3051c15d95d000273bca3b2f127e70d16a28e2769a19bf976a4e47f088
+  metadata.gz: ceb0fb42649e7e03c7f125204eb12a315225acbf731d35e6c850e1a12730c6c9
+  data.tar.gz: 5534007db95190d63581020952e22a0f227231ac7917bbda63bcbdf619b4df8e
 SHA512:
-  metadata.gz: 1f687f12236ef9af2041ff33a0ba5df7bdb378ee316ff84ce0c7ae298ab018a973ee168a88eadc07cc4a9d86a3d6ceca9d006a0a166c9f7e4d90462444e70720
-  data.tar.gz: b3d78f111182e36d322c1eaa41f7297b1bddcf286e8240780de2be6092ebd39c36ba9b708b4e013cde8fb8327c751f0a86e73d266951ea4978d5cd72e11c8f34
+  metadata.gz: 4542db6ff37a9b265b11a7b5e7197ea90502d2e1db8f4e71624ad155f5895456e10bf454688e544a4aa098e1d52f7df78fbde4b236d2656b6f13a5b07c127fd8
+  data.tar.gz: 35ec24c9f75bf7f69e5da4d4150377c5d8e9dcaf2e6aaed571b4199787df3b46af3e196611de4eae23d241fa3eeaaa06d0754a6199749d1174bdc61297b229b5

data/README.md

@@ -40,7 +40,7 @@ Cronitor.environment = 'development' #default: 'production'
 ```
 
 
-To monitor jobs insert the server middleware (most people do this in the Sidekiq initializer)
+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
 Sidekiq.configure_server do |config|
@@ -51,7 +51,7 @@ 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.
+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,7 +65,6 @@ class MyJob
 end
 ```
 
-
 To disable Cronitor for a specific job you can set the following option:
 
 ```ruby
@@ -78,39 +77,15 @@ class MyJob
 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.
+## 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
-  class UnmonitoredJob
-    include Sidekiq::Job
-    sidekiq_options cronitor_disabled: true
-  end
-
-  class NoInstrumentationJob < UnmonitoredJob
-    def perform
-    end
-  end
+Sidekiq::Cronitor::PeriodicJobs.sync_schedule!
+# or
+Sidekiq::Cronitor::SidekiqScheduler.sync_schedule!
 ```
 
-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.
-
-## Job Monitoring
-If you are using Cronitor to monitor scheduled/periodic jobs and have jobs schedules already defined you can use rake tasks to upload the schedule to Cronitor for monitoring.
-
-In your projects Rakefile you can load the task to be available to you in your project.
-It might be a good idea to sync these schedules on every deploy
-
-```ruby
-  # your Rakefile, find the path to the gem
-  spec = Gem::Specification.find_by_name 'sidekiq-cronitor'
-  # if you are using sidekiq_scheduler this task should parse and upload the schedule.
-  load "#{spec.gem_dir}/lib/tasks/sidekiq_scheduler.rake"
-  # if you are using Sidekiq Pro Periodic Jobs this is an example script
-  # Note: this hasn't been tested on Sidekiq Pro yet
-  load "#{spec.gem_dir}/lib/tasks/periodic_jobs.rake"
-  # You only really need to load one of the rake files unless you are somehow running both systems
-```
 
 ## Development
 

data/lib/sidekiq/cronitor/periodic_jobs.rb

@@ -1,14 +1,20 @@
+# frozen_string_literal: true
+
 module Sidekiq::Cronitor
   class PeriodicJobs
     def self.sync_schedule!
       monitors_payload = []
       loops = Sidekiq::Periodic::LoopSet.new
       loops.each do |lop|
-        job_key = lop.klass.sidekiq_options.fetch("cronitor_key", nil) || lop.klass.to_s
-        cronitor_disabled = lop.klass.sidekiq_options.fetch("cronitor_disabled", false)
-        monitors_payload << {key: job_key, schedule: lop.schedule, metadata: lop.options, platform: 'sidekiq', type: 'job' } unless cronitor_disabled
+        job_key = lop.klass.sidekiq_options.fetch('cronitor_key', lop.klass.to_s)
+        next if lop.klass.sidekiq_options.fetch('cronitor_disabled', false)
+
+        monitors_payload << { key: job_key, schedule: lop.schedule, metadata: lop.options, platform: 'sidekiq', type: 'job' }
       end
+
       Cronitor::Monitor.put(monitors: monitors_payload)
+    rescue Cronitor::Error => e
+      Sidekiq.logger.error("[cronitor] error during #{name}.#{__method__}: #{e}")
     end
   end
 end

data/lib/sidekiq/cronitor/sidekiq_scheduler.rb

@@ -1,21 +1,25 @@
+# frozen_string_literal: true
+
 module Sidekiq::Cronitor
   class SidekiqScheduler
     def self.sync_schedule!
       monitors_payload = []
       # go through the scheduled jobs and find cron defined ones
-      Sidekiq.get_schedule.each do |k, v|
+      Sidekiq.get_schedule.each do |_k, v|
         # make sure the job has a cron or every definition, we skip non cron/every defined jobs for now
-        if !v["cron"].nil? || !v["every"].nil?
-          schedule = v["cron"] || v["every"]
-          # 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", nil) || v["class"]
-          # if monitoring for this job is turned off
-          cronitor_disabled = job_klass.sidekiq_options.fetch("cronitor_disabled", false)
-          monitors_payload << {key: job_key.to_s, schedule: schedule, platform: 'sidekiq', type: 'job' } unless cronitor_disabled
-        end
+        next unless (schedule = v['cron'] || v['every'])
+
+        # 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)
+
+        monitors_payload << { key: job_key.to_s, schedule: schedule, platform: 'sidekiq', type: 'job' }
       end
+
       Cronitor::Monitor.put(monitors: monitors_payload)
+    rescue Cronitor::Error => e
+      Sidekiq.logger.error("[cronitor] error during #{name}.#{__method__}: #{e}")
     end
   end
 end

data/lib/sidekiq/cronitor/version.rb

@@ -1,5 +1,5 @@
 module Sidekiq
   module Cronitor
-    VERSION = '3.1.1'
+    VERSION = '3.3.0'
   end
 end

metadata

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