1monitorix.conf(5) Monitorix configuration file monitorix.conf(5)
2
6 monitorix.conf - Configuration file for Monitorix.
7
9 Monitorix is a free, open source, lightweight system monitoring tool
10 designed to monitor as many services and system resources as possible.
11 It has been created to be used on production Linux/UNIX servers, but
12 due to its simplicity and small size may also be used to monitor embed‐
13 ded devices as well.
14 It consists mainly of two programs: a collector, called monitorix,
16 which is a Perl daemon that is started automatically like any other
17 system service, and a CGI script called monitorix.cgi. Since 3.0 ver‐
18 sion Monitorix includes its own HTTP server built in, so you don't need
19 to install any web server to use it.
20 Every time monitorix is started it reads the configuration file from
22 the path specified in the command line (using the -c option), and once
23 checked, it creates the index.html file that will act as the Monitorix
24 main page.
25 It also creates a file called <base_dir>/cgi/monitorix.conf.path that
27 includes the absolute path of the configuration file. This file will be
28 read by monitorix.cgi to determine the exact location of the configura‐
29 tion file.
30
32 IMPORTANT NOTE: these options have default values that might vary
33 depending on your operating system. Please check the configuration
34 files in /etc/monitorix/conf.d/.
35 Blank lines are ignored, and whitespace before and after a token or
37 value is ignored as well as tabulators, although a value can contain
38 whitespace within. Lines which begin with a # are considered comments
39 and ignored.
40 If you want to comment out a large block you can use C-style comments.
42 A /* signals the begin of a comment block and the */ signals the end of
43 the comment block.
44 If an option has multiple values their must be separated by comma.
46 title
48 A free description of the server; where it is located, the Com‐
49 pany name, etc.
50 Default value: Place a Title Here
52 hostname
54 The name of the host.
55 Default value:
57 theme_color
59 RRDtool comes with a default white theme, and since Monitorix
60 introduces its own black theme, you have two predefined themes
61 to choose from.
62 Default value: black
64 refresh_rate
66 The refresh rate (in seconds) of the statistics web page dis‐
67 played in your browser. If set to 0, page refreshing is dis‐
68 abled.
69 Default value: 150
71 iface_mode
73 The interface mode defines the manner in which data is shown in
74 the browser. Since version 1.4.0 it has been possible to display
75 the graphic data using plain text tables. This allows Monitorix
76 to be used by those running screen reader software, and also
77 simplifies automatic data processing through scripts.
78 The possible values are:
80 graph for rendered graphs.
81 text for plain text representation.
82 Default value: graph
84 enable_zoom
86 Zoom allows double clicking any graph in order to see a larger
87 version (zoomed in). This is especially useful for seeing addi‐
88 tional detail.
89 Default value: y
91 netstats_in_bps
93 This option toggles network values between bits (bps) and Bytes
94 (Bps) per second. By default the values will be shown in Bytes
95 per second (Bps).
96 Default value: n
98 netstats_mode
100 This option toggles network visualization mode between over‐
101 lapped (input and output values appear one in front the other)
102 and separated (input values appear on top and output values
103 below, in negative).
104 Default value: overlapped
106 disable_javascript_void
108 This option enables or disables the use of javascript:void-URLs
109 when opening windows with zoomed graphs. Some people likes to
110 open links in the background by pressing the middle mouse button
111 in Firefox, and with the default javascript:void-URLs the only
112 they get is an empty window with nothing in it.
113 Default value: n
115 temperature_scale
117 This option toggles between values in Celsius or in Fahrenheit
118 in those graphs that represent temperatures.
119 The possible values are:
121 c for Celsius.
122 f for Fahrenheit.
123 Default value: c
125 show_gaps
127 This option, when enabled, shows the gaps (missing data) in the
128 graphs. This is specially useful to detect if the server or Mon‐
129 itorix were stopped for a while, or any other unavailability.
130 In order to be able to locate those gaps easily in each graph,
132 it uses the white color in the default black theme and the black
133 color in the white theme. These default colors are defined in
134 monitorix.conf so they can be changed as any other option.
135 Default value: n
137 global_zoom
139 This option zooms all the graphs (including the legend's font
140 size) by the given amount. The factor must be greater than 0 and
141 it accepts decimal values.
142 This is specially useful for people with big screens that either
144 want to avoid using the browser feature to zoom the contents of
145 the window and for those that watch the graphs from certain dis‐
146 tance.
147 Keep in mind that the contents of the graphs remains with the
149 same detail level all the time, and that it doesn't affects to
150 the standard zoomed graph that appears when clicking in the pic‐
151 ture.
152 Default value: 1
154 max_historic_years
156 This option defines the maximum number of years of historical
157 data in all graphs.
158 WARNING: Every time this value is extended Monitorix will resize
160 every .rrd file accordingly, removing all historical data.
161 There is no longer any upper limit for this value.
163 Default value: 1
165 accept_selfsigned_certs
167 This option forces to accept self-signed certificates when col‐
168 lecting values remotely using HTTPS protocol.
169 Default value: y
171 priority
173 Sometimes when a server is under heavy use, Monitorix might be
174 unable to collect some statistical data due to its normal prior‐
175 ity (0 by default). This makes monitoring useless because graphs
176 are empty during that hard period of time.
177 In order to mitigate this situation this option sets the prior‐
179 ity in which Monitorix will be scheduled by the kernel. The
180 accepted range of values is the same as in the setpriority()
181 system call: that is, from -20 (maximum priority) to 19 (lowest
182 priority).
183 Default value: 0
185 image_format
187 This is the format of each generated graph. There are only two
188 possible values: PNG and SVG.
189 Default value: PNG
191 enable_parallelizing
193 This option will fork an independent process for each graph in
194 order to speed up graph generation in multi-core systems. It's
195 best to keep it disabled on unicore processors.
196 Default value: y
198 include_dir
200 The main configuration file is usually called monitorix.conf and
201 its location is provided as part of the command line arguments.
202 In addition, other configuration files may be loaded placing
203 them in the directory pointed by this option. The names must end
204 with .conf to be included.
205 This option is mainly intended to include third-party modules
207 with their own configuration files without having to modify any
208 file from your Monitorix installation. All modules are located
209 in /usr/lib/monitorix (in some operating systems that path can
210 change).
211 All the configuration files in there will be loaded in alpha‐
213 betic order, so the last file loaded will overwrite any previous
214 option.
215 Default value: /etc/monitorix/conf.d
217 ip_default_table
219 This option will define in which table Monitorix will put all
220 iptables rules for network traffic accounting monitoring. It
221 only works on Linux.
222 Although this is a global option, only the graphs port, nginx
224 and traffacct are affected by it.
225 Default value: filter
227 ipv6_disabled
229 This option enables or disables the use of the ip6tables com‐
230 mand. It only works on Linux.
231 Although this is a global option, only the graph port is cur‐
233 rently affected by it.
234 Default value: n
236 url_prefix_proxy
238 This option forces monitorix.cgi to bypass the URL building.
239 This is specially useful when Monitorix is used behind a reverse
240 proxy.
241 An example would be: http://myexternalwebsite.com
243 Default value:
245 enable_hourly_view
247 This option enables or disables the ability to select the hourly
248 view in the main page.
249 No .rrd file will change by selecting this option and the his‐
251 torical data won't be affected.
252 Default value: n
254 user_agent_id
256 This option defines the string to be used to identify Monitorix
257 in the HTTP requests. Its value will be sent as the "User-Agent"
258 header.
259 The default value will depend on the current Perl version in
261 your system. An example would be libwww-perl/5.833.
262 enable_back_button
264 This option enables or disables the ability to go back to the
265 main page from the graphs page without using the browser's back
266 button.
267 It will show a back arrow in the upper-left corner and it is
269 specially useful for people using the browser in full-screen
270 mode.
271 Default value: n
273 rrdtool_extra_options
275 This option permits create a comma-separated list of RRDtool
276 options that will be included in all graphs. This is specially
277 useful if you want to take advantage of an specific RRDtool
278 graphics option.
279 An example would be:
281 rrdtool_extra_options = "--grid-dash=1:0, --no-legend"
283 use_external_firewall
285 By default, Monitorix creates a set of iptables rules to collect
286 the amount of network activity that some graphs (port.pm and
287 nginx.pm) need. This might be a problem for people using an
288 external firewall that could eventually remove such iptables
289 rules created by Monitorix. In these cases, you may want to set
290 this option as y to tell Monitorix to not create such iptables
291 rules, but expect that they will be already created by an exter‐
292 nal software.
293 Keep in mind that the rule names created in your firewall must
295 coincide with the names that Monitorix expects to find for each
296 case. Familiarize yourself with the iptables rules created auto‐
297 matically by Monitorix before enabling this option.
298 Default value: n
300 base_dir
302 This is the absolute path to the directory where all the web
303 elements are located:
304 cgi/ directory where resides monitorix.cgi.
306 imgs/ directory for the .png graph images.
307 index.html Monitorix main page.
308 logo_bot.png Monitorix bottom logo.
309 logo_top.png Monitorix top logo.
310 monitorixico.png Monitorix favicon logo.
311 Default value: /var/lib/monitorix/www/
313 (depends on the operating system)
314 base_lib
316 This is the absolute path to the directory where all of the
317 monthly reports, daily traffic usage, and RRD files are located:
318 reports/ monthly reports localization directory.
320 usage/ daily traffic usage data directory.
321 *.rrd RRD files.
322 Default value: /var/lib/monitorix/
324 (depends on the operating system)
325 base_url
327 This is the URL prefix that Monitorix utilizes when referring to
328 its own pages and files.
329 Default value: /monitorix
331 base_cgi
333 This is the URL prefix that Monitorix utilizes when referring to
334 monitorix.cgi.
335 Default value: /monitorix-cgi
337 HTTP built-in server
339 enabled
340 This enables or disables the HTTP server that Monitorix has
341 built-in. This is specially useful for system administrators
342 that don't want to install a web server (Apache, Lighttpd,
343 Nginx, etc.) to see the Monitorix graphs.
344 Default value: y
346 host
348 This option takes an optional host address for this server to
349 bind to. If none is specified (default) it will bind to all
350 interfaces.
351 Default value:
353 port
355 This is the network port from where the HTTP server will listen
356 on.
357 Default value: 8080
359 user/group
361 This sets the user and group that the HTTP server will run as.
362 Default value for user: nobody
364 Default value for group: nobody
365 log_file
367 This is the path to the HTTP server log file.
368 If you leave this option blank or undefined Monitorix will log
370 using the standard file descriptors. This is specially useful on
371 systemd-based systems, you'll need to use the command journalctl
372 -u monitorix to see the logs.
373 Default value: /var/log/monitorix-httpd
375 hosts_deny
377 This is a comma delimited set of IP addresses which are not per‐
378 mitted to access Monitorix graphs. There is the special keyword
379 called all that can be used to deny all IP addresses.
380 The access control uses the same approach as in the TCP-Wrap‐
382 pers; the search stops at the first match:
383 - Access will be granted when an IP address matches an
385 entry in the hosts_allow list.
386 - Otherwise, access will be denied when an IP address
387 matches an entry in the hosts_deny list.
388 - Otherwise, access will be granted.
389 Default value:
391 hosts_allow
393 This is the opposite of hosts_deny option. IP addresses listed
394 here are permitted to access Monitorix graphs. There is also the
395 special keyword called all that can be used to allow access to
396 all IP addresses.
397 Default value:
399 https_url
401 This will force to use the prefix https:// in all links. This is
402 special useful if you plan to use a reverse-proxy HTTPS server
403 in front of the Monitorix HTTP built-in server.
404 Default value: n
406 autocheck_responsiveness
408 There is a well known problem with the HTTP built-in server that
409 Monitorix implements using the Perl module 'HTTP::Server::Sim‐
410 ple'. It looks like it's pretty weak to the common attacks that
411 any web server receives every day. As a consequence of that, it
412 just hangs, and when you want to see the stats of your server,
413 you just see your browser waiting for a response that never
414 comes, which ends up with a timeout. In these cases, you are
415 forced to login to your server and restart Monitorix, in order
416 to refresh the HTTP built-in server.
417 So in order to mitigate (hopefully) all this annoying hangups,
419 this options acts like an autocheck to control the responsive‐
420 ness of the HTTP server on every minute, and in case of no
421 response then it will be restarted automatically.
422 Default value: y
424 HTTP built-in server with access authentication
426 enabled
427 This enables or disables the authentication mechanism to control
428 access to pages and other resources. The only allowed mechanism
429 is Basic and uses the 401 status code and the WWW-Authenticate
430 response header.
431 It's highly recommended to set this option according your needs
433 before start Monitorix.
434 For more information about the Basic access authentication mech‐
436 anism and its security implications, please refer to
437 http://en.wikipedia.org/wiki/Basic_access_authentication.
438 Default value: n
440 msg
442 This option sets the Realm to be used in the authentication.
443 That message should appear in the client dialog box to help user
444 to identify the secure area.
445 Default value: Monitorix: Restricted access
447 htpasswd
449 This option sets the path to the password file that was created
450 with the help of the htpasswd.pl script. That script encrypts
451 and validates passwords using the system's crypt() routine. If
452 your Monitorix package doesn't come with that script, you may
453 use the similar htpasswd(1) program provided with the Apache web
454 server.
455 The format of the password file consist of one or more lines
457 with a username and password separated by a colon.
458 The following is an example of a password file:
460 paul:oGkEsQK6RYIII
462 peter:HF1r7qRL4Kg6E
463 Since the script uses the crypt() algorithm, only the first 8
465 characters of the password are used to form the password. If the
466 supplied password is longer, the extra characters will be
467 silently discarded.
468 WARNING: don't use the character colon ':' as part of your name
470 or password since this character is used as field separator.
471 Default value: /var/lib/monitorix/htpasswd
473 hosts_deny
475 This is a comma delimited set of IP addresses which will be
476 forced to do authentication. There is the special keyword called
477 all that can be used to deny all IP addresses.
478 The access control uses a similar approach as in the TCP-Wrap‐
480 pers; the search stops at the first match:
481 - Access will be granted when an IP address matches an
483 entry in the hosts_allow list.
484 - Otherwise, access will be denied when an IP address
485 matches an entry in the hosts_deny list.
486 - Otherwise, access will be denied (if not defined it will
487 deny all hosts).
488 Default value: all
490 hosts_allow
492 This is the opposite of hosts_deny option. IP addresses listed
493 here will bypass the authentication mechanism (even when it is
494 enabled). It helps in specific cases like to avoid to have to
495 include the auth credentials in the url_prefix of the emailre‐
496 ports module. There is also the special keyword called all that
497 can be used to allow access to all IP addresses.
498 Default value:
500 Log files pathnames
502 log_file
503 This is the path of the Monitorix log file. Please check this
504 file periodically and especially after every update to confirm
505 proper operation.
506 If you leave this option blank or undefined Monitorix will log
508 using the standard file descriptors. This is specially useful on
509 systemd-based systems, you'll need to use the command journalctl
510 -u monitorix to see the logs.
511 Default value: /var/log/monitorix
513 secure_log
515 This is the path to the system log (also known as auth.log,
516 etc.) Monitorix uses this file to report SSH, POP3, FTP and Tel‐
517 net successful logins.
518 Default value: /var/log/secure
520 mail_log
522 This is the path to the mail log file. Monitorix uses this file
523 to report messages sent (supporting Sendmail and Postfix for‐
524 mats), and the MailScanner log format for spam-mail and virus-
525 mail alerts.
526 Default value: /var/log/maillog
528 milter_gl
530 This is the path to the dump file of milter-greylist.
531 Default value: /var/milter-greylist/greylist.db
533 imap_log
535 This is the path to the IMAP (Dovecot or UW-IMAP) log file. Mon‐
536 itorix uses this file to report IMAP and POP3 successful logins.
537 Default value: /var/log/imap
539 hylafax_log
541 This is the path to the Hylafax log file. Monitorix uses this
542 file to report successful FAX dispatches.
543 Default value: /var/spool/hylafax/etc/xferfaxlog
545 cups_log
547 This is the path to the CUPS page log file. Monitorix uses this
548 file to report on print jobs.
549 Default value: /var/log/cups/page_log
551 ftp_log
553 This is the path to the FTP server (ProFTPD, vsftpd or Pure-
554 FTPd) log. Monitorix uses this file to report FTP successful
555 logins and other FTP-related information.
556 Default value: /var/log/proftpd/access.log
558 fail2ban_log
560 This is the path to the Fail2ban log file. Monitorix uses this
561 file only if the option graph_mode has the value rate.
562 Default value: /var/log/fail2ban.log
564 spamassassin_log
566 This is the path to the Spamassassin log file. Monitorix uses
567 this file to report spam-mail alerts.
568 Default value: /var/log/maillog
570 clamav_log
572 This is the path to the Clamav log file. Monitorix uses this
573 file to report virus-mail alerts.
574 Default value: /var/log/clamav/clamav.log
576 cg_logdir
578 This is the path to the CommuniGate logs directory. Monitorix
579 uses these files to report the number of mail messages success‐
580 fully received and sent, and to report IMAP and POP3 successful
581 logins.
582 Default value: /var/CommuniGate/SystemLogs/
584 squid_log
586 This is the path to the Squid log file. Monitorix uses this file
587 to report on Squid Proxy requests.
588 Default value: /var/log/squid/access.log
590 imap_log_date_format
592 This is the Dovecot date format as it appears in the imap_log
593 file.
594 Default value: %b %d
596 secure_log_date_format
598 This is secure_log date format.
599 Default value: %b %e
601 Piwik tracking code
603 enabled
604 This enables the inclusion of the Piwik tracking code in the
605 main index.html file. Please refer to
606 http://piwik.org/docs/tracking-api/ for more information on how
607 to fill these fields.
608 Default value: n
610 Enable or disable graphs
612 graph_enable
613 This enables or disables the monitoring of each graph. Placing a
614 y on a desired graph and restarting Monitorix will automatically
615 create the RRD file for that graph and start gathering informa‐
616 tion according to its settings.
617 System load average and usage (system.pm)
619 This graph shows information about system load average (classical UNIX
620 triplet), memory allocation, active processes (on Linux brought
621 directly from the /proc directory), entropy and the system uptime.
622 loadavg_enabled
624 This section enables or disables the alert capabilities for this
625 graph. Only the alert for the average CPU load is currently
626 implemented. It works as follows:
627 This alert uses the minimum value between the second and the
629 third load averages (those that represent the last 5 and 15 min‐
630 utes), and if it reaches the loadavg_threshold value for the
631 interval of time defined in loadavg_timeintvl, Monitorix will
632 execute the external alert script defined in loadavg_script.
633 The idea to use min(load5, load15) is to obtain a more symmetric
635 curve and a sooner cancellation of the alert.
636 The default Monitorix installation includes an example of a
638 shell-script alert called monitorix-alert.sh which you can use
639 as a base for your own script.
640 Default value: n
642 loadavg_timeintvl
644 This is the period of time (in seconds) that the threshold needs
645 to be exceeded before the external alert script is executed.
646 Default value: 3600
648 loadavg_threshold
650 This is the value that needs to be reached or exceeded within
651 the specified time period in loadavg_timeintvl to trigger the
652 mechanism for a particular action, which in this case is the
653 execution of an external alert script.
654 The value of this option is compared against the last 15 minutes
656 of CPU load average.
657 Default value: 5.0
659 loadavg_script
661 This is the full path name of the script that will be executed
662 by this alert.
663 It will receive the following three parameters:
665 1st - the value currently defined in loadavg_timeintvl.
667 2nd - the value currently defined in loadavg_threshold.
668 3rd - the current 15min CPU load average.
669 Default value: /path/to/script.sh
671 Global kernel usage (kern.pm)
673 Note that the VFS graph is just informative of how the kernel is bal‐
674 ancing its tables. graph_mode
675 This changes the layout of the kernel usage graph, the possible
676 values are r for a real graph, or s for a stacked graph (every
677 line or area is stacked on top of the previous element).
678 Default value: r
680 list
682 This is the list of values offered in modern Linux kernels.
683 Older Linux kernels or other Operating Systems may not have all
684 of them. Placing a y or an n will enable or disable the value in
685 the graph.
686 Kernel usage per processor (proc.pm)
688 max
689 This is the number of processors or cores that your system has.
690 There is no limit, however keep in mind that every time this
691 number is changed Monitorix will resize the proc.rrd file
692 accordingly, removing all historical data.
693 Default value: 4
695 graphs_per_row
697 This is the number of processor graphs that will be put in a
698 row. Consider the interaction of this parameter with the size
699 and data options (below) in order to adjust the size and number
700 of graphs in relation to your horizontal screen size.
701 Default value: 2
703 size
705 This option sets the size of all processors graphs.
706 The possible values are:
708 main for 450x150 graphs.
709 medium for 325x150 graphs.
710 medium2 for 325x70 graphs.
711 small for 200x66 graphs.
712 mini for 183x66 graphs.
713 tiny for 110x40 graphs.
714 Default value: medium
716 DATA
718 This option will completely enable or disable the legend in the
719 processor graphs.
720 Default value: y
722 HP ProLiant System Health (hptemp.pm)
724 list
725 This list will hold the defined temperature sensors for each
726 graph. You must have installed the command hplog that comes with
727 HP ProLiant System Health Application and Command Line Utili‐
728 ties.
729 Each graph has a limited number of IDs:
731 graph_0 up to 8 IDs.
733 graph_1 up to 6 IDs.
734 graph_2 up to 6 IDs.
735 The following is a configuration example of selected IDs:
737 # hplog -t
739 ID TYPE LOCATION STATUS CURRENT THRESHOLD
740 1 Basic Sensor Ambient Normal 75F/ 24C 107F/ 42C
741 2 Basic Sensor CPU (1) Normal 104F/ 40C 179F/ 82C
742 3 Basic Sensor CPU (2) Normal ---F/---C 179F/ 82C
743 4 Basic Sensor Memory Board Normal ---F/---C 188F/ 87C
744 5 Basic Sensor Memory Board Normal 82F/ 28C 188F/ 87C
745 6 Basic Sensor Memory Board Normal ---F/---C 188F/ 87C
746 7 Basic Sensor System Board Normal 89F/ 32C 192F/ 89C
747 8 Basic Sensor System Board Normal ---F/---C 192F/ 89C
748 9 Basic Sensor System Board Normal 84F/ 29C 192F/ 89C
749 10 Basic Sensor System Board Normal 118F/ 48C 230F/110C
750 11 Basic Sensor System Board Normal 96F/ 36C 192F/ 89C
751 12 Basic Sensor System Board Normal 84F/ 29C 154F/ 68C
752 13 Basic Sensor System Board Normal 87F/ 31C 154F/ 68C
753 14 Basic Sensor System Board Normal 89F/ 32C 156F/ 69C
754 15 Basic Sensor System Board Normal 93F/ 34C 161F/ 72C
755 16 Basic Sensor Ambient Normal ---F/---C 192F/ 89C
756 17 Basic Sensor System Board Normal ---F/---C 192F/ 89C
757 18 Basic Sensor SCSI Backplane Normal 32F/ 0C 140F/ 60C
758 <list>
760 graph_0 = 2, 3
761 graph_1 = 1, 5, 18
762 graph_2 = 7, 9, 10, 11, 12, 13
763 </list>
764 alerts
766 This optional list enables the alert capabilities for this graph
767 and complements with the list option. Each alert has three
768 fields separated by comma: the time interval, the threshold and
769 the path to the script to be executed.
770 The time interval is the period of time (in seconds) that the
772 threshold needs to be exceeded before the external script is
773 executed.
774 The threshold is the temperature that needs to be reached or
776 exceeded within the specified time in time interval to execute
777 the external script.
778 The script is the full path name of the script that will be exe‐
780 cuted by this alert.
781 Each defined sensor has its own alert.
783 The default Monitorix installation includes an example of a
785 shell-script alert called monitorix-alert.sh which you can use
786 as a base for your own script.
787 The following is an example of an alert defined for the first
789 temperature sensor:
790 <alerts>
792 2 = 3600, 40, /path/to/script.sh
793 </alerts>
794 Such alert means that if the value of the sensor number 2
796 reaches or exceeds 40 during at least one hour (3600 seconds)
797 the script in /path/to/script.sh will be executed.
798 The external script will receive the following arguments:
800 1st - the value defined as time interval.
802 2nd - the value defined as threshold.
803 3rd - the value of the sensor.
804 LM-Sensors and GPU temperatures (lmsens.pm)
806 list
807 In this list you may specify the sensors you want to monitor
808 with the same names as they appear in your sensors(1) command.
809 For example, imagine a sensors(1) output like this:
811 # sensors
813 coretemp-isa-0000
814 Adapter: ISA adapter
815 Core 0: +51.0°C (high = +78.0°C, crit = +100.0°C)
816 coretemp-isa-0001
818 Adapter: ISA adapter
819 Core 1: +49.0°C (high = +78.0°C, crit = +100.0°C)
820 f71882fg-isa-0a00
822 Adapter: ISA adapter
823 3.3V: +3.30 V
824 Vcore: +1.21 V (max = +2.04 V)
825 Vdimm: +1.82 V
826 Vchip: +1.38 V
827 +5V: +5.00 V
828 12V: +14.37 V
829 5VSB: +4.33 V
830 3VSB: +3.30 V
831 Battery: +3.22 V
832 CPU: 2035 RPM
833 System: 1765 RPM ALARM
834 Power: 2110 RPM ALARM
835 Aux: 2080 RPM ALARM
836 M/B Temp: +36.00 C
837 CPU Temp: +29.00 C
838 Then you may want to configure that list as:
840 <list>
842 core0 = Core 0
843 core1 = Core 1
844 mb0 = M/B Temp
845 cpu0 = CPU Temp
846 fan0 = CPU
847 fan1 = System
848 fan2 = Power
849 fan3 = Aux
850 volt0 = 3.3V
851 volt1 = VCore
852 volt2 = Vdimm
853 volt3 = Vchip
854 volt4 = \+5V
855 volt5 = 12V
856 volt6 = 5VSB
857 volt7 = 3VSB
858 volt8 = Battery
859 gpu0 = nvidia
860 </list>
861 Note that you need to escape the plus and minus signs in the
863 voltage labels. It also recommended to enclose the values using
864 double quotes.
865 The last one, gpu0, is set here just in case you have a sup‐
867 ported graphics card and want to monitor its temperature. Cur‐
868 rently only NVIDIA and ATI graphic cards are supported; with the
869 values nvidia and ati respectively. It requires the official
870 NVIDIA or ATI drivers.
871 This list has the following maximums allowed:
873 Up to 16 core keys (from core0 to core15).
875 Up to 2 mb keys (mb0 and mb1).
876 Up to 4 cpu keys (from cpu0 to cpu3).
877 Up to 9 fan keys (from fan0 to fan8).
878 Up to 12 volt keys (from volt0 to volt11).
879 Up to 9 gpu keys (from gpu0 to gpu8).
880 desc
882 This list complements the list option. It basically allows you
883 to change the name that will appear in the graph, hiding the
884 real name of the sensor. If no association is defined, then Mon‐
885 itorix will display the name of the key (left side) in the desc
886 option (in uppercase in some graphs).
887 <desc>
889 mb0 = M/B
890 fan0 = CPUFan
891 gpu0 = ATI
892 </desc>
893 Please note that in the default graph all names are limited to 5
895 characters in order to fit up to 9 different values. In the
896 zoomed graphs the limit is 8 characters.
897 alerts
899 This optional list enables the alert capabilities for this graph
900 and complements with the list option. Each alert has three
901 fields separated by comma: the time interval, the threshold and
902 the path to the script to be executed.
903 The time interval is the period of time (in seconds) that the
905 threshold needs to be exceeded before the external script is
906 executed.
907 The threshold is the temperature or volts, or whatever that
909 needs to be reached or exceeded within the specified time in
910 time interval to execute the external script.
911 The script is the full path name of the script that will be exe‐
913 cuted by this alert.
914 Each defined sensor has its own alert.
916 The default Monitorix installation includes an example of a
918 shell-script alert called monitorix-alert.sh which you can use
919 as a base for your own script.
920 The following is an example of an alert defined for the first
922 temperature sensor:
923 <alerts>
925 core0 = 3600, 40, /path/to/script.sh
926 </alerts>
927 Such alert means that if the value of the sensor core0 reaches
929 or exceeds 40 during at least one hour (3600 seconds) the script
930 in /path/to/script.sh will be executed.
931 The external script will receive the following arguments:
933 1st - the value defined as time interval.
935 2nd - the value defined as threshold.
936 3rd - the value of the sensor.
937 Generic sensors statistics (gensens.pm)
939 This graph helps to monitor up to three (so far) different sensors:
940 temperatures, CPU frequencies and battery status which, depending of
941 your machine, they should appear in the /sys directory.
942 list
944 This is a list of an unlimited number of groups to define the
945 sensors to monitor. Each group is numbered starting from 0, and
946 each one can hold up to 9 different entries separated by comma
947 which corresponds to the names of the sensors present in your
948 computer that you want to monitor. This module is capable to
949 identify the type of the group by searching the substrings temp,
950 cpu and bat, so it will put automatically the vertical label in
951 the graph accordingly (Celsius or Fahrenheit, Hz or Charge
952 respectively). Of course, it cannot supports mixed sensors in a
953 same group. For example, if you need to monitor more than 9 tem‐
954 perature sensors just create a new group in list.
955 An example would be:
957 <list>
959 0 = temp0, temp1
960 1 = cpu0, cpu1, cpu2, cpu3
961 2 = bat0
962 </list>
963 title
964 In this option you must associate a title with the group number
965 specified in list. This is the title that will appear as the
966 name of the graph. Following the settings in the example above:
967 <title>
969 0 = Temperatures
970 1 = CPU frequency
971 2 = Battery status
972 </title>
973 desc
974 In this option you must associate the complete pathname of the
975 file from where to get the value of each entry defined in the
976 list option. Following the settings in the example above:
977 <desc>
979 temp0 = /sys/devices/virtual/thermal/ther‐
980 mal_zone0/temp
981 temp1 = /sys/devices/virtual/thermal/ther‐
982 mal_zone1/temp
983 cpu0 = /sys/devices/system/cpu/cpu0/cpufreq/scal‐
984 ing_cur_freq
985 cpu1 = /sys/devices/system/cpu/cpu1/cpufreq/scal‐
986 ing_cur_freq
987 cpu2 = /sys/devices/system/cpu/cpu2/cpufreq/scal‐
988 ing_cur_freq
989 cpu3 = /sys/devices/system/cpu/cpu3/cpufreq/scal‐
990 ing_cur_freq
991 bat0 = /sys/class/power_supply/BAT0/capacity
992 </desc>
993 unit
994 With this option you can define the order of magnitude associ‐
995 ated to a specific value. This is used in both temperatures and
996 CPU frequencies, since this kind of temperature sensors tend to
997 give the value in 1000ths of degrees Celsius. In the case of CPU
998 frequencies the values come in Mhz which means that they need to
999 be converted to Hz by multiplying them by 1000. Since the bat‐
1000 tery value represents a percentage, it doesn't need any special
1001 calculation. Therefore you can define something like this:
1002 <unit>
1004 temp0 = 1000
1005 temp1 = 1000
1006 cpu0 = 0.001
1007 cpu1 = 0.001
1008 cpu2 = 0.001
1009 cpu3 = 0.001
1010 bat0 = 1
1011 </unit>
1012 map
1013 With this option you can optionally rename any of the sensor
1014 names defined in the list option. Following the above example:
1015 <map>
1017 temp0 = Temperature Zone 0
1018 temp1 = Temperature Zone 1
1019 cpu0 = CPU0 frequency
1020 cpu1 = CPU1 frequency
1021 cpu2 = CPU2 frequency
1022 cpu3 = CPU3 frequency
1023 bat0 = Battery 0
1024 </map>
1025 All names are limited to 20 characters.
1027 alerts
1029 This optional list enables the alert capabilities for this graph
1030 and complements with the list option. Each alert has four fields
1031 separated by comma: the time interval, the threshold, the path
1032 to the script to be executed and when the alert must be trig‐
1033 gered. the last field is optional.
1034 The time interval is the period of time (in seconds) that the
1036 threshold needs to be exceeded before the external script is
1037 executed.
1038 The threshold is the value (temperature, Hz or battery charge)
1040 that needs to be reached or exceeded within the specified time
1041 in time interval to execute the external script. It can be spec‐
1042 ified as a unique value or as a range of two values separated by
1043 a dash.
1044 The script is the full path name of the script that will be exe‐
1046 cuted by this alert.
1047 The when value specifies when the alert must be triggered (above
1049 or below) the threshold, being above the default value when it's
1050 not specified. This forth parameter is only relevant when the
1051 threshold value is not a range.
1052 Each defined sensor has its own alert.
1054 The default Monitorix installation includes an example of a
1056 shell-script alert called monitorix-alert.sh which you can use
1057 as a base for your own script.
1058 The following is an example of an alert defined for the first
1060 temperature sensor:
1061 <alerts>
1063 temp0 = 3600, 40, /path/to/script.sh, above
1064 temp1 = 3600, 10, /path/to/script.sh, below
1065 temp2 = 3600, 40-60, /path/to/script.sh
1066 </alerts>
1067 The first alert means that if the value of the sensor temp0
1069 exceeds above 40 during at least one hour (3600 seconds) the
1070 script in /path/to/script.sh will be executed.
1071 The second alert means that if the value of the sensor temp1
1073 exceeds below 10 during at least one hour (3600 seconds) the
1074 script in /path/to/script.sh will be executed.
1075 The third alert means that if the value of the sensor temp2
1077 exceeds either below 40 or above of 60 during at least one hour
1078 (3600 seconds) the script in /path/to/script.sh will be exe‐
1079 cuted.
1080 The external script will receive the following arguments:
1082 1st - the value defined as time interval.
1084 2nd - the value defined as threshold.
1085 3rd - the value of the sensor.
1086 4th - the direction or when that alert was triggered by
1087 (above or below).
1088 IPMI sensor statistics (ipmi.pm)
1090 This graph is able to monitor an unlimited number of IPMI sensors (tem‐
1091 peratures, fans and voltages).
1092 list
1094 This is a comma-separated list that describes the groups of sen‐
1095 sors in desc. Put one description for each group. For every
1096 group specified you need to specify its sensors in the desc
1097 option.
1098 WARNING: Every time the number of entries in this option
1100 changes, Monitorix will resize the ipmi.rrd file accordingly,
1101 removing all historical data.
1102 An example would be:
1104 list = Temperatures, Fans, Voltages
1106 desc
1108 This is a list of sensors per group defined.
1109 <desc>
1111 0 = CPU Temp, System Temp
1112 1 = FAN 1
1113 2 = Vcore, 3.3VCC, 12V, VDIMM, 5VCC, CPU VTT, VBAT, VSB,
1114 AVCC
1115 </desc>
1116 The maximum number of sensors allowed for each group is 9.
1118 units
1120 This is the type of sensor in each group. It's important to not
1121 mix different type of sensors in a same group. This value is
1122 informative only, it's mostly used as a title for the y-axis in
1123 the graphs and should match with the output of the ipmitool com‐
1124 mand.
1125 map
1127 This list complements the desc option. It basically allows you
1128 to change the name that will appear in the graph, hiding the
1129 real name of the sensor. If no association is defined, then Mon‐
1130 itorix will display the name specified in the desc option. Note,
1131 this only works in names that don't include whitespaces.
1132 alerts
1134 This optional list enables the alert capabilities for this graph
1135 and complements with the desc option. Each alert has three
1136 fields separated by comma: the time interval, the threshold and
1137 the path to the script to be executed.
1138 The time interval is the period of time (in seconds) that the
1140 threshold needs to be exceeded before the external script is
1141 executed.
1142 The threshold is the temperature that needs to be reached or
1144 exceeded within the specified time in time interval to execute
1145 the external script.
1146 The script is the full path name of the script that will be exe‐
1148 cuted by this alert.
1149 Each defined sensor has its own alert.
1151 The default Monitorix installation includes an example of a
1153 shell-script alert called monitorix-alert.sh which you can use
1154 as a base for your own script.
1155 The following is an example of an alert defined for the first
1157 temperature sensor:
1158 <alerts>
1160 CPU_Temp = 3600, 40, /path/to/script.sh
1161 </alerts>
1162 Notice that the spaces in the sensor's name must be con‐
1164 verted to underscores, since a variable can hold spaces
1165 in its name.
1166 Such alert means that if the value of the sensor CPU_Temp
1168 reaches or exceeds 40 during at least one hour (3600 seconds)
1169 the script in /path/to/script.sh will be executed.
1170 The external script will receive the following arguments:
1172 1st - the value defined as time interval.
1174 2nd - the value defined as threshold.
1175 3rd - the value of the sensor.
1176 graphs_per_row
1178 This is the number of graphs that will be put in a row.
1179 Default value: 2
1181 extra_args
1183 This option includes any extra argument to the ipmitool command
1184 executed by Monitorix, which is "ipmitool <extra_args> sdr".
1185 This is specially useful if you need to monitor a remote server.
1186 An example would be:
1187 extra_args = -H <remote_ip> -U root -P <password>
1189 Default value: none
1191 Ambient sensor statistics (ambsens.pm)
1193 This graph is able to monitor an unlimited number of ambient sensors
1194 (temperatures, humidity, barometer, etc.).
1195 list
1197 This is a comma-separated list that describes the type of sen‐
1198 sors in desc. Put one description for each type. For every type
1199 specified you need to specify its sensors in the desc option.
1200 Each one most be referenced as a numeric value starting from
1201 zero in the desc option. There you will define all the sensors
1202 than come with that type of sensor.
1203 WARNING: Every time the number of entries in this option
1205 changes, Monitorix will resize the ambsens.rrd file accordingly,
1206 removing all historical data.
1207 An example would be:
1209 list = Ambient temperature, Humidity
1211 desc
1213 This is a list of sensors per type defined. The name is irrele‐
1214 vant.
1215 <desc>
1217 0 = at1, at2, at3
1218 1 = h0
1219 </desc>
1220 The maximum number of sensors allowed for each type is 9.
1222 units
1224 This is the class of sensor for each type. It's important to not
1225 mix different type of sensors in a same group. This value is
1226 informative only, it's mostly used as a title for the y-axis in
1227 the graphs.
1228 cmd
1230 This list complements the desc option. It basically allows you
1231 to associate a script or program that will be executed to
1232 retrieve the value for each sensor.
1233 map
1235 This list complements the desc option. It basically allows you
1236 to change the name that will appear in the graph, hiding the
1237 real name of the sensor. If no association is defined, then Mon‐
1238 itorix will display the name specified in the desc option. Note,
1239 this only works in names that don't include whitespaces.
1240 alerts
1242 This optional list enables the alert capabilities for this graph
1243 and complements with the list option. Each alert has four fields
1244 separated by comma: the time interval, the threshold, the path
1245 to the script to be executed and when the alert must be trig‐
1246 gered. the last field is optional.
1247 The time interval is the period of time (in seconds) that the
1249 threshold needs to be exceeded before the external script is
1250 executed.
1251 The threshold is the value (temperature, etc.) that needs to be
1253 reached or exceeded within the specified time in time interval
1254 to execute the external script. It can be specified as a unique
1255 value or as a range of two values separated by a dash.
1256 The script is the full path name of the script that will be exe‐
1258 cuted by this alert.
1259 The when value specifies when the alert must be triggered (above
1261 or below) the threshold, being above the default value when it's
1262 not specified. This forth parameter is only relevant when the
1263 threshold value is not a range.
1264 Each defined sensor has its own alert.
1266 The default Monitorix installation includes an example of a
1268 shell-script alert called monitorix-alert.sh which you can use
1269 as a base for your own script.
1270 The following is an example of an alert defined for the first
1272 temperature sensor:
1273 <alerts>
1275 temp0 = 3600, 40, /path/to/script.sh, above
1276 temp1 = 3600, 10, /path/to/script.sh, below
1277 temp2 = 3600, 40-60, /path/to/script.sh
1278 </alerts>
1279 The first alert means that if the value of the sensor temp0
1281 exceeds above 40 during at least one hour (3600 seconds) the
1282 script in /path/to/script.sh will be executed.
1283 The second alert means that if the value of the sensor temp1
1285 exceeds below 10 during at least one hour (3600 seconds) the
1286 script in /path/to/script.sh will be executed.
1287 The third alert means that if the value of the sensor temp2
1289 either exceeds below 40 or above of 60 during at least one hour
1290 (3600 seconds) the script in /path/to/script.sh will be exe‐
1291 cuted.
1292 The external script will receive the following arguments:
1294 1st - the value defined as time interval.
1296 2nd - the value defined as threshold.
1297 3rd - the value of the sensor.
1298 4th - the direction or when that alert was triggered by
1299 (above or below).
1300 graphs_per_row
1302 This is the number of graphs that will be put in a row.
1303 Default value: 2
1305 NVIDIA temperatures and usage (nvidia.pm)
1307 This graph requires to have installed the official NVIDIA drivers.
1308 max
1310 This is the number of NVIDIA cards currently plugged in your
1311 system.
1312 The maximum allowed is 9.
1314 Default value: 1
1316 Disk drive temperatures and health (disk.pm)
1318 This graph is able to monitor an unlimited number of disk drives.
1319 list
1321 This is a list of groups of disk drives that you want to moni‐
1322 tor. Each group will become a graph and there may be an unlim‐
1323 ited number of groups. You can define device names or paths to
1324 devices like /dev/disk/by-path/pci-0000:00:11.0-scsi-0:0:0:0.
1325 WARNING: Every time the number of groups in this option changes,
1327 Monitorix will resize the disk.rrd file accordingly, removing
1328 all historical data.
1329 To collect the disk drive temperatures and health the smartmon‐
1331 tools or the hddtemp command are required.
1332 It is recommended that you first check if either smartctl(8) or
1334 hddtemp are able to collect data from the disk drive(s) that you
1335 plan to monitor. You may test this with the following command:
1336 # hddtemp /dev/sda
1338 /dev/sda: WDC WD1600AABS-00M1A0: 48°C
1339 If you see good results as above, you can add it to the group 0
1341 like this:
1342 <list>
1344 0 = /dev/sda, /dev/disk/by-
1345 path/pci-0000:00:11.0-scsi-0:0:0:0
1346 1 = /dev/sdc, /dev/sdd
1347 </list>
1348 The maximum number of disk device names allowed per group is 8.
1350 map
1352 This list complements the list option. It basically allows you
1353 to change the disk name that will appear in the graph, hiding
1354 the real device name. If no association is defined, then Moni‐
1355 torix will display the name of the disk as it is.
1356 <map>
1358 /dev/sda = "system disk"
1359 pci-0000:00:11.0-scsi-0:0:0:0 = "data disk"
1360 </map>
1361 desc
1363 This list complements the list option. It basically allows you
1364 to include a title for every group of disk drives. The title
1365 will appear in the bottom of the graph.
1366 <desc>
1368 0 = Local disks
1369 1 = Remote disks
1370 </desc>
1371 realloc_enabled
1373 This section enables or disables one of the alert capabilities
1374 for this graph; the alert for the number of reallocated sectors
1375 in disk. It works as follows:
1376 If the number of reallocated sectors in any of the specified
1378 disk device names reaches the realloc_threshold (the interval of
1379 time is not used here), Monitorix will execute the external
1380 alert script defined in realloc_script.
1381 The default Monitorix installation includes an example of a
1383 shell-script alert called monitorix-alert.sh which you can use
1384 as a base for your own script.
1385 Default value: n
1387 realloc_timeintvl
1389 Not used in this alert.
1390 Default value: 0
1392 realloc_threshold
1394 This is the value that needs to be reached or exceeded to trig‐
1395 ger the mechanism for a particular action, which in this case is
1396 the execution of an external alert script.
1397 Default value: 1
1399 realloc_script
1401 This is the full path name of the script that will be executed
1402 by this alert.
1403 It will receive the following three parameters:
1405 1st - the value currently defined in realloc_timeintvl.
1407 2nd - the value currently defined in realloc_threshold.
1408 3rd - the current number of reallocated sectors.
1409 Default value: /path/to/script.sh
1411 pendsect_enabled
1413 This section enables or disables one of the alert capabilities
1414 for this graph; the alert for the number of current pending sec‐
1415 tors (or bad sectors) in disk. It works as follows:
1416 If the number of current pending sectors in any of the specified
1418 disk device names reaches the pendsect_threshold (the interval
1419 of time is not used here), Monitorix will execute the external
1420 alert script defined in pendsect_script.
1421 The default Monitorix installation includes an example of a
1423 shell-script alert called monitorix-alert.sh which you can use
1424 as a base for your own script.
1425 Default value: n
1427 pendsect_timeintvl
1429 Not used in this alert.
1430 Default value: 0
1432 pendsect_threshold
1434 This is the value that needs to be reached or exceeded to trig‐
1435 ger the mechanism for a particular action, which in this case is
1436 the execution of an external alert script.
1437 Default value: 1
1439 pendsect_script
1441 This is the full path name of the script that will be executed
1442 by this alert.
1443 It will receive the following three parameters:
1445 1st - the value currently defined in pendsect_timeintvl.
1447 2nd - the value currently defined in pendsect_threshold.
1448 3rd - the current number of pending sectors.
1449 Default value: /path/to/script.sh
1451 accept_invalid_disk
1453 During the init stage this graph verifies that every defined
1454 device name does exist in the system. If not, then the graph
1455 disables itself.
1456 This option changes this behavior and permits to continue work‐
1458 ing even if the device names defined doesn't exist. Keep in mind
1459 that you will continue seeing error messages in the logfile.
1460 Default value: n
1462 Filesystem usage and I/O activity (fs.pm)
1464 This graph is able to monitor an unlimited number of filesystems.
1465 list
1467 This is a list of groups of mounted filesystems that you want to
1468 monitor. Each group will become a graph and there may be an
1469 unlimited number of groups.
1470 WARNING: Every time the number of groups in this option changes,
1472 Monitorix will resize the fs.rrd file accordingly, removing all
1473 historical data.
1474 Take special care to use the same name as appears in the output
1476 of the df(1) command (the swap device is a special case). An
1477 example would be:
1478 <list>
1480 0 = /, swap, boot, home, /mnt/backup
1481 </list>
1482 The maximum number of filesystems allowed per group is 8.
1484 desc
1486 This list complements the list option. It basically allows you
1487 to change the name that will appear in the graph, hiding the
1488 real name of the mount point. If no association is defined, then
1489 Monitorix will display the name specified in the list option.
1490 <desc>
1492 / = Root FS
1493 /home = My Home
1494 /mnt/backup = Backups
1495 </desc>
1496 You can define as much entries as you want.
1498 devmap
1500 This optional list complements the list option. When Monitorix
1501 is started, and in order to be able to show I/O activity, it
1502 attempts to detect the mapping of devices specified in list, as
1503 defined in the df command output column "Mounted on". In the
1504 event that devices are not detected by Monitorix, the devmap
1505 option shall be used to manually define them, according to the
1506 underlying OS:
1507 Linux (kernel > 2.4)
1509 <devmap> device must match a device listed in the
1510 "/proc/diskstats" file.
1511 Linux (kernel <= 2.4)
1513 <devmap> is not used, but because something is
1514 defined in <devmap>, Monitorix will extract
1515 "disk_io" lines from the "/proc/stat" file.
1516 FreeBSD
1518 <devmap> device recognized by the output of
1519 "iostat -xI <dev>" command.
1520 OpenBSD and NetBSD
1522 <devmap> is not used, but because something is
1523 defined in <devmap>, Monitorix will use the output
1524 of "iostat -DI" command.
1525 Just an example:
1527 <devmap>
1528 /mnt/home = dm-1
1529 /mnt/backup = cciss/c0d2p6
1530 </devmap>
1531 You can define as much entries as you want.
1533 alerts
1535 This optional list enables the alert capabilities for this graph
1536 and complements with the list option. Each alert has three
1537 fields separated by comma: the time interval, the threshold and
1538 the path to the script to be executed.
1539 The time interval is the period of time (in seconds) that the
1541 threshold needs to be exceeded before the external script is
1542 executed.
1543 The threshold is the percentage of disk space used in the file
1545 system that needs to be reached or exceeded within the specified
1546 time in time interval to execute the external script.
1547 The script is the full path name of the script that will be exe‐
1549 cuted by this alert.
1550 Each defined filesystem has its own alert.
1552 The default Monitorix installation includes an example of a
1554 shell-script alert called monitorix-alert.sh which you can use
1555 as a base for your own script.
1556 The following is an example of an alert defined for the root
1558 filesystem:
1559 <alerts>
1561 / = 3600, 98, /path/to/script.sh
1562 </alerts>
1563 Such alert means that if the percentage of disk space used in
1565 the root filesystem reaches or exceeds 98 (more than 98) during
1566 at least one hour (3600 seconds) the script in
1567 /path/to/script.sh will be executed.
1568 The external script will receive the following arguments:
1570 1st - the value defined as time interval.
1572 2nd - the value defined as threshold.
1573 3rd - the filesystem disk usage.
1574 ZFS statistics (zfs.pm)
1576 This graph is able to monitor an unlimited number of pools.
1577 max_pools
1579 This is the maximum number of pools that you can define in list.
1580 There is no limit to the number of pools monitored, but keep in
1581 mind that every time this number changes, Monitorix will resize
1582 the zfs.rrd file accordingly, removing all historical data.
1583 Default value: 5
1585 list
1587 This is a comma-separated list of pool names. The number of pool
1588 names defined here can't be greater than the number defined in
1589 max_pools.
1590 Directory usage statistics (du.pm)
1592 This graph is able to monitor the usage of an unlimited number of
1593 directories.
1594 IMPORTANT NOTE: The du command makes intensive disk I/O access that
1596 might slow down the whole system. Moreover, continued executions of
1597 this command will affect the buffer cache mechanism and this will also
1598 increase the system response time.
1599 list
1601 This is a comma-separated list that describes the groups of
1602 directories in desc. Put one description for each group. For
1603 every group specified you need to specify its directories in the
1604 desc option.
1605 WARNING: Every time the number of entries in this option
1607 changes, Monitorix will resize the du.rrd file accordingly,
1608 removing all historical data.
1609 An example would be:
1611 list = System, Users
1613 desc
1615 This is a list of directories per group defined.
1616 <desc>
1618 0 = /var/spool/mail, /var/spool/mqueue, /etc, /var/ftp,
1619 /tmp
1620 1 = /home/ace, /home/gene, /home/paul, /home/peter
1621 </desc>
1622 The maximum number of directories allowed for each group is 9.
1624 type
1626 This specifies the information that will be presented for each
1627 directory specified in each list. It accepts two possible val‐
1628 ues:
1629 size for the directory size (which is the default
1631 option).
1632 files for the number of files inside the directory.
1633 An example would be:
1635 <type>
1637 0 = size
1638 1 = files
1639 </type>
1640 dirmap
1642 This list complements the desc option. It basically allows you
1643 to change the name that will appear in the graph, hiding the
1644 real name of the directory. If no association is defined, then
1645 Monitorix will display the name specified in the desc option.
1646 graphs_per_row
1648 This is the number of graphs that will be put in a row.
1649 Default value: 2
1651 extra_args
1653 This option includes any extra argument to the du command exe‐
1654 cuted by Monitorix, which is "du -ks". This is specially useful
1655 if you want to skip directories on different file systems, in
1656 this case just define this option like this:
1657 extra_args = "-x"
1659 IMPORTANT NOTICE: Keep in mind that including certain flags like
1661 '-h' (which gives results in human readable format) could make
1662 Monitorix unable to interpret the results.
1663 Network traffic and usage (net.pm)
1665 max
1666 This is the maximum number of network interfaces that you can
1667 define in list. There is no limit, but keep in mind that every
1668 time this number changes, Monitorix will resize the net.rrd file
1669 accordingly, removing all historical data.
1670 Default value: 10
1672 list
1674 This is a comma-separated list of network interfaces that you
1675 may want to monitor. An example would be:
1676 list = eth0, eth1
1678 desc
1680 This is the option where each network interface specified in
1681 list is described. Each definition consists of three parameters
1682 separated by comma: the description of the interface and the
1683 rigid and limit values.
1684 Put one description for each interface listed. An example would
1686 be:
1687 <desc>
1689 eth0 = FastEthernet LAN, 0, 1000
1690 eth1 = ADSL 10Mbs Internet, 0, 1000
1691 </desc>
1692 gateway
1694 This is where the network interface that acts as the gateway for
1695 this server is defined. This is mainly used if you plan to moni‐
1696 tor network traffic usage of your devices/networks using the
1697 traffacct graph below.
1698 Netstat statistics (netstat.pm)
1700 This graph shows the state of the all IPv4 and IPv6 network connec‐
1701 tions.
1702 Only the command to be used can be set here, besides the limit and
1704 rigid values.
1705 cmd
1707 This is the command that will be used to gather statistics.
1708 There are two possible values:
1709 ss
1711 netstat
1712 Default value: ss
1714 Tinyproxy statistics (tinyproxy.pm)
1716 This graph is able to monitor an unlimited number of Tinyproxy instal‐
1717 lations.
1718 list
1720 This is a comma-separated list of URLs of Tinyproxys.
1721 WARNING: Every time the number of entries in this option
1723 changes, Monitorix will resize the tinyproxy.rrd file accord‐
1724 ingly, removing all historical data.
1725 Default value: http://your.proxy.com/
1727 desc
1729 This list complements the list option, it defines the URL from
1730 where Monitorix must gather the statistics for each Tinyproxy
1731 defined.
1732 An example of this option would be:
1734 <desc>
1736 http://your.proxy.com = http://tinyproxy.stats
1737 </desc>
1738 show_url
1740 If set to y Monitorix will show the original URL of each
1741 Tinyproxy at the bottom of the graph. For security reasons you
1742 may want to hide this information.
1743 Default value: y
1745 Traffic Control statistics (tc.pm)
1747 This graph is able to monitor an unlimited number of network interfaces
1748 managed by the tc command.
1749 list
1751 This is a comma-separated list of network interfaces that you
1752 may want to monitor. An example would be:
1753 list = eth0, eth1
1755 desc
1757 This is the option where you define the queue disciplines you
1758 want to monitor for each network interface specified in list.
1759 An example would be:
1761 <desc>
1763 eth0 = cbq 1, sfq 10, sfq 20, sfq 30, ingress ffff
1764 eth1 = htb 1, pfifo 20, pfifo 21, pfifo 22
1765 </desc>
1766 The maximum number of qdiscs allowed is 9.
1768 map
1770 This option complements the desc option. It basically allows you
1771 to change the name of the qdiscs that will appear in the graphs.
1772 If no association is defined, then Monitorix will show the name
1773 as specified in the desc option.
1774 Since the qdisc names have the space character in their names,
1776 they can't be used as the key in the association, instead you
1777 must the use their position number (starting by 0) in the desc
1778 option.
1779 An example would be:
1781 <map>
1783 <eth0>
1784 0 = Class Based Queueing
1785 1 = Stochastic Fairness Queueing 10
1786 </eth0>
1787 <eth1>
1788 0 = Hierarchical Token Bucket
1789 </eth1>
1790 </map>
1791 Libvirt statistics (libvirt.pm)
1793 This graph is able to monitor an unlimited number of virtual machines
1794 managed by Libvirt.
1795 cmd
1797 This is the command that will be used to gather statistics from
1798 each virtual machine listed in list.
1799 Default value: virsh
1801 An example would be:
1803 cmd = virsh -r -c qemu:///session
1805 list
1807 This is a list of groups of virtual machines that you want to
1808 monitor. Each group will become a graph and there may be an
1809 unlimited number of groups.
1810 WARNING: Every time the number of groups in this option changes,
1812 Monitorix will resize the libvirt.rrd file accordingly, removing
1813 all historical data.
1814 An example would be:
1816 <list>
1818 0 = centos6, winxp
1819 </list>
1820 The maximum number of virtual machines allowed per group is 8.
1822 desc
1824 This list complements the list option and is mandatory for every
1825 virtual machine listed. You must define the virtual block device
1826 and the MAC address of the virtual network device that you want
1827 to monitor for every virtual machine. Just like this:
1828 <desc>
1830 centos6 = CentOS 6, vda, 52:54:00:45:d0:e7
1831 winxp = MS Windows XP, hda, 52:54:00:97:1c:e5
1832 </desc>
1833 You might also define this list using sections for each virtual
1835 machine, this way you'll be able to define multiple disks and
1836 multiple network interfaces for each virtual machine. Just like
1837 this:
1838 <desc>
1840 <centos6>
1841 desc = "CentOS 6"
1842 disk = vda, vdb, vdc
1843 net = 52:54:00:45:d0:e7, 52:54:00:45:d0:e8
1844 </centos6>
1845 </desc>
1846 To obtain all these values you might want to use the following
1848 commands:
1849 # virsh domblklist centos6
1851 Target Source
1852 ------------------------------------------------
1853 vda /home/jordi/kvm/centos6.img
1854 hdc -
1855 # virsh domiflist centos6
1857 Interface Type Source Model MAC
1858 -------------------------------------------------------
1859 vnet3 network default virtio 52:54:00:45:d0:e7
1860 This option also allows you to change the name that will appear
1862 in the graph, hiding the real name of the virtual machine. If no
1863 association is defined, then Monitorix will display the name
1864 specified in the list option.
1865 Process statistics (process.pm)
1867 This graph is able to monitor an unlimited number of processes. This
1868 graph requires a Linux kernel version 2.6.20 at least to support
1869 process I/O accounting. Some systems with older kernels might also have
1870 been ported it though.
1871 list
1873 This is a list of groups of processes that you want to monitor.
1874 Each group will become a graph and there may be an unlimited
1875 number of groups.
1876 WARNING: Every time the number of groups in this option changes,
1878 Monitorix will resize the process.rrd file accordingly, removing
1879 all historical data.
1880 Monitorix uses the following command to find the processes
1882 listed in this option:
1883 # ps -eo pid,comm,command
1885 Therefore names in the process list can be either exactly to the
1887 process name as it appears in the comm columns, or just a sub‐
1888 string of the process name that appears in the command column.
1889 An example of this option would be:
1891 <list>
1893 0 = httpd, sshd, ntpd, mysqld, proftpd, clamd, imap,
1894 sendmail, named, bash
1895 </list>
1896 The maximum number of processes allowed per group is 10.
1898 desc
1900 This list complements the list option. It basically allows you
1901 to change the name that will appear in the graph, hiding the
1902 real name of the process. If no association is defined, then
1903 Monitorix will display the name specified in the list option.
1904 <desc>
1906 httpd = Apache
1907 imap = Dovecot
1908 named = Bind
1909 </desc>
1910 You can define as much entries as you want.
1912 System services demand (serv.pm)
1914 This graph requires either MailScanner or amavisd-new mail scanners in
1915 order to account spam and virus emails.
1916 mode
1918 This option toggles the way the System Services Demand data is
1919 represented in the graph. There are two possible values:
1920 i for incremental style.
1922 l for load (peaks) style.
1923 Default value: i
1925 Mail statistics (mail.pm)
1927 This graph requires either MailScanner or amavisd-new mail scanners in
1928 order to account spam and virus emails. Spamassassin and Clamav
1929 antivirus are also used for spam and virus email accounting.
1930 mta
1932 This option specifies the MTA that Monitorix will use to collect
1933 mail statistics. The currently supported MTAs are:
1934 Sendmail
1935 Postfix
1936 Exim
1937 NOTE: the pflogsumm utility is required when using the Postfix
1939 MTA.
1940 Default value: sendmail
1942 greylist
1944 This option specifies the Greylisting implementation that Moni‐
1945 torix will use to collect statistical information.
1946 The currently supported Greylisting software is:
1948 milter-greylist
1949 postgrey
1950 In the case of milter-greylist, Monitorix shows the same data
1952 that appears at the end of the file greylist.db.
1953 In the case of Postgrey, Monitorix reads the mail_log file and
1955 searches for a specific type of lines. Lines of type
1956 "action=greylist, reason=new" appear as Greylisted in the graph.
1957 Lines of type "action=greylist, reason=early-retry" appear as
1958 Delayed in the graph. Lines of type "action=pass, reason=triplet
1959 found" appear as Passed in the graph. And finally, lines of type
1960 "action=pass, reason=client whitelist" appear as Whitelisted in
1961 the graph.
1962 Default value: milter-greylist
1964 stats_rate
1966 This option only affects the Mail Statistics and the Greylisting
1967 graphs, and it specifies the rate in which the values are saved
1968 and shown. This option has two possible values:
1969 real
1970 per_second
1971 If it's set to its default value (real), it will show the mes‐
1973 sages as in a 'per minute' rate. Since Monitorix collects data
1974 on every minute, this should be the preferred way to see the
1975 results.
1976 In the other hand, and in order to keep backwards compatibility,
1978 if this option is missing in the configuration file, it will act
1979 as if it was set up as per_second, which means that the number
1980 of messages collected in each minute will be divided by 60.
1981 Default value: real
1983 delvd_enabled
1985 This section enables or disables one of the alert capabilities
1986 for this graph; the alert for the number of delivered messages.
1987 It works as follows:
1988 If the number of delivered messages reaches the delvd_threshold
1990 value for the interval of time defined in delvd_timeintvl, Moni‐
1991 torix will execute the external alert script defined in
1992 delvd_script.
1993 The default Monitorix installation includes an example of a
1995 shell-script alert called monitorix-alert.sh which you can use
1996 as a base for your own script.
1997 Default value: n
1999 delvd_timeintvl
2001 This is the period of time (in seconds) that the threshold needs
2002 to be exceeded before the external alert script is executed.
2003 Default value: 60
2005 delvd_threshold
2007 This is the value that needs to be reached or exceeded within
2008 the specified time period in delvd_timeintvl to trigger the
2009 mechanism for a particular action, which in this case is the
2010 execution of an external alert script.
2011 The value of this option is compared against the number of
2013 delivered messages since the last delvd_timeintvl seconds.
2014 Default value: 100
2016 delvd_script
2018 This is the full path name of the script that will be executed
2019 by this alert.
2020 It will receive the following three parameters:
2022 1st - the value currently defined in delvd_timeintvl.
2024 2nd - the value currently defined in delvd_threshold.
2025 3rd - the number of delivered messages.
2026 Default value: /path/to/script.sh
2028 mqueued_enabled
2030 This section enables or disables one of the alert capabilities
2031 for this graph; the alert for the number of queued messages. It
2032 works as follows:
2033 If the number of queued messages reaches the mqueued_threshold
2035 value for the interval of time defined in mqueued_timeintvl,
2036 Monitorix will execute the external alert script defined in
2037 mqueued_script.
2038 The default Monitorix installation includes an example of a
2040 shell-script alert called monitorix-alert.sh which you can use
2041 as a base for your own script.
2042 Default value: n
2044 mqueued_timeintvl
2046 This is the period of time (in seconds) that the threshold needs
2047 to be exceeded before the external alert script is executed.
2048 Default value: 3600
2050 mqueued_threshold
2052 This is the value that needs to be reached or exceeded within
2053 the specified time period in mqueued_timeintvl to trigger the
2054 mechanism for a particular action, which in this case is the
2055 execution of an external alert script.
2056 The value of this option is compared with the number of messages
2058 in the mail queue.
2059 Default value: 100
2061 mqueued_script
2063 This is the full path name of the script that will be executed
2064 by this alert.
2065 It will receive the following three parameters:
2067 1st - the value currently defined in mqueued_timeintvl.
2069 2nd - the value currently defined in mqueued_threshold.
2070 3rd - the number of messages in the mail queue.
2071 Default value: /path/to/script.sh
2073 Network port traffic (port.pm)
2075 This graph requires the iptables(8) command and optionally the
2076 ip6tables(8) command on Linux systems and the ipfw command on *BSD sys‐
2077 tems.
2078 max
2080 This is the number of network ports that you want to monitor.
2081 There is no limit to the number of ports monitored, but keep in
2082 mind that every time this number changes, Monitorix will resize
2083 the port.rrd file accordingly, removing all historical data.
2084 Default value: 9
2086 rule
2088 This is the rule number that Monitorix will use when using the
2089 ipfw command to manage network port activity on *BSD systems.
2090 Change it if you think it might conflict with any other rule
2091 number.
2092 Default value: 24000
2094 list
2096 You may define here up to max network port numbers. If you need
2097 to monitor the same network port with TCP and UDP protocols, you
2098 can add your own suffix to the port number (e.g: 443t and 443u)
2099 in order to distinguish it from the double definition in the
2100 <desc> block. It also support port ranges (e.g: 49152:65534) to
2101 be able to monitor the traffic of a number of consecutive ports
2102 summarized on a unique graph.
2103 If you see a red color in the background of a network port
2105 graph, it means that there is not a daemon listening on that
2106 port. This can be useful to know if some service gone down unex‐
2107 pectedly. Of course, this is only valid on a single port, not
2108 ranged ports.
2109 desc
2111 This is the option where each network port specified in list is
2112 described. Each port definition consists of six parameters sepa‐
2113 rated by comma:
2114 - an small port description.
2115 - the network protocol (tcp or udp).
2116 - the connection type (in, out or in/out).
2117 - the rigid value.
2118 - the limit value.
2119 - the L optional option which specifies that this port
2120 should be listening and Monitorix will advice it, by
2121 changing the background color of the graph to red, if
2122 finds it down. This option has no effect on ranged ports.
2123 There is also support (Linux only) for IPv6 network ports activ‐
2125 ity by using protocol names as tcp6 or udp6.
2126 An example would be:
2128 list = 25, 25ip6, 80, 53t, 53u, 49152:65534
2129 <desc>
2130 25 = SMTP, tcp, in/out, 0, 1000, L
2131 25ip6 = SMTP, tcp6, in/out, 0, 1000, L
2132 80 = HTTP, tcp, in, 0, 1000, L
2133 53t = DNS, tcp, in, 0, 1000, L
2134 53u = DNS, udp, in, 0, 1000, L
2135 49152:65534 = FTP_PSV, tcp, in, 0, 1000
2136 </desc>
2137 As you can see, you cannot use the same port number twice.
2139 Instead, you must distinguish it with some suffix. Monitorix
2140 will automatically extract all the first numeric digits, and
2141 will use that value as the network port number.
2142 graphs_per_row
2144 This is the number of graphs that will be put in a row. Consider
2145 the interaction of this parameter with the max option in order
2146 to adjust the size and number of graphs in relation to your hor‐
2147 izontal screen size.
2148 Default value: 3
2150 size
2152 This is the size of the graphs of the ports. It currently
2153 accepts up to 8 different size names: main, medium, medium2,
2154 small, mini, tiny, zoom and remote. You can check the resolution
2155 of each size in the configuration file, inside the list named
2156 graph_size.
2157 Default value: mini
2159 cmd
2161 This is the command that will be used to test if the network
2162 port is down (not listening). There are two possible values:
2163 ss
2165 netstat
2166 Default value: ss
2168 Users using the system (user.pm)
2170 Only the limit and rigid values can be set here.
2171 FTP statistics (ftp.pm)
2173 This graph supports currently ProFTPD, vsftpd and Pure-FTPd log file
2174 formats.
2175 For best results with the ProFTPD server I recommend to add the follow‐
2177 ing line in its configuration file:
2178 ExtendedLog /var/log/proftpd/access.log AUTH,DIRS,READ,WRITE
2180 For best results with the vsftpd server I recommend to setup the option
2182 xferlog_std_format to NO, and the option ftp_log to
2183 /var/log/vsftpd.log.
2184 Pure-FTPd users might want to consider using the system syslog logfile.
2186 server
2188 This option specifies the FTP server. The currently supported
2189 FTP servers are:
2190 ProFTPD
2191 vsftpd
2192 Pure-FTPd
2193 Default value: proftpd
2195 anon_user
2197 This option lists the different names (separated by comma) that
2198 can adopt the Anonymous user in the FTP server defined in
2199 server.
2200 Default value: anonymous, ftp
2202 Apache statistics (apache.pm)
2204 This graph requires that mod_status be loaded and ExtendedStatus option
2205 set to On in order to collect full status information of the Apache web
2206 server.
2207 This graph is able to monitor an unlimited number of local and remote
2209 Apache web servers.
2210 list
2212 This is a comma-separated list of URLs of the monitored Apache
2213 web servers.
2214 WARNING: Every time the number of entries in this option
2216 changes, Monitorix will resize the apache.rrd file accordingly,
2217 removing all historical data.
2218 Default value: http://localhost/server-status?auto
2220 alerts
2222 This optional list enables the alert capabilities for this graph
2223 and complements with the list option. Each alert has three
2224 fields separated by comma: the time interval, the threshold and
2225 the path to the script to be executed.
2226 The time interval is the period of time (in seconds) that the
2228 threshold needs to be exceeded before the external script is
2229 executed.
2230 The threshold is the number of remaining free slots that needs
2232 to be reached or exceeded within the specified time in time
2233 interval to execute the external script.
2234 The script is the full path name of the script that will be exe‐
2236 cuted by this alert.
2237 Each defined Apache has its own alert.
2239 The default Monitorix installation includes an example of a
2241 shell-script alert called monitorix-alert.sh which you can use
2242 as a base for your own script.
2243 The following is an example of an alert defined for the local
2245 Apache:
2246 <alerts>
2248 http://localhost/server-status?auto = 3600, 5,
2249 /path/to/script.sh
2250 </alerts>
2251 Such alert means that if the remaining free slots reaches or
2253 exceeds 5 (less than 5) during at least one hour (3600 seconds)
2254 the script in /path/to/script.sh will be executed.
2255 The external script will receive the following arguments:
2257 1st - the value defined as time interval.
2259 2nd - the value defined as threshold.
2260 3rd - the remaining free slots.
2261 Nginx statistics (nginx.pm)
2263 This graph may require adding some lines in the configuration file
2264 nginx.conf. Please see the README.nginx file to determine the exact
2265 steps needed to configure Nginx to get status information.
2266 This graph requires the iptables(8) command on Linux systems, and the
2268 ipfw command on *BSD systems.
2269 url
2271 This is the URL to be used to collect Nginx stats.
2272 Default value: http://localhost/nginx_status
2274 port
2276 This is the network port the Nginx web server is listening on.
2277 It will be used for traffic (with iptables), and for nginx_sta‐
2278 tus if url is not specified. If port of nginx_status is differ‐
2279 ent from port then specify it in the url
2280 (http://host:port/nginx_status)
2281 Default value: 80
2283 rule
2285 This is the rule number that Monitorix will use when using the
2286 ipfw command to manage Nginx network activity on *BSD systems.
2287 Change it if you think it might conflict with any other rule
2288 number.
2289 Default value: 24100
2291 cmd
2293 This is the command that will be used to test if the Nginx web
2294 server is down (not listening). There are two possible values:
2295 ss
2297 netstat
2298 Default value: ss
2300 Lighttpd statistics (lighttpd.pm)
2302 This graph requires that mod_status is loaded in order to collect sta‐
2303 tus information from the Lighttpd web server.
2304 This graph is able to monitor an unlimited number of local and remote
2306 Lighttpd web servers.
2307 list
2309 This is a comma-separated list of URLs of the monitored Lighttpd
2310 web servers.
2311 WARNING: Every time the number of entries of this option
2313 changes, Monitorix will resize the lighttpd.rrd file accord‐
2314 ingly, removing all historical data.
2315 Default value: http://localhost/server-status?auto
2317 MySQL statistics (mysql.pm)
2319 This graph requires that you create a password protected MySQL user
2320 that is NOT granted privileges on any DB.
2321 Example:
2323 mysql> CREATE USER 'user'@'localhost' IDENTIFIED BY 'password';
2325 mysql> FLUSH PRIVILEGES;
2326 where user is the new user name and password is the password that will
2328 be used for that user.
2329 This graph is able to monitor an unlimited number of local and remote
2331 MySQL web servers.
2332 NOTE: It is strongly recommended that you restart the MySQL service in
2334 order to avoid high peaks that could prevent correct display of the
2335 first plotted data.
2336 conn_type
2338 This option toggles the way how Monitorix establishes the con‐
2339 nection with the MySQL server. There are two possible values:
2340 host using the network (hostname and IP address).
2342 socket using a socket file.
2343 Default value: host
2345 list
2347 This is a comma-separated list of hostnames or path to sockets
2348 of MySQL servers.
2349 WARNING: Every time the number of entries of this option change
2351 Monitorix will resize the mysql.rrd file accordingly, removing
2352 all historical data.
2353 Default value: localhost
2355 desc
2357 This is the option where each entry specified in the list is
2358 described. Each definition consists of three parameters sepa‐
2359 rated by comma: the port, the username and the password.
2360 An example using the host type would be:
2362 <desc>
2363 localhost = 3306, user, secret
2364 </desc>
2365 When using the socket type the network port is, of course,
2367 irrelevant but its field is still mandatory. This means that you
2368 must respect the three comma-separated values.
2369 Some of the values shown in the graphs are the result of a cal‐
2371 culation of two values from either SHOW [GLOBAL] STATUS or SHOW
2372 VARIABLES. The following is an explanation of them:
2373 Thread Cache Hit Rate
2375 (1 - (Threads_created / Connections)) * 100
2376 When an application connects to a MySQL database, the database
2377 has to create a thread to manage the connection and the queries
2378 that will be sent in that connection. The database instructs the
2379 kernel to create a new thread, and the kernel allocates
2380 resources and creates the thread, then returns it to the MySQL
2381 service. When the connection is terminated by the application,
2382 MySQL tells the kernel to destroy the thread and free the
2383 resources. This create/destroy mechanism causes considerable
2384 overhead if the MySQL server has many new connections per sec‐
2385 ond.
2386 If MySQL doesn't destroy the thread when the connection is ter‐
2387 minated, but reuses it and assigns it to the next connection
2388 then this will decrease the kernel overhead. This is why a high
2389 Thread Cache Hit Rate improves MySQL performance and decreases
2390 the system's CPU usage.
2391 Setting the parameter thread_cache_size in the my.cnf file
2392 accordingly will help to correctly balance between having a
2393 great thread cache and keeping MySQL memory consumption reason‐
2394 able.
2395 Higher is better.
2396 Query Cache Hit Rate
2398 Qcache_hits / (Qcache_hits + Com_select) * 100
2399 Higher should be considered better.
2400 A query cache size increase is recommended if the query cache
2401 usage is very close to 100% and the query cache hit rate is far
2402 from 100%. But sometimes a size increase will not lead to a bet‐
2403 ter hit rate: this means that the increase was not needed and
2404 that the application do not run enough cacheable SELECT queries.
2405 This value should grow proportionally with the number of exe‐
2406 cuted queries as long as the query cache is performing well.
2407 Please also have a look at the Query cache usage percentage to
2408 know if your query_cache configuration is appropriate.
2409 For more information please refer to http://www.databasejour‐
2411 nal.com/features/mysql/article.php/3808841/Optimizing-the-MySQL-
2412 Query-Cache.htm
2413 Query Cache Usage
2415 (1 - (Qcache_free_memory / query_cache_size)) * 100
2416 This value should be reasonably far from 100%, otherwise con‐
2417 sider incrementing the query_cache_size parameter in my.cnf.
2418 Connections Usage
2420 (Max_used_connections / max_connections) * 100
2421 This value should be reasonably far from 100%, otherwise con‐
2422 sider incrementing the max_connections parameter in my.cnf.
2423 Key Buffer Usage
2425 (Key_blocks_used / (Key_blocks_used + Key_blocks_unused)) * 100
2426 This value should be reasonably far from 100%, otherwise con‐
2427 sider incrementing the key_buffer_size parameter in my.cnf.
2428 InnoDB Buffer Pool Usage
2430 (1 - (Innodb_buffer_pool_pages_free / Innodb_buf‐
2431 fer_pool_pages_total)) * 100
2432 This value should be reasonably far from 100%, otherwise con‐
2433 sider incrementing the innodb_buffer_pool_size parameter in
2434 my.cnf.
2435 Temp. Tables To Disk
2437 (Created_temp_disk_tables / Created_temp_disk_tables + Cre‐
2438 ated_temp_tables)) * 100
2439 During operation, MySQL has to create some temporary tables
2440 (that can be explicit, so created by the web application, or
2441 implicit, so for example MySQL has to create one when he runs
2442 some "SELECT DISTINCT", "UNION" or "VIEW" queries). MySQL will
2443 prefer to save this tmp tables to memory, for a fast access. But
2444 if tmp_table_size gets saturated, he has to write them on the
2445 disk instead, making the access slower.
2446 Note that if you modify the value of tmp_table_size in the MySQL
2447 configuration file, you should also modify the value of
2448 max_heap_table_size as well, since both values should have the
2449 same value because MySQL uses the minimum of both, so raising
2450 one of them is useless.
2451 Therefore this value helps to know how many tmp tables go to the
2452 disk instead than to the memory. Keep in mind that some large
2453 queries, involving TEXT and BLOB columns, are directly written
2454 to the disk instead than to the memory, because they would be
2455 too big. So you probably will want to avoid having a high % of
2456 tmp tables written to the disk, but you will never reach 0% on a
2457 big site, and this is fine.
2458 Lower is better ... but 0% is not reachable and you should not
2459 try to reach it, usually.
2460 PostgreSQL statistics (pgsql.pm)
2462 This graph is able to monitor an unlimited number of PostgreSQL
2463 servers.
2464 list
2466 This is a comma-separated list of names of PostgreSQL servers.
2467 WARNING: Every time the number of entries in this option
2469 changes, Monitorix will resize the pgsql.rrd file accordingly,
2470 removing all historical data.
2471 Default value: localhost
2473 desc
2475 This is a list of blocks of names specified in the list option.
2476 <desc>
2478 <localhost>
2479 host = localhost
2480 port = 5432
2481 username = user
2482 password = secret
2483 db_list =
2484 </localhost>
2485 </desc>
2486 host
2488 This is the hostname or IP address of the PostgreSQL server name
2489 specified in its block.
2490 Default value: localhost
2492 port
2494 This is the port number of the PostgreSQL server name specified
2495 in its block.
2496 Default value: 5432
2498 username
2500 This is the username for authentication of the PostgreSQL server
2501 name specified in its block.
2502 password
2504 This is the password for authentication of the PostgreSQL server
2505 name specified in its block.
2506 db_list
2508 This is a comma-separated list of up to 9 databases that will be
2509 monitored in the PostgreSQL server name specified in its block.
2510 MongoDB statistics (mongodb.pm)
2512 This graph is able to monitor an unlimited number of MongoDB servers.
2513 list
2515 This is a comma-separated list of names of MongoDB servers.
2516 WARNING: Every time the number of entries in this option
2518 changes, Monitorix will resize the mongodb.rrd file accordingly,
2519 removing all historical data.
2520 Default value: localhost
2522 max_db
2524 This is the maximum number of databases to be monitored in a
2525 MongoDB server. There is no limitation, just specify here the
2526 number of entries of the db_list option that has the most
2527 entries.
2528 WARNING: Every time the number of entries in this option
2530 changes, Monitorix will resize the mongodb.rrd file accordingly,
2531 removing all historical data.
2532 Default value: 1
2534 desc
2536 This is a list of blocks of names specified in the list option.
2537 <desc>
2539 <localhost>
2540 host = 127.0.0.1
2541 db_list = mydb
2542 </localhost>
2543 </desc>
2544 host
2546 This is the hostname or IP address of the MongoDB server speci‐
2547 fied in its block.
2548 Default value: 127.0.0.1
2550 port
2552 This is the port number of the MongoDB server specified in its
2553 block.
2554 Default value:
2556 username
2558 This is the username for authentication of the MongoDB server
2559 specified in its block.
2560 password
2562 This is the password for authentication of the MongoDB server
2563 specified in its block.
2564 db_list
2566 This is a comma-separated list of databases to be monitored of
2567 the MongoDB server specified in its block.
2568 Default value: mydb
2570 Varnish cache statistics (varnish.pm)
2572 This graph monitors a local installation of the Varnish HTTP accelera‐
2573 tor.
2574 Only the limit and rigid values can be set here.
2576 PageSpeed Module statistics (pagespeed.pm)
2578 This graph is able to monitor an unlimited number of PageSpeed instal‐
2579 lations.
2580 list
2582 This is a comma-separated list of URLs of PageSpeed status
2583 pages.
2584 WARNING: Every time the number of entries in this option
2586 changes, Monitorix will resize the pagespeed.rrd file accord‐
2587 ingly, removing all historical data.
2588 Default value: http://modpagespeed.com/mod_pagespeed_statistics
2590 For more information please refer to https://develop‐
2592 ers.google.com/speed/pagespeed/module and http://stackover‐
2593 flow.com/questions/9115595/what-do-the-mod-pagespeed-statistics-mean
2594 Squid Proxy Web Cache (squid.pm)
2596 cmd
2597 This command displays statistics about the Squid HTTP proxy
2598 process and is the main command used to collect all data.
2599 Default value: squidclient -h 127.0.0.1
2601 graph_0
2603 graph_1
2604 These two lists hold the selected Squid result or status codes
2605 to be shown in each graph. Feel free to mix result status and
2606 code status in any of the two options.
2607 For more information about the list of all the result and status
2609 codes, please refer to http://wiki.squid-cache.org/Squid‐
2610 Faq/SquidLogs.
2611 Each graph has a limit number of 9 entries.
2613 NFS server statistics (nfss.pm)
2615 version
2616 This option specifies which NFS server version is running in the
2617 system in order to correctly gather the correct values.
2618 The possible values are:
2620 2 for NFS v2.
2621 3 for NFS v3.
2622 4 for NFS v4.
2623 Default value: 3
2625 graph_0
2627 graph_1
2628 graph_2
2629 These three lists hold the defined NFS server activity statis‐
2630 tics to be shown in each graph. Put every statistic name exactly
2631 as they appear in the output of the nfsstat(8) command.
2632 Each graph has a limit number of 10 entries.
2634 NFS client statistics (nfsc.pm)
2636 version
2637 This option specifies which NFS server version is running in the
2638 system in order to correctly gather the correct values.
2639 The possible values are:
2641 2 for NFS v2.
2642 3 for NFS v3.
2643 4 for NFS v4.
2644 Default value: 3
2646 graph_1
2648 graph_2
2649 graph_3
2650 graph_4
2651 graph_5
2652 These five lists hold the defined NFS client activity statistics
2653 to be shown in each graph. Put every statistic name exactly as
2654 they appear in the output of the nfsstat(8) command.
2655 Each graph has the following limit number of entries:
2657 graph_1 up to 10 entries.
2659 graph_2 up to 10 entries.
2660 graph_3 up to 4 entries.
2661 graph_4 up to 4 entries.
2662 graph_5 up to 4 entries.
2663 BIND statistics (bind.pm)
2665 This graph requires a BIND server with version 9.5 or higher, and in
2666 order to see all statistics provided by BIND you must configure the
2667 statistics-channels option like this:
2668 statistics-channels {
2670 inet 127.0.0.1 port 8053;
2671 };
2672 This graph is able to monitor an unlimited number of BIND servers.
2674 list
2676 This is a comma-separated list of URLs of BIND servers status
2677 pages.
2678 WARNING: Every time the number of entries in this option
2680 changes, Monitorix will resize the bind.rrd file accordingly,
2681 removing all historical data.
2682 Default value: http://localhost:8053/
2684 in_queries_list
2686 This is a comma-separated list of RR (Resource Records) types
2687 for each BIND server specified in list option. The RR types
2688 defined here will appear in the Incoming Queries graph which
2689 shows the number of incoming queries for each RR type.
2690 For a complete list of RR types check the BIND 9 Administrator
2692 Reference Manual at
2693 <http://ftp.isc.org/www/bind/arm95/Bv9ARM.html>.
2694 <in_queries_list>
2696 http://localhost:8053/ = A, AAAA, ANY, DS, MX, NS, PTR,
2697 SOA, SRV, TXT, NAPTR, A6, CNAME, SPF, KEY, DNSKEY, HINFO, WKS,
2698 PX, NSAP
2699 </in_queries_list>
2700 The maximum number of RR types allowed for this graph is 20.
2702 out_queries_list
2704 This is a comma-separated list of RR (Resource Records) types
2705 for each BIND server. The RR types defined here will appear in
2706 the Outgoing Queries graph (_default view) which shows the num‐
2707 ber of outgoing queries sent by the DNS server resolver for each
2708 RR type.
2709 <out_queries_list>
2711 http://localhost:8053/ = A, AAAA, ANY, DS, MX, NS, PTR,
2712 SOA, SRV, TXT, NAPTR, A6, CNAME, SPF, KEY, DNSKEY, HINFO, WKS,
2713 PX, NSAP
2714 </out_queries_list>
2715 The maximum number of RR types allowed for this graph is 20.
2717 server_stats_list
2719 This is a comma-separated list of counters about incoming
2720 request processing. The counters defined here will appear in the
2721 Server Statistics graph.
2722 <server_stats_list>
2724 http://localhost:8053/ = Requestv4, Requestv6, ReqEdns0,
2725 ReqBadEDNSVer, ReqTSIG, ReqSIG0, ReqBadSIG, ReqTCP, Response,
2726 QrySuccess, QryAuthAns, QryNoauthAns, QryReferral, QryNxrrset,
2727 QrySERVFAIL, QryNXDOMAIN, QryRecursion, QryDuplicate, Qry‐
2728 Dropped, QryFailure
2729 </server_stats_list>
2730 The maximum number of counters allowed for this graph is 20.
2732 resolver_stats_list
2734 This is a comma-separated list of counters about name resolution
2735 performed in the internal resolver. The counters defined here
2736 will appear in the Resolver Statistics graph (_default view).
2737 <resolver_stats_list>
2739 http://localhost:8053/ = Queryv4, Queryv6, Responsev4,
2740 Responsev6, NXDOMAIN, SERVFAIL, FORMERR, OtherError, EDNS0Fail,
2741 Truncated, Lame, Retry, QueryTimeout, GlueFetchv4, GlueFetchv6,
2742 GlueFetchv4Fail, GlueFetchv6Fail, ValAttempt, ValOk, ValNegOk
2743 </resolver_stats_list>
2744 The maximum number of counters allowed for this graph is 20.
2746 cache_rrsets_list
2748 This is a comma-separated list of RR (Resource Records) types
2749 for each BIND server. The RR types defined here will appear in
2750 the Cache DB RRsets graph (_default view) which shows the number
2751 of RRsets per RR type (positive or negative) and nonexistent
2752 names stored in the cache database.
2753 <cache_rrsets_list>
2755 http://localhost:8053/ = A, !A, AAAA, !AAAA, DLV, !DLV, DS,
2756 !DS, MX, NS, CNAME, !CNAME, SOA, !SOA, !ANY, PTR, RRSIG, NSEC,
2757 DNSKEY, NXDOMAIN
2758 </cache_rrsets_list>
2759 The maximum number of RR types allowed for this graph is 20.
2761 Unbound statistics (unbound.pm)
2763 This graph monitors a local installation of an Unbound name server. It
2764 requires you to configure the options extended-statistics as yes and
2765 statistics-cumulative as no.
2766 cmd
2768 This is the command that will be used to gather statistics from
2769 Unbound.
2770 Default value: unbound-control
2772 queries_type
2774 This is a comma-separated list of query types. The types defined
2775 here will appear in the Queries by type graph.
2776 Default value: queries_type = A, AAAA, ANY, DS, MX, NS, PTR,
2778 SOA, SRV, TXT, NAPTR, A6, CNAME, SPF, KEY, DNSKEY, HINFO, WKS,
2779 PX, NSAP
2780 The maximum number of types allowed for this graph is 20.
2782 NTP statistics (ntp.pm)
2784 This graph is able to monitor an unlimited number of NTP servers.
2785 list
2787 This is a comma-separated list of NTP servers.
2788 WARNING: Every time the number of entries in this option
2790 changes, Monitorix will resize the ntp.rrd file accordingly,
2791 removing all historical data.
2792 Default value: localhost
2794 desc
2796 This is a list of groups of Reference Identifier and Kiss-
2797 o'-Death Codes for every hostname specified in the list option.
2798 For more information on these NTP codes:
2800 <http://www.iana.org/assignments/ntp-parameters/ntp-parame‐
2801 ters.xml>
2802 <http://www.iana.org/go/rfc5905>
2803 <desc>
2805 localhost = AUTH, AUTO, CRYP, DENY, GPS, INIT, NKEY, RATE,
2806 RMOT, RSTR
2807 </desc>
2808 The maximum number of codes allowed for each hostname is 10.
2810 extra_args
2812 This option includes any extra argument to the NTP command exe‐
2813 cuted by Monitorix, which is "ntpq -pn". This is specially use‐
2814 ful if you want to force using IPv4, in this case just define
2815 this option like this:
2816 extra_args = "-4"
2818 Monitorix will add this extra argument to the NTP command which
2820 will become as "ntpq -pn -4".
2821 Chrony statistics (chrony.pm)
2823 This graph is able to monitor an unlimited number of Chrony daemons.
2824 list
2826 This is a comma-separated list of hostnames with the network
2827 port running chronyd. The format is <hostname>:<port> being the
2828 port number optional.
2829 WARNING: Every time the number of entries in this option
2831 changes, Monitorix will resize the chrony.rrd file accordingly,
2832 removing all historical data.
2833 Default value: localhost
2835 Fail2ban statistics (fail2ban.pm)
2837 This graph is able to monitor an unlimited number of Fail2ban jails.
2838 list
2840 This is a comma-separated list that describes the groups of
2841 jails in desc. Put one description for each group. For every
2842 group specified you need to specify its description in the desc
2843 option.
2844 WARNING: Every time the number of entries in this option
2846 changes, Monitorix will resize the fail2ban.rrd file accord‐
2847 ingly, removing all historical data.
2848 An example would be:
2850 list = Security, Overload / Abuse
2852 desc
2854 This is a list of jails per group defined in your Fail2ban con‐
2855 figuration.
2856 <desc>
2858 0 = [apache], [apache-mod-security], [apache-overflows],
2859 [courierauth], [ssh], [pam-generic], [php-url-fopen], [vsftpd]
2860 1 = [apache-imdbphp], [apache-evasive], [apache-badbots],
2861 [apache-robots-txt], [communigate], [named-refused-udp], [named-
2862 refused-tcp], [trac-ticketspam]
2863 </desc>
2864 The maximum number of jails allowed for each group is 9.
2866 graphs_per_row
2868 This is the number of fail2ban graphs that will be put in a row.
2869 Default value: 2
2871 graph_mode
2873 This option changes how the values are represented in the graph.
2874 It has two possible values: absolute which is the default, and
2875 rate. The former takes the values directly from the command
2876 fail2ban-client status <JAIL> and so the values in the graph
2877 will appear as absolute. The later option shows the values in a
2878 rating format per minute.
2879 Default value: absolute
2881 Icecast Streaming Media Server (icecast.pm)
2883 This graph is able to monitor an unlimited number of Icecast servers.
2884 list
2886 This is a list of URLs of Icecast server status pages.
2887 WARNING: Every time the number of entries in this option
2889 changes, Monitorix will resize the icecast.rrd file accordingly,
2890 removing all historical data.
2891 Default value: http://localhost:8000/status.xsl
2893 desc
2895 This is a comma-separated list of Mount Points configured for
2896 every URL specified in the list option. IMPORTANT: the Mount
2897 Points must be specified in the same order that appears in the
2898 Icecast Server Status page.
2899 <desc>
2901 http://localhost:8000/status.xsl = stream1, stream2,
2902 stream3
2903 </desc>
2904 The maximum number of mountpoints allowed for each URL is 9.
2906 graph_mode
2908 This changes the layout of the listeners graph, the possible
2909 values are r for a real graph, or s for a stacked graph (every
2910 line or area is stacked on top of the previous element).
2911 Default value: r
2913 Raspberry Pi sensor statistics (raspberrypi.pm)
2915 For more information please refer to
2916 http://elinux.org/RPI_vcgencmd_usage.
2917 cmd
2919 This is where the vcgencmd command is installed.
2920 Default value: /opt/vc/bin/vcgencmd
2922 clocks
2924 This is a comma-separated list of clock types that will be rep‐
2925 resented in the first graph.
2926 An example would be:
2928 clocks = arm, core, h264, isp, v3d, uart, emmc, pixel, hdmi
2930 The maximum number of clocks allowed is 9.
2932 volts
2934 This is a comma-separated list of voltage types that will be
2935 represented in the third graph.
2936 An example would be:
2938 volts = core, sdram_c, sdram_i, sdram_p
2940 The maximum number of clocks allowed is 6.
2942 Alternative PHP Cache statistics (phpapc.pm)
2944 This graph is able to monitor an unlimited number of PHP-APC installa‐
2945 tions.
2946 list
2948 This is a comma-separated list of URLs of PHP-APC status pages.
2949 WARNING: Every time the number of entries in this option
2951 changes, Monitorix will resize the phpapc.rrd file accordingly,
2952 removing all historical data.
2953 Default value: http://localhost/apc.php?auto
2955 Memcached statistics (memcached.pm)
2957 This graph is able to monitor an unlimited number of Memcached instal‐
2958 lations.
2959 list
2961 This is a comma-separated list of hostnames with network port
2962 running Memcached.
2963 WARNING: Every time the number of entries in this option
2965 changes, Monitorix will resize the memcached.rrd file accord‐
2966 ingly, removing all historical data.
2967 Default value: localhost:11211
2969 Redis statistics (redis.pm)
2971 This graph is able to monitor an unlimited number of Redis installa‐
2972 tions.
2973 list
2975 This is a comma-separated list of hostnames with network port
2976 running Redis.
2977 WARNING: Every time the number of entries in this option
2979 changes, Monitorix will resize the redis.rrd file accordingly,
2980 removing all historical data.
2981 Default value: localhost:6379
2983 PHP-FPM statistics (phpfpm.pm)
2985 This graph is able to monitor an unlimited number of PHP-FPM pools.
2986 group
2988 This is a list of names (separated by comma) of the groups of
2989 pools that you want to monitor. The pools included in each group
2990 will be defined in the list option. You can define unlimited
2991 number of groups.
2992 WARNING: Every time the number of groups changes, Monitorix will
2994 resize the phpfpm.rrd file accordingly, removing all historical
2995 data.
2996 An example of this option would be:
2998 <group>
3000 0 = First group of domains
3001 1 = Second group of domains
3002 </group>
3003 list
3005 This is a list of pool names that you want to monitor for each
3006 group defined in group.
3007 An example of this option would be:
3009 <list>
3011 0 = example1, example2, example3
3012 1 = example10, example11
3013 </list>
3014 The maximum number of pools allowed per group is 8.
3016 desc
3018 This list complements the list option, it defines where and how
3019 Monitorix must gather the statistics for each pool defined.
3020 An example of this option would be:
3022 <desc>
3024 example1 = http://www.example1.com/php_fpm_status
3025 example2 = http://www.example2.com/php_fpm_status
3026 example3 = http://www.example3.com/php_fpm_status
3027 example10 = http://www.example10.com/php_fpm_status
3028 example11 = http://www.example11.com/php_fpm_status
3029 </desc>
3030 map
3032 This list also complements the list option. It basically allows
3033 you to change the name that will appear in the graph, hiding the
3034 real name of the pool. If no association is defined, then Moni‐
3035 torix will display the name specified in the list option.
3036 An example of this option would be:
3038 <map>
3040 example1 = DOMAIN4
3041 example12 = DOMAIN55
3042 </map>
3043 APC UPS statistics (apcupsd.pm)
3045 This graph is able to monitor an unlimited number of APC UPS (apcupsd)
3046 installations.
3047 cmd
3049 This is the command that will be used (with the values in list)
3050 to get the statistics.
3051 Default value: apcaccess
3053 list
3055 This is a comma-separated list of hostnames with the network
3056 port running apcupsd.
3057 WARNING: Every time the number of entries in this option
3059 changes, Monitorix will resize the apcupsd.rrd file accordingly,
3060 removing all historical data.
3061 Default value: localhost:3551
3063 Network UPS Tools statistics (nut.pm)
3065 This graph is able to monitor an unlimited number of Network UPS Tools
3066 (upsc) installations.
3067 list
3069 This is a comma-separated list of UPS names with optionally the
3070 hostname and the network port where it's running upsd. The for‐
3071 mat of each entry must be:
3072 upsname[@hostname[:port]]
3074 WARNING: Every time the number of entries in this option
3076 changes, Monitorix will resize the nut.rrd file accordingly,
3077 removing all historical data.
3078 Default value: ups@localhost
3080 Wowza Media Server (wowza.pm)
3082 This graph is able to monitor an unlimited number of Wowza servers.
3083 list
3085 This is a comma-separated list of URLs of Wowza server status
3086 pages. Each URL can include the Basic Authentication in the form
3087 of http://username:password@localhost:8086/connectioncounts.
3088 WARNING: Every time the number of entries in this option
3090 changes, Monitorix will resize the wowza.rrd file accordingly,
3091 removing all historical data.
3092 Default value: http://localhost:8086/connectioncounts
3094 desc
3096 This is a comma-separated list of applications configured for
3097 every URL specified in the list option.
3098 <desc>
3100 http://localhost:8086/connectioncounts = channel1, chan‐
3101 nel2, channel3
3102 </desc>
3103 The maximum number of applications allowed for each URL is 8.
3105 Devices interrupt activity (int.pm)
3107 Only the limit and rigid values can be set here.
3108 Verlihub statistics (verlihub.pm)
3110 This graph monitors the Verlihub software for DC++ network.
3111 Monitoring the Internet traffic of your LAN (traffacct.pm)
3113 If your server acts as the gateway for a group of PCs, devices or even
3114 whole networks in your local LAN, you may want to know how much Inter‐
3115 net traffic each one is generating.
3116 This graph requires the iptables(8) command on GNU/Linux systems, and
3118 the ipfw command on *BSD systems.
3119 The following are the options you will need to configure to accomplish
3121 all of this.
3122 enabled
3124 This option enables this feature.
3125 Default value: n
3127 max
3129 This is the number of LAN devices you want to monitor. There is
3130 no limit, but keep in mind that every time this number changes,
3131 Monitorix will resize the traffacct.rrd file, removing all his‐
3132 torical data.
3133 Default value: 10
3135 graphs_per_row
3137 If your horizontal screen resolution is pretty wide, you may
3138 want to increase the number of graphs that appear on each row.
3139 Default value: 2
3141 list
3143 This is a comma-separated list of names of PCs, LAN devices or
3144 whole networks that you want to monitor. The only requirement is
3145 that all they must utilize this server as their gateway.
3146 If the names in this list are able to be resolved by a DNS query
3148 then you don't need to define the desc list (below) with corre‐
3149 sponding IP addresses, unless you want monthly reports.
3150 An example would be:
3152 list = pc8, printer, scanner, lan3
3154 desc
3156 This is the list of IP addresses with network masks and email
3157 addresses corresponding to the entries defined in the list. This
3158 option is only used when the those entries are not resolvable
3159 through a DNS query.
3160 An example would be:
3162 <desc>
3164 0 = 192.168.1.101/32, ace@example.com
3165 1 = 192.168.1.102/32, gene@example.com
3166 2 = 192.168.1.103/32, paul@example.com
3167 3 = 192.168.1.104/32, peter@example.com
3168 </desc
3169 Monthly reports of Internet traffic (traffacct.pm)
3171 enabled
3172 If this option is set to y, Monitorix will send a report of all
3173 the monthly Internet activity of the defined devices in list to
3174 the specified email address on the first day of each month.
3175 Default value: n
3177 language
3179 Define here the language used in the monthly report.
3180 The current possible values are: ca, de, en, it, nl_NL, pl and
3182 zh_CN.
3183 Default value: en
3185 default_mail
3187 This is the default email address used to send the monthly
3188 reports. This option is only used if the second parameter in
3189 desc list is empty.
3190 Default value: root@localhost
3192 url_prefix
3194 This is the prefix of the same URL you use to connect to Moni‐
3195 torix. This is needed in order to get the graphs of the same
3196 machine.
3197 Default value: http://localhost:8080
3199 smtp_hostname
3201 This is the hostname that will be used as a SMTP relay to
3202 deliver the monthly report emails.
3203 Default value: localhost
3205 from_address
3207 This is the address that will be used as remittent for all the
3208 monthly report emails.
3209 Default value: noreply@example.com
3211 Monitoring remote servers (Multihost)
3213 The Multihost feature allows you to monitor an unlimited number of
3214 remote servers that already have Monitorix installed. Make sure that
3215 all servers (local and remote) have the same version of Monitorix, oth‐
3216 erwise there would be some incompatibilities that would prevent showing
3217 correctly the graphs.
3218 enabled
3220 This option enables the Multihost feature.
3221 Default value: n
3223 footer_url
3225 If set to y Monitorix will show the original URL of each server
3226 at the bottom of the graph. Where security is important you may
3227 want to hide this information.
3228 Default value: y
3230 graphs_per_row
3232 If your horizontal screen resolution is pretty wide, you may
3233 want to increase the number of graphs that appear on each row.
3234 Default value: 2
3236 default_option_when_all
3238 If the user has defined a considerable amount of remote servers
3239 and it selects the option "All" in the Hostname list and "All
3240 graphs" in the Graph list, the browser may hang for a while due
3241 to the huge amount of images to download remotely from different
3242 servers.
3243 This option prevents precisely that this happens accidentally by
3245 setting a default value in the Graph list. Of course, the user
3246 is able to change it to "All graphs" at any moment.
3247 The value of this option may be any of the ones that appear in
3249 the <graphs> section (near the end) of the monitorix.conf file.
3250 Default value: "System load"
3252 remotehost_list
3254 This is a comma-separated list with descriptive names of remote
3255 servers with Monitorix already installed and working that you
3256 plan to monitor from here.
3257 An example of this list would be:
3259 remotehost_list = server 1, server 2, server 3
3261 remotehost_desc
3263 This is a numbered list that describes each of the names defined
3264 in the remotehost_list option and the remote values of base_url
3265 and base_cgi options.
3266 An example would be:
3268 <remotehost_desc>
3270 0 = http://www.example.com,/monitorix,/monitorix-cgi
3271 1 = http://10.0.0.1,/monitorix,/monitorix-cgi
3272 2 = http://192.168.0.100:8080,/,/
3273 </remotehost_desc>
3274 As you can see all these three entries use URLs to designate the
3276 location of each remote server. This means that each server most
3277 also have been enabled the HTTP built-in server, or have been
3278 installed a CGI capable web server like Apache.
3279 groups
3281 This enables the server grouping for those environments where
3282 there are too much servers to display at the same time. Hence,
3283 you can group them in order to show them separately.
3284 Default value: n
3286 remotegroup_list
3288 This is a list of groups of remote servers with Monitorix
3289 already installed and working that you plan to monitor from
3290 here.
3291 An example of this list would be:
3293 remotegroup_list = My Group
3295 remotegroup_desc
3297 This is a numbered list that describes each of the names defined
3298 in the remotegroup_list option.
3299 An example would be:
3301 <remotegroup_desc>
3303 0 = server2, server 3
3304 </remotegroup_desc>
3305 Automatic email reports (emailreports)
3307 This allows to send automatically selected graphs to one or more email
3308 addresses. This could be specially useful for some system administra‐
3309 tors who prefer receiving via email selected graphs instead of browsing
3310 to the remote servers every day.
3311 enabled
3313 This option enables this feature. Note that you still need to
3314 enable the same option for each time interval you want to acti‐
3315 vate: daily, weekly, monthly, yearly.
3316 Default value: n
3318 url_prefix
3320 This is the prefix of the same URL you use to connect to Moni‐
3321 torix. Such URL is needed in order to get the graphs of that
3322 machine.
3323 This option supports sending the credentials in the standard
3325 HTTP "Authorization" header, just like this:
3326 http://username:password@localhost:8080
3328 Default value: http://localhost:8080
3330 smtp_hostname
3332 This is the hostname that will be used as a SMTP relay to
3333 deliver the automatic email reports.
3334 method
3336 This option specifies the method of sending emails. The current
3337 valid options are smtp and relay. By default this option is not
3338 defined which is the same as if smtp option was defined.
3339 Default value:
3341 from_address
3343 This is the address that will be used as remittent for all the
3344 monthly report emails.
3345 Default value: noreply@example.com
3347 subject_prefix
3349 This is a string that will be prefixed in the Subject of all
3350 emails that will be sent.
3351 Default value: Monitorix:
3353 hour
3355 This is the hour (in 24h format) when the email reports will be
3356 sent.
3357 Default value: 0
3359 minute
3361 This is the minute when the email reports will be sent.
3362 Default value: 0
3364 daily
3366 weekly
3367 monthly
3368 yearly
3369 The email reports are sent based on the following schedule:
3370 daily reports will be sent every day at 00:00h.
3372 weekly reports will be sent the first Monday of each week.
3373 monthly reports will be sent the first day of each month.
3374 yearly reports will be sent the first day of each year.
3375 enabled
3377 This option enables each report individually.
3378 Default value: n
3380 graphs
3382 This is a comma-separated list of graph names you want to appear
3383 in the email report. The names are the same as their .rrd files.
3384 There is a list of them in the graph_name option in moni‐
3385 torix.conf.
3386 Default value: system, fs
3388 to
3390 This is a comma-separated list of recipient email addresses.
3391 addendum_script
3393 This is the full path name of an external script that will be
3394 executed during the creation of the report, and its output will
3395 be appended to the mail. This is useful for system administra‐
3396 tors that want to add extra system information to the reports.
3397 Default value:
3399 rigid and limit values
3401 rigid
3402 This value defines how the graph must be scaled. Its possible
3403 values are:
3404 0 No rigid, the graph will be scaled automatically. Only the
3406 lower-limit value will be used if it's defined.
3407 1 The graph will be scaled by default according the values in
3408 limit but without rigidness.
3409 2 The graph will be forced to scale using the contents of
3410 limit as its upper-limit and lower-limit values.
3411 limit
3413 This is where you can enter the upper-limit and lower-limit val‐
3414 ues (separated by a colon) for a graph. The lower-limit value is
3415 optional. Some examples would be:
3416 100:0 which means 100 as the upper-limit value and 0 for the
3418 lower-limit value. This is commonly used for percentage values.
3419 1000 which means 1000 as the upper-limit value and leaving
3420 undefined the lower-limit value. This can also be written as
3421 1000:.
3422
3424 Monitorix is written by Jordi Sanfeliu <jordi@fibranet.cat>
3425
3427 Copyright © 2005-2021 Jordi Sanfeliu
3428 Licensed under the GNU General Public License version 2 (GPLv2).
3429
3431 monitorix(8), rrdtool(1)
34323.13.1 Jan 2021 monitorix.conf(5)