This enables or disables the HTTP server that Monitorix has built-in. This is specially useful for system administrators that don't want to install a web server (Apache, Lighttpd, Nginx, etc.) to see the Monitorix graphs.

Default value: y

This option takes an optional host address for this server to bind to. If none is specified (default) it will bind to all interfaces.

Default value:

This is the network port from where the HTTP server will listen on.

Default value: 8080

This sets the user and group that the HTTP server will run as.

Default value for user: nobody
Default value for group: nobody

This is the path to the HTTP server log file.

Default value: /var/log/monitorix-httpd

This is a comma delimited set of IP addresses which are not permitted to access Monitorix graphs. There is the special keyword called all that can be used to deny all IP addresses.

The access control uses the same approach as in the TCP-Wrappers; the search stops at the first match:

- Access will be granted when an IP address matches an entry in the hosts_allow list.
- Otherwise, access will be denied when an IP address matches an entry in the hosts_deny list.
- Otherwise, access will be granted.

Default value:

This is the opposite of hosts_deny option. IP addresses listed here are permitted to access Monitorix graphs. There is also the special keyword called all that can be used to allow access to all IP addresses.

Default value:

This will force to use the prefix https:// in all links. This is special useful if you plan to use a reverse-proxy HTTPS server in front of the Monitorix built-in HTTP.

Default value: n

This enables or disables the authentication mechanism to control access to pages and other resources. The only allowed mechanism is Basic and uses the 401 status code and the WWW-Authenticate response header.

It's highly recommended to set this option according your needs before start Monitorix.

For more information about the Basic access authentication mechanism and its security implications, please refer to http://en.wikipedia.org/wiki/Basic_access_authentication.

Default value: n

This option sets the Realm to be used in the authentication. That message should appear in the client dialog box to help user to identify the secure area.

Default value: Monitorix: Restricted access

This option sets the path to the password file that was created with the help of the htpasswd.pl script. That script encrypts and validates passwords using the system's crypt() routine. If your Monitorix package doesn't come with that script, you may use the similar htpasswd(1) program provided with the Apache web server.

The format of the password file consist of one or more lines with a username and password separated by a colon.

The following is an example of a password file:

paul:oGkEsQK6RYIII
peter:HF1r7qRL4Kg6E

Since the script uses the crypt() algorithm, only the first 8 characters of the password are used to form the password. If the supplied password is longer, the extra characters will be silently discarded.

WARNING: don't use the character colon ':' as part of your name or password since this character is used as field separator.

Default value: /var/lib/monitorix/htpasswd

This is the path to the Monitorix log file. Please check this file periodically and especially after every update to confirm proper operation.

Default value: /var/log/monitorix

This is the path to the system log (also known as auth.log, etc.) Monitorix uses this file to report SSH, POP3, FTP and Telnet successful logins.

Default value: /var/log/secure

This is the path to the mail log file. Monitorix uses this file to report messages sent (supporting Sendmail and Postfix formats), and the MailScanner log format for spam-mail and virus-mail alerts.

Default value: /var/log/maillog

This is the path to the dump file of milter-greylist.

Default value: /var/milter-greylist/greylist.db

This is the path to the IMAP (Dovecot or UW-IMAP) log file. Monitorix uses this file to report IMAP and POP3 successful logins.

Default value: /var/log/imap

This is the path to the Hylafax log file. Monitorix uses this file to report successful FAX dispatches.

Default value: /var/spool/hylafax/etc/xferfaxlog

This is the path to the CUPS page log file. Monitorix uses this file to report on print jobs.

Default value: /var/log/cups/page_log

This is the path to the FTP server (ProFTPD, vsftpd or Pure-FTPd) log. Monitorix uses this file to report FTP successful logins and other FTP-related information.

Default value: /var/log/proftpd/access.log

This is the path to the Fail2ban log file. Monitorix uses this file to report IP addresses banned.

Default value: /var/log/fail2ban.log

This is the path to the Spamassassin log file. Monitorix uses this file to report spam-mail alerts.

Default value: /var/log/maillog

This is the path to the Clamav log file. Monitorix uses this file to report virus-mail alerts.

Default value: /var/log/clamav/clamav.log

This is the path to the CommuniGate logs directory. Monitorix uses these files to report the number of mail messages successfully received and sent, and to report IMAP and POP3 successful logins.

Default value: /var/CommuniGate/SystemLogs/

This is the path to the Squid log file. Monitorix uses this file to report on Squid Proxy requests.

Default value: /var/log/squid/access.log

This is the Dovecot date format as it appears in the imap_log file.

Default value: %b %d

This is secure_log date format.

Default value: %b %e

This enables the inclusion of the Piwik tracking code in the main index.html file. Please refer to http://piwik.org/docs/tracking-api/ for more information on how to fill these fields.

Default value: n

This enables or disables the monitoring of each graph. Placing a y on a desired graph and restarting Monitorix will automatically create the RRD file for that graph and start gathering information according to its settings.

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:

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 loadavg_threshold value for the interval of time defined in loadavg_timeintvl, Monitorix will execute the external alert script defined in loadavg_script.

The default Monitorix installation includes an example of a shell-script alert called monitorix-alert.sh which you can use as a base for your own script.

Default value: n

This is the period of time (in seconds) that the threshold needs to be exceeded before the external alert script is executed.

Default value: 3600

This is the value that needs to be reached or exceeded within the specified time period in loadavg_timeintvl to trigger the mechanism for a particular action, which in this case is the execution of an external alert script.

The value of this option is compared against the last 15 minutes of CPU load average.

Default value: 5.0

This is the full path name of the script that will be executed by this alert.

It will receive the following three parameters:

1st - the value currently defined in loadavg_timeintvl.
2nd - the value currently defined in loadavg_threshold.
3rd - the current 15min CPU load average.

Default value: /path/to/script.sh

This changes the layout of the kernel usage graph, the possible values are r for a real graph, or s for a stacked graph (every line or area is stacked on top of the previous element).

Default value: r

This is the list of values offered in modern Linux kernels. Older Linux kernels or other Operating Systems may not have all of them. Placing a y or an n will enable or disable the value in the graph.

This is the number of processors or cores that your system has. There is no limit, however keep in mind that every time this number is changed Monitorix will resize the proc.rrd file accordingly, removing all historical data.

Default value: 4

This is the number of processor graphs that will be put in a row. Consider the interaction of this parameter with the size and data options (below) in order to adjust the size and number of graphs in relation to your horizontal screen size.

Default value: 2

This option sets the size of all processors graphs.

The possible values are:

Default value: medium

This option will completely enable or disable the legend in the processor graphs.

Default value: y

This list will hold the defined temperature sensors for each graph. You must have installed the command hplog that comes with HP ProLiant System Health Application and Command Line Utilities.

Each graph has a limited number of IDs:

graph_0 up to 8 IDs.
graph_1 up to 6 IDs.
graph_2 up to 6 IDs.

The following is a configuration example of selected IDs:

# hplog -t
ID TYPE LOCATION STATUS CURRENT THRESHOLD 1 Basic Sensor Ambient Normal 75F/ 24C 107F/ 42C 2 Basic Sensor CPU (1) Normal 104F/ 40C 179F/ 82C 3 Basic Sensor CPU (2) Normal ---F/---C 179F/ 82C 4 Basic Sensor Memory Board Normal ---F/---C 188F/ 87C 5 Basic Sensor Memory Board Normal 82F/ 28C 188F/ 87C 6 Basic Sensor Memory Board Normal ---F/---C 188F/ 87C 7 Basic Sensor System Board Normal 89F/ 32C 192F/ 89C 8 Basic Sensor System Board Normal ---F/---C 192F/ 89C 9 Basic Sensor System Board Normal 84F/ 29C 192F/ 89C
10 Basic Sensor System Board Normal 118F/ 48C 230F/110C
11 Basic Sensor System Board Normal 96F/ 36C 192F/ 89C
12 Basic Sensor System Board Normal 84F/ 29C 154F/ 68C
13 Basic Sensor System Board Normal 87F/ 31C 154F/ 68C
14 Basic Sensor System Board Normal 89F/ 32C 156F/ 69C
15 Basic Sensor System Board Normal 93F/ 34C 161F/ 72C
16 Basic Sensor Ambient Normal ---F/---C 192F/ 89C
17 Basic Sensor System Board Normal ---F/---C 192F/ 89C
18 Basic Sensor SCSI Backplane Normal 32F/ 0C 140F/ 60C

This optional list enables the alert capabilities for this graph and complements with the list option. Each alert has three fields separated by comma: the time interval, the threshold and the path to the script to be executed.

The time interval is the period of time (in seconds) that the threshold needs to be exceeded before the external script is executed.

The threshold is the temperature that needs to be reached or exceeded within the specified time in time interval to execute the external script.

The script is the full path name of the script that will be executed by this alert.

Each defined sensor has its own alert.

The default Monitorix installation includes an example of a shell-script alert called monitorix-alert.sh which you can use as a base for your own script.

The following is an example of an alert defined for the first temperature sensor:

Such alert means that if the value of the sensor number 2 reaches or exceeds 40 during at least one hour (3600 seconds) the script in /path/to/script will be executed.

The external script will receive the following arguments:

In this list you may specify the sensors you want to monitor with the same names as they appear in your sensors(1) command.

For example, imagine a sensors(1) output like this:

# sensors
coretemp-isa-0000
Adapter: ISA adapter
Core 0: +51.0°C (high = +78.0°C, crit = +100.0°C)

coretemp-isa-0001
Adapter: ISA adapter
Core 1: +49.0°C (high = +78.0°C, crit = +100.0°C)

f71882fg-isa-0a00
Adapter: ISA adapter
3.3V: +3.30 V
Vcore: +1.21 V (max = +2.04 V)
Vdimm: +1.82 V
Vchip: +1.38 V
+5V: +5.00 V
12V: +14.37 V
5VSB: +4.33 V
3VSB: +3.30 V
Battery: +3.22 V
CPU: 2035 RPM
System: 1765 RPM ALARM
Power: 2110 RPM ALARM
Aux: 2080 RPM ALARM
M/B Temp: +36.00 C
CPU Temp: +29.00 C

Then you may want to configure that list as:

Note that you need to escape the plus and minus signs in the voltage labels. It also recommended to enclose the values using double quotes.

The last one, gpu0, is set here just in case you have a supported graphics card and want to monitor its temperature. Currently only NVIDIA and ATI graphic cards are supported; with the values nvidia and ati respectively. It requires the official NVIDIA or ATI drivers.

This list has the following maximums allowed:

This list complements the list option. It basically allows you to change the name that will appear in the graph, hiding the real name of the sensor. If no association is defined, then Monitorix will display the name of the key (left side) in the desc option (in uppercase in some graphs).

Please note that in the default graph all names are limited to 5 characters in order to fit up to 9 different values. In the zoomed graphs the limit is 8 characters.

This optional list enables the alert capabilities for this graph and complements with the list option. Each alert has three fields separated by comma: the time interval, the threshold and the path to the script to be executed.

The time interval is the period of time (in seconds) that the threshold needs to be exceeded before the external script is executed.

The threshold is the temperature or volts, or whatever that needs to be reached or exceeded within the specified time in time interval to execute the external script.

The script is the full path name of the script that will be executed by this alert.

Each defined sensor has its own alert.

The default Monitorix installation includes an example of a shell-script alert called monitorix-alert.sh which you can use as a base for your own script.

The following is an example of an alert defined for the first temperature sensor:

Such alert means that if the value of the sensor core0 reaches or exceeds 40 during at least one hour (3600 seconds) the script in /path/to/script will be executed.

The external script will receive the following arguments:

This is a fixed list that can only hold two keys (0 and 1). Each key though can hold up to 9 different entries separated by comma which corresponds to the names of the sensors present in your computer. The key 0 is only for temperature sensors and the key 1 is for CPU frequencies. All this is hard-coded and a bit rigid currently but it might change in the future.

An example would be:

In this option you must associate the complete pathname of the file from where to get the value of each entry defined in the list. Following the settings in the example above:

With this option you can define the order of magnitude associated to a specific value. This is used in both temperatures and CPU frequencies, since this kind of temperature sensors tend to give the value in 1000ths of degrees Celsius. In the case of CPU frequencies the values come in Mhz which means that they need to be converted to Hz by multiplying them by 1000. Therefore you can define something like this:

With this option you can optionally rename any of the sensor names defined in the list option. Following the above example:

All names are limited to 20 characters.

This optional list enables the alert capabilities for this graph and complements with the list option. Each alert has three fields separated by comma: the time interval, the threshold and the path to the script to be executed.

The time interval is the period of time (in seconds) that the threshold needs to be exceeded before the external script is executed.

The threshold is the value (either temperature or HZ) that needs to be reached or exceeded within the specified time in time interval to execute the external script.

The script is the full path name of the script that will be executed by this alert.

Each defined sensor has its own alert.

The default Monitorix installation includes an example of a shell-script alert called monitorix-alert.sh which you can use as a base for your own script.

The following is an example of an alert defined for the first temperature sensor:

Such alert means that if the value of the sensor temp0 reaches or exceeds 40 during at least one hour (3600 seconds) the script in /path/to/script will be executed.

The external script will receive the following arguments:

This is a comma-separated list that describes the groups of sensors in desc. Put one description for each group. For every group specified you need to specify its sensors in the desc option.

WARNING: Every time the number of entries in this option changes, Monitorix will resize the ipmi.rrd file accordingly, removing all historical data.

An example would be:

list = Temperatures, Fans, Voltages

This is a list of sensors per group defined.

<desc>
0 = CPU Temp, System Temp
1 = FAN 1
2 = Vcore, 3.3VCC, 12V, VDIMM, 5VCC, CPU VTT, VBAT, VSB, AVCC
</desc>

The maximum number of sensors allowed for each group is 9.

This is the type of sensor in each group. It's important to not mix different type of sensors in a same group. This value is informative only, it's mostly used as a title for the y-axis in the graphs and should match with the output of the ipmitool command.

This list complements the desc option. It basically allows you to change the name that will appear in the graph, hiding the real name of the sensor. If no association is defined, then Monitorix will display the name specified in the desc option. Note, this only works in names that don't include whitespaces.

This optional list enables the alert capabilities for this graph and complements with the desc option. Each alert has three fields separated by comma: the time interval, the threshold and the path to the script to be executed.

The time interval is the period of time (in seconds) that the threshold needs to be exceeded before the external script is executed.

The threshold is the temperature that needs to be reached or exceeded within the specified time in time interval to execute the external script.

The script is the full path name of the script that will be executed by this alert.

Each defined sensor has its own alert.

The default Monitorix installation includes an example of a shell-script alert called monitorix-alert.sh which you can use as a base for your own script.

The following is an example of an alert defined for the first temperature sensor:

Such alert means that if the value of the sensor CPU_Temp reaches or exceeds 40 during at least one hour (3600 seconds) the script in /path/to/script will be executed.

The external script will receive the following arguments:

This is the number of graphs that will be put in a row.

Default value: 2

This option includes any extra argument to the ipmitool command executed by Monitorix, which is "ipmitool <extra_args> sdr". This is specially useful if you need to monitor a remote server. An example would be:

extra_args = -H <remote_ip> -U root -P <password>

Default value: none

This is the number of NVIDIA cards currently plugged in your system.

The maximum allowed is 9.

Default value: 1

This is a list of groups of disk drives that you want to monitor. Each group will become a graph and there may be an unlimited number of groups. You can define device names or paths to devices like /dev/disk/by-path/pci-0000:00:11.0-scsi-0:0:0:0.

WARNING: Every time the number of groups in this option changes, Monitorix will resize the disk.rrd file accordingly, removing all historical data.

To collect the disk drive temperatures and health the smartmontools or the hddtemp command are required.

It is recommended that you first check if either smartctl(8) or hddtemp are able to collect data from the disk drive(s) that you plan to monitor. You may test this with the following command:

If you see good results as above, you can add it to the group 0 like this:

The maximum number of disk device names allowed per group is 8.

This section enables or disables one of the alert capabilities for this graph; the alert for the number of reallocated sectors in disk. It works as follows:

If the number of reallocated sectors in any of the specified disk device names reaches the realloc_threshold (the interval of time is not used here), Monitorix will execute the external alert script defined in realloc_script.

The default Monitorix installation includes an example of a shell-script alert called monitorix-alert.sh which you can use as a base for your own script.

Default value: n

Not used in this alert.

Default value: 0

This is the value that needs to be reached or exceeded to trigger the mechanism for a particular action, which in this case is the execution of an external alert script.

Default value: 1

This is the full path name of the script that will be executed by this alert.

It will receive the following three parameters:

1st - the value currently defined in realloc_timeintvl.
2nd - the value currently defined in realloc_threshold.
3rd - the current number of reallocated sectors.

Default value: /path/to/script.sh

This section enables or disables one of the alert capabilities for this graph; the alert for the number of current pending sectors (or bad sectors) in disk. It works as follows:

If the number of current pending sectors in any of the specified disk device names reaches the pendsect_threshold (the interval of time is not used here), Monitorix will execute the external alert script defined in pendsect_script.

The default Monitorix installation includes an example of a shell-script alert called monitorix-alert.sh which you can use as a base for your own script.

Default value: n

Not used in this alert.

Default value: 0

This is the value that needs to be reached or exceeded to trigger the mechanism for a particular action, which in this case is the execution of an external alert script.

Default value: 1

This is the full path name of the script that will be executed by this alert.

It will receive the following three parameters:

1st - the value currently defined in pendsect_timeintvl.
2nd - the value currently defined in pendsect_threshold.
3rd - the current number of pending sectors.

Default value: /path/to/script.sh

During the init stage this graph verifies that every defined device name does exist in the system. If not, then the graph disables itself.

This option changes this behavior and permits to continue working even if the device names defined doesn't exist. Keep in mind that you will continue seeing error messages in the logfile.

Default value: n

This is a list of groups of mounted filesystems that you want to monitor. Each group will become a graph and there may be an unlimited number of groups.

WARNING: Every time the number of groups in this option changes, Monitorix will resize the fs.rrd file accordingly, removing all historical data.

Take special care to use the same name as appears in the output of the df(1) command (the swap device is a special case). An example would be:

The maximum number of filesystems allowed per group is 8.

