forked from mhfs/sidekiq-failures
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update sidekiq and improve readme/gemspec
- Loading branch information
Showing
3 changed files
with
25 additions
and
13 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,30 +1,46 @@ | ||
# Sidekiq::Failures | ||
|
||
Keeps track of Sidekiq failed jobs and adds a tab to the Web UI to let you browse | ||
them. Makes use of Sidekiq's custom tabs and middlewares. | ||
them. Makes use of Sidekiq's custom tabs and middleware chain. | ||
|
||
It mimics the way Resque keeps track of failures. | ||
|
||
Note that each failed retry will create a new failed job. This might result in a | ||
prety big failures list. Think twice before using this project. In most cases | ||
automatic retries allied with exception notifications will be enough. | ||
pretty big failures list. Think twice before using this project. In most cases | ||
automatic retries allied to exception notifications will be enough. | ||
|
||
## Important Note! | ||
|
||
This is an ongoing, alpha level project. Be prepared that the API might change and bugs might occur. | ||
|
||
## Installation | ||
|
||
Add this line to your application's Gemfile: | ||
|
||
gem 'sidekiq-failures' | ||
```ruby | ||
gem 'sidekiq-failures' | ||
``` | ||
|
||
And then execute: | ||
## Dependencies | ||
|
||
$ bundle | ||
Depends on Sidekiq >= 2.2.1 | ||
|
||
## Usage | ||
|
||
Simply having the gem in your Gemfile should be enough. | ||
|
||
Your failed jobs will be visible via a Failures tab in the Web UI. | ||
|
||
## 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 | ||
|
||
## License | ||
|
||
Released under the MIT License. See the [LICENSE][license] file for further details. | ||
|
||
[license]: https://github.com/mhfs/sidekiq-failures/blob/master/LICENSE |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters