Monitorix logo
Welcome to The Monitorix Project
Take control over your small server
monitorix.conf.5


Manual Reference Pages  - monitorix.conf (5)

NAME

monitorix.conf - Configuration file for Monitorix.

CONTENTS

Synopsis
Description
Configuration Options
     System load average and usage (system.rrd)
     Global kernel usage (kern.rrd)
     Kernel usage per processor (proc.rrd)
     HP ProLiant System Health (hptemp.rrd)
     LM-Sensors and GPU temperatures (lmsens.rrd)
     NVIDIA temperatures and usage (nvidia.rrd)
     Disk drive temperatures and health (disk.rrd)
     Filesystem usage and I/O activity (fs.rrd)
     Network traffic and usage (net.rrd)
     System services demand (serv.rrd)
     Mail statistics (mail.rrd)
     Network port traffic (port.rrd)
     Users using the system (user.rrd)
     Apache statistics (apache.rrd)
     Nginx statistics (nginx.rrd)
     MySQL statistics (mysql.rrd)
     Squid Proxy Web Cache (squid.rrd)
     NFS server statistics (nfss.rrd)
     NFS client statistics (nfsc.rrd)
     NTP statistics (ntp.rrd)
     Icecast Streaming Media Server (icecast.rrd)
     Devices interrupt activity (int.rrd)
     Monitoring remote servers (Multihost)
     Monitoring the Internet traffic of LAN PCs, devices or whole networks
Author
See Also

SYNOPSIS

Monitorix is a free, open source, lightweight system monitoring tool designed to monitor as many services and system resources as possible. It has been created to be used under production UNIX/Linux servers, but due to its simplicity and small size you may also use it to monitor embedded devices as well.

It mainly consists of two programs: a collector called monitorix, which is a Perl daemon that is started automatically like any other system service, and a CGI script called monitorix.cgi.

Everytime monitorix is started it reads the configuration file from the path specified in the command line (using the -c option), and once checked, it creates the index.html file that will act as the Monitorix main page.

It also creates a file called $BASE_DIR/cgi-bin/monitorix.conf.path that includes the absolute path of the configuration file. This file will be read by monitorix.cgi to know the exact location of the configuration file. If by any reason it is unable to locate this file, it will try two alternative locations; /etc/monitorix.conf and /usr/local/etc/monitorix.conf.

DESCRIPTION

This configuration file is a Perl file where you set the value directly to the variables that Monitorix will use during its normal operation; you should take special precaution to not break some Perl basic syntax.

CONFIGURATION OPTIONS

Because this file follows the Perl syntax, you’ll find different type of options (scalar or normal variables, arrays and associative arrays), each one prefixed with $, @ and % respectively. This is important to keep in mind as the prefix symbols indicates you what type of values accepts each option.

Remember to enclose all the values using double quotes.

TITLE

A description of the server, or where it is located or the Company name, etc.

Default value: Place a Title Here

HOSTNAME

The name of the host.

Default value: none

THEME_COLOR

RRDtool comes with its default white theme and since Monitorix introduces its own black theme, you only have two predefined themes to choose.

Default value: black

REFRESH_RATE

The browser refresh rate of the statistics web page (in seconds). If it is set to 0 the page reloading is disabled.

Default value: 150

IFACE_MODE

This defines how will be shown the data in the browser. Since 1.4.0 version it’s possible to display the same graphic data using plain text tables. This should make life easier either for blind people or people with vision impairments using screen readers software, or even for automatic data processing through scripts.

The possible values are:

graph for rendered graphs
text for plain text representation

Default value: graph

ENABLE_ZOOM

This permits to click on any graph image and see a bigger picture (zoomed in) of it. It is specially useful when you need to see a graph with more detail.

Default value: Y

NETSTATS_IN_BPS

This option toggles network values between bits and bytes per second.

Default value: N

BASE_DIR

This is the absolute path to the directory where all the web stuff will reside:

cgi-bin/ monitorix.cgi script
imgs/ all the .png graph images
index.html Monitorix main page
logo_bot.png Monitorix bottom logo
logo_top.png Monitorix top logo
monitorixico.png Monitorix favicon logo

