Run-time log filtering via vtysh commands (#4524)

Run-time log filtering via vtysh commands

1 files changed, 28 insertions, 0 deletions

diff --git a/doc/user/basic.rst b/doc/user/basic.rst
index 3d3a75d4b..5509fd5f0 100644
--- a/doc/user/basic.rst
+++ b/doc/user/basic.rst
@@ -189,6 +189,29 @@ 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.
+
+   .. note::
+
+      Log filters help when you need to turn on debugs that cause significant
+      load on the system (enabling certain debugs can bring FRR to a halt).
+      Log filters prevent this but you should still expect a small performance
+      hit due to filtering each of all those logs.
+
+.. 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 +344,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