-
Notifications
You must be signed in to change notification settings - Fork 82
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add receptorctl work results doc (#1064)
- Loading branch information
1 parent
9753cfb
commit ef41510
Showing
2 changed files
with
27 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,26 @@ | ||
------------ | ||
work results | ||
------------ | ||
|
||
.. contents:: | ||
:local: | ||
|
||
``receptorctl work results`` gets results for successfully completed, failed, stopped, or currently running, units of work. | ||
|
||
Command syntax: ``receptorctl --socket=<socket_path> work results [<<Options>>] <<Unit ID>> [...]`` | ||
|
||
``socket_path`` is the control socket address for the Receptor connection. | ||
The default is ``unix:`` for a Unix socket. | ||
Use ``tcp://`` for a TCP socket. | ||
The corresponding environment variable is ``RECEPTORCTL_SOCKET``. | ||
|
||
.. code-block:: text | ||
ss --listening --processes --unix 'src = unix:<socket_path>' | ||
Netid State Recv-Q Send-Q Local Address:Port Peer Address:Port Process | ||
u_str LISTEN 0 4096 /tmp/local.sock 38130170 * 0 users:(("receptor",pid=3226769,fd=7)) | ||
``ps -fp $(pidof receptor)`` | ||
``lsof -p <pid>`` | ||
|
||
``Unit ID`` is a unique identifier for a work unit (job). When running the ``work results`` command, you should specify the ``Unit ID`` for the Receptor node to which you are connected. |