diff --git a/man/man5/monitorix.conf.5 b/man/man5/monitorix.conf.5 index 541f376..3c7ce77 100644 --- a/man/man5/monitorix.conf.5 +++ b/man/man5/monitorix.conf.5 @@ -242,17 +242,19 @@ This is the FTP server (ProFTPD or vsftpd) date format as it appears in the \fBf .P Default value: \fI%b %e\fP .RE -.P -.SS Alert capabilities -.BI enable_alerts +.SS Enable or disable graphs +.BI graph_enable .RS -This enables or disables the alert capabilities that were introduced in Monitorix version 1.4.0. Only two alerts are currently implemented; one for the average CPU load and one for the root filesystem disk use. They work as follows: +This enables or disables the monitoring of each graph. Placing a \fIy\fP on a desired graph and restarting Monitorix will automatically create the RRD file for that graph and start gathering information according to its settings. +.RE +.SS System load average and usage (system.rrd) +.BI alerts_enabled +.RS +This section enables or disables the alert capabilities for this graph. Only the alert for the average CPU load is currently implemented. It works as follows: .P -The CPU load average uses the third value (the one that represents the last 15 minutes of load average), and if it reaches the \fBloadavg_threshold\fP value for the interval of time defined in \fBloadavg_timeintvl\fP, Monitorix will execute the external alert script defined in \fBloadavg_script\fP. +The CPU load average uses the third value (the one that represents the last 15 minutes of the load average), and if it reaches the \fBloadavg_threshold\fP value for the interval of time defined in \fBloadavg_timeintvl\fP, Monitorix will execute the external alert script defined in \fBloadavg_script\fP. .P -For the root filesystem disk use, if the percentage of disk space used reaches the \fBrootfs_threshold\fP value for the interval of time defined in \fBrootfs_timeintvl\fP, Monitorix will execute the external alert script defined in \fBrootfs_script\fP. -.P -The default Monitorix installation includes an example alert shell-script called \fBmonitorix-alert.sh\fP which you can use as a base for your own script. +The default Monitorix installation includes an example of a shell-script alert called \fBmonitorix-alert.sh\fP which you can use as a base for your own script. .P Default value: \fIn\fP .RE @@ -287,45 +289,6 @@ It will receive the following three parameters: .P Default value: \fI/path/to/script.sh\fP .RE -.P -.BI rootfs_timeintvl -.RS -This is the period of time (in seconds) that the threshold needs to be exceeded before the external alert script is executed. -.P -Default value: \fI3600\fP -.RE -.P -.BI rootfs_threshold -.RS -This is the value that needs to be reached or exceeded within the specified time period in \fBrootfs_timeintvl\fP to trigger the mechanism for a particular action, which in this case is the execution of an external alert script. -.P -The value of this option is compared to the current root filesystem disk usage. -.P -Default value: \fI100\fP -.RE -.P -.BI rootfs_script -.RS -This is the full path name of the script that will be executed by this alert. -.P -It will receive the following three parameters: -.P -1st - the value currently defined in \fBrootfs_timeintvl\fP -.br -2nd - the value currently defined in \fBrootfs_threshold\fP -.br -3rd - the current root filesystem disk usage -.P -Default value: \fI/path/to/script.sh\fP -.RE -.P -.SS Enable or disable graphs -.BI graph_enable -.RS -This enables or disables the monitoring of each graph. Placing a \fIy\fP on a desired graph and restarting Monitorix will automatically create the RRD file for that graph and start gathering information according to its settings. -.RE -.SS System load average and usage (system.rrd) -Only the limit and rigid values may be set here. .SS Global kernel usage (kern.rrd) .BI graph_mode .RS @@ -664,6 +627,48 @@ This list complements the \fBlist\fP option. When Monitorix is started it tries .P You can define as much entries as you want. .RE +.P +.BI alerts_enabled +.RS +This section enables or disables the alert capabilities for this graph. Only the alert for the root filesystem disk usage is currently implemented. It works as follows: +.P +If the percentage of disk space used in the root filesystem reaches the \fBrootfs_threshold\fP value for the interval of time defined in \fBrootfs_timeintvl\fP, Monitorix will execute the external alert script defined in \fBrootfs_script\fP. +.P +The default Monitorix installation includes an example of a shell-script alert called \fBmonitorix-alert.sh\fP which you can use as a base for your own script. +.P +Default value: \fIn\fP +.RE +.P +.BI rootfs_timeintvl +.RS +This is the period of time (in seconds) that the threshold needs to be exceeded before the external alert script is executed. +.P +Default value: \fI3600\fP +.RE +.P +.BI rootfs_threshold +.RS +This is the value that needs to be reached or exceeded within the specified time period in \fBrootfs_timeintvl\fP to trigger the mechanism for a particular action, which in this case is the execution of an external alert script. +.P +The value of this option is compared to the current root filesystem disk usage. +.P +Default value: \fI100\fP +.RE +.P +.BI rootfs_script +.RS +This is the full path name of the script that will be executed by this alert. +.P +It will receive the following three parameters: +.P +1st - the value currently defined in \fBrootfs_timeintvl\fP +.br +2nd - the value currently defined in \fBrootfs_threshold\fP +.br +3rd - the current root filesystem disk usage +.P +Default value: \fI/path/to/script.sh\fP +.RE .SS Network traffic and usage (net.rrd) .BI list .RS @@ -739,6 +744,81 @@ The currently supported Greylist software is: .P Default value: \fImilter-greylist\fP .RE +.P +.BI alerts_enabled +.RS +This section enables or disables the alert capabilities for this graph. There are only two alerts implemented: the alert for the number of delivered messages and for the number of queued messages. They work as follows: +.P +If the number of delivered messages reaches the \fBdelvd_threshold\fP value for the interval of time defined in \fBdelvd_timeintvl\fP, Monitorix will execute the external alert script defined in \fBdelvd_script\fP. +.P +If the number of queued messages reaches the \fBmqueued_threshold\fP value for the interval of time defined in \fBmqueued_timeintvl\fP, Monitorix will execute the external alert script defined in \fBmqueued_script\fP. +.P +The default Monitorix installation includes an example of a shell-script alert called \fBmonitorix-alert.sh\fP which you can use as a base for your own script. +.P +Default value: \fIn\fP +.RE +.P +.BI delvd_timeintvl +.RS +This is the period of time (in seconds) that the threshold needs to be exceeded before the external alert script is executed. +.P +Default value: \fI60\fP +.RE +.P +.BI delvd_threshold +.RS +This is the value that needs to be reached or exceeded within the specified time period in \fBdelvd_timeintvl\fP to trigger the mechanism for a particular action, which in this case is the execution of an external alert script. +.P +The value of this option is compared against the number of delivered messages since the last \fBdelvd_timeintvl\fP seconds. +.P +Default value: \fI100\fP +.RE +.P +.BI delvd_script +.RS +This is the full path name of the script that will be executed by this alert. +.P +It will receive the following three parameters: +.P +1st - the value currently defined in \fBdelvd_timeintvl\fP +.br +2nd - the value currently defined in \fBdelvd_threshold\fP +.br +3rd - the number of delivered messages +.P +Default value: \fI/path/to/script.sh\fP +.RE +.P +.BI mqueued_timeintvl +.RS +This is the period of time (in seconds) that the threshold needs to be exceeded before the external alert script is executed. +.P +Default value: \fI3600\fP +.RE +.P +.BI mqueued_threshold +.RS +This is the value that needs to be reached or exceeded within the specified time period in \fBmqueued_timeintvl\fP to trigger the mechanism for a particular action, which in this case is the execution of an external alert script. +.P +The value of this option is compared with the number of messages in the mail queue. +.P +Default value: \fI100\fP +.RE +.P +.BI mqueued_script +.RS +This is the full path name of the script that will be executed by this alert. +.P +It will receive the following three parameters: +.P +1st - the value currently defined in \fBmqueued_timeintvl\fP +.br +2nd - the value currently defined in \fBmqueued_threshold\fP +.br +3rd - the number of messages in the mail queue +.P +Default value: \fI/path/to/script.sh\fP +.RE .SS Network port traffic (port.rrd) This graph requires the \fIiptables\fP command on Linux systems and the \fIipfw\fP command on FreeBSD and OpenBSD systems. .P