summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorOndrej Zajicek <santiago@crfreenet.org>2015-03-02 09:41:14 +0100
committerOndrej Zajicek <santiago@crfreenet.org>2015-03-02 09:41:14 +0100
commit8bcb5fb1e8a0718f88f99cde2f5b5a3bae5c4451 (patch)
treec4ce5adbef88e2b2b002d42e274773f424aa1f19 /doc
parent4e63974471c4e2f11781cda163e0dc2ac6fb72f9 (diff)
Implement latency tracking, internal event log and watchdog
Diffstat (limited to 'doc')
-rw-r--r--doc/bird.conf.example10
-rw-r--r--doc/bird.sgml17
2 files changed, 24 insertions, 3 deletions
diff --git a/doc/bird.conf.example b/doc/bird.conf.example
index dcc62e29..bbfe0020 100644
--- a/doc/bird.conf.example
+++ b/doc/bird.conf.example
@@ -33,6 +33,10 @@
# Turn on global debugging of all protocols
#debug protocols all;
+# Turn on internal watchdog
+#watchdog warning 5 s;
+#watchdog timeout 30 s;
+
# The direct protocol automatically generates device routes to
# all network interfaces. Can exist in as many instances as you wish
# if you want to populate multiple routing tables with device routes.
@@ -162,7 +166,7 @@ protocol static {
# };
# };
#}
-
+
#protocol bgp {
# disabled;
@@ -186,7 +190,7 @@ protocol static {
# source address 198.51.100.14; # What local address we use for the TCP connection
# password "secret"; # Password used for MD5 authentication
# rr client; # I am a route reflector and the neighor is my client
-# rr cluster id 1.0.0.1; # Use this value for cluster id instead of my router id
+# rr cluster id 1.0.0.1; # Use this value for cluster id instead of my router id
# export where source=RTS_STATIC;
# export filter {
# if source = RTS_STATIC then {
@@ -202,7 +206,7 @@ protocol static {
# reject;
# };
#}
-#
+#
# Template usage example
#template bgp rr_client {
# disabled;
diff --git a/doc/bird.sgml b/doc/bird.sgml
index 04d8284f..bcf1c8fb 100644
--- a/doc/bird.sgml
+++ b/doc/bird.sgml
@@ -344,6 +344,23 @@ protocol rip {
of connects and disconnects, 2 and higher for logging of all client
commands). Default: 0.
+ <tag>debug latency <m/switch/</tag>
+ Activate tracking of elapsed time for internal events. Recent events
+ could be examined using <cf/dump events/ command. Default: off.
+
+ <tag>debug latency limit <m/time/</tag>
+ If <cf/debug latency/ is enabled, this option allows to specify a limit
+ for elapsed time. Events exceeding the limit are logged. Default: 1 s.
+
+ <tag>watchdog warning <m/time/</tag>
+ Set time limit for I/O loop cycle. If one iteration took more time to
+ complete, a warning is logged. Default: 5 s.
+
+ <tag>watchdog timeout <m/time/</tag>
+ Set time limit for I/O loop cycle. If the limit is breached, BIRD is
+ killed by abort signal. The timeout has effective granularity of
+ seconds, zero means disabled. Default: disabled (0).
+
<tag>mrtdump "<m/filename/"</tag>
Set MRTdump file name. This option must be specified to allow MRTdump
feature. Default: no dump file.