Skip to content

julienXX/resque-slack

Repository files navigation

Resque Slack

A Resque plugin. Requires Resque >= 1.19 and a >= 1.9 Ruby (MRI, JRuby or Rubinius).

Post a notification in a Slack channel when one your jobs fails.

Installation

Add this line to your application's Gemfile:

gem 'resque-slack'

And then execute:

$ bundle

Or install it yourself as:

$ gem install resque-slack

Usage

Configure your channel, token and notification verbosity:

require 'resque/failure/slack'

Resque::Failure::Slack.configure do |config|
  config.channel = 'CHANNEL_ID'  # required
  config.token = 'TEAM_TOKEN'    # required
  config.level = verbosity_level # optional
end

Resque::Failure.backend = Resque::Failure::Slack

Level can be:

  • verbose: worker, payload, exception and full backtrace
  • compact: worker, payload and exception
  • minimal: worker and payload only

NB: Your team token is found here

Contributing

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Added some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request

Build Status Code Climate

About

Post failed Resque jobs notifications in a Slack channel

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages