summaryrefslogtreecommitdiffstats
path: root/doc/user/basic.rst
diff options
context:
space:
mode:
authorStephen Worley <sworley@cumulusnetworks.com>2019-06-13 22:07:08 +0200
committerStephen Worley <sworley@cumulusnetworks.com>2019-06-19 23:20:24 +0200
commitc103b19f6d0aea06e5b994b8e462de70ddaee5a8 (patch)
treeefc831812218c1fbf43f0533e0021927b9935332 /doc/user/basic.rst
parentlib: Filter logs as they come in via macros (diff)
downloadfrr-c103b19f6d0aea06e5b994b8e462de70ddaee5a8.tar.xz
frr-c103b19f6d0aea06e5b994b8e462de70ddaee5a8.zip
doc: Add docs for log-filter and show log-filter
Add some user documentation for applying/deleting/showing log filters with the new commands. Signed-off-by: Stephen Worley <sworley@cumulusnetworks.com>
Diffstat (limited to 'doc/user/basic.rst')
-rw-r--r--doc/user/basic.rst21
1 files changed, 21 insertions, 0 deletions
diff --git a/doc/user/basic.rst b/doc/user/basic.rst
index 3d3a75d4b..8395087e8 100644
--- a/doc/user/basic.rst
+++ b/doc/user/basic.rst
@@ -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