Sidekiq::Scheduler::Notification
Simple notification middleware with slack when invoke/error/finish to sidekiq jobs.
Installation
Add this line to your application's Gemfile:
gem 'sidekiq-scheduler-notification'
And then execute:
$ bundle
Or install it yourself as:
$ gem install sidekiq-scheduler-notification
Usage
Added following configuration to initializer like config/initializer/sidekiq.rb
SidekiqScheduler::Scheduler.notify_webhook = "https://hooks.slack.com/services/xxx/yyyzzz"
and append notification
variable into schedule.yml
used by sidekiq-scheduler. like this
NotificationJob:
cron: "15 * * * *"
notification: true
Finally, You need to load schedule.yml
at first before loading to this gem. You can add to read schedule.yml to sidekiq startup hook.
Sidekiq.options[:lifecycle_events][:startup].unshift -> {
Sidekiq.schedule = YAML.load_file(File.expand_path("../../../config/scheduler.yml",__FILE__))
}
Development
After checking out the repo, run bin/setup
to install dependencies. Then, run rake test
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.
Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/hsbt/sidekiq-scheduler-notification.
License
The gem is available as open source under the terms of the MIT License.