| Shawn O. Pearce | 4016a93 | 2009-05-28 15:12:40 -0700 | [diff] [blame^] | 1 | gerrit show-queue |
| 2 | ================= |
| 3 | |
| 4 | NAME |
| 5 | ---- |
| 6 | gerrit show-queue - Display the background work queues, including replication |
| 7 | |
| 8 | SYNOPSIS |
| 9 | -------- |
| 10 | [verse] |
| 11 | 'ssh' -p <port> <host> 'gerrit show-queue' |
| 12 | |
| 13 | DESCRIPTION |
| 14 | ----------- |
| 15 | Presents a table of the pending background activity the Gerrit |
| 16 | daemon will perform in the near future. Gerrit contains an internal |
| 17 | scheduler, similar to cron, that it uses to queue and dispatch both |
| 18 | short and long term background activity. |
| 19 | |
| 20 | Tasks that are completed or cancelled exit the queue very quickly |
| 21 | once they enter this state, but it can be possible to observe tasks |
| 22 | in these states. |
| 23 | |
| 24 | ACCESS |
| 25 | ------ |
| 26 | Caller must be a member of the privileged 'Administrators' group. |
| 27 | |
| 28 | SCRIPTING |
| 29 | --------- |
| 30 | Intended for interactive use only. |
| 31 | |
| 32 | DISPLAY |
| 33 | ------- |
| 34 | |
| 35 | S:: |
| 36 | Current state of the task. States are: |
| 37 | + |
| 38 | * `D`: task is complete, but hasn't released its worker yet. |
| 39 | * `C`: task has been cancelled, but hasn't left the queue yet. |
| 40 | * `R`: task is actively running on a worker thread. |
| 41 | * `W`: task is ready to run, waiting for a worker thread. |
| 42 | * `S`: task is sleeping until its Start time. |
| 43 | |
| 44 | Start:: |
| 45 | Time (local to the server) that this task will begin |
| 46 | execution. Blank if the task is completed, running, or |
| 47 | ready to run but is waiting for a worker thread to become |
| 48 | available. |
| 49 | |
| 50 | Task:: |
| 51 | Short text description of the task that will be performed |
| 52 | at the given time. |
| 53 | |
| 54 | EXAMPLES |
| 55 | -------- |
| 56 | |
| 57 | The following queue contains two tasks scheduled to replicate the |
| 58 | `tools/gerrit.git` project to two different remote systems, `dst1` |
| 59 | and `dst2`: |
| 60 | |
| 61 | ==== |
| 62 | $ ssh -p 29418 review.example.com gerrit show-queue |
| 63 | S Start Task |
| 64 | -------------------------------------------------------------- |
| 65 | S 14:31:15.435 mirror dst1:/home/git/tools/gerrit.git |
| 66 | S 14:31:25.434 mirror dst2:/var/cache/tools/gerrit.git |
| 67 | -------------------------------------------------------------- |
| 68 | 2 tasks |
| 69 | ==== |
| 70 | |
| 71 | DEFECTS |
| 72 | ------- |
| 73 | There is a small race condition where tasks may disappear from the |
| 74 | output of this command while they transition from the ready/waiting |
| 75 | (`W`) or sleeping (`S`) state to the running (`R`) state. |
