Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
minor improvement to readme
  • Loading branch information
mhfs committed Dec 8, 2012
1 parent 93f6741 commit 7380d53
Showing 1 changed file with 8 additions and 13 deletions.
21 changes: 8 additions & 13 deletions README.md
Expand Up @@ -5,8 +5,9 @@ them. Makes use of Sidekiq's custom tabs and middleware chain.

It mimics the way Resque keeps track of failures.

TIP: Note that each failed job/retry will create a new failed job that will
only be removed by you manually. This might result in a pretty big failures list.
TIP: Note that each failed job/retry might create a new failed job that will
only be removed by you manually. This might result in a pretty big failures list
depending on how you configure failures tracking in your workers.

## Installation

Expand All @@ -22,7 +23,7 @@ Depends on Sidekiq >= 2.2.1

## Usage and Modes

Simply having the gem in your Gemfile is enough to get you going. Your failed jobs will be visible via a Failures tab in the Web UI.
Simply having the gem in your Gemfile is enough to get you started. Your failed jobs will be visible via a Failures tab in the Web UI.

Sidekiq-failures offers three failures tracking options (per worker):

Expand All @@ -38,9 +39,7 @@ class MyWorker

sidekiq_options :failures => true

def perform
# hard work
end
def perform; end
end
```

Expand All @@ -56,9 +55,7 @@ class MyWorker

sidekiq_options :failures => :exhausted

def perform
# hard work
end
def perform; end
end
```

Expand All @@ -72,15 +69,13 @@ class MyWorker

sidekiq_options :failures => false

def perform
# hard work
end
def perform; end
end
```

## TODO

* Trigger retry of specific failed jobs via Web UI.
* Allow triggering retry of specific failed jobs via Web UI.

## Contributing

Expand Down

0 comments on commit 7380d53

Please sign in to comment.