Oban.Plugins.Stager (Oban v2.9.0) View Source

Transition jobs to the available state when they reach their scheduled time.

This module is necessary for the execution of scheduled and retryable jobs.

Options

  • :interval - the number of milliseconds between database updates. This is directly tied to the resolution of scheduled jobs. For example, with an interval of 5_000ms, scheduled jobs are checked every 5 seconds. The default is 1_000ms.
  • :limit — the number of jobs that will be staged each time the plugin runs. Defaults to 5,000, which you can increase if staging can't keep up with your insertion rate or decrease if you're experiencing staging timeouts.

Instrumenting with Telemetry

The Oban.Plugins.Stager plugin adds the following metadata to the [:oban, :plugin, :stop] event:

  • :staged_count - the number of jobs that were staged in the database

Link to this section Summary

Functions

Returns a specification to start this module under a supervisor.

Link to this section Types

Specs

option() ::
  {:conf, Oban.Config.t()}
  | {:name, GenServer.name()}
  | {:interval, pos_integer()}

Link to this section Functions

Returns a specification to start this module under a supervisor.

See Supervisor.