]> git.proxmox.com Git - mirror_frr.git/commitdiff
doc: Add docs for log-filter and show log-filter
authorStephen Worley <sworley@cumulusnetworks.com>
Thu, 13 Jun 2019 20:07:08 +0000 (16:07 -0400)
committerStephen Worley <sworley@cumulusnetworks.com>
Wed, 19 Jun 2019 21:20:24 +0000 (17:20 -0400)
Add some user documentation for applying/deleting/showing
log filters with the new commands.

Signed-off-by: Stephen Worley <sworley@cumulusnetworks.com>
doc/user/basic.rst

index 3d3a75d4b1b420744bd9fe4dc0498b682c8631d8..8395087e8d7b39edcbcb8a0eda5ded51e46afe4b 100644 (file)
@@ -189,6 +189,22 @@ Basic Config Commands
    is used to start the daemon then this command is turned on by default
    and cannot be turned off and the [no] form of the command is dissallowed.
 
+.. index::
+   single: no log-filter WORD [DAEMON]
+   single: log-filter WORD [DAEMON]
+
+.. clicmd:: [no] log-filter WORD [DAEMON]
+
+   This command forces logs to be filtered on a specific string. A log message
+   will only be printed if it matches on one of the filters in the log-filter
+   table. Can be daemon independent.
+
+.. index:: log-filter clear [DAEMON]
+.. clicmd:: log-filter clear [DAEMON]
+
+   This command clears all current filters in the log-filter table. Can be
+   daemon independent.
+
 .. index:: service password-encryption
 .. clicmd:: service password-encryption
 
@@ -321,6 +337,11 @@ Terminal Mode Commands
    Shows the current configuration of the logging system. This includes the
    status of all logging destinations.
 
+.. index:: show log-filter
+.. clicmd:: show log-filter
+
+   Shows the current log filters applied to each daemon.
+
 .. index:: show memory
 .. clicmd:: show memory