aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorBadlop <badlop@process-one.net>2009-02-13 19:27:56 +0000
committerBadlop <badlop@process-one.net>2009-02-13 19:27:56 +0000
commit3524172856fea6cc5be3e0987f1acb3fd1524d0b (patch)
tree9bc3a9aaf657ac377a9ec108dbe13a2891fd95b3 /doc
parentprevent from calling get_vh_registered_users/2 when not available (diff)
* src/ejabberd_system_monitor.erl: Allow parametrizable watchdog
threshold: option watchdog_large_heap or chatting with the watchdog bot (EJAB-545) * src/ejabberd_config.erl: Likewise * doc/guide.tex: Likewise * doc/guide.html: Likewise SVN Revision: 1872
Diffstat (limited to 'doc')
-rw-r--r--doc/guide.html12
-rw-r--r--doc/guide.tex14
2 files changed, 17 insertions, 9 deletions
diff --git a/doc/guide.html b/doc/guide.html
index 645ae6d5c..55ce1dc69 100644
--- a/doc/guide.html
+++ b/doc/guide.html
@@ -3366,14 +3366,16 @@ There are some simple and safe examples in the article
<H2 CLASS="section"><!--SEC ANCHOR --><A NAME="htoc87">7.3</A>&#XA0;&#XA0;<A HREF="#watchdog">Watchdog Alerts</A></H2><!--SEC END --><P> <A NAME="watchdog"></A>
</P><P><TT>ejabberd</TT> includes a watchdog mechanism that may be useful to developers
when troubleshooting a problem related to memory usage.
-If a process in the <TT>ejabberd</TT> server consumes a lot of memory,
+If a process in the <TT>ejabberd</TT> server consumes more memory than the configured threshold,
a message is sent to the Jabber accounts defined with the option
<TT>watchdog_admins</TT>
- in the <TT>ejabberd</TT> configuration file.
-Note that the threshold to define what is too much memory usage
-is only configurable editing the source code.
-Example configuration:
+ in the <TT>ejabberd</TT> configuration file.</P><P>The memory consumed is measured in <TT>words</TT>:
+a word on 32-bit architecture is 4 bytes, and a word on 64-bit architecture 8 bytes.
+The threshold by default is 1000000 words.
+This value can be configured with the option <TT>watchdog_large_heap</TT>,
+or in a conversation with the watchdog alert bot.</P><P>Example configuration:
</P><PRE CLASS="verbatim">{watchdog_admins, ["admin2@localhost", "admin2@example.org"]}.
+{watchdog_large_heap, 30000000}.
</PRE><P>To remove watchdog admins, remove them in the option.
To remove all watchdog admins, set the option with an empty list:
</P><PRE CLASS="verbatim">{watchdog_admins, []}.
diff --git a/doc/guide.tex b/doc/guide.tex
index e7ea7c13e..169dc612e 100644
--- a/doc/guide.tex
+++ b/doc/guide.tex
@@ -4428,15 +4428,22 @@ To exit the shell, close the window or press the keys: control+c control+c.
\ejabberd{} includes a watchdog mechanism that may be useful to developers
when troubleshooting a problem related to memory usage.
-If a process in the \ejabberd{} server consumes a lot of memory,
+If a process in the \ejabberd{} server consumes more memory than the configured threshold,
a message is sent to the Jabber accounts defined with the option
\term{watchdog\_admins}
\ind{options!watchdog\_admins} in the \ejabberd{} configuration file.
-Note that the threshold to define what is too much memory usage
-is only configurable editing the source code.
+
+The memory consumed is measured in \term{words}:
+a word on 32-bit architecture is 4 bytes,
+and a word on 64-bit architecture is 8 bytes.
+The threshold by default is 1000000 words.
+This value can be configured with the option \term{watchdog\_large\_heap},
+or in a conversation with the watchdog alert bot.
+
Example configuration:
\begin{verbatim}
{watchdog_admins, ["admin2@localhost", "admin2@example.org"]}.
+{watchdog_large_heap, 30000000}.
\end{verbatim}
To remove watchdog admins, remove them in the option.
@@ -4445,7 +4452,6 @@ To remove all watchdog admins, set the option with an empty list:
{watchdog_admins, []}.
\end{verbatim}
-
\appendix{}
\makechapter{i18ni10n}{Internationalization and Localization}