SextantDocs
v2.4latest
v2.4latestv1.9legacy

Switching keeps you on the same page when it exists in the other version.

On this page

queuesBeta

List queues with their depth and throughput, and pause or resume them without restarting anything.

Updated CLI reference Version v2.4

Queues are declared in the config file. The CLI reads their state and pauses them.

Text
sextant queues list      List queues with depth and throughput
sextant queues pause     Stop workers from starting new jobs
sextant queues resume    Let workers start jobs again

queues list

Shell
$ sextant queues list
QUEUE    STATE    CONCURRENCY  QUEUED  RUNNING  FAILED  DEAD  WAIT(P95)
default  running  10           3       2        0       0     40 ms
emails   running  20           41      12       2       0     830 ms
reports  paused   2            18      0        0       0     n/a

Add --watch to refresh every two seconds.

Pause and resume a queue

Shell
sextant queues pause reports --reason "warehouse migration"
sextant queues resume reports

While a queue is paused:

  • it keeps accepting jobs, which wait as queued;
  • running jobs finish normally;
  • no new job starts on any worker;
  • scheduled jobs still become queued at their time.
--reasonstring optional
Free text stored with the pause and shown in queues list -o json.
--forduration optional
Resume automatically after this long.

A pause survives server restarts: it is stored, not held in memory. The same actions are available as POST /v2/queues/{queue}/pause and /resume in the Queues API.