This list complements the list option. It basically allows you to change the name that will appear in the graph, hiding the real name of the mount point. If no association is defined, then Monitorix will display the name specified in the list option.

You can define as much entries as you want.

This optional list complements the list option. When Monitorix is started, and in order to be able to show I/O activity, it attempts to detect the mapping of devices specified in list, as defined in the df command output column "Mounted on". In the event that devices are not detected by Monitorix, the devmap option shall be used to manually define them, according to the underlying OS:

Just an example:

You can define as much entries as you want.

This optional list enables the alert capabilities for this graph and complements with the list option. Each alert has three fields separated by comma: the time interval, the threshold and the path to the script to be executed.

The time interval is the period of time (in seconds) that the threshold needs to be exceeded before the external script is executed.

The threshold is the percentage of disk space used in the file system that needs to be reached or exceeded within the specified time in time interval to execute the external script.

The script is the full path name of the script that will be executed by this alert.

Each defined filesystem has its own alert.

The default Monitorix installation includes an example of a shell-script alert called monitorix-alert.sh which you can use as a base for your own script.

The following is an example of an alert defined for the root filesystem:

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 /path/to/script will be executed.

The external script will receive the following arguments:

This is the maximum number of pools that you can define in list. There is no limit to the number of pools monitored, but keep in mind that every time this number changes, Monitorix will resize the zfs.rrd file accordingly, removing all historical data.

Default value: 5

This is a comma-separated list of pool names. The number of pool names defined here can't be greater than the number defined in max_pools.

This is a comma-separated list that describes the groups of directories in desc. Put one description for each group. For every group specified you need to specify its directories in the desc option.

WARNING: Every time the number of entries in this option changes, Monitorix will resize the du.rrd file accordingly, removing all historical data.

An example would be:

list = System, Users

This is a list of directories per group defined.

<desc>
0 = /var/spool/mail, /var/spool/mqueue, /etc, /var/ftp, /tmp
1 = /home/ace, /home/gene, /home/paul, /home/peter
</desc>

The maximum number of directories allowed for each group is 9.

This list complements the desc option. It basically allows you to change the name that will appear in the graph, hiding the real name of the directory. If no association is defined, then Monitorix will display the name specified in the desc option.

This is the number of graphs that will be put in a row.

Default value: 2

This option includes any extra argument to the du command executed by Monitorix, which is "du -ks". This is specially useful if you want to skip directories on differents file systems, in this case just define this option like this:

IMPORTANT NOTICE: Keep in mind that including certain flags like '-h' (which gives results in human readable format) could make Monitorix unable to interpret the results.

This is the maximum number of network interfaces that you can define in list. There is no limit, but keep in mind that every time this number changes, Monitorix will resize the net.rrd file accordingly, removing all historical data.

Default value: 10

This is a comma-separated list of network interfaces that you may want to monitor. An example would be:

This is the option where each network interface specified in list is described. Each definition consists of three parameters separated by comma: the description of the interface and the rigid and limit values.

Put one description for each interface listed. An example would be:

This is where the network interface that acts as the gateway for this server is defined. This is mainly used if you plan to monitor network traffic usage of your devices/networks using the traffacct graph below.

This is a comma-separated list of network interfaces that you may want to monitor. An example would be:

This is the option where you define the queue disciplines you want to monitor for each network interface specified in list.

An example would be:

The maximum number of qdiscs allowed is 9.

This option complements the desc option. It basically allows you to change the name of the qdiscs that will appear in the graphs. If no association is defined, then Monitorix will show the name as specified in the desc option.

Since the qdisc names have the space character in their names, they can't be used as the key in the association, instead you must the use their position number (starting by 0) in the desc option.

An example would be:

This is the command that will be used to gather statistics from each virtual machine listed in list.

Default value: virsh

An example would be:

This is a list of groups of virtual machines that you want to monitor. Each group will become a graph and there may be an unlimited number of groups.

WARNING: Every time the number of groups in this option changes, Monitorix will resize the libvirt.rrd file accordingly, removing all historical data.

An example would be:

The maximum number of virtual machines allowed per group is 8.

This list complements the list option and is mandatory for every virtual machine listed. You must define the virtual block device and the MAC address of the virtual network device that you want to monitor for every virtual machine. Just like this:

You might also define this list using sections for each virtual machine, this way you'll be able to define multiple disks and multiple network interfaces for each virtual machine. Just like this:

To obtain all these values you might want to use the following commands:

# virsh domblklist centos6
Target Source
------------------------------------------------
vda /home/jordi/kvm/centos6.img
hdc -

# virsh domiflist centos6
Interface Type Source Model MAC
-------------------------------------------------------
vnet3 network default virtio 52:54:00:45:d0:e7

This option also allows you to change the name that will appear in the graph, hiding the real name of the virtual machine. If no association is defined, then Monitorix will display the name specified in the list option.

This is a list of groups of processes that you want to monitor. Each group will become a graph and there may be an unlimited number of groups.

WARNING: Every time the number of groups in this option changes, Monitorix will resize the process.rrd file accordingly, removing all historical data.

Monitorix uses the following command to find the processes listed in this option:

Therefore names in the process list must *EXACTLY* correspond to those in the comm (or command) field of the above command (no substring, no wildcard).

An example of this option would be:

The maximum number of processes allowed per group is 10.

This list complements the list option. It basically allows you to change the name that will appear in the graph, hiding the real name of the process. If no association is defined, then Monitorix will display the name specified in the list option.

You can define as much entries as you want.

This option toggles the way the System Services Demand data is represented in the graph. There are two possible values:

Default value: i

This option specifies the MTA that Monitorix will use to collect mail statistics. The currently supported MTAs are:

NOTE: the pflogsumm utility is required when using the Postfix MTA.

Default value: sendmail

This option specifies the Greylisting implementation that Monitorix will use to collect statistical information.

The currently supported Greylisting software is:

In the case of milter-greylist, Monitorix shows the same data that appears at the end of the file greylist.db.

In the case of Postgrey, Monitorix reads the mail_log file and searches for a specific type of lines. Lines of type "action=greylist, reason=new" appear as Greylisted in the graph. Lines of type "action=greylist, reason=early-retry" appear as Delayed in the graph. Lines of type "action=pass, reason=triplet found" appear as Passed in the graph. And finally, lines of type "action=pass, reason=client whitelist" appear as Whitelisted in the graph.

