Oban v0.12.0 is out with some fun features, testing improvements, bug fixes and a helpful (optional) migration for large pruning operations. Thanks to all of the contributors who made this one possible!
From the CHANGELOG
Migration Optional (V7)
The queries used to prune by limit and age are written to utilize a single partial index for a huge performance boost on large tables. The new V7 migration will create the index for you—but that may not be ideal for tables with millions of completed or discarded jobs because it can’t be done concurrently.
If you have an extremely large jobs table you can add the index concurrently in a dedicated migration:
create index(
:oban_jobs,
["attempted_at desc", :id],
where: "state in ('completed', 'discarded')",
name: :oban_jobs_attempted_at_id_index,
concurrently: true
)
Added
-
[Oban] Add
start_queue/3andstop_queue/2for dynamically starting and stopping supervised queues across nodes. -
[Oban] Add
drain_queue/3to accept drain options.with_scheduled: trueallows draining scheduled jobs. -
[Oban] Expose
circuit_backoffas a “twiddly” option that controls how long tripped circuit breakers wait until re-opening. -
[Oban.Testing] Accept a value/delta tuple for testing timestamp fields. This allows more robust testing of timestamps such as
scheduled_at. -
[Oban.Telemetry] Emit
[:oban, :trip_circuit]and[:oban, :open_circuit]events for circuit breaker activity. Previously an error was logged when the circuit was tripped, but there wasn’t any way to monitor circuit breakers.Circuit breaker activity is logged by the default telemetry logger (both
:trip_circuitand:open_circuitevents).
Fixed
-
[Oban.Query] Avoid using prepared statements for all unique queries. This forces Postgres to use a custom plan (which utilizes the compound index) rather than falling back to a generic plan.
-
[Oban.Job] Include all permitted fields when converting a Job to a map, preserving any optional values that were either specified by the user or came via Worker defaults.
-
[Oban.Migrations] Guard against missing migration modules in federated environments.
Changed
-
[Oban] Allow the multi
nameprovided toOban.insert/3,4to be any term, not just an atom. -
[Oban.Query] Use a consistent and more performant set of queries for pruning. Both pruning methods are optimized to utilize a single partial index.
