diff --git a/man/man5/monitorix.conf.5 b/man/man5/monitorix.conf.5 index d03a318..370bfc6 100644 --- a/man/man5/monitorix.conf.5 +++ b/man/man5/monitorix.conf.5 @@ -966,7 +966,7 @@ The following is an example of an alert defined for the root filesystem: .P .RE -Such alert means that if the percentage of disk space used in the root filesystem reaches or exceeds 98 during at least one hour (3600 seconds) the script in \fI/path/to/script\fP will be executed. +Such alert means that if the percentage of disk space used in the root filesystem reaches or exceeds 98 (more than 98) during at least one hour (3600 seconds) the script in \fI/path/to/script\fP will be executed. .P The external script will receive the following arguments: .P @@ -1409,6 +1409,43 @@ WARNING: Every time the number of entries in this option changes, Monitorix will .P Default value: \fIhttp://localhost/server-status?auto\fP .RE +.P +.BI alerts +.RS +This optional list enables the alert capabilities for this graph and complements with the \fBlist\fP option. Each alert has three fields separated by comma: the \fItime interval\fP, the \fIthreshold\fP and the path to the \fIscript\fP to be executed. +.P +The \fItime interval\fP is the period of time (in seconds) that the \fIthreshold\fP needs to be exceeded before the external script is executed. +.P +The \fIthreshold\fP is the number of remaining free slots that needs to be reached or exceeded within the specified time in \fItime interval\fP to execute the external script. +.P +The \fIscript\fP is the full path name of the script that will be executed by this alert. +.P +Each defined Apache has its own alert. +.P +The default Monitorix installation includes an example of a shell-script alert called \fImonitorix-alert.sh\fP which you can use as a base for your own script. +.P +The following is an example of an alert defined for the local Apache: +.P +.RS + +.br + http://localhost/server-status?auto = 3600, 5, /path/to/script +.br + +.P +.RE +Such alert means that if the remaining free slots reaches or exceeds 5 (less than 5) during at least one hour (3600 seconds) the script in \fI/path/to/script\fP will be executed. +.P +The external script will receive the following arguments: +.P +.RS +1st - the value defined as \fItime interval\fP. +.br +2nd - the value defined as \fIthreshold\fP. +.br +3rd - the remaining free slots. +.P +.RE .SS Nginx statistics (nginx.rrd) This graph may require adding some lines in the configuration file \fInginx.conf\fP. Please see the \fIREADME.nginx\fP file to determine the exact steps needed to configure Nginx to get status information. .P