Default value: /usr/share/monitorix/
(depends on the operating system)

BASE_LIB

This is the absolute path to the directory where will reside all the RRD files and monthly reports stuff:

reports/ monthly reports localization
usage/ daily traffic usage data
*.rrd RRD files

Default value: /var/lib/monitorix/
(depends on the operating system)

BASE_URL

This is the prefix in the URL that Monitorix will use when refering its own pages and files.

Default value: /monitorix

BASE_CGI

This is the prefix in the URL that Monitorix will use to refer monitorix.cgi.

Default value: /monitorix-cgi

LOG_FILE

This is the path to the Monitorix log file. Please check this file periodically and specially after every update, to see if all is working fine.

Default value: /var/log/monitorix

SECURE_LOG

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

Default value: /var/log/secure

MAIL_LOG

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

Default value: /var/log/maillog

MILTER_GL

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

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

IMAP_LOG

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

Default value: /var/log/imap

HYLAFAX_LOG

This is the path of the Hylafax log file. Monitorix uses this file to account successful FAX sent.

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

CUPS_LOG

This is the path of the CUPS page log file. Monitorix uses this file to account printed jobs.

Default value: /var/log/cups/page_log

FAIL2BAN_LOG

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

Default value: /var/log/fail2ban.log

SPAMASSASSIN_LOG

This is the path of the CUPS page log file. Monitorix uses this file to account spam-mail alerts.

Default value: /var/log/maillog

CLAMAV_LOG

This is the path of the CUPS page log file. Monitorix uses this file to account virus-mail alerts.

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

CG_LOGDIR

This is the path of the CommuniGate logs directory. Monitorix uses the files in to account the number of mails successfully received and sent, and to account IMAP and POP3 successful logins.

Default value: /var/CommuniGate/SystemLogs/

SQUID_LOG

This is the log file where all the Squid requests activity is saved.

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

ENABLE_ALERTS
This enables or disables the alert capabilities that were introduced in the 1.4.0 version. There are only two alerts currently implemented; one for the CPU load average and one for the root filesystem disk usage. They work as follows:

For the CPU load average it uses the third value, (the one that represents the last 15 minutes of load average), and if it reaches the ALERT_LOADAVG_THRESHOLD value for the interval of time defined in ALERT_LOADAVG_TIMEINTVL it will execute the external alert script defined in ALERT_LOADAVG_SCRIPT.

For the root filesystem disk usage, it monitors its percentage of usage and if it reaches the ALERT_ROOTFS_THRESHOLD value for the interval of time defined in ALERT_ROOTFS_TIMEINTVL it will execute the external alert script defined in ALERT_ROOTFS_SCRIPT.

Your Monitorix installation should include an example alert shell-script called monitorix-alert.sh. Use it as a base for your own script.

Default value: N

ALERT_LOADAVG_TIMEINTVL

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

Default value: 3600

ALERT_LOADAVG_THRESHOLD

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

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

Default value: 5.0

ALERT_LOADAVG_SCRIPT

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 current defined value in ALERT_LOADAVG_TIMEINTVL
2nd - the current defined value in ALERT_LOADAVG_THRESHOLD
3rd - the current CPU load average 15min value

Default value: /path/to/script.sh

ALERT_ROOTFS_TIMEINTVL

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

Default value: 3600

ALERT_ROOTFS_THRESHOLD

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

The value of this option is compared directly with the current root filesystem disk usage.

Default value: 100

ALERT_ROOTFS_SCRIPT

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 current defined value in ALERT_ROOTFS_TIMEINTVL
2nd - the current defined value in ALERT_ROOTFS_THRESHOLD
3rd - the current root filesystem disk usage

Default value: /path/to/script.sh

GRAPH_ENABLE

This enables or disables the monitoring of each graph. Just placing a Y on a desired graph and restart Monitorix, will automatically create the RRD file for that graph and will start gathering information according its settings.

    System load average and usage (system.rrd)

