Skip to content

Commit 841739b

Browse files
committed
flux-overlay(1): document trace subcommand
Problem: there is no documentation for flux overlay trace. Amend the flux-overlay(1) man page.
1 parent 27e7eec commit 841739b

File tree

1 file changed

+36
-0
lines changed

1 file changed

+36
-0
lines changed

doc/man1/flux-overlay.rst

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ SYNOPSIS
1414
| **flux** **overlay** **lookup** *target*
1515
| **flux** **overlay** **parentof** *rank*
1616
| **flux** **overlay** **disconnect** [*--parent=RANK*] *target*
17+
| **flux** **overlay** **trace** [*-r rank*] [*-t TYPE,...*] [*topic-glob*]
1718
1819

1920
DESCRIPTION
@@ -119,6 +120,41 @@ Disconnect a subtree rooted at *target* (hostname or rank).
119120
Set parent rank to *NODEID*. By default, the parent is determined from
120121
the topology.
121122

123+
trace
124+
-----
125+
126+
.. program:: flux overlay trace
127+
128+
Display message summaries for messages transmitted and received on the
129+
overlay network. A topic string glob pattern may be supplied as a positional
130+
argument.
131+
132+
.. option:: -r, --rank=NODEID
133+
134+
Filter output by overlay network peer rank. Note that this rank is not
135+
necessarily the same as the message source or destination.
136+
137+
.. option:: -t, --type=TYPE,...
138+
139+
Filter output by message type, a comma-separated list. Valid types are
140+
``request``, ``response``, ``event``, or ``control``.
141+
142+
.. option:: -L, --color=WHEN
143+
144+
Colorize output when supported; WHEN can be ``always`` (default if omitted),
145+
``never``, or ``auto`` (default).
146+
147+
.. option:: -H, --human
148+
149+
Display human-readable output. See also :option:`--color` and
150+
:option:`--delta`.
151+
152+
.. option:: -d, --delta
153+
154+
With :option:`--human`, display the time delta between messages instead
155+
of a relative offset since the last absolute timestamp.
156+
157+
122158

123159
EXAMPLES
124160
========

0 commit comments

Comments
 (0)