Skip to content

Commit 1897599

Browse files
committed
trace: improve documentation for mi trace command
1 parent b269858 commit 1897599

File tree

1 file changed

+8
-2
lines changed

1 file changed

+8
-2
lines changed

modules/tracer/doc/tracer_admin.xml

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -346,7 +346,8 @@ modparam("tracer", "trace_id",
346346
</title>
347347
<para>
348348
Enable/disable tracing(globally or for a specific trace id) or dump
349-
info about trace ids.
349+
info about trace ids. This command requires named parameters
350+
(each parameter is ginven in the format param_name=param_value).
350351
</para>
351352
<para>
352353
Name: <emphasis>trace</emphasis>
@@ -392,7 +393,12 @@ modparam("tracer", "trace_id",
392393
MI FIFO Command Format:
393394
</para>
394395
<programlisting format="linespecific">
395-
opensips-cli -x mi trace tid2 on
396+
# Display global tracing mode and all trace destinations:
397+
opensips-cli -x mi trace
398+
# Turn off global tracing:
399+
opensips-cli -x mi trace mode=off
400+
# Turn on tracing for destination id tid2:
401+
opensips-cli -x mi trace id=tid2 mode=on
396402
</programlisting>
397403
</section>
398404

0 commit comments

Comments
 (0)