sidekiq-cronitor 1.0.0.alpha2 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: d7a312993ccafb8425bb94bfff6deec07241ff5e
-  data.tar.gz: 96bba8e59b67eafaf8dda5e42a2b5c4804e41344
+SHA256:
+  metadata.gz: 77c9e01c256be04515fbd21f7e467fb28e632a37f94d639847c6af8ad6e9823b
+  data.tar.gz: 2c78645ae3fb16b98b52777b3b3124aaa76e6860fc606bee2bc2ab8696275663
 SHA512:
-  metadata.gz: 65f500c417e836ee253b45c156dcf4fe39ab6e9103d892378e7a0bce8c74f5d1811d0b9359d3a1d953dc8ee32204ae0902a93c2f101c671f690d34e678379253
-  data.tar.gz: 59b58af7800b9a659b0b59f57c3972b50cfcd64459c2975c75728aa745b405a69fbf6f5fe92f1b02041752b1eaf6cc3010b0a5ec8b1f7d6880139404c4aa8b89
+  metadata.gz: 70c63ea8977ac11afe3991a1290950ed1deaa95c0147e8434fc3d0cf0fd4ed965d6d31354b150ae74e505497d7a5499023ea93f41a7eeca14fdddefc2a38a2c7
+  data.tar.gz: 6474a1e11df5373147b252fe327373e084f34abb60b6708f99c81df6b1c6d37643642228f1651fca7ddc4d9c0b988abec2f6a045f949f3e0a8e07dd5cc953b30

