proxmox-mirrors/mirror_frr
1
0
Fork 0
mirror of https://git.proxmox.com/git/mirror_frr synced 2025-08-05 10:08:41 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

doc: add unique-id & backtrace user docs

Browse Source 
Signed-off-by: David Lamparter <equinox@opensourcerouting.org>
This commit is contained in:
David Lamparter 2021-11-10 11:53:32 +01:00
parent 3942ee1f7b
commit de75bdc37b
1 changed files with 36 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
doc/user/basic.rst
View File

@ -244,6 +244,42 @@ Basic Config Commands
Use unbuffered output for log and debug messages; normally there is
some internal buffering.
.. clicmd:: log unique-id
Include ``[XXXXX-XXXXX]`` log message unique identifier in the textual part
of log messages. This is enabled by default, but can be disabled with
``no log unique-id``. Please make sure the IDs are enabled when including
logs for FRR bug reports.
The unique identifiers are automatically generated based on source code
file name, format string (before filling out) and severity. They do not
change "randomly", but some cleanup work may cause large chunks of ID
changes between releases. The IDs always start with a letter, consist of
letters and numbers (and a dash for readability), are case insensitive, and
``I``, ``L``, ``O`` & ``U`` are excluded.
This option will not affect future logging targets which allow putting the
unique identifier in auxiliary metadata outside the log message text
content. (No such logging target exists currently, but RFC5424 syslog and
systemd's journald both support it.)
.. clicmd:: debug unique-id XXXXX-XXXXX backtrace
Print backtraces (call stack) for specific log messages, identified by
their unique ID (see above.) Includes source code location and current
event handler being executed. On some systems you may need to install a
`debug symbols` package to get proper function names rather than raw code
pointers.
This command can be issued inside and outside configuration mode, and is
saved to configuration only if it was given in configuration mode.
.. warning::
Printing backtraces can significantly slow down logging calls and cause
log files to quickly balloon in size. Remember to disable backtraces
when they're no longer needed.
.. clicmd:: service password-encryption
Encrypt password.