Default value: milter-greylist

This option only affects the Mail Statistics and the Greylisting graphs, and it specifies the rate in which the values are saved and shown. This option has two possible values:

If it's set to its default value (real), it will show the messages as in a 'per minute' rate. Since Monitorix collects data on every minute, this should be the preferred way to see the results.

In the other hand, and in order to keep backwards compatibility, if this option is missing in the configuration file, it will act as if it was set up as per_second, which means that the number of messages collected in each minute will be divided by 60.

Default value: real

This section enables or disables one of the alert capabilities for this graph; the alert for the number of delivered messages. It works as follows:

If the number of delivered messages reaches the delvd_threshold value for the interval of time defined in delvd_timeintvl, Monitorix will execute the external alert script defined in delvd_script.

The default Monitorix installation includes an example of a shell-script alert called monitorix-alert.sh which you can use as a base for your own script.

Default value: n

This is the period of time (in seconds) that the threshold needs to be exceeded before the external alert script is executed.

Default value: 60

This is the value that needs to be reached or exceeded within the specified time period in delvd_timeintvl to trigger the mechanism for a particular action, which in this case is the execution of an external alert script.

The value of this option is compared against the number of delivered messages since the last delvd_timeintvl seconds.

Default value: 100

This is the full path name of the script that will be executed by this alert.

It will receive the following three parameters:

1st - the value currently defined in delvd_timeintvl.
2nd - the value currently defined in delvd_threshold.
3rd - the number of delivered messages.

Default value: /path/to/script.sh

This section enables or disables one of the alert capabilities for this graph; the alert for the number of queued messages. It works as follows:

If the number of queued messages reaches the mqueued_threshold value for the interval of time defined in mqueued_timeintvl, Monitorix will execute the external alert script defined in mqueued_script.

The default Monitorix installation includes an example of a shell-script alert called monitorix-alert.sh which you can use as a base for your own script.

Default value: n

This is the period of time (in seconds) that the threshold needs to be exceeded before the external alert script is executed.

Default value: 3600

This is the value that needs to be reached or exceeded within the specified time period in mqueued_timeintvl to trigger the mechanism for a particular action, which in this case is the execution of an external alert script.

The value of this option is compared with the number of messages in the mail queue.

Default value: 100

This is the full path name of the script that will be executed by this alert.

It will receive the following three parameters:

1st - the value currently defined in mqueued_timeintvl.
2nd - the value currently defined in mqueued_threshold.
3rd - the number of messages in the mail queue.

Default value: /path/to/script.sh

This is the number of network ports that you want to monitor. There is no limit to the number of ports monitored, but keep in mind that every time this number changes, Monitorix will resize the port.rrd file accordingly, removing all historical data.

Default value: 9

This is the rule number that Monitorix will use when using the ipfw command to manage network port activity on *BSD systems. Change it if you think it might conflict with any other rule number.

Default value: 24000

You may define here up to max network port numbers. If you need to monitor the same network port with TCP and UDP protocols, you can add your own suffix to the port number (e.g: 443t and 443u) in order to distinguish it from the double definition in the <desc> block.

If you see a red color in the background of a network port graph, it means that there is not a daemon listening on that port. This can be useful to know if some service gone down unexpectedly.

This is the option where each network port specified in list is described. Each port definition consists of six parameters separated by comma:

There is also support (Linux only) for IPv6 network ports activity by using protocol names as tcp6 or udp6.

An example would be:

As you can see, you cannot use the same port number twice. Instead, you must distinguish it with some suffix. Monitorix will automatically extract all the first numeric digits, and will use that value as the network port number.

This is the number of graphs that will be put in a row. Consider the interaction of this parameter with the max option in order to adjust the size and number of graphs in relation to your horizontal screen size.

Default value: 3

This option specifies the FTP server. The currently supported FTP servers are:

Default value: proftpd

This option lists the different names (separated by comma) that can adopt the Anonymous user in the FTP server defined in server.

Default value: anonymous, ftp

This is a comma-separated list of URLs of the monitored Apache web servers.

WARNING: Every time the number of entries in this option changes, Monitorix will resize the apache.rrd file accordingly, removing all historical data.

Default value: http://localhost/server-status?auto

This optional list enables the alert capabilities for this graph and complements with the list option. Each alert has three fields separated by comma: the time interval, the threshold and the path to the script to be executed.

The time interval is the period of time (in seconds) that the threshold needs to be exceeded before the external script is executed.

The threshold is the number of remaining free slots that needs to be reached or exceeded within the specified time in time interval to execute the external script.

The script is the full path name of the script that will be executed by this alert.

Each defined Apache has its own alert.

The default Monitorix installation includes an example of a shell-script alert called monitorix-alert.sh which you can use as a base for your own script.

The following is an example of an alert defined for the local Apache:

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 /path/to/script will be executed.

The external script will receive the following arguments:

This is the URL to be used to collect Nginx stats.

Default value: http://localhost/nginx_status

