Add receptorctl traceroute documentation (#1038)

ansible · May 20, 2024 · b2f85b4 · b2f85b4
1 parent 6cb0a16
commit b2f85b4
Show file tree

Hide file tree

Showing 5 changed files with 28 additions and 3 deletions.
diff --git a/docs/source/receptorctl/receptorctl_index.rst b/docs/source/receptorctl/receptorctl_index.rst
@@ -11,4 +11,5 @@ The Receptor client, ``receptorctl``, provides a command line interface for inte
 
    receptorctl_ping
    receptorctl_status
+   receptorctl_traceroute
    receptorctl_work_list
diff --git a/docs/source/receptorctl/receptorctl_ping.rst b/docs/source/receptorctl/receptorctl_ping.rst
@@ -21,7 +21,7 @@ Command syntax: ``receptorctl --socket=<socket_path> [--count <count>] [--delay
   u_str         LISTEN         0              4096                   /tmp/local.sock 38130170                            * 0            users:(("receptor",pid=3226769,fd=7))
 
 ``ps -fp $(pidof receptor)``
-``lsof -p <<pid>``
+``lsof -p <pid>``
 
 ``count`` specifies the number of pings to send.  The value must be a positive integer. The default is ``4``.
 

diff --git a/docs/source/receptorctl/receptorctl_status.rst b/docs/source/receptorctl/receptorctl_status.rst
@@ -21,7 +21,7 @@ Command syntax: ``receptorctl --socket=<socket_path> status [--json]``
   u_str         LISTEN         0              4096                   /tmp/local.sock 38130170                            * 0            users:(("receptor",pid=3226769,fd=7))
 
 ``ps -fp $(pidof receptor)``
-``lsof -p <<pid>``
+``lsof -p <pid>``
 
 ``--json`` option returns the output in JSON format.
    The default output format is human-readable.

diff --git a/docs/source/receptorctl/receptorctl_traceroute.rst b/docs/source/receptorctl/receptorctl_traceroute.rst
@@ -0,0 +1,24 @@
+----------
+traceroute
+----------
+
+.. contents::
+   :local:
+
+``receptorctl traceroute`` Displays the network route that packets follow to Receptor nodes.
+
+Command syntax: ``receptorctl --socket=<socket_path> traceroute <remote_node>``
+
+``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>``
diff --git a/docs/source/receptorctl/receptorctl_work_list.rst b/docs/source/receptorctl/receptorctl_work_list.rst
@@ -21,7 +21,7 @@ Command syntax: ``receptorctl --socket=<socket_path> work list``
   u_str         LISTEN         0              4096                   /tmp/local.sock 38130170                            * 0            users:(("receptor",pid=3226769,fd=7))
 
 ``ps -fp $(pidof receptor)``
-``lsof -p <<pid>``
+``lsof -p <pid>``
 
 The output is divided into work unit sections listed below.
 Field values might be listed separately.