You are only able to setup here the limit and rigid values.

    Global kernel usage (kern.rrd)

KERN_GRAPH_MODE
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

KERN_DATA

This is the list of values offered in modern Linux kernels, older Linux kernel or other Operating Systems may not have it all. Placing a Y or a N will enable or disable the value in the graph.

    Kernel usage per processor (proc.rrd)

PROC_MAX
This is the number of processors or cores that your system has. There is no limit in that number but keep in mind that everytime this number changes, Monitorix will remove the current proc.rrd file (losing all the historical data) and will create a new one to fit the needs, even if the new number is smaller.

Default value: 4

PROC_PER_ROW

This is the number of processor graphs that will be put in a row. Consider combine this number with the PROC_SIZE and PROC_DATA options (below) in order to adjust the size of the graphs according to this option.

Default value: 2

PROC_SIZE

This option sets the size of all processors graphs.

The possible values are:

main for 450x150 graphs
medium for 325x150 graphs
small for 200x66 graphs
mini for 183x66 graphs
tiny for 110x40 graphs

Default value: medium

PROC_DATA

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

Default value: Y

    HP ProLiant System Health (hptemp.rrd)

HPTEMP_1
HPTEMP_2
HPTEMP_3
These arrays will hold the defined temperature sensors for each graph. You must have installed the latest version of hplog that comes with HP ProLiant System Health Application and Command Line Utilities.

Each graph has a limit number of IDs:

HPTEMP_1 up to 8 IDs
HPTEMP_2 up to 6 IDs
HPTEMP_3 up to 6 IDs

The following is a configuration example of a 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

our @HPTEMP_1 = (
"2",
"3",
);
our @HPTEMP_2 = (
"1",
"5",
"18",
);
our @HPTEMP_3 = (
"7",
"9",
"10",
"11",
"12",
"13",
);

    LM-Sensors and GPU temperatures (lmsens.rrd)

SENSORS_LIST
You may specify in this associative array the sensors you want to monitor with the same names as they appear in your sensors command.

For example, imagine a sensors 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 the SENSORS_LIST associative array as:

our %SENSORS_LIST = (
"CORE0" => "Core 0",
"CORE1" => "Core 1",
"MB0" => "M/B Temp",
"CPU0" => "CPU Temp",
"FAN0" => "CPU",
"FAN1" => "System",
"FAN2" => "Power",
"FAN3" => "Aux",
"VOLT0" => "3.3V",
"VOLT1" => "VCore",
"VOLT2" => "Vdimm",
"VOLT3" => "Vchip",
"VOLT4" => "\\+5V",
"VOLT5" => "12V",
"VOLT6" => "5VSB",
"VOLT7" => "3VSB",
"VOLT8" => "Battery",
"GPU0" => "nvidia",
);

Note that you need to double-escape the plus and minus signs in the voltage labels.

The last one; GPU0, is set here just in case you have an NVIDIA card and you want to monitor its temperature. Currently only NVIDIA cards are supported so the value nvidia is mandatory.

This array has the following maximums allowed:

Up to 16 CORE keys
Up to 2 MB keys
Up to 4 CPU keys
Up to 9 FAN keys
Up to 12 VOLT keys
Up to 9 GPU keys

    NVIDIA temperatures and usage (nvidia.rrd)

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

The maximum allowed is 9.

Default value: 1

    Disk drive temperatures and health (disk.rrd)

DISK_LIST
You may specify in this array the disk device names that you want to monitor. Keep in mind that smartmontools and optionally the hddtemp command is required to collect the disk drives temperatures and health values.

It’s recommendable to test first if either smartctl or hddtemp are able to collect the temperature and health values of the device drive(s) you plan to monitor. You may test this with the following command:

# hddtemp /dev/sda
/dev/sda: WDC WD1600AABS-00M1A0: 48°C

If you see good results, you can add it in the list like this:

our @DISK_LIST = (
"/dev/sda",
"/dev/sdb",
);

The maximum number of disk device names allowed is 8.

    Filesystem usage and I/O activity (fs.rrd)

