sidekiq-cronitor 3.1.0 → 3.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 826cb62a159a1c7f33af2cdabe5f56edfb2debaef6d73f9541f61106a8f77e0a
-  data.tar.gz: e459ad13e7723388db7c4448c192edb426de1454a2b22a28ec3441917bc17fdc
+  metadata.gz: 7fdd6b7a4900b0b4325bdecbb6774f71748e20d81aa44969b4687e6ee833e4b2
+  data.tar.gz: f61d0a3051c15d95d000273bca3b2f127e70d16a28e2769a19bf976a4e47f088
 SHA512:
-  metadata.gz: b3f6e392551e1118f5db63a7057fa61b4aa0efb060fa9eb2b598f8afc6ad5c268e68c614dad8dfbf168b128a2139fae26fc6e5835754826f35dd6ea361c9e50a
-  data.tar.gz: 58046cc6213e103480928fb4bcc908a5cdc3b4848881aeba4d54af956690f98081b66bf8e492127205e643a62a9396283dd7d0a6d1cf364698fe04c947b0d731
+  metadata.gz: 1f687f12236ef9af2041ff33a0ba5df7bdb378ee316ff84ce0c7ae298ab018a973ee168a88eadc07cc4a9d86a3d6ceca9d006a0a166c9f7e4d90462444e70720
+  data.tar.gz: b3d78f111182e36d322c1eaa41f7297b1bddcf286e8240780de2be6092ebd39c36ba9b708b4e013cde8fb8327c751f0a86e73d266951ea4978d5cd72e11c8f34

data/README.md

@@ -95,6 +95,23 @@ If you have an entire group or category of jobs you wish to disable monitoring o
 
 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
 
 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/periodic_jobs.rb

@@ -0,0 +1,14 @@
+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
+      end
+      Cronitor::Monitor.put(monitors: monitors_payload)
+    end
+  end
+end

data/lib/sidekiq/cronitor/sidekiq_scheduler.rb

@@ -0,0 +1,21 @@
+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|
+        # 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
+      end
+      Cronitor::Monitor.put(monitors: monitors_payload)
+    end
+  end
+end

data/lib/sidekiq/cronitor/version.rb

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

data/lib/sidekiq/cronitor.rb

@@ -3,6 +3,14 @@ require 'cronitor'
 
 require 'sidekiq/cronitor/version'
 
+if defined? SidekiqScheduler
+  require 'sidekiq/cronitor/sidekiq_scheduler'
+end
+
+if defined? Sidekiq::Periodic
+  require 'sidekiq/cronitor/periodic_jobs'
+end
+
 module Sidekiq::Cronitor
   class ServerMiddleware
     def call(worker, message, queue)
@@ -24,7 +32,7 @@ module Sidekiq::Cronitor
     end
 
     def cronitor_disabled?(worker)
-      disabled = worker.class.sidekiq_options.fetch(:cronitor_disabled, nil)
+      disabled = worker.class.sidekiq_options.fetch("cronitor_disabled", nil)
       if disabled.nil?
         options(worker).fetch(:disabled, false)
       else
@@ -33,14 +41,14 @@ module Sidekiq::Cronitor
     end
 
     def job_key(worker)
-      worker.class.sidekiq_options.fetch(:cronitor_key, nil) ||
+      worker.class.sidekiq_options.fetch("cronitor_key", nil) ||
       options(worker).fetch(:key, worker.class.name)
     end
 
     def options(worker)
       # 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, {})
+      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.1.0
+  version: 3.1.1
 platform: ruby
 authors:
 - Zeke Gabrielse
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-04-04 00:00:00.000000000 Z
+date: 2022-04-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sidekiq
@@ -107,6 +107,8 @@ files:
 - LICENSE
 - README.md
 - lib/sidekiq/cronitor.rb
+- lib/sidekiq/cronitor/periodic_jobs.rb
+- lib/sidekiq/cronitor/sidekiq_scheduler.rb
 - lib/sidekiq/cronitor/version.rb
 homepage: https://github.com/cronitor/sidekiq-cronitor
 licenses: