gerrit/Documentation/cmd-show-queue.txt
Shawn O. Pearce 3f1a13afb3 kill: Support killing any queued task by interrupting it
We probably don't have enough cancellation points in our code to
really kill most tasks before they fully complete.  For example,
most of the JGit upload-pack and receive-pack code path uses
NullProgressMonitor, which unfortunately does not check if the
calling thread has been interrupted.

Change-Id: I57379ba77d7aefc720421d74771fb65ab6be61fa
Signed-off-by: Shawn O. Pearce <sop@google.com>
2009-11-21 13:34:56 -08:00

79 lines
2.1 KiB
Plaintext

gerrit show-queue
=================
NAME
----
gerrit show-queue - Display the background work queues, including replication
SYNOPSIS
--------
[verse]
'ssh' -p <port> <host> 'ps'
'ssh' -p <port> <host> 'gerrit show-queue'
DESCRIPTION
-----------
Presents a table of the pending activity the Gerrit daemon
is currently performing, or will perform in the near future.
Gerrit contains an internal scheduler, similar to cron, that it
uses to queue and dispatch both short and long term activity.
Tasks that are completed or cancelled exit the queue very quickly
once they enter this state, but it can be possible to observe tasks
in these states.
ACCESS
------
Caller must be a member of the privileged 'Administrators' group.
SCRIPTING
---------
Intended for interactive use only.
DISPLAY
-------
Task::
Unique task identifier on this server. May be passed into
link:cmd-kill.html[kill] to cancel or terminate the task.
Task identifiers have a period of 2\^32-1, and start from
a random value.
State::
If running, blank.
+
If the task has completed, but has not yet been reaped, 'done'.
If the task has been killed, but has not yet halted or been removed
from the queue, 'killed'.
+
If the task is ready to execute but is waiting for an idle thread
in its associated thread pool, 'waiting'.
+
Otherwise the time (local to the server) that this task will begin
execution.
Command::
Short text description of the task that will be performed
at the given time.
EXAMPLES
--------
The following queue contains two tasks scheduled to replicate the
`tools/gerrit.git` project to two different remote systems, `dst1`
and `dst2`:
====
$ ssh -p 29418 review.example.com gerrit show-queue
Task State Command
------------------------------------------------------------------------------
7aae09b2 14:31:15.435 mirror dst1:/home/git/tools/gerrit.git
9ad09d27 14:31:25.434 mirror dst2:/var/cache/tools/gerrit.git
------------------------------------------------------------------------------
2 tasks
====
GERRIT
------
Part of link:index.html[Gerrit Code Review]