FS_LIST
This is the list of the mounted filesystems (not including the root filesystem /), to be monitored. Take special care to put the same name as appears in the output of the df command. An example would be:

our @FS_LIST = (
"/boot",
"/home",
"/mnt/backup",
);

The maximum allowed is 9.

FS_DESC

This array complements with the FS_LIST array. Each option pairs with the one in the same position of the array. It basically permits to change the name that will appear in the graph, hence hiding the real name of the mount point. If no name is defined, then it will show the one specified in the FS_LIST array.

our @FS_DESC = (
"",
"My Home",
"Backups",
);

The maximum allowed is 9.

    Network traffic and usage (net.rrd)

NET_LIST
This is the list of network interfaces that you may want to monitor. An example would be:

our @NET_LIST = (
"eth0",
"eth1",
);

The maximum allowed is 10.

NET_DESC

This is the list where to put the description of each network interface listed in the NET_LIST. Put one description per each interface listed. An example would be:

our @NET_DESC = (
"FastEthernet LAN",
"ADSL 10Mbs Internet",
);

The maximum allowed is 10.

NET_RIGID

This is the list where to put the rigidness that will affect how the graph will be scaled.

The possible values are:

0 No rigid actually, no lower-limit and no upper-limit.
1 No rigid actually, but with lower-limit and upper-limit.
2 Rigid with lower-limit and upper-limit.

Remember to put an entry for each network interface listed in the NET_LIST array. An example would be:

our @NET_RIGID = (
"0",
"2",
);

The maximum allowed is 10.

NET_LIMIT

This is the list where to put the upper limit value of the graph. Since Monitorix uses bytes/s instead of bits/s, the value accepted here must be in bytes.

Remember to put an entry for each network interface listed in the NET_LIST array. Following the description of the above example, it would be:

our @NET_LIMIT = (
"10000000",
"1000000",
);

That is:

"Fast Ethernet LAN" means 100Mb/s, which means ~10MB/s which means 10000000 bytes.

and

"ADSL 10Mb Internet" means 10Mb/s, which means ~1MB/s which means 1000000 bytes.

The maximum allowed is 10.

NET_GATEWAY

Put here the network interface name that acts as the gateway for this server. This is mainly used if you plan to monitor the network traffic usage of the PCs on your LAN using the PC_LIST option below.

    System services demand (serv.rrd)

SERV_MODE
This option toggles the way how is represented the data in the graph. There are two possible values:

I for incremental style
L for load (spikes) style

Default value: I

    Mail statistics (mail.rrd)

MAIL_SHOW_QUEUE
This option changes the view of the top-right small graph. The two possible values are Y to show the mail queue, or N to show the mail network traffic in KB/s. This network traffic is almost the same one that appears in the SMTP network port traffic graph except that the data is collected directly from the MTA instead of using iptables (on Linux systems).

Default value: Y

MAIL_MTA

This option specifies the MTA that Monitorix will use to collect the statistics information. In the future more MTA will be supported.

The currently supported MTAs are:

Sendmail

Default value: sendmail

MAIL_GREYLIST

This option specifies the Greylisting implementation that Monitorix will use to collect the statistics information. In the future more Greylisting software will be supported.

The currently supported Greylistings are:

milter-greylist

Default value: milter-greylist

    Network port traffic (port.rrd)

PORT_MAX
This is the number of network ports that you want to monitor. There is no limit in that number but keep in mind that everytime this number changes, Monitorix will remove the current port.rrd file (losing all the historical data) and will create a new one to fit the needs, even if the new number is smaller.

Default value: 9

PORT_RULE

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

Default value: 24000

PORT_LIST

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

PORT_NAME

This array complements with the PORT_LIST array. Each option pairs with the one in the same position of the array. It basically permits to name a network port.

PORT_PROT

This array complements with the PORT_LIST array. Each option pairs with the one in the same position of the array. It permits to define the protocol type to be used in the traffic accounting. The protocol type must be valid and supported by your system.

    Users using the system (user.rrd)

