* doc/guide.tex: Watchdog alert documentation

* src/ejabberd.cfg.example: Likewise

SVN Revision: 790

3 files changed, 28 insertions, 0 deletions

diff --git a/ChangeLog b/ChangeLog
index 109219f96..c702bc98c 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,8 @@
+2007-06-25  Mickael Remond  <mickael.remond@process-one.net>
+
+	* doc/guide.tex: Watchdog alert documentation
+	* src/ejabberd.cfg.example: Likewise
+
 2007-06-22  Alexey Shchepin  <alexey@sevcom.net>
 
 	* src/mod_irc/mod_irc.erl: Added an option for default IRC
diff --git a/doc/guide.tex b/doc/guide.tex
index dbc70a8fb..55d2f6926 100644
--- a/doc/guide.tex
+++ b/doc/guide.tex
@@ -3178,6 +3178,24 @@ domain.
 %\label{backup}
 %\ind{backup}
 
+\section{Debugging}
+\label{debugging}
+\ind{debugging}
+
+\subsection{Watchdog alerts}
+\label{watchdog}
+\ind{debugging!watchdog}
+
+ejabberd including a watchdog mechanism to be notified in realtime
+through XMPP when any processus consumes too much memory.
+
+To enable the watchdog, add the \term{watchdog\_admins}
+\ind{options!watchdog\_admins} option in the config file:
+
+\begin{verbatim}
+{watchdog_admins, [``admin@localhost'']}.
+\end{verbatim}
+
 \appendix{}
 \section{Internationalization and Localization}
 \label{i18nl10n}
diff --git a/src/ejabberd.cfg.example b/src/ejabberd.cfg.example
index b5e5559e1..f649d71b5 100644
--- a/src/ejabberd.cfg.example
+++ b/src/ejabberd.cfg.example
@@ -45,6 +45,11 @@
 %{registration_watchers, ["admin1@localhost",
 %                         "admin2@localhost"]}.
 
+% Debug: 
+% watchdog admins receive live notifications on ejabberd process consuming too
+% much memory
+% {watchdog_admins, ["admin1@localhost"]}.
+
 % Only admins can send announcement messages:
 {access, announce, [{allow, admin}]}.