sidekiq-cronitor 3.1.0 → 3.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 826cb62a159a1c7f33af2cdabe5f56edfb2debaef6d73f9541f61106a8f77e0a
-  data.tar.gz: e459ad13e7723388db7c4448c192edb426de1454a2b22a28ec3441917bc17fdc
+  metadata.gz: ebea71b4352db386aa8712eb8462b88b4f2a91ed0e7921face88453eb56981e7
+  data.tar.gz: 74fd0296d97a9480d55442d777937c6ae21f6a0821b6c690c8f9d366432ad998
 SHA512:
-  metadata.gz: b3f6e392551e1118f5db63a7057fa61b4aa0efb060fa9eb2b598f8afc6ad5c268e68c614dad8dfbf168b128a2139fae26fc6e5835754826f35dd6ea361c9e50a
-  data.tar.gz: 58046cc6213e103480928fb4bcc908a5cdc3b4848881aeba4d54af956690f98081b66bf8e492127205e643a62a9396283dd7d0a6d1cf364698fe04c947b0d731
+  metadata.gz: 699883656bff1c2adc7e08fcbae41006e4be244a256ffebe30b54b891b51dde4367f412ca4616b6a35571b0c2c892ee4f207696fa42575eb276e203295869260
+  data.tar.gz: 1edd11e88318b33b950626aae9b7615e0e5bf007ae74bc0e5a68582979f9d6741c5120b9ea4551fd1a3a675890a43d56ca69fa857be3a54b7dd9c9a5b0836677

data/README.md

@@ -3,7 +3,7 @@
 [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.
 
 
-#### NOTE: Version 3.0.0 changes the integration method from 2.x.x. This is a breaking change. You now add the middleware in the Sidekiq initializer. You can opt of out telemetry for specific jobs with a sidekiq_options (see below)
+#### 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.
 
 ## Installation
 
@@ -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,22 +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.
 
 ## Development
 

data/lib/sidekiq/cronitor/periodic_jobs.rb

@@ -0,0 +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', 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

@@ -0,0 +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|
+        # make sure the job has a cron or every definition, we skip non cron/every defined jobs for now
+        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.0'
+    VERSION = '3.4.0'
   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
@@ -51,7 +59,7 @@ module Sidekiq::Cronitor
 
       Sidekiq.logger.debug("[cronitor] ping: worker=#{job_key(worker)} state=#{state} message=#{message}")
 
-      cronitor(worker).ping(state: state)
+      cronitor(worker).ping(state: state, message: message)
     rescue Cronitor::Error => e
       Sidekiq.logger.error("[cronitor] error during ping: worker=#{job_key(worker)} error=#{e.message}")
     rescue => e

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-cronitor
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 3.4.0
 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-08-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sidekiq
@@ -31,14 +31,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -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: