sidekiq-cronitor 1.0.0.alpha

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a9be623c484eb06cd00eb0c7687351252266e2f5
+  data.tar.gz: 473caa08118deaae2c4ff3985fdfe31fb59ad2f8
+SHA512:
+  metadata.gz: 66712be66af8fab84b8a41763f806bc411278841a984996e91e23cd841fdb2adcc2f49841ec1dc4417dfc9a9edffa602304fbbfdc04ffa27407c53b51cc8d714
+  data.tar.gz: c3f8671045720143dc77b8e686bafe12a5af8705969319a5f3181b3c8ab09f500c9883ec935ed13ce812ca19f579efce71bca028277b858308c3aadf8de3840e

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Samuel Cochran
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,106 @@
+# Sidekiq Cronitor
+
+Call a [Cronitor](https://cronitor.io) around your [Sidekiq](https://sidekiq.org) jobs.
+
+## Installation
+
+Add sidekiq-cronitor your application's Gemfile, near sidekiq:
+
+```ruby
+gem "sidekiq"
+gem "sidekiq-cronitor"
+```
+
+And then 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:
+
+```sh
+export CRONITOR_TOKEN="abcdef1234567890abcdef1234567890"
+sidekiq
+```
+
+Any sidekiq worker you'd like to monitor just includes `Sidekiq::Cronitor` right after `Sidekiq::Worker`:
+
+```ruby
+class MyWorker
+  include Sidekiq::Worker
+  include Sidekiq::Cronitor
+
+  def perform
+    # ...
+  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 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.
+
+You can also just supply a Cronitor instance to use directly:
+
+```ruby
+class MyWorker
+  include Sidekiq::Worker
+  include Sidekiq::Cronitor
+
+  sidekiq_options cronitor: Cronitor.new(...)
+
+  def perform
+    # ...
+  end
+end
+```
+
+## 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.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## 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.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/sidekiq/cronitor.rb

@@ -0,0 +1,111 @@
+require "sidekiq"
+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
+    #
+    # 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
+      end
+    end
+  end
+
+  def cronitor
+    self.class.cronitor
+  end
+
+  module ClassMethods
+    def cronitor
+      return @cronitor if defined? @cronitor
+
+      # Sidekiq always stores options as string keys, shallowly at least
+      opts = sidekiq_options.fetch("cronitor", {})
+
+      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
+
+      # If we're using Sidekiq::Cron and there's a job for this class then use
+      # it's cron schedule for a default not_on_schedudle rule, and tag this as
+      # a cron job
+      if defined?(Sidekiq::Cron) && job = Sidekiq::Cron::Job.all.find { |j| j.klass == name }
+        kwargs[:opts][:rules] ||= [{rule_type: "not_on_schedule", value: job.cron}]
+        kwargs[:opts][:tags] ||= ["cron-job", "sidekiq-cron", "sidekiq-cronitor"]
+      end
+
+      # Some hints about where this monitor came from
+      kwargs[:opts][:tags] ||= ["sidekiq-cronitor"]
+      kwargs[:opts][:note] ||= "Created by sidekiq-cronitor"
+
+      begin
+        @cronitor = Cronitor.new(**kwargs)
+      rescue Cronitor::Error => e
+        Sidekiq.logger.warn "Couldn't initialize Cronitor: #{e.to_s}"
+
+        @cronitor = nil
+      end
+    end
+  end
+
+  class Middleware
+    def call(worker, message, queue)
+      begin
+        ping worker, "run"
+
+        yield
+      rescue => e
+        ping worker, "failed", e.to_s
+
+        raise
+      else
+        ping worker, "complete"
+      end
+    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 cronitor? worker
+      worker.is_a?(Sidekiq::Cronitor) && worker.cronitor
+    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
+    end
+  end
+end

data/lib/sidekiq/cronitor/version.rb

@@ -0,0 +1,5 @@
+module Sidekiq
+  module Cronitor
+    VERSION = "1.0.0.alpha"
+  end
+end

metadata

@@ -0,0 +1,138 @@
+--- !ruby/object:Gem::Specification
+name: sidekiq-cronitor
+version: !ruby/object:Gem::Version
+  version: 1.0.0.alpha
+platform: ruby
+authors:
+- Samuel Cochran
+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-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sidekiq
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: cronitor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !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
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/sidekiq/cronitor.rb
+- lib/sidekiq/cronitor/version.rb
+homepage: https://github.com/sj26/sidekiq-cronitor
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.14
+signing_key: 
+specification_version: 4
+summary: Monitor your sidekiq jobs with Cronitor
+test_files: []