This is the network port the Nginx web server is listening on. It will be used for traffic (with iptables), and for nginx_status if url is not specified. If port of nginx_status is different from port then specify it in the url (http://host:port/nginx_status)

Default value: 80

This is the rule number that Monitorix will use when using the ipfw command to manage Nginx network activity on *BSD systems. Change it if you think it might conflict with any other rule number.

Default value: 24100

This is a comma-separated list of URLs of the monitored Lighttpd web servers.

WARNING: Every time the number of entries of this option changes, Monitorix will resize the lighttpd.rrd file accordingly, removing all historical data.

Default value: http://localhost/server-status?auto

This option toggles the way how Monitorix establishes the connection with the MySQL server. There are two possible values:

Default value: host

This is a comma-separated list of hostnames or path to sockets of MySQL servers.

WARNING: Every time the number of entries of this option change Monitorix will resize the mysql.rrd file accordingly, removing all historical data.

Default value: localhost

This is the option where each entry specified in the list is described. Each definition consists of three parameters separated by comma: the port, the username and the password.

An example using the host type would be:

When using the socket type the network port is, of course, irrelevant but its field is still mandatory. This means that you must respect the three comma-separated values.

Some of the values shown in the graphs are the result of a calculation of two values from either SHOW [GLOBAL] STATUS or SHOW VARIABLES. The following is an explanation of them:

Thread Cache Hit Rate
(1 - (Threads_created / Connections)) * 100
When an application connects to a MySQL database, the database has to create a thread to manage the connection and the queries that will be sent in that connection. The database instructs the kernel to create a new thread, and the kernel allocates resources and creates the thread, then returns it to the MySQL service. When the connection is terminated by the application, MySQL tells the kernel to destroy the thread and free the resources. This create/destroy mechanism causes considerable overhead if the MySQL server has many new connections per second.
If MySQL doesn't destroy the thread when the connection is terminated, but reuses it and assigns it to the next connection then this will decrease the kernel overhead. This is why a high Thread Cache Hit Rate improves MySQL performance and decreases the system's CPU usage.
Setting the parameter thread_cache_size in the my.cnf file accordingly will help to correctly balance between having a great thread cache and keeping MySQL memory consumption reasonable.
Higher is better.

Query Cache Hit Rate
Qcache_hits / (Qcache_hits + Com_select) * 100
Higher should be considered better.
A query cache size increase is recommended if the query cache usage is very close to 100% and the query cache hit rate is far from 100%. But sometimes a size increase will not lead to a better hit rate: this means that the increase was not needed and that the application do not run enough cacheable SELECT queries.
This value should grow proportionally with the number of executed queries as long as the query cache is performing well. Please also have a look at the Query cache usage percentage to know if your query_cache configuration is appropriate.

For more information please refer to http://www.databasejournal.com/features/mysql/article.php/3808841/Optimizing-the-MySQL-Query-Cache.htm

Query Cache Usage
(1 - (Qcache_free_memory / query_cache_size)) * 100
This value should be reasonably far from 100%, otherwise consider incrementing the query_cache_size parameter in my.cnf.

Connections Usage
(Max_used_connections / max_connections) * 100
This value should be reasonably far from 100%, otherwise consider incrementing the max_connections parameter in my.cnf.

Key Buffer Usage
(Key_blocks_used / (Key_blocks_used + Key_blocks_unused)) * 100
This value should be reasonably far from 100%, otherwise consider incrementing the key_buffer_size parameter in my.cnf.

InnoDB Buffer Pool Usage
(1 - (Innodb_buffer_pool_pages_free / Innodb_buffer_pool_pages_total)) * 100
This value should be reasonably far from 100%, otherwise consider incrementing the innodb_buffer_pool_size parameter in my.cnf.

Temp. Tables To Disk
(Created_temp_disk_tables / Created_temp_disk_tables + Created_temp_tables)) * 100
During operation, MySQL has to create some temporary tables (that can be explicit, so created by the web application, or implicit, so for example MySQL has to create one when he runs some "SELECT DISTINCT", "UNION" or "VIEW" queries). MySQL will prefer to save this tmp tables to memory, for a fast access. But if tmp_table_size gets saturated, he has to write them on the disk instead, making the access slower.
Note that if you modify the value of tmp_table_size in the MySQL configuration file, you should also modify the value of max_heap_table_size as well, since both values should have the same value because MySQL uses the minimum of both, so raising one of them is useless.
Therefore this value helps to know how many tmp tables go to the disk instead than to the memory. Keep in mind that some large queries, involving TEXT and BLOB columns, are directly written to the disk instead than to the memory, because they would be too big. So you probably will want to avoid having a high % of tmp tables written to the disk, but you will never reach 0% on a big site, and this is fine.
Lower is better ... but 0% is not reachable and you should not try to reach it, usually.

This is a comma-separated list of names of MongoDB servers.

WARNING: Every time the number of entries in this option changes, Monitorix will resize the mongodb.rrd file accordingly, removing all historical data.

Default value: localhost

This is the maximum number of databases to be monitored in a MongoDB server. There is no limitation, just specify here the number of entries of the db_list option that has the most entries.

WARNING: Every time the number of entries in this option changes, Monitorix will resize the mongodb.rrd file accordingly, removing all historical data.

Default value: 1

This is a list of blocks of names specified in the list option.

<desc>
<localhost>
host = 127.0.0.1
db_list = mydb
</localhost>
</desc>

The maximum number of mountpoints allowed for each URL is 9.

This is the hostname or IP address of the MongoDB server specified in its block.

Default value: 127.0.0.1

This is the port number of the MongoDB server specified in its block.

Default value:

This is a comma-separated list of databases to be monitored of the MongoDB server specified in its block.

Default value: mydb

This is a comma-separated list of URLs of PageSpeed status pages.

WARNING: Every time the number of entries in this option changes, Monitorix will resize the pagespeed.rrd file accordingly, removing all historical data.

Default value: http://modpagespeed.com/mod_pagespeed_statistics

This command displays statistics about the Squid HTTP proxy process and is the main command used to collect all data.

Default value: squidclient -h 127.0.0.1

These two lists hold the selected Squid result or status codes to be shown in each graph. Feel free to mix result status and code status in any of the two options.

For more information about the list of all the result and status codes, please refer to http://wiki.squid-cache.org/SquidFaq/SquidLogs.

Each graph has a limit number of 9 entries.

This option specifies which NFS server version is running in the system in order to correctly gather the correct values.

The possible values are:

Default value: 3

These three lists hold the defined NFS server activity statistics to be shown in each graph. Put every statistic name exactly as they appear in the output of the nfsstat(8) command.

Each graph has a limit number of 10 entries.

This option specifies which NFS server version is running in the system in order to correctly gather the correct values.

The possible values are:

Default value: 3

These five lists hold the defined NFS client activity statistics to be shown in each graph. Put every statistic name exactly as they appear in the output of the nfsstat(8) command.

Each graph has the following limit number of entries:

graph_1 up to 10 entries.
graph_2 up to 10 entries.
graph_3 up to 4 entries.
graph_4 up to 4 entries.
graph_5 up to 4 entries.

This is a comma-separated list of URLs of BIND servers status pages.

WARNING: Every time the number of entries in this option changes, Monitorix will resize the bind.rrd file accordingly, removing all historical data.

