From: Rafael Zalamena <rzalamena@opensourcerouting.org>
Date: Mon, 13 Apr 2020 19:34:11 +0000 (-0300)
Subject: doc: update BFD debugging section
X-Git-Tag: base_7.4~84^2
X-Git-Url: https://git.puffer.fish/?a=commitdiff_plain;h=2b21c5500d049185d2569ad88598708dc19ab34c;p=matthieu%2Ffrr.git

doc: update BFD debugging section

Show more information about BFD debug feature.

Signed-off-by: Rafael Zalamena <rzalamena@opensourcerouting.org>
---

diff --git a/doc/user/bfd.rst b/doc/user/bfd.rst
index e6a3c4977a..32397d1303 100644
--- a/doc/user/bfd.rst
+++ b/doc/user/bfd.rst
@@ -476,13 +476,36 @@ You can also clear packet counters per session with the following commands, only
                 Session down events: 0
                 Zebra notifications: 4
 
-Logging / debugging
-===================
+Debugging
+=========
 
-There are no fine grained debug controls for bfdd. Just enable debug logs.
+By default only informational, warning and errors messages are going to be
+displayed. If you want to get debug messages and other diagnostics then make
+sure you have `debugging` level enabled:
 
 ::
 
    config
    log file /var/log/frr/frr.log debugging
    log syslog debugging
+
+You may also fine tune the debug messages by selecting one or more of the
+debug levels:
+
+.. index:: [no] debug bfd network
+.. clicmd:: [no] debug bfd network
+
+   Toggle network events: show messages about socket failures and unexpected
+   BFD messages that may not belong to registered peers.
+
+.. index:: [no] debug bfd peer
+.. clicmd:: [no] debug bfd peer
+
+   Toggle peer event log messages: show messages about peer creation/removal
+   and state changes.
+
+.. index:: [no] debug bfd zebra
+.. clicmd:: [no] debug bfd zebra
+
+   Toggle zebra message events: show messages about interfaces, local
+   addresses, VRF and daemon peer registrations.