Skip to content

Commit

Permalink
Document that timeouts raise an Oban.TimeoutError
Browse files Browse the repository at this point in the history
Closes #1136
  • Loading branch information
sorentwo committed Aug 13, 2024
1 parent bf7f0bf commit eec82cc
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -772,6 +772,10 @@ Define the `timeout` based on the number of attempts:
def timeout(%_{attempt: attempt}), do: attempt * :timer.seconds(5)
```

If the job fails to execute before the timeout period then it will error with a dedicated
`Oban.TimeoutError` exception. Timeouts are treated like any other failure and the job will be
retried as usual if more attempts are available.

## Instrumentation, Error Reporting, and Logging

Oban provides integration with [Telemetry][tele], a dispatching library for
Expand Down

0 comments on commit eec82cc

Please sign in to comment.