Skip to content

Schedule Tasks

Tasks let you run background jobs on a schedule: trigger an Event periodically, purge old Occurrences, refresh a monitor and so on.

Task list

The list at https://SERVER_ADDRESS/admin/bitcaster/task/ ⧉ shows the name, the function, the scheduling and whether the task is active.

Add a task

  1. Click Add task
  2. Provide a name and a slug
  3. Set func to the fully qualified name of the dramatiq actor to run (e.g. bitcaster.runner.tasks.scan_occurrences)
  4. Optionally add args and kwargs passed to the function
  5. Choose the trigger type and its configuration:
  6. interval — run every N seconds/minutes/hours/days
  7. cron — run according to a crontab expression
  8. date — run once at a given time
  9. Save

Run and monitor

  • active — enable or disable the task without deleting it
  • next run time — when the task will run next (update it to reschedule)
  • replace existing — replace a running instance with the same id
  • max instances — maximum number of concurrent instances

Executions are recorded in the Process Log.