summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorStephen Worley <sworley@cumulusnetworks.com>2019-06-25 16:49:43 +0200
committerStephen Worley <sworley@cumulusnetworks.com>2019-06-25 16:49:43 +0200
commit018fa5f85dad6324c08b3f1fddf7553bc63819dd (patch)
tree9f81139df129a99dd648b27828396e68f2ea58bf /doc
parentlib: Remove extraneous spacing/output filter cmds (diff)
downloadfrr-018fa5f85dad6324c08b3f1fddf7553bc63819dd.tar.xz
frr-018fa5f85dad6324c08b3f1fddf7553bc63819dd.zip
doc: Add a performance note for log filtering
Add a not under the log-filter command to indicate that, while filtering reduces load on the system by large margins, there may still be a small performance hit from filtering those. Signed-off-by: Stephen Worley <sworley@cumulusnetworks.com>
Diffstat (limited to 'doc')
-rw-r--r--doc/user/basic.rst7
1 files changed, 7 insertions, 0 deletions
diff --git a/doc/user/basic.rst b/doc/user/basic.rst
index 8395087e8..5509fd5f0 100644
--- a/doc/user/basic.rst
+++ b/doc/user/basic.rst
@@ -199,6 +199,13 @@ Basic Config Commands
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]