data/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2017 Samuel Cochran
+Copyright (c) 2020 Cronitor.io
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -7,21 +7,23 @@ Call a [Cronitor](https://cronitor.io) around your [Sidekiq](https://sidekiq.org
 Add sidekiq-cronitor your application's Gemfile, near sidekiq:
 
 ```ruby
-gem "sidekiq"
-gem "sidekiq-cronitor"
+gem 'sidekiq'
+gem 'sidekiq-cronitor'
 ```
 
 And then bundle:
 
-    $ bundle
+```
+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_TOKEN` before starting Sidekiq:
+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:
 
 ```sh
-export CRONITOR_TOKEN="abcdef1234567890abcdef1234567890"
-sidekiq
+export CRONITOR_API_KEY='abcdef1234567890abcdef1234567890'
+bundle exec sidekiq
 ```
 
 Any sidekiq worker you'd like to monitor just includes `Sidekiq::Cronitor` right after `Sidekiq::Worker`:
@@ -37,53 +39,16 @@ class MyWorker
 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 name.
-
-To use a monitor you've already created you can also configure a code directly:
-
-```ruby
-class MyWorker
-  include Sidekiq::Worker
-  include Sidekiq::Cronitor
-
-  sidekiq_options cronitor: {code: "abc123"}
-
-  def perform
-    # ...
-  end
-end
-```
-
-To use a different name or customise how a missing monitor will be created you can use a sidekiq option named `cronitor`:
-
-```ruby
-class MyWorker
-  include Sidekiq::Worker
-  include Sidekiq::Cronitor
-
-  sidekiq_options cronitor: {
-    name: "Some Monitor",
-    rules: [{rule_type: "ran_longer_than", value: 60, time_unit: "seconds"}]
-  }
-
-  def perform
-    # ...
-  end
-end
-```
-
-For more information on what rules you can use take a look at the [Cronitor Monitors API docs](https://cronitor.io/docs/monitor-api).
-
-If you're using [sidekiq-cron](https://github.com/ondrejbartas/sidekiq-cron) the missing monitor will have a default `not_on_schedule` rule based on the cron schedule matched by you worker class.
+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.
 
-You can also just supply a Cronitor instance to use directly:
+To use a monitor you've already created, you can configure the monitor's `key` directly:
 
 ```ruby
 class MyWorker
   include Sidekiq::Worker
   include Sidekiq::Cronitor
 
-  sidekiq_options cronitor: Cronitor.new(...)
+  sidekiq_options cronitor: { key: 'abc123' }
 
   def perform
     # ...
@@ -99,7 +64,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/sj26/sidekiq-cronitor. 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.rb

@@ -1,25 +1,20 @@
-require "sidekiq"
-require "cronitor"
+require 'sidekiq'
+require 'cronitor'
 
-require "sidekiq/cronitor/version"
+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"
+    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
-    #
-    # This might only occur when the worker class is first loaded in a
-    # development rails environment, but that happens before the middleware
-    # chain is invoked so we're all good.
-    #
     Sidekiq.configure_server do |config|
-      unless config.server_middleware.exists? Sidekiq::Cronitor::Middleware
-        config.server_middleware.add Sidekiq::Cronitor::Middleware
+      unless config.server_middleware.exists?(Sidekiq::Cronitor::Middleware)
+        config.server_middleware.add(Sidekiq::Cronitor::Middleware)
       end
     end
   end
@@ -30,110 +25,53 @@ module Sidekiq::Cronitor
 
   module ClassMethods
     def cronitor
-      return @cronitor if defined? @cronitor
+      return @cronitor if defined?(@cronitor)
 
-      # Sidekiq always stores options as string keys, shallowly at least
-      opts = sidekiq_options.fetch("cronitor", {})
+      opts = sidekiq_options.fetch('cronitor', {})
+      key = opts.symbolize_keys.fetch(:key, name)
 
-      if opts.is_a? Cronitor
-        return @cronitor = opts
-      end
-
-      # Cronitor (and our code below) expects deeply symbolized keys
-      opts = Utils.deep_symbolize_keys(opts)
-
-      # Extract token and code into top level kwargs
-      kwargs = opts.slice(:token, :code).merge(opts: opts)
-
-      # Default monitor name to sidekiq worker (class) name
-      kwargs[:opts][:name] ||= name
-
-      # Some hints about where this monitor came from
-      kwargs[:opts][:tags] ||= []
-      kwargs[:opts][:tags] << "sidekiq-cronitor"
-      if environment = ENV["RAILS_ENV"] || ENV["RACK_ENV"] || Sidekiq.options[:environment]
-        kwargs[:opts][:tags] << environment
-      end
-      kwargs[:opts][:note] ||= "Created by sidekiq-cronitor"
-
-      # If we can find a schedule for this worker then we can automatically add
-      # a not_on_schedule rule and tag it as a cron-job
-      if schedule = cronitor_schedule
-        kwargs[:opts][:rules] ||= [{rule_type: "not_on_schedule", value: schedule}]
-        kwargs[:opts][:tags] << "cron-job"
-      end
+      Sidekiq.logger.debug("[cronitor] initializing monitor: worker=#{name} key=#{key}")
 
       begin
-        @cronitor = Cronitor.new(**kwargs)
+        @cronitor = Cronitor::Monitor.new(key)
       rescue Cronitor::Error => e
-        Sidekiq.logger.warn "Couldn't initialize Cronitor: #{e.to_s}"
+        Sidekiq.logger.error("[cronitor] failed to initialize monitor: worker=#{name} error=#{e.message}")
 
         @cronitor = nil
       end
     end
-
-    private def cronitor_schedule
-      name = self.name
-
-      if defined?(Sidekiq::Cron)
-        # If we can find a Sidekiq::Cron job with a matching worker class
-        # then presume its schedule.
-        Sidekiq::Cron::Job.all.each do |job|
-          if job.klass == name
-            return job.cron
-          end
-        end
-      elsif defined?(Sidekiq::Periodic)
-        # If we can find a Sidekiq Enterprise Periodic Loop with a matching
-        # worker class then presume its schedule.
-        Sidekiq::Periodic::LoopSet.new.each do |loop_|
-          if loop_.klass == name
-            return loop_.schedule
-          end
-        end
-      end
-
-      # ¯\_(ツ)_/¯
-      return nil
-    end
   end
 
   class Middleware
     def call(worker, message, queue)
-      begin
-        ping worker, "run"
+      ping(worker: worker, state: 'run')
 
-        yield
-      rescue => e
-        ping worker, "failed", e.to_s
+      yield
+    rescue => e
+      ping(worker: worker, state: 'fail', message: e.to_s)
 
-        raise
-      else
-        ping worker, "complete"
-      end
+      raise e
+    else
+      ping(worker: worker, state: 'complete')
     end
 
     private
 
-    def ping(worker, type, msg=nil)
-      if cronitor? worker
-        Sidekiq.logger.debug "Cronitor ping: #{type}"
-        worker.cronitor.ping(type)
-      end
-    rescue Cronitor::Error => e
-      Sidekiq.logger.warn "Couldn't ping Cronitor: #{e.to_s}"
-    end
+    def ping(worker:, state:, message: nil)
+      return unless has_cronitor?(worker)
+
+      Sidekiq.logger.debug("[cronitor] ping: worker=#{worker.class.name} state=#{state} message=#{message}")
 
-    def cronitor? worker
-      worker.is_a?(Sidekiq::Cronitor) && worker.cronitor
+      worker.cronitor.ping(state: state)
+    rescue Cronitor::Error => e
+      Sidekiq.logger.error("[cronitor] error during ping: worker=#{worker.class.name} error=#{e.message}")
+    rescue => e
+      Sidekiq.logger.error("[cronitor] unexpected error: worker=#{worker.class.name} error=#{e.message}")
+      Sidekiq.logger.error(e.backtrace.first)
     end
-  end
 
-  module Utils
-    def self.deep_symbolize_keys(hash) #+nodoc+
-      hash.each_with_object({}) do |(key, value), new_hash|
-        new_hash[key.to_sym] = value.is_a?(Hash) ? deep_symbolize_keys(value) : value
-      end
+    def has_cronitor?(worker)
+      worker.is_a?(Sidekiq::Cronitor) && worker.respond_to?(:cronitor) && !worker.cronitor.api_key.nil?
     end
   end
 end

data/lib/sidekiq/cronitor/version.rb

@@ -1,5 +1,5 @@
 module Sidekiq
   module Cronitor
-    VERSION = "1.0.0.alpha2"
+    VERSION = '2.0.0'
   end
 end

metadata

@@ -1,34 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-cronitor
 version: !ruby/object:Gem::Version
-  version: 1.0.0.alpha2
+  version: 2.0.0
 platform: ruby
 authors:
+- Zeke Gabrielse
 - Samuel Cochran
-autorequire: 
+autorequire:
 bindir: bin
-cert_chain:
-- |
-  -----BEGIN CERTIFICATE-----
-  MIIDKDCCAhCgAwIBAgIBBTANBgkqhkiG9w0BAQUFADA6MQ0wCwYDVQQDDARzajI2
-  MRQwEgYKCZImiZPyLGQBGRYEc2oyNjETMBEGCgmSJomT8ixkARkWA2NvbTAeFw0x
-  NzA3MzEwNTQ3MDVaFw0xODA3MzEwNTQ3MDVaMDoxDTALBgNVBAMMBHNqMjYxFDAS
-  BgoJkiaJk/IsZAEZFgRzajI2MRMwEQYKCZImiZPyLGQBGRYDY29tMIIBIjANBgkq
-  hkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAsr60Eo/ttCk8GMTMFiPr3GoYMIMFvLak
-  xSmTk9YGCB6UiEePB4THSSA5w6IPyeaCF/nWkDp3/BAam0eZMWG1IzYQB23TqIM0
-  1xzcNRvFsn0aQoQ00k+sj+G83j3T5OOV5OZIlu8xAChMkQmiPd1NXc6uFv+Iacz7
-  kj+CMsI9YUFdNoU09QY0b+u+Rb6wDYdpyvN60YC30h0h1MeYbvYZJx/iZK4XY5zu
-  4O/FL2ChjL2CPCpLZW55ShYyrzphWJwLOJe+FJ/ZBl6YXwrzQM9HKnt4titSNvyU
-  KzE3L63A3PZvExzLrN9u09kuWLLJfXB2sGOlw3n9t72rJiuBr3/OQQIDAQABozkw
-  NzAJBgNVHRMEAjAAMAsGA1UdDwQEAwIEsDAdBgNVHQ4EFgQU99dfRjEKFyczTeIz
-  m3ZsDWrNC80wDQYJKoZIhvcNAQEFBQADggEBADGiXpvK754s0zTFx3y31ZRDdvAI
-  lA209JIjUlDyr9ptCRadihyfF2l9/hb+hLemiPEYppzG6vEK1TIyzbAR36yOJ8CX
-  4vPkCXLuwHhs6UIRbwN+IEy41nsIlBxmjLYei8h3t/G2Vm2oOaLdbjDXS+Srl9U8
-  shsE8ft81PxSQfzEL7Mr9cC9XvWbHW+SyTpfGm8rAtaqZkNeke4U8a0di4oz2EfA
-  P4lSfmXxsd1C71ckIp0cyXkPhyTtpyS/5hq9HhuUNzEHkSDe36/Rd1xYKV5JxMC2
-  YAttWFUs06lor2q1wwncPaMtUtbWwW35+1IV6xhs2rFY6DD/I6ZkK3GnHdY=
-  -----END CERTIFICATE-----
-date: 2017-12-10 00:00:00.000000000 Z
+cert_chain: []
+date: 2021-05-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sidekiq
@@ -36,56 +17,56 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '6.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '6.0'
 - !ruby/object:Gem::Dependency
   name: cronitor
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '2.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -100,9 +81,25 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-description: Integrates sidekiq with cronitor so that workers call run/complete/failed
-  around their perform methods
-email: sj26@sj26.com
+- !ruby/object:Gem::Dependency
+  name: bump
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+description: Integrates Sidekiq with Cronitor so that workers send lifecycle events
+  - run/complete/fail - around their perform methods
+email:
+- zeke@keygen.sh
+- sj26@sj26.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -111,11 +108,11 @@ files:
 - README.md
 - lib/sidekiq/cronitor.rb
 - lib/sidekiq/cronitor/version.rb
-homepage: https://github.com/sj26/sidekiq-cronitor
+homepage: https://github.com/cronitor/sidekiq-cronitor
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -126,13 +123,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.14
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
-summary: Monitor your sidekiq jobs with Cronitor
+summary: Monitor your Sidekiq jobs with Cronitor
 test_files: []

data.tar.gz.sig

@@ -1,2 +0,0 @@
-���h`�=��^�!1W�d?	Bx�B0n���c5���=�{=3�C�5.ΟwP��C�-O��o�K��!�p��f	��o����[����Պ����������`��
-��L���}��ܪ{*�xn7�O%Pl�c��h�����cm����sx���`���X���b�;��VS2��&�+���7\q"ةt ���c�]:��'za�[��`��B�0۽�:�?�龭KJbX��h��Is