You are only able to setup here the limit and rigid values.

    Apache statistics (apache.rrd)

This graph requires that mod_status be loaded and ExtendedStatus option set to On in order to collect full status information of the Apache web server.

APACHE_PORT

This is the network port from where Apache web server is listening on.

Default value: 80

    Nginx statistics (nginx.rrd)

This graph might require adding some lines in the configuration file nginx.conf. Please see the README.nginx file to know the exact steps needed to configure Nginx to get status information.

NGINX_PORT

This is the network port from where Nginx web server is listening on.

Default value: 80

NGINX_RULE

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

Default value: 24100

    MySQL statistics (mysql.rrd)

This graph requires you create a MySQL user with a password that is NOT granted privilege to any DB.

Example:

mysql> CREATE USER ’user’@’localhost’ IDENTIFIED BY ‘password’;
mysql> FLUSH PRIVILEGES;

where ’user’ is the new user name and ’password’ is the password that will be used for that user.

NOTE: It’s strongly recommended to restart MySQL service in order to avoid spikes too high that could prevent seeing correctly the first plotted data.

MYSQL_CMD

This is the command used to get the MySQL statistics.

Default value: mysql

MYSQL_HOST

This is the hostname used to connect the MySQL server.

Default value: localhost

MYSQL_PORT

This is the TCP/IP port number to use for the connection.

Default value: 3306

MYSQL_USER

This is user name to use when connecting to the server. See the example above.

Default value: none

MYSQL_PASS

This is password to use when connecting to the server. See the example above.

Default value: none

Some of the values shown in the graphs are the result of a calculation of two values appeared either in the ’SHOW [GLOBAL] STATUS’ or in ’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. So it has to instruct the kernel to create a new thread (the kernel will allocate resources, create the thread and then give it to MySQL service). When the connection is terminated by the application, MySQL tells the kernel to destroy the thread and free the resources. This creation/destroy mechanism becomes a considerable overhead if the MySQL server has a lot of new connections per second.
If MySQL don’t destroy the thread when the connection is terminated, but reuses it and assigns it to the next connection this indeed 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 balance correctly between having a great thread cache while keeping a reasonable memory consumption of MySQL.
Higher is better.

Query Cache Hit Rate
Qcache_hits / Qcache_inserts
Higher should be considered better. This value should grow proportionally with the number of executed queries, if 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.

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.

    Squid Proxy Web Cache (squid.rrd)

SQUID_CMD

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

Default value: squidclient

SQUID_GRAPH_1
SQUID_GRAPH_2
These arrays 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 two arrays.

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.

    NFS server statistics (nfss.rrd)

NFSS_VERSION

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

The possible values are:

2 for NFS version 2
3 for NFS version 3
4 for NFS version 4

Default value: 3

NFSS_GRAPH_1
NFSS_GRAPH_2
NFSS_GRAPH_3
These arrays hold the defined NFS server activity statistics to be shown in each graph.

Each graph has a limit number of 10 entries.

    NFS client statistics (nfsc.rrd)

NFSC_VERSION

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

The possible values are:

2 for NFS version 2
3 for NFS version 3
4 for NFS version 4

Default value: 3

NFSC_GRAPH_1
NFSC_GRAPH_2
NFSC_GRAPH_3
NFSC_GRAPH_4
NFSC_GRAPH_5
These arrays hold the defined NFS client activity statistics to be shown in each graph.

Each graph has the following limit number of entries:

NFSC_GRAPH_1 up to 10 entries
NFSC_GRAPH_2 up to 10 entries
NFSC_GRAPH_3 up to 4 entries
NFSC_GRAPH_4 up to 4 entries
NFSC_GRAPH_5 up to 4 entries

    NTP statistics (ntp.rrd)

NTP_HOST_LIST
This is a list of unlimited hostnames of NTP servers.

Default value: localhost

NTP_CODE_LIST

This is a double dimensioned array of group of Reference Identifier and Kiss-o’-Death Codes for every hostname specified in the NTP_HOST_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>

