sidekiq-cronitor 2.0.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 77c9e01c256be04515fbd21f7e467fb28e632a37f94d639847c6af8ad6e9823b
-  data.tar.gz: 2c78645ae3fb16b98b52777b3b3124aaa76e6860fc606bee2bc2ab8696275663
+  metadata.gz: cab38f6cd486339c23ce89d495d8fd320536ad475385c77f2f28f08ddc78a47b
+  data.tar.gz: ecee9682b2caf0b6becfa83354a5be5275c192f57ab09e1c2da2368ce2aa85f1
 SHA512:
-  metadata.gz: 70c63ea8977ac11afe3991a1290950ed1deaa95c0147e8434fc3d0cf0fd4ed965d6d31354b150ae74e505497d7a5499023ea93f41a7eeca14fdddefc2a38a2c7
-  data.tar.gz: 6474a1e11df5373147b252fe327373e084f34abb60b6708f99c81df6b1c6d37643642228f1651fca7ddc4d9c0b988abec2f6a045f949f3e0a8e07dd5cc953b30
+  metadata.gz: fcbd75ca1e900e2a409d281c2fbad43e6fd76e6c03778c2b87df92cf50160573e96fd437a06f5db1b95e6c7e7c53ec9e3af9dfdce486bef9da517b7f08c07a25
+  data.tar.gz: 9b61ae50868b37b951c444090180ab4b8e0ce680185c61291f6eb16ae71a4138de89cf97d785a330c58948917cc287578526a9b2cb3c78a2b5a2fa779c4b6d8f

data/README.md

@@ -1,6 +1,9 @@
 # Sidekiq Cronitor
 
-Call a [Cronitor](https://cronitor.io) around your [Sidekiq](https://sidekiq.org) jobs.
+[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)
 
 ## Installation
 
@@ -19,39 +22,62 @@ bundle
 
 ## Usage
 
-Make sure you've got a Cronitor [API Key](https://cronitor.io/docs/api-overview) from [your settings](https://cronitor.io/settings) in your ENV as `CRONITOR_API_KEY` before starting Sidekiq:
+Configure `sidekiq-cronitor` with an [API Key](https://cronitor.io/docs/api-overview) from [your settings](https://cronitor.io/settings). You can use ENV variables to configure Cronitor:
 
 ```sh
-export CRONITOR_API_KEY='abcdef1234567890abcdef1234567890'
+export CRONITOR_API_KEY='api_key_123'
+export CRONITOR_ENVIRONMENT='development' #default: 'production'
+
 bundle exec sidekiq
 ```
 
-Any sidekiq worker you'd like to monitor just includes `Sidekiq::Cronitor` right after `Sidekiq::Worker`:
+Or declare the API key directly on the Cronitor module from within your application (e.g. the Sidekiq initializer).
 
 ```ruby
-class MyWorker
-  include Sidekiq::Worker
-  include Sidekiq::Cronitor
+require 'cronitor'
+Cronitor.api_key = 'api_key_123'
+Cronitor.environment = 'development' #default: 'production'
+```
 
-  def perform
-    # ...
+
+To monitor jobs insert the server middleware (most people do this in the Sidekiq initializer)
+
+```ruby
+Sidekiq.configure_server do |config|
+  config.server_middleware do |chain|
+    chain.add Sidekiq::Cronitor::ServerMiddleware
   end
 end
 ```
 
-By default this will look for an existing monitor named after your worker, `MyWorker` in the case above, and pings that. Otherwise it will try to create a new monitor with the worker's name, which you can configure rules for at a later time via your Cronitor dashboard.
 
-To use a monitor you've already created, you can configure the monitor's `key` directly:
+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`:
 
 ```ruby
-class MyWorker
-  include Sidekiq::Worker
-  include Sidekiq::Cronitor
+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' }
 
   def perform
-    # ...
+  end
+end
+```
+
+
+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 }
+
+  def perform
   end
 end
 ```

data/lib/sidekiq/cronitor/version.rb

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

data/lib/sidekiq/cronitor.rb

@@ -4,74 +4,55 @@ require 'cronitor'
 require 'sidekiq/cronitor/version'
 
 module Sidekiq::Cronitor
-  def self.included(base)
-    unless base.ancestors.include?(Sidekiq::Worker)
-      raise ArgumentError, 'Sidekiq::Cronitor can only be included in a Sidekiq::Worker'
-    end
-
-    base.extend(ClassMethods)
-
-    # Automatically add sidekiq middleware when we're first included
-    Sidekiq.configure_server do |config|
-      unless config.server_middleware.exists?(Sidekiq::Cronitor::Middleware)
-        config.server_middleware.add(Sidekiq::Cronitor::Middleware)
-      end
-    end
-  end
-
-  def cronitor
-    self.class.cronitor
-  end
-
-  module ClassMethods
-    def cronitor
-      return @cronitor if defined?(@cronitor)
-
-      opts = sidekiq_options.fetch('cronitor', {})
-      key = opts.symbolize_keys.fetch(:key, name)
-
-      Sidekiq.logger.debug("[cronitor] initializing monitor: worker=#{name} key=#{key}")
-
-      begin
-        @cronitor = Cronitor::Monitor.new(key)
-      rescue Cronitor::Error => e
-        Sidekiq.logger.error("[cronitor] failed to initialize monitor: worker=#{name} error=#{e.message}")
-
-        @cronitor = nil
-      end
-    end
-  end
-
-  class Middleware
+  class ServerMiddleware
     def call(worker, message, queue)
       ping(worker: worker, state: 'run')
 
-      yield
+      result = yield
     rescue => e
       ping(worker: worker, state: 'fail', message: e.to_s)
 
       raise e
     else
       ping(worker: worker, state: 'complete')
+      result # to be consistent with client middleware, return results of yield
     end
 
     private
+    def cronitor(worker)
+      Cronitor::Monitor.new(job_key(worker))
+    end
+
+    def cronitor_disabled?(worker)
+      options(worker).fetch(:disabled, false)
+    end
+
+    def job_key(worker)
+      options(worker).fetch(:key, worker.class.name)
+    end
+
+    def options(worker)
+      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
+    end
 
     def ping(worker:, state:, message: nil)
-      return unless has_cronitor?(worker)
+      return unless should_ping?(worker)
 
-      Sidekiq.logger.debug("[cronitor] ping: worker=#{worker.class.name} state=#{state} message=#{message}")
+      Sidekiq.logger.debug("[cronitor] ping: worker=#{job_key(worker)} state=#{state} message=#{message}")
 
-      worker.cronitor.ping(state: state)
+      cronitor(worker).ping(state: state)
     rescue Cronitor::Error => e
-      Sidekiq.logger.error("[cronitor] error during ping: worker=#{worker.class.name} error=#{e.message}")
+      Sidekiq.logger.error("[cronitor] error during ping: worker=#{job_key(worker)} error=#{e.message}")
     rescue => e
-      Sidekiq.logger.error("[cronitor] unexpected error: worker=#{worker.class.name} error=#{e.message}")
+      Sidekiq.logger.error("[cronitor] unexpected error: worker=#{job_key(worker)} error=#{e.message}")
       Sidekiq.logger.error(e.backtrace.first)
     end
 
-    def has_cronitor?(worker)
-      worker.is_a?(Sidekiq::Cronitor) && worker.respond_to?(:cronitor) && !worker.cronitor.api_key.nil?
+    def should_ping?(worker)
+      !cronitor(worker).api_key.nil? && !cronitor_disabled?(worker)
     end
   end
 end

metadata

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