Default value: http://localhost:8053/

This is a comma-separated list of RR (Resource Records) types for each BIND server specified in list option. The RR types defined here will appear in the Incoming Queries graph which shows the number of incoming queries for each RR type.

For a complete list of RR types check the BIND 9 Administrator Reference Manual at <http://ftp.isc.org/www/bind/arm95/Bv9ARM.html>.

<in_queries_list>
http://localhost:8053/ = A, AAAA, ANY, DS, MX, NS, PTR, SOA, SRV, TXT, NAPTR, A6, CNAME, SPF, KEY, DNSKEY, HINFO, WKS, PX, NSAP
</in_queries_list>

The maximum number of RR types allowed for this graph is 20.

This is a comma-separated list of RR (Resource Records) types for each BIND server. The RR types defined here will appear in the Outgoing Queries graph (_default view) which shows the number of outgoing queries sent by the DNS server resolver for each RR type.

<out_queries_list>
http://localhost:8053/ = A, AAAA, ANY, DS, MX, NS, PTR, SOA, SRV, TXT, NAPTR, A6, CNAME, SPF, KEY, DNSKEY, HINFO, WKS, PX, NSAP
</out_queries_list>

The maximum number of RR types allowed for this graph is 20.

This is a comma-separated list of counters about incoming request processing. The counters defined here will appear in the Server Statistics graph.

<server_stats_list>
http://localhost:8053/ = Requestv4, Requestv6, ReqEdns0, ReqBadEDNSVer, ReqTSIG, ReqSIG0, ReqBadSIG, ReqTCP, Response, QrySuccess, QryAuthAns, QryNoauthAns, QryReferral, QryNxrrset, QrySERVFAIL, QryNXDOMAIN, QryRecursion, QryDuplicate, QryDropped, QryFailure
</server_stats_list>

The maximum number of counters allowed for this graph is 20.

This is a comma-separated list of counters about name resolution performed in the internal resolver. The counters defined here will appear in the Resolver Statistics graph (_default view).

<resolver_stats_list>
http://localhost:8053/ = Queryv4, Queryv6, Responsev4, Responsev6, NXDOMAIN, SERVFAIL, FORMERR, OtherError, EDNS0Fail, Truncated, Lame, Retry, QueryTimeout, GlueFetchv4, GlueFetchv6, GlueFetchv4Fail, GlueFetchv6Fail, ValAttempt, ValOk, ValNegOk
</resolver_stats_list>

The maximum number of counters allowed for this graph is 20.

This is a comma-separated list of RR (Resource Records) types for each BIND server. The RR types defined here will appear in the Cache DB RRsets graph (_default view) which shows the number of RRsets per RR type (positive or negative) and nonexistent names stored in the cache database.

<cache_rrsets_list>
http://localhost:8053/ = A, !A, AAAA, !AAAA, DLV, !DLV, DS, !DS, MX, NS, CNAME, !CNAME, SOA, !SOA, !ANY, PTR, RRSIG, NSEC, DNSKEY, NXDOMAIN
</cache_rrsets_list>

The maximum number of RR types allowed for this graph is 20.

This is a comma-separated list of NTP servers.

WARNING: Every time the number of entries in this option changes, Monitorix will resize the ntp.rrd file accordingly, removing all historical data.

Default value: localhost

This is a list of groups of Reference Identifier and Kiss-o'-Death Codes for every hostname specified in the list option.

For more information on these NTP codes:
<http://www.iana.org/assignments/ntp-parameters/ntp-parameters.xml>
<http://www.iana.org/go/rfc5905>

<desc>
localhost = AUTH, AUTO, CRYP, DENY, GPS, INIT, NKEY, RATE, RMOT, RSTR
</desc>

The maximum number of codes allowed for each hostname is 10.

This option includes any extra argument to the NTP command executed by Monitorix, which is "ntpq -pn". This is specially useful if you want to force using IPv4, in this case just define this option like this:

Monitorix will add this extra argument to the NTP command which will become as "ntpq -pn -4".

This is a comma-separated list of hostnames with the network port running chronyd. The format is <hostname>:<port> being the port number optional.

WARNING: Every time the number of entries in this option changes, Monitorix will resize the chrony.rrd file accordingly, removing all historical data.

Default value: localhost

This is a comma-separated list that describes the groups of jails in desc. Put one description for each group. For every group specified you need to specify its description in the desc option.

WARNING: Every time the number of entries in this option changes, Monitorix will resize the fail2ban.rrd file accordingly, removing all historical data.

An example would be:

list = Security, Overload / Abuse

This is a list of jails per group defined in your Fail2ban configuration.

<desc>
0 = [apache], [apache-mod-security], [apache-overflows], [courierauth], [ssh], [pam-generic], [php-url-fopen], [vsftpd]
1 = [apache-imdbphp], [apache-evasive], [apache-badbots], [apache-robots-txt], [communigate], [named-refused-udp], [named-refused-tcp], [trac-ticketspam]
</desc>

The maximum number of jails allowed for each group is 9.

This is the number of fail2ban graphs that will be put in a row.

Default value: 2

This is a list of URLs of Icecast server status pages.

WARNING: Every time the number of entries in this option changes, Monitorix will resize the icecast.rrd file accordingly, removing all historical data.

Default value: http://localhost:8000/status.xsl

This is a comma-separated list of Mount Points configured for every URL specified in the list option. IMPORTANT: the Mount Points must be specified in the same order that appears in the Icecast Server Status page.

<desc>
http://localhost:8000/status.xsl = stream1, stream2, stream3
</desc>

The maximum number of mountpoints allowed for each URL is 9.

This changes the layout of the listeners graph, the possible values are r for a real graph, or s for a stacked graph (every line or area is stacked on top of the previous element).

Default value: r

This is where the vcgencmd command is installed.

Default value: /opt/vc/bin/vcgencmd

This is a comma-separated list of clock types that will be represented in the first graph.

An example would be:

clocks = arm, core, h264, isp, v3d, uart, emmc, pixel, hdmi

The maximum number of clocks allowed is 9.

This is a comma-separated list of voltage types that will be represented in the third graph.

An example would be:

volts = core, sdram_c, sdram_i, sdram_p