our @NTP_CODE_LIST = (
        [
                "AUTH",
                "AUTO",
                "CRYP",
                "DENY",
                "GPS",
                "INIT",
                "NKEY",
                "RATE",
                "RMOT",
                "RSTR",
        ],
        [
                "DENY",
                "RMOT",
                "RSTR",
        ],
);

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

    Icecast Streaming Media Server (icecast.rrd)

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

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

ICECAST_MP_LIST

This is a double dimensioned array of mountpoints configured for every URL specified in the ICECAST_URL_LIST option.

our @ICECAST_MP_LIST = (
        [
        "/stream1",
        "/stream2",
        "/stream3",
        ],
        [
                "/stream1",
                "/stream2",
        ],
);

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

ICECAST_GRAPH_MODE

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

    Devices interrupt activity (int.rrd)

You are only able to setup here the limit and rigid values.

    Monitoring remote servers (Multihost)

The Multihost feature allows you to monitor an unlimitted number of remote servers with Monitorix already installed on.

MULTIHOST

This option enables the Multihost feature.

Default value: N

MULTIHOST_FOOTER

If set to Y Monitorix will show the original URL of each server in the bottom part of the graph. Only where the security is important you may want to hide this information.

Default value: Y

MULTIHOST_IMGS_PER_ROW

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

Default value: 2

REMOTEHOST_LIST

This is a list of the remote servers where Monitorix it’s already installed and working and you plan to monitor them from this one. It consists of a pair of values being in the left side the description of each server and in the right side the URL or IP address.

An example of this list would be:

our @REMOTEHOST_LIST = (
"WWW Linux", "http://www.example.com",
"Backup Linux", "http://192.168.1.4",
"SMTP Linux", "http://71.16.11.2:8080",
);

As you can see all three entries use URLs to designate the location of each remote server. This means that on each server most also have been installed a CGI capable web server like Apache.

    Monitoring the Internet traffic of LAN PCs, devices or whole networks

If your server acts as the gateway for a group of PCs, devices or even whole networks in your local LAN, perhaps you’d want to know about the Internet traffic is using each one of them.

The following are the options you will need to configure to accomplish all of this.

PC_LAN

This option enables this feature.

Default value: N

PC_MAX

This is the number of LAN devices you want to monitor. There is no limit in that number but keep in mind that everytime this number changes, Monitorix will remove the current pc.rrd file (losing all the historical data) and will create a new one to fit the needs, even if the new number is smaller.

Default value: 10

PC_IMGS_PER_ROW

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

Default value: 2

PC_LIST

This is the list of names of PCs, LAN devices or whole networks that you want to monitor. The only requirement is that all they must have as the gateway the IP of this server.

If the names in this list are able to be resolved by a DNS query then you don’t need to define the PC_IP list (below) with their corresponding IP addresses.

An example would be:

our @PC_LIST = (
"pc8",
"printer",
"scanner",
"lan3",
);

PC_IP

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

An example would be:

our @PC_IP = (
"192.168.1.108/32",
"192.168.1.122/32",
"192.168.1.203/32",
"192.168.2.0/24",
);

PC_ENABLE_MONTHLY_REPORTS

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

Default value: N

PC_REPORT_LANG

Define here the language used in the monthly report.

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

Default value: en

PC_DEFAULT_MAIL

This is the default email address used to send the monthly reports. This option is only used if the PC_REPORT_MAIL array is empty.

Default value: root@localhost

PC_REPORT_MAIL

This is the list of email addresses (one per entry) that corresponds to each name listed in the PC_LIST array. If this list is empty then the PC_DEFAULT_MAIL option will be used as the default email address for all the PCs.

An example would be:

our @PC_MAIL = (
"user1@example.com",
"user2@example.com",
"user3@example.com",
"admin@example.com",
);

AUTHOR

Monitorix is written by Jordi Sanfeliu <jordi@fibranet.cat>

SEE ALSO

monitorix(8), rrdtool(1)


2.4.1 monitorix.conf (5) "Jan 2012"
Generated by manServer 1.07 from monitorix.conf.5 using man macros.