daveed/resque-notifier

# Resque::Notifier

[![Join the chat at https://gitter.im/resque-notifier/Lobby](https://badges.gitter.im/resque-notifier/Lobby.svg)](https://gitter.im/resque-notifier/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)

[![Gem Version](https://badge.fury.io/rb/resque-notifier.svg)](https://badge.fury.io/rb/resque-notifier)
[![Build Status](https://circleci.com/gh/daveed/resque-notifier.svg?style=shield&circle-token=6c0248354723eb52f17d7fcee18969620278f6a6)](https://circleci.com/gh/daveed/resque-notifier/tree/master)
[![Code Climate](https://codeclimate.com/github/daveed/resque-notifier/badges/gpa.svg)](https://codeclimate.com/github/daveed/resque-notifier) [![Test Coverage](https://codeclimate.com/github/daveed/resque-notifier/badges/coverage.svg)](https://codeclimate.com/github/daveed/resque-notifier/coverage)

Resque Notifier is a Resque plugin that sends notifications when a job fails.

## Requirements

Ruby 2.2.0

## Installation

Add this line to your application's Gemfile:

```ruby
gem 'resque-notifier'
```

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install resque-notifier

## Usage

### This gem activates a notifier when environment variables are set.

    example: Slack
    RESQUE_HOOK=https://hooks.slack.com/services/<generated_hash>
    RESQUE_CHANNEL="#channel-name"

### Optional environment variable for linking to resque-web

    example: if you access your failed jobs through resque-web on http://my.domain.com/resque/overview
    RESQUE_HOST=http://my.domain.com


### Add the Notifier backend to your existing Resque configuration (config/initializers/resque.rb)

```ruby
require 'resque/failure/notifier'
Resque::Failure::Multiple.classes = [Resque::Failure::Redis, Resque::Failure::Notifier]
Resque::Failure.backend = Resque::Failure::Multiple
```


## Example

If you are using Slack, you can define a channel to receive failed job messages. Multiple errors are ignored until they are cleared from Resque. Resque-Notifier will only send the first failed job of the same Class and Exception names. For example:

    Worker: mac000dwright.local:28852:*
    Class: http://my.domain.com/resque/failed/?class=User
    Exception: NoMethodError
    Error: undefined method `some_method' for nil:NilClass


## Contributing

1. Fork it ( https://github.com/[my-github-username]/resque-notifier/fork )
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create a new Pull Request