The maximum number of clocks allowed is 6.

This is a comma-separated list of URLs of PHP-APC status pages.

WARNING: Every time the number of entries in this option changes, Monitorix will resize the phpapc.rrd file accordingly, removing all historical data.

Default value: http://localhost/apc.php?auto

This is a comma-separated list of hostnames with network port running Memcached.

WARNING: Every time the number of entries in this option changes, Monitorix will resize the memcached.rrd file accordingly, removing all historical data.

Default value: localhost:11211

This is the command that will be used (with the values in list) to get the statistics.

Default value: apcaccess

This is a comma-separated list of hostnames with the network port running apcupsd.

WARNING: Every time the number of entries in this option changes, Monitorix will resize the apcupsd.rrd file accordingly, removing all historical data.

Default value: localhost:3551

This is a comma-separated list of UPS names with optionally the hostname and the network port where it's running upsd. The format of each entry must be:

upsname[@hostname[:port]]

WARNING: Every time the number of entries in this option changes, Monitorix will resize the nut.rrd file accordingly, removing all historical data.

Default value: ups@localhost

This is a comma-separated list of URLs of Wowza server status pages. Each URL can include the Basic Authentication in the form of http://username:password@localhost:8086/connectioncounts.

WARNING: Every time the number of entries in this option changes, Monitorix will resize the wowza.rrd file accordingly, removing all historical data.

Default value: http://localhost:8086/connectioncounts

This is a comma-separated list of applications configured for every URL specified in the list option.

<desc>
http://localhost:8086/connectioncounts = channel1, channel2, channel3
</desc>

The maximum number of applications allowed for each URL is 8.

This option enables this feature.

Default value: n

This is the number of LAN devices you want to monitor. There is no limit, but keep in mind that every time this number changes, Monitorix will resize the traffacct.rrd file, removing all historical data.

Default value: 10

If your horizontal screen resolution is pretty wide, you may want to increase the number of graphs that appear on each row.

Default value: 2

This is a comma-separated list of names of PCs, LAN devices or whole networks that you want to monitor. The only requirement is that all they must utilize this server as their gateway.

If the names in this list are able to be resolved by a DNS query then you don't need to define the desc list (below) with corresponding IP addresses, unless you want monthly reports.

An example would be:

This is the list of IP addresses with network masks and email addresses corresponding to the entries defined in the list. This option is only used when the those entries are not resolvable through a DNS query.

An example would be:

If this option is set to y, Monitorix will send a report of all the monthly Internet activity of the defined devices in list to the specified email address on the first day of each month.

Default value: n

Define here the language used in the monthly report.

The current possible values are: ca, de, en, it, nl_NL, pl and zh_CN.

Default value: en

This is the default email address used to send the monthly reports. This option is only used if the second parameter in desc list is empty.

Default value: root@localhost

This is the prefix of the same URL you use to connect to Monitorix. This is needed in order to get the graphs of the same machine.

Default value: http://localhost:8080

This is the hostname that will be used as a SMTP relay to deliver the monthly report emails.

Default value: localhost

This is the address that will be used as remitent for all the monthly report emails.

Default value: noreply@example.com

This option enables the Multihost feature.

Default value: n

If set to y Monitorix will show the original URL of each server at the bottom of the graph. Where security is important you may want to hide this information.

Default value: y

If your horizontal screen resolution is pretty wide, you may want to increase the number of graphs that appear on each row.

Default value: 2

This is a comma-separated list with descriptive names of remote servers with Monitorix already installed and working that you plan to monitor from here.

An example of this list would be:

This is a numbered list that describes each of the names defined in the remotehost_list option and the remote values of base_url and base_cgi options.

An example would be:

As you can see all these three entries use URLs to designate the location of each remote server. This means that each server most also have been enabled the built-in HTTP server, or have been installed a CGI capable web server like Apache.

This enables the server grouping for those environments where there are too much servers to display at the same time. Hence, you can group them in order to show them separatedly.

Default value: n

This is a list of groups of remote servers with Monitorix already installed and working that you plan to monitor from here.

An example of this list would be:

This is a numbered list that describes each of the names defined in the remotegroup_list option.

An example would be:

This option enables this feature. Note that you still need to enable the same option for each time interval you want to activate: daily, weekly, monthly, yearly.

Default value: n

This is the prefix of the same URL you use to connect to Monitorix. Such URL is needed in order to get the graphs of that machine.

This option supports sending the credentials in the standard HTTP "Authorization" header, just like this:

http://username:password@localhost:8080

Default value: http://localhost:8080

This is the hostname that will be used as a SMTP relay to deliver the automatic email reports.

This option specifies the method of sending emails. The current valid options are smtp and relay. By default this option is not defined which is the same as if smtp option was defined.

Default value:

This is the address that will be used as remitent for all the monthly report emails.

Default value: noreply@example.com

This is the hour (in 24h format) when the email reports will be sent.

Default value: 0

This is the minute when the email reports will be sent.

Default value: 0

The email reports are sent based on the following schedule:

daily reports will be sent every day at 00:00h.
weekly reports will be sent the first Monday of each week.
monthly reports will be sent the first day of each month.
yearly reports will be sent the first day of each year.

This option enables each report individually.

Default value: n

This is a comma-separated list of graph names you want to appear in the email report. The names are the same as their .rrd files. There is a list of them in the graph_name option in monitorix.conf.

Default value: system, fs

This is a comma-separated list of recipient email addresses.

This is the full path name of an external script that will be executed during the creation of the report, and its output will be appended to the mail. This is useful for system administrators that want to add extra system information to the reports.

Default value:

This value defines how the graph must be scaled. Its possible values are:

0 No rigid, the graph will be scaled automatically. Only the lower-limit value will be used if it's defined.
1 The graph will be scaled by default according the values in limit but without rigidness.
2 The graph will be forced to scale using the contents of limit as its upper-limit and lower-limit values.

This is where you can enter the upper-limit and lower-limit values (separated by a colon) for a graph. The lower-limit value is optional. Some examples would be:

100:0 which means 100 as the upper-limit value and 0 for the lower-limit value. This is commonly used for percentage values.
1000 which means 1000 as the upper-limit value and leaving undefined the lower-limit value. This can also be written as 1000:.