oban-bg / oban

💎 Robust job processing in Elixir, backed by modern PostgreSQL and SQLite3
https://oban.pro
Apache License 2.0
3.37k stars 313 forks source link

Documentation request: What happens if a job times out? #1136

Closed kybishop closed 3 months ago

kybishop commented 3 months ago

The documentation on timeouts does a great job of explaining how to add a timeout to a job, but does not explain what happens if a timeout occurs. Does it return {:error, :timeout}? Does it simply fail?

Would love to see the consequences of adding a timeout so we can plan accordingly in our error handlers 🙇

sorentwo commented 3 months ago

Does it return {:error, :timeout}? Does it simply fail?

The short answer is that it errors with an Oban.TimeoutError. We'll update the docs with that info.