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 disable_javascript_void
100 This option enables or disables the use of javascript:void-URLs
101 when opening windows with zoomed graphs. Some people likes to
102 open links in the background by pressing the middle mouse button
103 in Firefox, and with the default javascript:void-URLs the only
104 they get is an empty window with nothing in it.
105 Default value: n
107 temperature_scale
109 This option toggles between values in Celsius or in Fahrenheit
110 in those graphs that represent temperatures.
111 The possible values are:
113 c for Celsius.
114 f for Fahrenheit.
115 Default value: c
117 show_gaps
119 This option, when enabled, shows the gaps (missing data) in the
120 graphs. This is specially useful to detect if the server or Mon‐
121 itorix were stopped for a while, or any other unavailability.
122 In order to be able to locate those gaps easily in each graph,
124 it uses the white color in the default black theme and the black
125 color in the white theme. These default colors are defined in
126 monitorix.conf so they can be changed as any other option.
127 Default value: n
129 global_zoom
131 This option zooms all the graphs (including the legend's font
132 size) by the given amount. The factor must be greater than 0 and
133 it accepts decimal values.
134 This is specially useful for people with big screens that either
136 want to avoid using the browser feature to zoom the contents of
137 the window and for those that watch the graphs from certain dis‐
138 tance.
139 Keep in mind that the contents of the graphs remains with the
141 same detail level all the time, and that it doesn't affects to
142 the standard zoomed graph that appears when clicking in the pic‐
143 ture.
144 Default value: 1
146 max_historic_years
148 This option defines the maximum number of years of historical
149 data in all graphs.
150 WARNING: Every time this value is extended Monitorix will resize
152 every .rrd file accordingly, removing all historical data.
153 There is no longer any upper limit for this value.
155 Default value: 1
157 accept_selfsigned_certs
159 This option forces to accept self-signed certificates when col‐
160 lecting values remotely using HTTPS protocol.
161 Default value: y
163 priority
165 Sometimes when a server is under heavy use, Monitorix might be
166 unable to collect some statistical data due to its normal prior‐
167 ity (0 by default). This makes monitoring useless because graphs
168 are empty during that hard period of time.
169 In order to mitigate this situation this option sets the prior‐
171 ity in which Monitorix will be scheduled by the kernel. The
172 accepted range of values is the same as in the setpriority()
173 system call: that is, from -20 (maximum priority) to 19 (lowest
174 priority).
175 Default value: 0
177 image_format
179 This is the format of each generated graph. There are only two
180 possible values: PNG and SVG.
181 Default value: PNG
183 include_dir
185 The main configuration file is usually called monitorix.conf and
186 its location is provided as part of the command line arguments.
187 In addition, other configuration files may be loaded placing
188 them in the directory pointed by this option. The names must end
189 with .conf to be included.
190 This option is mainly intended to include third-party modules
192 with their own configuration files without having to modify any
193 file from your Monitorix installation. All modules are located
194 in /usr/lib/monitorix (in some operating systems that path can
195 change).
196 All the configuration files in there will be loaded in alpha‐
198 betic order, so the last file loaded will overwrite any previous
199 option.
200 Default value: /etc/monitorix/conf.d
202 ip_default_table
204 This option will define in which table Monitorix will put all
205 iptables rules for network traffic accounting monitoring. It
206 only works on Linux.
207 Although this is a global option, only the graphs port, nginx
209 and traffacct are affected by it.
210 Default value: filter
212 ipv6_disabled
214 This option enables or disables the use of the ip6tables com‐
215 mand. It only works on Linux.
216 Although this is a global option, only the graph port is cur‐
218 rently affected by it.
219 Default value: n
221 url_prefix_proxy
223 This option forces monitorix.cgi to bypass the URL building.
224 This is specially usefull when Monitorix is used behind a
225 reverse proxy.
226 An example would be: http://myexternalwebsite.com
228 Default value:
230 enable_hourly_view
232 This option enables or disables the ability to select the hourly
233 view in the main page.
234 No .rrd file will change by selecting this option and the his‐
236 torical data won't be affected.
237 Default value: n
239 user_agent_id
241 This option defines the string to be used to identify Monitorix
242 in the HTTP requests. Its value will be sent as the "User-Agent"
243 header.
244 The default value will depend on the current Perl version in
246 your system. An example would be libwww-perl/5.833.
247 enable_back_button
249 This option enables or disables the ability to go back to the
250 main page from the graphs page without using the browser's back
251 button.
252 It will show a back arrow in the upper-left corner and it is
254 specially useful for people using the browser in full-screen
255 mode.
256 Default value: n
258 base_dir
260 This is the absolute path to the directory where all the web
261 elements are located:
262 cgi/ directory where resides monitorix.cgi.
264 imgs/ directory for the .png graph images.
265 index.html Monitorix main page.
266 logo_bot.png Monitorix bottom logo.
267 logo_top.png Monitorix top logo.
268 monitorixico.png Monitorix favicon logo.
269 Default value: /var/lib/monitorix/www/
271 (depends on the operating system)
272 base_lib
274 This is the absolute path to the directory where all of the
275 monthly reports, daily traffic usage, and RRD files are located:
276 reports/ monthly reports localization directory.
278 usage/ daily traffic usage data directory.
279 *.rrd RRD files.
280 Default value: /var/lib/monitorix/
282 (depends on the operating system)
283 base_url
285 This is the URL prefix that Monitorix utilizes when refering to
286 its own pages and files.
287 Default value: /monitorix
289 base_cgi
291 This is the URL prefix that Monitorix utilizes when refering to
292 monitorix.cgi.
293 Default value: /monitorix-cgi
295 HTTP built-in server
297 enabled
298 This enables or disables the HTTP server that Monitorix has
299 built-in. This is specially useful for system administrators
300 that don't want to install a web server (Apache, Lighttpd,
301 Nginx, etc.) to see the Monitorix graphs.
302 Default value: y
304 host
306 This option takes an optional host address for this server to
307 bind to. If none is specified (default) it will bind to all
308 interfaces.
309 Default value:
311 port
313 This is the network port from where the HTTP server will listen
314 on.
315 Default value: 8080
317 user/group
319 This sets the user and group that the HTTP server will run as.
320 Default value for user: nobody
322 Default value for group: nobody
323 log_file
325 This is the path to the HTTP server log file.
326 Default value: /var/log/monitorix-httpd
328 hosts_deny
330 This is a comma delimited set of IP addresses which are not per‐
331 mitted to access Monitorix graphs. There is the special keyword
332 called all that can be used to deny all IP addresses.
333 The access control uses the same approach as in the TCP-Wrap‐
335 pers; the search stops at the first match:
336 - Access will be granted when an IP address matches an
338 entry in the hosts_allow list.
339 - Otherwise, access will be denied when an IP address
340 matches an entry in the hosts_deny list.
341 - Otherwise, access will be granted.
342 Default value:
344 hosts_allow
346 This is the opposite of hosts_deny option. IP addresses listed
347 here are permitted to access Monitorix graphs. There is also the
348 special keyword called all that can be used to allow access to
349 all IP addresses.
350 Default value:
352 https_url
354 This will force to use the prefix https:// in all links. This is
355 special useful if you plan to use a reverse-proxy HTTPS server
356 in front of the Monitorix HTTP built-in server.
357 Default value: n
359 autocheck_responsiveness
361 There is a well known problem with the HTTP built-in server that
362 Monitorix implements using the Perl module 'HTTP::Server::Sim‐
363 ple'. It looks like it's pretty weak to the common attacks that
364 any web server receives every day. As a consequence of that, it
365 just hangs, and when you want to see the stats of your server,
366 you just see your browser waiting for a response that never
367 comes, which ends up with a timeout. In these cases, you are
368 forced to login to your server and restart Monitorix, in order
369 to refresh the HTTP built-in server.
370 So in order to mitigate (hopefully) all this annoying hangups,
372 this options acts like an autocheck to control the responsive‐
373 ness of the HTTP server on every minute, and in case of no
374 response then it will be restarted automatically.
375 Default value: y
377 HTTP built-in server with access authentication
379 enabled
380 This enables or disables the authentication mechanism to control
381 access to pages and other resources. The only allowed mechanism
382 is Basic and uses the 401 status code and the WWW-Authenticate
383 response header.
384 It's highly recommended to set this option according your needs
386 before start Monitorix.
387 For more information about the Basic access authentication mech‐
389 anism and its security implications, please refer to
390 http://en.wikipedia.org/wiki/Basic_access_authentication.
391 Default value: n
393 msg
395 This option sets the Realm to be used in the authentication.
396 That message should appear in the client dialog box to help user
397 to identify the secure area.
398 Default value: Monitorix: Restricted access
400 htpasswd
402 This option sets the path to the password file that was created
403 with the help of the htpasswd.pl script. That script encrypts
404 and validates passwords using the system's crypt() routine. If
405 your Monitorix package doesn't come with that script, you may
406 use the similar htpasswd(1) program provided with the Apache web
407 server.
408 The format of the password file consist of one or more lines
410 with a username and password separated by a colon.
411 The following is an example of a password file:
413 paul:oGkEsQK6RYIII
415 peter:HF1r7qRL4Kg6E
416 Since the script uses the crypt() algorithm, only the first 8
418 characters of the password are used to form the password. If the
419 supplied password is longer, the extra characters will be
420 silently discarded.
421 WARNING: don't use the character colon ':' as part of your name
423 or password since this character is used as field separator.
424 Default value: /var/lib/monitorix/htpasswd
426 Log files pathnames
428 log_file
429 This is the path to the Monitorix log file. Please check this
430 file periodically and especially after every update to confirm
431 proper operation.
432 Default value: /var/log/monitorix
434 secure_log
436 This is the path to the system log (also known as auth.log,
437 etc.) Monitorix uses this file to report SSH, POP3, FTP and Tel‐
438 net successful logins.
439 Default value: /var/log/secure
441 mail_log
443 This is the path to the mail log file. Monitorix uses this file
444 to report messages sent (supporting Sendmail and Postfix for‐
445 mats), and the MailScanner log format for spam-mail and virus-
446 mail alerts.
447 Default value: /var/log/maillog
449 milter_gl
451 This is the path to the dump file of milter-greylist.
452 Default value: /var/milter-greylist/greylist.db
454 imap_log
456 This is the path to the IMAP (Dovecot or UW-IMAP) log file. Mon‐
457 itorix uses this file to report IMAP and POP3 successful logins.
458 Default value: /var/log/imap
460 hylafax_log
462 This is the path to the Hylafax log file. Monitorix uses this
463 file to report successful FAX dispatches.
464 Default value: /var/spool/hylafax/etc/xferfaxlog
466 cups_log
468 This is the path to the CUPS page log file. Monitorix uses this
469 file to report on print jobs.
470 Default value: /var/log/cups/page_log
472 ftp_log
474 This is the path to the FTP server (ProFTPD, vsftpd or Pure-
475 FTPd) log. Monitorix uses this file to report FTP successful
476 logins and other FTP-related information.
477 Default value: /var/log/proftpd/access.log
479 fail2ban_log
481 This is the path to the Fail2ban log file. Monitorix uses this
482 file to report IP addresses banned.
483 Default value: /var/log/fail2ban.log
485 spamassassin_log
487 This is the path to the Spamassassin log file. Monitorix uses
488 this file to report spam-mail alerts.
489 Default value: /var/log/maillog
491 clamav_log
493 This is the path to the Clamav log file. Monitorix uses this
494 file to report virus-mail alerts.
495 Default value: /var/log/clamav/clamav.log
497 cg_logdir
499 This is the path to the CommuniGate logs directory. Monitorix
500 uses these files to report the number of mail messages success‐
501 fully received and sent, and to report IMAP and POP3 successful
502 logins.
503 Default value: /var/CommuniGate/SystemLogs/
505 squid_log
507 This is the path to the Squid log file. Monitorix uses this file
508 to report on Squid Proxy requests.
509 Default value: /var/log/squid/access.log
511 imap_log_date_format
513 This is the Dovecot date format as it appears in the imap_log
514 file.
515 Default value: %b %d
517 secure_log_date_format
519 This is secure_log date format.
520 Default value: %b %e
522 Piwik tracking code
524 enabled
525 This enables the inclusion of the Piwik tracking code in the
526 main index.html file. Please refer to
527 http://piwik.org/docs/tracking-api/ for more information on how
528 to fill these fields.
529 Default value: n
531 Enable or disable graphs
533 graph_enable
534 This enables or disables the monitoring of each graph. Placing a
535 y on a desired graph and restarting Monitorix will automatically
536 create the RRD file for that graph and start gathering informa‐
537 tion according to its settings.
538 System load average and usage (system.pm)
540 This graph shows information about system load average (classical UNIX
541 triplet), memory allocation, active processes (on Linux brought
542 directly from the /proc directory), entropy and the system uptime.
543 loadavg_enabled
545 This section enables or disables the alert capabilities for this
546 graph. Only the alert for the average CPU load is currently
547 implemented. It works as follows:
548 This alert uses the minimum value between the second and the
550 third load averages (those that represent the last 5 and 15 min‐
551 utes), and if it reaches the loadavg_threshold value for the
552 interval of time defined in loadavg_timeintvl, Monitorix will
553 execute the external alert script defined in loadavg_script.
554 The idea to use min(load5, load15) is to obtain a more symmetric
556 curve and a sooner cancellation of the alert.
557 The default Monitorix installation includes an example of a
559 shell-script alert called monitorix-alert.sh which you can use
560 as a base for your own script.
561 Default value: n
563 loadavg_timeintvl
565 This is the period of time (in seconds) that the threshold needs
566 to be exceeded before the external alert script is executed.
567 Default value: 3600
569 loadavg_threshold
571 This is the value that needs to be reached or exceeded within
572 the specified time period in loadavg_timeintvl to trigger the
573 mechanism for a particular action, which in this case is the
574 execution of an external alert script.
575 The value of this option is compared against the last 15 minutes
577 of CPU load average.
578 Default value: 5.0
580 loadavg_script
582 This is the full path name of the script that will be executed
583 by this alert.
584 It will receive the following three parameters:
586 1st - the value currently defined in loadavg_timeintvl.
588 2nd - the value currently defined in loadavg_threshold.
589 3rd - the current 15min CPU load average.
590 Default value: /path/to/script.sh
592 Global kernel usage (kern.pm)
594 Note that the VFS graph is just informative of how the kernel is bal‐
595 ancing its tables. graph_mode
596 This changes the layout of the kernel usage graph, the possible
597 values are r for a real graph, or s for a stacked graph (every
598 line or area is stacked on top of the previous element).
599 Default value: r
601 list
603 This is the list of values offered in modern Linux kernels.
604 Older Linux kernels or other Operating Systems may not have all
605 of them. Placing a y or an n will enable or disable the value in
606 the graph.
607 Kernel usage per processor (proc.pm)
609 max
610 This is the number of processors or cores that your system has.
611 There is no limit, however keep in mind that every time this
612 number is changed Monitorix will resize the proc.rrd file
613 accordingly, removing all historical data.
614 Default value: 4
616 graphs_per_row
618 This is the number of processor graphs that will be put in a
619 row. Consider the interaction of this parameter with the size
620 and data options (below) in order to adjust the size and number
621 of graphs in relation to your horizontal screen size.
622 Default value: 2
624 size
626 This option sets the size of all processors graphs.
627 The possible values are:
629 main for 450x150 graphs.
630 medium for 325x150 graphs.
631 medium2 for 325x70 graphs.
632 small for 200x66 graphs.
633 mini for 183x66 graphs.
634 tiny for 110x40 graphs.
635 Default value: medium
637 DATA
639 This option will completely enable or disable the legend in the
640 processor graphs.
641 Default value: y
643 HP ProLiant System Health (hptemp.pm)
645 list
646 This list will hold the defined temperature sensors for each
647 graph. You must have installed the command hplog that comes with
648 HP ProLiant System Health Application and Command Line Utili‐
649 ties.
650 Each graph has a limited number of IDs:
652 graph_0 up to 8 IDs.
654 graph_1 up to 6 IDs.
655 graph_2 up to 6 IDs.
656 The following is a configuration example of selected IDs:
658 # hplog -t
660 ID TYPE LOCATION STATUS CURRENT THRESHOLD
661 1 Basic Sensor Ambient Normal 75F/ 24C 107F/ 42C
662 2 Basic Sensor CPU (1) Normal 104F/ 40C 179F/ 82C
663 3 Basic Sensor CPU (2) Normal ---F/---C 179F/ 82C
664 4 Basic Sensor Memory Board Normal ---F/---C 188F/ 87C
665 5 Basic Sensor Memory Board Normal 82F/ 28C 188F/ 87C
666 6 Basic Sensor Memory Board Normal ---F/---C 188F/ 87C
667 7 Basic Sensor System Board Normal 89F/ 32C 192F/ 89C
668 8 Basic Sensor System Board Normal ---F/---C 192F/ 89C
669 9 Basic Sensor System Board Normal 84F/ 29C 192F/ 89C
670 10 Basic Sensor System Board Normal 118F/ 48C 230F/110C
671 11 Basic Sensor System Board Normal 96F/ 36C 192F/ 89C
672 12 Basic Sensor System Board Normal 84F/ 29C 154F/ 68C
673 13 Basic Sensor System Board Normal 87F/ 31C 154F/ 68C
674 14 Basic Sensor System Board Normal 89F/ 32C 156F/ 69C
675 15 Basic Sensor System Board Normal 93F/ 34C 161F/ 72C
676 16 Basic Sensor Ambient Normal ---F/---C 192F/ 89C
677 17 Basic Sensor System Board Normal ---F/---C 192F/ 89C
678 18 Basic Sensor SCSI Backplane Normal 32F/ 0C 140F/ 60C
679 <list>
681 graph_0 = 2, 3
682 graph_1 = 1, 5, 18
683 graph_2 = 7, 9, 10, 11, 12, 13
684 </list>
685 alerts
687 This optional list enables the alert capabilities for this graph
688 and complements with the list option. Each alert has three
689 fields separated by comma: the time interval, the threshold and
690 the path to the script to be executed.
691 The time interval is the period of time (in seconds) that the
693 threshold needs to be exceeded before the external script is
694 executed.
695 The threshold is the temperature that needs to be reached or
697 exceeded within the specified time in time interval to execute
698 the external script.
699 The script is the full path name of the script that will be exe‐
701 cuted by this alert.
702 Each defined sensor has its own alert.
704 The default Monitorix installation includes an example of a
706 shell-script alert called monitorix-alert.sh which you can use
707 as a base for your own script.
708 The following is an example of an alert defined for the first
710 temperature sensor:
711 <alerts>
713 2 = 3600, 40, /path/to/script.sh
714 </alerts>
715 Such alert means that if the value of the sensor number 2
717 reaches or exceeds 40 during at least one hour (3600 seconds)
718 the script in /path/to/script.sh will be executed.
719 The external script will receive the following arguments:
721 1st - the value defined as time interval.
723 2nd - the value defined as threshold.
724 3rd - the value of the sensor.
725 LM-Sensors and GPU temperatures (lmsens.pm)
727 list
728 In this list you may specify the sensors you want to monitor
729 with the same names as they appear in your sensors(1) command.
730 For example, imagine a sensors(1) output like this:
732 # sensors
734 coretemp-isa-0000
735 Adapter: ISA adapter
736 Core 0: +51.0°C (high = +78.0°C, crit = +100.0°C)
737 coretemp-isa-0001
739 Adapter: ISA adapter
740 Core 1: +49.0°C (high = +78.0°C, crit = +100.0°C)
741 f71882fg-isa-0a00
743 Adapter: ISA adapter
744 3.3V: +3.30 V
745 Vcore: +1.21 V (max = +2.04 V)
746 Vdimm: +1.82 V
747 Vchip: +1.38 V
748 +5V: +5.00 V
749 12V: +14.37 V
750 5VSB: +4.33 V
751 3VSB: +3.30 V
752 Battery: +3.22 V
753 CPU: 2035 RPM
754 System: 1765 RPM ALARM
755 Power: 2110 RPM ALARM
756 Aux: 2080 RPM ALARM
757 M/B Temp: +36.00 C
758 CPU Temp: +29.00 C
759 Then you may want to configure that list as:
761 <list>
763 core0 = Core 0
764 core1 = Core 1
765 mb0 = M/B Temp
766 cpu0 = CPU Temp
767 fan0 = CPU
768 fan1 = System
769 fan2 = Power
770 fan3 = Aux
771 volt0 = 3.3V
772 volt1 = VCore
773 volt2 = Vdimm
774 volt3 = Vchip
775 volt4 = \+5V
776 volt5 = 12V
777 volt6 = 5VSB
778 volt7 = 3VSB
779 volt8 = Battery
780 gpu0 = nvidia
781 </list>
782 Note that you need to escape the plus and minus signs in the
784 voltage labels. It also recommended to enclose the values using
785 double quotes.
786 The last one, gpu0, is set here just in case you have a sup‐
788 ported graphics card and want to monitor its temperature. Cur‐
789 rently only NVIDIA and ATI graphic cards are supported; with the
790 values nvidia and ati respectively. It requires the official
791 NVIDIA or ATI drivers.
792 This list has the following maximums allowed:
794 Up to 16 core keys (from core0 to core15).
796 Up to 2 mb keys (mb0 and mb1).
797 Up to 4 cpu keys (from cpu0 to cpu3).
798 Up to 9 fan keys (from fan0 to fan8).
799 Up to 12 volt keys (from volt0 to volt11).
800 Up to 9 gpu keys (from gpu0 to gpu8).
801 desc
803 This list complements the list option. It basically allows you
804 to change the name that will appear in the graph, hiding the
805 real name of the sensor. If no association is defined, then Mon‐
806 itorix will display the name of the key (left side) in the desc
807 option (in uppercase in some graphs).
808 <desc>
810 mb0 = M/B
811 fan0 = CPUFan
812 gpu0 = ATI
813 </desc>
814 Please note that in the default graph all names are limited to 5
816 characters in order to fit up to 9 different values. In the
817 zoomed graphs the limit is 8 characters.
818 alerts
820 This optional list enables the alert capabilities for this graph
821 and complements with the list option. Each alert has three
822 fields separated by comma: the time interval, the threshold and
823 the path to the script to be executed.
824 The time interval is the period of time (in seconds) that the
826 threshold needs to be exceeded before the external script is
827 executed.
828 The threshold is the temperature or volts, or whatever that
830 needs to be reached or exceeded within the specified time in
831 time interval to execute the external script.
832 The script is the full path name of the script that will be exe‐
834 cuted by this alert.
835 Each defined sensor has its own alert.
837 The default Monitorix installation includes an example of a
839 shell-script alert called monitorix-alert.sh which you can use
840 as a base for your own script.
841 The following is an example of an alert defined for the first
843 temperature sensor:
844 <alerts>
846 core0 = 3600, 40, /path/to/script.sh
847 </alerts>
848 Such alert means that if the value of the sensor core0 reaches
850 or exceeds 40 during at least one hour (3600 seconds) the script
851 in /path/to/script.sh will be executed.
852 The external script will receive the following arguments:
854 1st - the value defined as time interval.
856 2nd - the value defined as threshold.
857 3rd - the value of the sensor.
858 Generic sensors statistics (gensens.pm)
860 This graph is able to monitor up to 9 temperatures and CPU frequencies
861 which, depending of your machine, should appear in the /sys/devices
862 directory.
863 list
865 This is a fixed list that can only hold two keys (0 and 1). Each
866 key though can hold up to 9 different entries separated by comma
867 which corresponds to the names of the sensors present in your
868 computer. The key 0 is only for temperature sensors and the key
869 1 is for CPU frequencies. All this is hard-coded and a bit rigid
870 currently but it might change in the future.
871 An example would be:
873 <list>
875 0 = temp0, temp1
876 1 = cpu0, cpu1, cpu2, cpu3
877 </list>
878 desc
879 In this option you must associate the complete pathname of the
880 file from where to get the value of each entry defined in the
881 list. Following the settings in the example above:
882 <desc>
884 temp0 = /sys/devices/virtual/thermal/ther‐
885 mal_zone0/temp
886 temp1 = /sys/devices/virtual/thermal/ther‐
887 mal_zone1/temp
888 cpu0 = /sys/devices/system/cpu/cpu0/cpufreq/scal‐
889 ing_cur_freq
890 cpu1 = /sys/devices/system/cpu/cpu1/cpufreq/scal‐
891 ing_cur_freq
892 cpu2 = /sys/devices/system/cpu/cpu2/cpufreq/scal‐
893 ing_cur_freq
894 cpu3 = /sys/devices/system/cpu/cpu3/cpufreq/scal‐
895 ing_cur_freq
896 </desc>
897 unit
898 With this option you can define the order of magnitude associ‐
899 ated to a specific value. This is used in both temperatures and
900 CPU frequencies, since this kind of temperature sensors tend to
901 give the value in 1000ths of degrees Celsius. In the case of CPU
902 frequencies the values come in Mhz which means that they need to
903 be converted to Hz by multiplying them by 1000. Therefore you
904 can define something like this:
905 <unit>
907 temp0 = 1000
908 temp1 = 1000
909 cpu0 = 0.001
910 cpu1 = 0.001
911 cpu2 = 0.001
912 cpu3 = 0.001
913 </unit>
914 map
915 With this option you can optionally rename any of the sensor
916 names defined in the list option. Following the above example:
917 <map>
919 temp0 = Temperature Zone 0
920 temp1 = Temperature Zone 1
921 cpu0 = CPU0 frequency
922 cpu1 = CPU1 frequency
923 cpu2 = CPU2 frequency
924 cpu3 = CPU3 frequency
925 </map>
926 All names are limited to 20 characters.
928 alerts
930 This optional list enables the alert capabilities for this graph
931 and complements with the list option. Each alert has four fields
932 separated by comma: the time interval, the threshold, the path
933 to the script to be executed and when the alert must be trig‐
934 gered. the last field is optional.
935 The time interval is the period of time (in seconds) that the
937 threshold needs to be exceeded before the external script is
938 executed.
939 The threshold is the value (either temperature or HZ) that needs
941 to be reached or exceeded within the specified time in time
942 interval to execute the external script.
943 The script is the full path name of the script that will be exe‐
945 cuted by this alert.
946 The when value specifies when the alert must be triggered (above
948 or below) the threshold, being above the default value when it's
949 not specified.
950 Each defined sensor has its own alert.
952 The default Monitorix installation includes an example of a
954 shell-script alert called monitorix-alert.sh which you can use
955 as a base for your own script.
956 The following is an example of an alert defined for the first
958 temperature sensor:
959 <alerts>
961 temp0 = 3600, 40, /path/to/script.sh, above
962 temp1 = 3600, 10, /path/to/script.sh, below
963 </alerts>
964 The first alert means that if the value of the sensor temp0
966 exceeds above 40 during at least one hour (3600 seconds) the
967 script in /path/to/script.sh will be executed.
968 The second alert means that if the value of the sensor temp1
970 exceeds below 10 during at least one hour (3600 seconds) the
971 script in /path/to/script.sh will be executed.
972 The external script will receive the following arguments:
974 1st - the value defined as time interval.
976 2nd - the value defined as threshold.
977 3rd - the value of the sensor.
978 4th - the direction or when that alert was triggered by
979 (above or below).
980 IPMI sensor statistics (ipmi.pm)
982 This graph is able to monitor an unlimited number of IPMI sensors (tem‐
983 peratures, fans and voltages).
984 list
986 This is a comma-separated list that describes the groups of sen‐
987 sors in desc. Put one description for each group. For every
988 group specified you need to specify its sensors in the desc
989 option.
990 WARNING: Every time the number of entries in this option
992 changes, Monitorix will resize the ipmi.rrd file accordingly,
993 removing all historical data.
994 An example would be:
996 list = Temperatures, Fans, Voltages
998 desc
1000 This is a list of sensors per group defined.
1001 <desc>
1003 0 = CPU Temp, System Temp
1004 1 = FAN 1
1005 2 = Vcore, 3.3VCC, 12V, VDIMM, 5VCC, CPU VTT, VBAT, VSB,
1006 AVCC
1007 </desc>
1008 The maximum number of sensors allowed for each group is 9.
1010 units
1012 This is the type of sensor in each group. It's important to not
1013 mix different type of sensors in a same group. This value is
1014 informative only, it's mostly used as a title for the y-axis in
1015 the graphs and should match with the output of the ipmitool com‐
1016 mand.
1017 map
1019 This list complements the desc option. It basically allows you
1020 to change the name that will appear in the graph, hiding the
1021 real name of the sensor. If no association is defined, then Mon‐
1022 itorix will display the name specified in the desc option. Note,
1023 this only works in names that don't include whitespaces.
1024 alerts
1026 This optional list enables the alert capabilities for this graph
1027 and complements with the desc option. Each alert has three
1028 fields separated by comma: the time interval, the threshold and
1029 the path to the script to be executed.
1030 The time interval is the period of time (in seconds) that the
1032 threshold needs to be exceeded before the external script is
1033 executed.
1034 The threshold is the temperature that needs to be reached or
1036 exceeded within the specified time in time interval to execute
1037 the external script.
1038 The script is the full path name of the script that will be exe‐
1040 cuted by this alert.
1041 Each defined sensor has its own alert.
1043 The default Monitorix installation includes an example of a
1045 shell-script alert called monitorix-alert.sh which you can use
1046 as a base for your own script.
1047 The following is an example of an alert defined for the first
1049 temperature sensor:
1050 <alerts>
1052 CPU_Temp = 3600, 40, /path/to/script.sh
1053 </alerts>
1054 Notice that the spaces in the sensor's name must be con‐
1056 verted to underscores, since a variable can hold spaces
1057 in its name.
1058 Such alert means that if the value of the sensor CPU_Temp
1060 reaches or exceeds 40 during at least one hour (3600 seconds)
1061 the script in /path/to/script.sh will be executed.
1062 The external script will receive the following arguments:
1064 1st - the value defined as time interval.
1066 2nd - the value defined as threshold.
1067 3rd - the value of the sensor.
1068 graphs_per_row
1070 This is the number of graphs that will be put in a row.
1071 Default value: 2
1073 extra_args
1075 This option includes any extra argument to the ipmitool command
1076 executed by Monitorix, which is "ipmitool <extra_args> sdr".
1077 This is specially useful if you need to monitor a remote server.
1078 An example would be:
1079 extra_args = -H <remote_ip> -U root -P <password>
1081 Default value: none
1083 Ambient sensor statistics (ambsens.pm)
1085 This graph is able to monitor an unlimited number of ambient sensors
1086 (temperatures, humidity, barometer, etc.).
1087 list
1089 This is a comma-separated list that describes the type of sen‐
1090 sors in desc. Put one description for each type. For every type
1091 specified you need to specify its sensors in the desc option.
1092 Each one most be referenced as a numeric value starting from
1093 zero in the desc option. There you will define all the sensors
1094 than come with that type of sensor.
1095 WARNING: Every time the number of entries in this option
1097 changes, Monitorix will resize the ambsens.rrd file accordingly,
1098 removing all historical data.
1099 An example would be:
1101 list = Ambient temperature, Humidity
1103 desc
1105 This is a list of sensors per type defined. The name is irrele‐
1106 vant.
1107 <desc>
1109 0 = at1, at2, at3
1110 1 = h0
1111 </desc>
1112 The maximum number of sensors allowed for each type is 9.
1114 units
1116 This is the class of sensor for each type. It's important to not
1117 mix different type of sensors in a same group. This value is
1118 informative only, it's mostly used as a title for the y-axis in
1119 the graphs.
1120 cmd
1122 This list complements the desc option. It basically allows you
1123 to associate a script or program that will be executed to
1124 retrieve the value for each sensor.
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 list option. Each alert has four fields
1136 separated by comma: the time interval, the threshold, the path
1137 to the script to be executed and when the alert must be trig‐
1138 gered. the last field is optional.
1139 The time interval is the period of time (in seconds) that the
1141 threshold needs to be exceeded before the external script is
1142 executed.
1143 The threshold is the value (either temperature or HZ) that needs
1145 to be reached or exceeded within the specified time in time
1146 interval to execute the external script.
1147 The script is the full path name of the script that will be exe‐
1149 cuted by this alert.
1150 The when value specifies when the alert must be triggered (above
1152 or below) the threshold, being above the default value when it's
1153 not specified.
1154 Each defined sensor has its own alert.
1156 The default Monitorix installation includes an example of a
1158 shell-script alert called monitorix-alert.sh which you can use
1159 as a base for your own script.
1160 The following is an example of an alert defined for the first
1162 temperature sensor:
1163 <alerts>
1165 temp0 = 3600, 40, /path/to/script.sh, above
1166 temp1 = 3600, 10, /path/to/script.sh, below
1167 </alerts>
1168 The first alert means that if the value of the sensor temp0
1170 exceeds above 40 during at least one hour (3600 seconds) the
1171 script in /path/to/script.sh will be executed.
1172 The second alert means that if the value of the sensor temp1
1174 exceeds below 10 during at least one hour (3600 seconds) the
1175 script in /path/to/script.sh will be executed.
1176 The external script will receive the following arguments:
1178 1st - the value defined as time interval.
1180 2nd - the value defined as threshold.
1181 3rd - the value of the sensor.
1182 4th - the direction or when that alert was triggered by
1183 (above or below).
1184 graphs_per_row
1186 This is the number of graphs that will be put in a row.
1187 Default value: 2
1189 NVIDIA temperatures and usage (nvidia.pm)
1191 This graph requires to have installed the official NVIDIA drivers.
1192 max
1194 This is the number of NVIDIA cards currently plugged in your
1195 system.
1196 The maximum allowed is 9.
1198 Default value: 1
1200 Disk drive temperatures and health (disk.pm)
1202 This graph is able to monitor an unlimited number of disk drives.
1203 list
1205 This is a list of groups of disk drives that you want to moni‐
1206 tor. Each group will become a graph and there may be an unlim‐
1207 ited number of groups. You can define device names or paths to
1208 devices like /dev/disk/by-path/pci-0000:00:11.0-scsi-0:0:0:0.
1209 WARNING: Every time the number of groups in this option changes,
1211 Monitorix will resize the disk.rrd file accordingly, removing
1212 all historical data.
1213 To collect the disk drive temperatures and health the smartmon‐
1215 tools or the hddtemp command are required.
1216 It is recommended that you first check if either smartctl(8) or
1218 hddtemp are able to collect data from the disk drive(s) that you
1219 plan to monitor. You may test this with the following command:
1220 # hddtemp /dev/sdb
1222 /dev/sdb: WDC WD1600AABS-00M1A0: 48°C
1223 If you see good results as above, you can add it to the group 0
1225 like this:
1226 <list>
1228 0 = /dev/sda, /dev/sdb
1229 </list>
1230 The maximum number of disk device names allowed per group is 8.
1232 realloc_enabled
1234 This section enables or disables one of the alert capabilities
1235 for this graph; the alert for the number of reallocated sectors
1236 in disk. It works as follows:
1237 If the number of reallocated sectors in any of the specified
1239 disk device names reaches the realloc_threshold (the interval of
1240 time is not used here), Monitorix will execute the external
1241 alert script defined in realloc_script.
1242 The default Monitorix installation includes an example of a
1244 shell-script alert called monitorix-alert.sh which you can use
1245 as a base for your own script.
1246 Default value: n
1248 realloc_timeintvl
1250 Not used in this alert.
1251 Default value: 0
1253 realloc_threshold
1255 This is the value that needs to be reached or exceeded to trig‐
1256 ger the mechanism for a particular action, which in this case is
1257 the execution of an external alert script.
1258 Default value: 1
1260 realloc_script
1262 This is the full path name of the script that will be executed
1263 by this alert.
1264 It will receive the following three parameters:
1266 1st - the value currently defined in realloc_timeintvl.
1268 2nd - the value currently defined in realloc_threshold.
1269 3rd - the current number of reallocated sectors.
1270 Default value: /path/to/script.sh
1272 pendsect_enabled
1274 This section enables or disables one of the alert capabilities
1275 for this graph; the alert for the number of current pending sec‐
1276 tors (or bad sectors) in disk. It works as follows:
1277 If the number of current pending sectors in any of the specified
1279 disk device names reaches the pendsect_threshold (the interval
1280 of time is not used here), Monitorix will execute the external
1281 alert script defined in pendsect_script.
1282 The default Monitorix installation includes an example of a
1284 shell-script alert called monitorix-alert.sh which you can use
1285 as a base for your own script.
1286 Default value: n
1288 pendsect_timeintvl
1290 Not used in this alert.
1291 Default value: 0
1293 pendsect_threshold
1295 This is the value that needs to be reached or exceeded to trig‐
1296 ger the mechanism for a particular action, which in this case is
1297 the execution of an external alert script.
1298 Default value: 1
1300 pendsect_script
1302 This is the full path name of the script that will be executed
1303 by this alert.
1304 It will receive the following three parameters:
1306 1st - the value currently defined in pendsect_timeintvl.
1308 2nd - the value currently defined in pendsect_threshold.
1309 3rd - the current number of pending sectors.
1310 Default value: /path/to/script.sh
1312 accept_invalid_disk
1314 During the init stage this graph verifies that every defined
1315 device name does exist in the system. If not, then the graph
1316 disables itself.
1317 This option changes this behavior and permits to continue work‐
1319 ing even if the device names defined doesn't exist. Keep in mind
1320 that you will continue seeing error messages in the logfile.
1321 Default value: n
1323 Filesystem usage and I/O activity (fs.pm)
1325 This graph is able to monitor an unlimited number of filesystems.
1326 list
1328 This is a list of groups of mounted filesystems that you want to
1329 monitor. Each group will become a graph and there may be an
1330 unlimited number of groups.
1331 WARNING: Every time the number of groups in this option changes,
1333 Monitorix will resize the fs.rrd file accordingly, removing all
1334 historical data.
1335 Take special care to use the same name as appears in the output
1337 of the df(1) command (the swap device is a special case). An
1338 example would be:
1339 <list>
1341 0 = /, swap, boot, home, /mnt/backup
1342 </list>
1343 The maximum number of filesystems allowed per group is 8.
1345 desc
1347 This list complements the list option. It basically allows you
1348 to change the name that will appear in the graph, hiding the
1349 real name of the mount point. If no association is defined, then
1350 Monitorix will display the name specified in the list option.
1351 <desc>
1353 / = Root FS
1354 /home = My Home
1355 /mnt/backup = Backups
1356 </desc>
1357 You can define as much entries as you want.
1359 devmap
1361 This optional list complements the list option. When Monitorix
1362 is started, and in order to be able to show I/O activity, it
1363 attempts to detect the mapping of devices specified in list, as
1364 defined in the df command output column "Mounted on". In the
1365 event that devices are not detected by Monitorix, the devmap
1366 option shall be used to manually define them, according to the
1367 underlying OS:
1368 Linux (kernel > 2.4)
1370 <devmap> device must match a device listed in the
1371 "/proc/diskstats" file.
1372 Linux (kernel <= 2.4)
1374 <devmap> is not used, but because something is
1375 defined in <devmap>, Monitorix will extract
1376 "disk_io" lines from the "/proc/stat" file.
1377 FreeBSD
1379 <devmap> device recognized by the output of
1380 "iostat -xI <dev>" command.
1381 OpenBSD and NetBSD
1383 <devmap> is not used, but because something is
1384 defined in <devmap>, Monitorix will use the output
1385 of "iostat -DI" command.
1386 Just an example:
1388 <devmap>
1389 /mnt/home = dm-1
1390 /mnt/backup = cciss/c0d2p6
1391 </devmap>
1392 You can define as much entries as you want.
1394 alerts
1396 This optional list enables the alert capabilities for this graph
1397 and complements with the list option. Each alert has three
1398 fields separated by comma: the time interval, the threshold and
1399 the path to the script to be executed.
1400 The time interval is the period of time (in seconds) that the
1402 threshold needs to be exceeded before the external script is
1403 executed.
1404 The threshold is the percentage of disk space used in the file
1406 system that needs to be reached or exceeded within the specified
1407 time in time interval to execute the external script.
1408 The script is the full path name of the script that will be exe‐
1410 cuted by this alert.
1411 Each defined filesystem has its own alert.
1413 The default Monitorix installation includes an example of a
1415 shell-script alert called monitorix-alert.sh which you can use
1416 as a base for your own script.
1417 The following is an example of an alert defined for the root
1419 filesystem:
1420 <alerts>
1422 / = 3600, 98, /path/to/script.sh
1423 </alerts>
1424 Such alert means that if the percentage of disk space used in
1426 the root filesystem reaches or exceeds 98 (more than 98) during
1427 at least one hour (3600 seconds) the script in
1428 /path/to/script.sh will be executed.
1429 The external script will receive the following arguments:
1431 1st - the value defined as time interval.
1433 2nd - the value defined as threshold.
1434 3rd - the filesystem disk usage.
1435 ZFS statistics (zfs.pm)
1437 This graph is able to monitor an unlimited number of pools.
1438 max_pools
1440 This is the maximum number of pools that you can define in list.
1441 There is no limit to the number of pools monitored, but keep in
1442 mind that every time this number changes, Monitorix will resize
1443 the zfs.rrd file accordingly, removing all historical data.
1444 Default value: 5
1446 list
1448 This is a comma-separated list of pool names. The number of pool
1449 names defined here can't be greater than the number defined in
1450 max_pools.
1451 Directory usage statistics (du.pm)
1453 This graph is able to monitor the usage of an unlimited number of
1454 directories.
1455 IMPORTANT NOTE: The du command makes intensive disk I/O access that
1457 might slow down the whole system. Moreover, continued executions of
1458 this command will affect the buffer cache mechanism and this will also
1459 increase the system response time.
1460 list
1462 This is a comma-separated list that describes the groups of
1463 directories in desc. Put one description for each group. For
1464 every group specified you need to specify its directories in the
1465 desc option.
1466 WARNING: Every time the number of entries in this option
1468 changes, Monitorix will resize the du.rrd file accordingly,
1469 removing all historical data.
1470 An example would be:
1472 list = System, Users
1474 desc
1476 This is a list of directories per group defined.
1477 <desc>
1479 0 = /var/spool/mail, /var/spool/mqueue, /etc, /var/ftp,
1480 /tmp
1481 1 = /home/ace, /home/gene, /home/paul, /home/peter
1482 </desc>
1483 The maximum number of directories allowed for each group is 9.
1485 type
1487 This specifies the information that will be presented for each
1488 directory specified in each list. It accepts two possible val‐
1489 ues:
1490 size for the directory size (which is the default
1492 option).
1493 files for the number of files inside the directory.
1494 An example would be:
1496 <type>
1498 0 = size
1499 1 = files
1500 </type>
1501 dirmap
1503 This list complements the desc option. It basically allows you
1504 to change the name that will appear in the graph, hiding the
1505 real name of the directory. If no association is defined, then
1506 Monitorix will display the name specified in the desc option.
1507 graphs_per_row
1509 This is the number of graphs that will be put in a row.
1510 Default value: 2
1512 extra_args
1514 This option includes any extra argument to the du command exe‐
1515 cuted by Monitorix, which is "du -ks". This is specially useful
1516 if you want to skip directories on differents file systems, in
1517 this case just define this option like this:
1518 extra_args = "-x"
1520 IMPORTANT NOTICE: Keep in mind that including certain flags like
1522 '-h' (which gives results in human readable format) could make
1523 Monitorix unable to interpret the results.
1524 Network traffic and usage (net.pm)
1526 max
1527 This is the maximum number of network interfaces that you can
1528 define in list. There is no limit, but keep in mind that every
1529 time this number changes, Monitorix will resize the net.rrd file
1530 accordingly, removing all historical data.
1531 Default value: 10
1533 list
1535 This is a comma-separated list of network interfaces that you
1536 may want to monitor. An example would be:
1537 list = eth0, eth1
1539 desc
1541 This is the option where each network interface specified in
1542 list is described. Each definition consists of three parameters
1543 separated by comma: the description of the interface and the
1544 rigid and limit values.
1545 Put one description for each interface listed. An example would
1547 be:
1548 <desc>
1550 eth0 = FastEthernet LAN, 0, 1000
1551 eth1 = ADSL 10Mbs Internet, 0, 1000
1552 </desc>
1553 gateway
1555 This is where the network interface that acts as the gateway for
1556 this server is defined. This is mainly used if you plan to moni‐
1557 tor network traffic usage of your devices/networks using the
1558 traffacct graph below.
1559 Netstat statistics (netstat.pm)
1561 This graph shows the state of the all IPv4 and IPv6 network connec‐
1562 tions.
1563 Only the command to be used can be set here, besides the limit and
1565 rigid values.
1566 cmd
1568 This is the command that will be used to gather statistics.
1569 There are two possible values:
1570 ss
1572 netstat
1573 Default value: ss
1575 Traffic Control statistics (tc.pm)
1577 This graph is able to monitor an unlimited number of network interfaces
1578 managed by the tc command.
1579 list
1581 This is a comma-separated list of network interfaces that you
1582 may want to monitor. An example would be:
1583 list = eth0, eth1
1585 desc
1587 This is the option where you define the queue disciplines you
1588 want to monitor for each network interface specified in list.
1589 An example would be:
1591 <desc>
1593 eth0 = cbq 1, sfq 10, sfq 20, sfq 30, ingress ffff
1594 eth1 = htb 1, pfifo 20, pfifo 21, pfifo 22
1595 </desc>
1596 The maximum number of qdiscs allowed is 9.
1598 map
1600 This option complements the desc option. It basically allows you
1601 to change the name of the qdiscs that will appear in the graphs.
1602 If no association is defined, then Monitorix will show the name
1603 as specified in the desc option.
1604 Since the qdisc names have the space character in their names,
1606 they can't be used as the key in the association, instead you
1607 must the use their position number (starting by 0) in the desc
1608 option.
1609 An example would be:
1611 <map>
1613 <eth0>
1614 0 = Class Based Queueing
1615 1 = Stochastic Fairness Queueing 10
1616 </eth0>
1617 <eth1>
1618 0 = Hierarchical Token Bucket
1619 </eth1>
1620 </map>
1621 Libvirt statistics (libvirt.pm)
1623 This graph is able to monitor an unlimited number of virtual machines
1624 managed by Libvirt.
1625 cmd
1627 This is the command that will be used to gather statistics from
1628 each virtual machine listed in list.
1629 Default value: virsh
1631 An example would be:
1633 cmd = virsh -r -c qemu:///session
1635 list
1637 This is a list of groups of virtual machines that you want to
1638 monitor. Each group will become a graph and there may be an
1639 unlimited number of groups.
1640 WARNING: Every time the number of groups in this option changes,
1642 Monitorix will resize the libvirt.rrd file accordingly, removing
1643 all historical data.
1644 An example would be:
1646 <list>
1648 0 = centos6, winxp
1649 </list>
1650 The maximum number of virtual machines allowed per group is 8.
1652 desc
1654 This list complements the list option and is mandatory for every
1655 virtual machine listed. You must define the virtual block device
1656 and the MAC address of the virtual network device that you want
1657 to monitor for every virtual machine. Just like this:
1658 <desc>
1660 centos6 = CentOS 6, vda, 52:54:00:45:d0:e7
1661 winxp = MS Windows XP, hda, 52:54:00:97:1c:e5
1662 </desc>
1663 You might also define this list using sections for each virtual
1665 machine, this way you'll be able to define multiple disks and
1666 multiple network interfaces for each virtual machine. Just like
1667 this:
1668 <desc>
1670 <centos6>
1671 desc = "CentOS 6"
1672 disk = vda, vdb, vdc
1673 net = 52:54:00:45:d0:e7, 52:54:00:45:d0:e8
1674 </centos6>
1675 </desc>
1676 To obtain all these values you might want to use the following
1678 commands:
1679 # virsh domblklist centos6
1681 Target Source
1682 ------------------------------------------------
1683 vda /home/jordi/kvm/centos6.img
1684 hdc -
1685 # virsh domiflist centos6
1687 Interface Type Source Model MAC
1688 -------------------------------------------------------
1689 vnet3 network default virtio 52:54:00:45:d0:e7
1690 This option also allows you to change the name that will appear
1692 in the graph, hiding the real name of the virtual machine. If no
1693 association is defined, then Monitorix will display the name
1694 specified in the list option.
1695 Process statistics (process.pm)
1697 This graph is able to monitor an unlimited number of processes. This
1698 graph requires a Linux kernel version 2.6.20 at least to support
1699 process I/O accounting. Some systems with older kernels might also have
1700 been ported it though.
1701 list
1703 This is a list of groups of processes that you want to monitor.
1704 Each group will become a graph and there may be an unlimited
1705 number of groups.
1706 WARNING: Every time the number of groups in this option changes,
1708 Monitorix will resize the process.rrd file accordingly, removing
1709 all historical data.
1710 Monitorix uses the following command to find the processes
1712 listed in this option:
1713 # ps -eo pid,comm,command
1715 Therefore names in the process list can be either exactly to the
1717 process name as it appears in the comm columns, or just a sub‐
1718 string of the process name that appears in the command column.
1719 An example of this option would be:
1721 <list>
1723 0 = httpd, sshd, ntpd, mysqld, proftpd, clamd, imap,
1724 sendmail, named, bash
1725 </list>
1726 The maximum number of processes allowed per group is 10.
1728 desc
1730 This list complements the list option. It basically allows you
1731 to change the name that will appear in the graph, hiding the
1732 real name of the process. If no association is defined, then
1733 Monitorix will display the name specified in the list option.
1734 <desc>
1736 httpd = Apache
1737 imap = Dovecot
1738 named = Bind
1739 </desc>
1740 You can define as much entries as you want.
1742 System services demand (serv.pm)
1744 This graph requires either MailScanner or amavisd-new mail scanners in
1745 order to account spam and virus emails.
1746 mode
1748 This option toggles the way the System Services Demand data is
1749 represented in the graph. There are two possible values:
1750 i for incremental style.
1752 l for load (peaks) style.
1753 Default value: i
1755 Mail statistics (mail.pm)
1757 This graph requires either MailScanner or amavisd-new mail scanners in
1758 order to account spam and virus emails. Spamassassin and Clamav
1759 antivirus are also used for spam and virus email accounting.
1760 mta
1762 This option specifies the MTA that Monitorix will use to collect
1763 mail statistics. The currently supported MTAs are:
1764 Sendmail
1765 Postfix
1766 Exim
1767 NOTE: the pflogsumm utility is required when using the Postfix
1769 MTA.
1770 Default value: sendmail
1772 greylist
1774 This option specifies the Greylisting implementation that Moni‐
1775 torix will use to collect statistical information.
1776 The currently supported Greylisting software is:
1778 milter-greylist
1779 postgrey
1780 In the case of milter-greylist, Monitorix shows the same data
1782 that appears at the end of the file greylist.db.
1783 In the case of Postgrey, Monitorix reads the mail_log file and
1785 searches for a specific type of lines. Lines of type
1786 "action=greylist, reason=new" appear as Greylisted in the graph.
1787 Lines of type "action=greylist, reason=early-retry" appear as
1788 Delayed in the graph. Lines of type "action=pass, reason=triplet
1789 found" appear as Passed in the graph. And finally, lines of type
1790 "action=pass, reason=client whitelist" appear as Whitelisted in
1791 the graph.
1792 Default value: milter-greylist
1794 stats_rate
1796 This option only affects the Mail Statistics and the Greylisting
1797 graphs, and it specifies the rate in which the values are saved
1798 and shown. This option has two possible values:
1799 real
1800 per_second
1801 If it's set to its default value (real), it will show the mes‐
1803 sages as in a 'per minute' rate. Since Monitorix collects data
1804 on every minute, this should be the preferred way to see the
1805 results.
1806 In the other hand, and in order to keep backwards compatibility,
1808 if this option is missing in the configuration file, it will act
1809 as if it was set up as per_second, which means that the number
1810 of messages collected in each minute will be divided by 60.
1811 Default value: real
1813 delvd_enabled
1815 This section enables or disables one of the alert capabilities
1816 for this graph; the alert for the number of delivered messages.
1817 It works as follows:
1818 If the number of delivered messages reaches the delvd_threshold
1820 value for the interval of time defined in delvd_timeintvl, Moni‐
1821 torix will execute the external alert script defined in
1822 delvd_script.
1823 The default Monitorix installation includes an example of a
1825 shell-script alert called monitorix-alert.sh which you can use
1826 as a base for your own script.
1827 Default value: n
1829 delvd_timeintvl
1831 This is the period of time (in seconds) that the threshold needs
1832 to be exceeded before the external alert script is executed.
1833 Default value: 60
1835 delvd_threshold
1837 This is the value that needs to be reached or exceeded within
1838 the specified time period in delvd_timeintvl to trigger the
1839 mechanism for a particular action, which in this case is the
1840 execution of an external alert script.
1841 The value of this option is compared against the number of
1843 delivered messages since the last delvd_timeintvl seconds.
1844 Default value: 100
1846 delvd_script
1848 This is the full path name of the script that will be executed
1849 by this alert.
1850 It will receive the following three parameters:
1852 1st - the value currently defined in delvd_timeintvl.
1854 2nd - the value currently defined in delvd_threshold.
1855 3rd - the number of delivered messages.
1856 Default value: /path/to/script.sh
1858 mqueued_enabled
1860 This section enables or disables one of the alert capabilities
1861 for this graph; the alert for the number of queued messages. It
1862 works as follows:
1863 If the number of queued messages reaches the mqueued_threshold
1865 value for the interval of time defined in mqueued_timeintvl,
1866 Monitorix will execute the external alert script defined in
1867 mqueued_script.
1868 The default Monitorix installation includes an example of a
1870 shell-script alert called monitorix-alert.sh which you can use
1871 as a base for your own script.
1872 Default value: n
1874 mqueued_timeintvl
1876 This is the period of time (in seconds) that the threshold needs
1877 to be exceeded before the external alert script is executed.
1878 Default value: 3600
1880 mqueued_threshold
1882 This is the value that needs to be reached or exceeded within
1883 the specified time period in mqueued_timeintvl to trigger the
1884 mechanism for a particular action, which in this case is the
1885 execution of an external alert script.
1886 The value of this option is compared with the number of messages
1888 in the mail queue.
1889 Default value: 100
1891 mqueued_script
1893 This is the full path name of the script that will be executed
1894 by this alert.
1895 It will receive the following three parameters:
1897 1st - the value currently defined in mqueued_timeintvl.
1899 2nd - the value currently defined in mqueued_threshold.
1900 3rd - the number of messages in the mail queue.
1901 Default value: /path/to/script.sh
1903 Network port traffic (port.pm)
1905 This graph requires the iptables(8) command and optionally the
1906 ip6tables(8) command on Linux systems and the ipfw command on *BSD sys‐
1907 tems.
1908 max
1910 This is the number of network ports that you want to monitor.
1911 There is no limit to the number of ports monitored, but keep in
1912 mind that every time this number changes, Monitorix will resize
1913 the port.rrd file accordingly, removing all historical data.
1914 Default value: 9
1916 rule
1918 This is the rule number that Monitorix will use when using the
1919 ipfw command to manage network port activity on *BSD systems.
1920 Change it if you think it might conflict with any other rule
1921 number.
1922 Default value: 24000
1924 list
1926 You may define here up to max network port numbers. If you need
1927 to monitor the same network port with TCP and UDP protocols, you
1928 can add your own suffix to the port number (e.g: 443t and 443u)
1929 in order to distinguish it from the double definition in the
1930 <desc> block.
1931 If you see a red color in the background of a network port
1933 graph, it means that there is not a daemon listening on that
1934 port. This can be useful to know if some service gone down unex‐
1935 pectedly.
1936 desc
1938 This is the option where each network port specified in list is
1939 described. Each port definition consists of six parameters sepa‐
1940 rated by comma:
1941 - an small port description.
1942 - the network protocol (tcp or udp).
1943 - the connection type (in, out or in/out).
1944 - the rigid value.
1945 - the limit value.
1946 - the L option which specifies that this port should be
1947 listening and Monitorix will advice it, by changing the
1948 background color of the graph to red, if finds it down.
1949 There is also support (Linux only) for IPv6 network ports activ‐
1951 ity by using protocol names as tcp6 or udp6.
1952 An example would be:
1954 list = 25, 25ip6, 80, 53
1955 <desc>
1956 25 = SMTP, tcp, in/out, 0, 1000, L
1957 25ip6 = SMTP, tcp6, in/out, 0, 1000, L
1958 80 = HTTP, tcp, in, 0, 1000, L
1959 53 = DNS, udp, in, 0, 1000, L
1960 </desc>
1961 As you can see, you cannot use the same port number twice.
1963 Instead, you must distinguish it with some suffix. Monitorix
1964 will automatically extract all the first numeric digits, and
1965 will use that value as the network port number.
1966 graphs_per_row
1968 This is the number of graphs that will be put in a row. Consider
1969 the interaction of this parameter with the max option in order
1970 to adjust the size and number of graphs in relation to your hor‐
1971 izontal screen size.
1972 Default value: 3
1974 Users using the system (user.pm)
1976 Only the limit and rigid values can be set here.
1977 FTP statistics (ftp.pm)
1979 This graph supports currently ProFTPD, vsftpd and Pure-FTPd log file
1980 formats.
1981 For best results with the ProFTPD server I recommend to add the follow‐
1983 ing line in its configuration file:
1984 ExtendedLog /var/log/proftpd/access.log AUTH,DIRS,READ,WRITE
1986 For best results with the vsftpd server I recommend to setup the option
1988 xferlog_std_format to NO, and the option ftp_log to
1989 /var/log/vsftpd.log.
1990 Pure-FTPd users might want to consider using the system syslog logfile.
1992 server
1994 This option specifies the FTP server. The currently supported
1995 FTP servers are:
1996 ProFTPD
1997 vsftpd
1998 Pure-FTPd
1999 Default value: proftpd
2001 anon_user
2003 This option lists the different names (separated by comma) that
2004 can adopt the Anonymous user in the FTP server defined in
2005 server.
2006 Default value: anonymous, ftp
2008 Apache statistics (apache.pm)
2010 This graph requires that mod_status be loaded and ExtendedStatus option
2011 set to On in order to collect full status information of the Apache web
2012 server.
2013 This graph is able to monitor an unlimited number of local and remote
2015 Apache web servers.
2016 list
2018 This is a comma-separated list of URLs of the monitored Apache
2019 web servers.
2020 WARNING: Every time the number of entries in this option
2022 changes, Monitorix will resize the apache.rrd file accordingly,
2023 removing all historical data.
2024 Default value: http://localhost/server-status?auto
2026 alerts
2028 This optional list enables the alert capabilities for this graph
2029 and complements with the list option. Each alert has three
2030 fields separated by comma: the time interval, the threshold and
2031 the path to the script to be executed.
2032 The time interval is the period of time (in seconds) that the
2034 threshold needs to be exceeded before the external script is
2035 executed.
2036 The threshold is the number of remaining free slots that needs
2038 to be reached or exceeded within the specified time in time
2039 interval to execute the external script.
2040 The script is the full path name of the script that will be exe‐
2042 cuted by this alert.
2043 Each defined Apache has its own alert.
2045 The default Monitorix installation includes an example of a
2047 shell-script alert called monitorix-alert.sh which you can use
2048 as a base for your own script.
2049 The following is an example of an alert defined for the local
2051 Apache:
2052 <alerts>
2054 http://localhost/server-status?auto = 3600, 5,
2055 /path/to/script.sh
2056 </alerts>
2057 Such alert means that if the remaining free slots reaches or
2059 exceeds 5 (less than 5) during at least one hour (3600 seconds)
2060 the script in /path/to/script.sh will be executed.
2061 The external script will receive the following arguments:
2063 1st - the value defined as time interval.
2065 2nd - the value defined as threshold.
2066 3rd - the remaining free slots.
2067 Nginx statistics (nginx.pm)
2069 This graph may require adding some lines in the configuration file
2070 nginx.conf. Please see the README.nginx file to determine the exact
2071 steps needed to configure Nginx to get status information.
2072 This graph requires the iptables(8) command on Linux systems, and the
2074 ipfw command on *BSD systems.
2075 url
2077 This is the URL to be used to collect Nginx stats.
2078 Default value: http://localhost/nginx_status
2080 port
2082 This is the network port the Nginx web server is listening on.
2083 It will be used for traffic (with iptables), and for nginx_sta‐
2084 tus if url is not specified. If port of nginx_status is differ‐
2085 ent from port then specify it in the url
2086 (http://host:port/nginx_status)
2087 Default value: 80
2089 rule
2091 This is the rule number that Monitorix will use when using the
2092 ipfw command to manage Nginx network activity on *BSD systems.
2093 Change it if you think it might conflict with any other rule
2094 number.
2095 Default value: 24100
2097 Lighttpd statistics (lighttpd.pm)
2099 This graph requires that mod_status is loaded in order to collect sta‐
2100 tus information from the Lighttpd web server.
2101 This graph is able to monitor an unlimited number of local and remote
2103 Lighttpd web servers.
2104 list
2106 This is a comma-separated list of URLs of the monitored Lighttpd
2107 web servers.
2108 WARNING: Every time the number of entries of this option
2110 changes, Monitorix will resize the lighttpd.rrd file accord‐
2111 ingly, removing all historical data.
2112 Default value: http://localhost/server-status?auto
2114 MySQL statistics (mysql.pm)
2116 This graph requires that you create a password protected MySQL user
2117 that is NOT granted privileges on any DB.
2118 Example:
2120 mysql> CREATE USER 'user'@'localhost' IDENTIFIED BY 'password';
2122 mysql> FLUSH PRIVILEGES;
2123 where user is the new user name and password is the password that will
2125 be used for that user.
2126 This graph is able to monitor an unlimited number of local and remote
2128 MySQL web servers.
2129 NOTE: It is strongly recommended that you restart the MySQL service in
2131 order to avoid high peaks that could prevent correct display of the
2132 first plotted data.
2133 conn_type
2135 This option toggles the way how Monitorix establishes the con‐
2136 nection with the MySQL server. There are two possible values:
2137 host using the network (hostname and IP address).
2139 socket using a socket file.
2140 Default value: host
2142 list
2144 This is a comma-separated list of hostnames or path to sockets
2145 of MySQL servers.
2146 WARNING: Every time the number of entries of this option change
2148 Monitorix will resize the mysql.rrd file accordingly, removing
2149 all historical data.
2150 Default value: localhost
2152 desc
2154 This is the option where each entry specified in the list is
2155 described. Each definition consists of three parameters sepa‐
2156 rated by comma: the port, the username and the password.
2157 An example using the host type would be:
2159 <desc>
2160 localhost = 3306, user, secret
2161 </desc>
2162 When using the socket type the network port is, of course,
2164 irrelevant but its field is still mandatory. This means that you
2165 must respect the three comma-separated values.
2166 Some of the values shown in the graphs are the result of a cal‐
2168 culation of two values from either SHOW [GLOBAL] STATUS or SHOW
2169 VARIABLES. The following is an explanation of them:
2170 Thread Cache Hit Rate
2172 (1 - (Threads_created / Connections)) * 100
2173 When an application connects to a MySQL database, the database
2174 has to create a thread to manage the connection and the queries
2175 that will be sent in that connection. The database instructs the
2176 kernel to create a new thread, and the kernel allocates
2177 resources and creates the thread, then returns it to the MySQL
2178 service. When the connection is terminated by the application,
2179 MySQL tells the kernel to destroy the thread and free the
2180 resources. This create/destroy mechanism causes considerable
2181 overhead if the MySQL server has many new connections per sec‐
2182 ond.
2183 If MySQL doesn't destroy the thread when the connection is ter‐
2184 minated, but reuses it and assigns it to the next connection
2185 then this will decrease the kernel overhead. This is why a high
2186 Thread Cache Hit Rate improves MySQL performance and decreases
2187 the system's CPU usage.
2188 Setting the parameter thread_cache_size in the my.cnf file
2189 accordingly will help to correctly balance between having a
2190 great thread cache and keeping MySQL memory consumption reason‐
2191 able.
2192 Higher is better.
2193 Query Cache Hit Rate
2195 Qcache_hits / (Qcache_hits + Com_select) * 100
2196 Higher should be considered better.
2197 A query cache size increase is recommended if the query cache
2198 usage is very close to 100% and the query cache hit rate is far
2199 from 100%. But sometimes a size increase will not lead to a bet‐
2200 ter hit rate: this means that the increase was not needed and
2201 that the application do not run enough cacheable SELECT queries.
2202 This value should grow proportionally with the number of exe‐
2203 cuted queries as long as the query cache is performing well.
2204 Please also have a look at the Query cache usage percentage to
2205 know if your query_cache configuration is appropriate.
2206 For more information please refer to http://www.databasejour‐
2208 nal.com/features/mysql/article.php/3808841/Optimizing-the-MySQL-
2209 Query-Cache.htm
2210 Query Cache Usage
2212 (1 - (Qcache_free_memory / query_cache_size)) * 100
2213 This value should be reasonably far from 100%, otherwise con‐
2214 sider incrementing the query_cache_size parameter in my.cnf.
2215 Connections Usage
2217 (Max_used_connections / max_connections) * 100
2218 This value should be reasonably far from 100%, otherwise con‐
2219 sider incrementing the max_connections parameter in my.cnf.
2220 Key Buffer Usage
2222 (Key_blocks_used / (Key_blocks_used + Key_blocks_unused)) * 100
2223 This value should be reasonably far from 100%, otherwise con‐
2224 sider incrementing the key_buffer_size parameter in my.cnf.
2225 InnoDB Buffer Pool Usage
2227 (1 - (Innodb_buffer_pool_pages_free / Innodb_buf‐
2228 fer_pool_pages_total)) * 100
2229 This value should be reasonably far from 100%, otherwise con‐
2230 sider incrementing the innodb_buffer_pool_size parameter in
2231 my.cnf.
2232 Temp. Tables To Disk
2234 (Created_temp_disk_tables / Created_temp_disk_tables + Cre‐
2235 ated_temp_tables)) * 100
2236 During operation, MySQL has to create some temporary tables
2237 (that can be explicit, so created by the web application, or
2238 implicit, so for example MySQL has to create one when he runs
2239 some "SELECT DISTINCT", "UNION" or "VIEW" queries). MySQL will
2240 prefer to save this tmp tables to memory, for a fast access. But
2241 if tmp_table_size gets saturated, he has to write them on the
2242 disk instead, making the access slower.
2243 Note that if you modify the value of tmp_table_size in the MySQL
2244 configuration file, you should also modify the value of
2245 max_heap_table_size as well, since both values should have the
2246 same value because MySQL uses the minimum of both, so raising
2247 one of them is useless.
2248 Therefore this value helps to know how many tmp tables go to the
2249 disk instead than to the memory. Keep in mind that some large
2250 queries, involving TEXT and BLOB columns, are directly written
2251 to the disk instead than to the memory, because they would be
2252 too big. So you probably will want to avoid having a high % of
2253 tmp tables written to the disk, but you will never reach 0% on a
2254 big site, and this is fine.
2255 Lower is better ... but 0% is not reachable and you should not
2256 try to reach it, usually.
2257 MongoDB statistics (mongodb.pm)
2259 This graph is able to monitor an unlimited number of MongoDB servers.
2260 list
2262 This is a comma-separated list of names of MongoDB servers.
2263 WARNING: Every time the number of entries in this option
2265 changes, Monitorix will resize the mongodb.rrd file accordingly,
2266 removing all historical data.
2267 Default value: localhost
2269 max_db
2271 This is the maximum number of databases to be monitored in a
2272 MongoDB server. There is no limitation, just specify here the
2273 number of entries of the db_list option that has the most
2274 entries.
2275 WARNING: Every time the number of entries in this option
2277 changes, Monitorix will resize the mongodb.rrd file accordingly,
2278 removing all historical data.
2279 Default value: 1
2281 desc
2283 This is a list of blocks of names specified in the list option.
2284 <desc>
2286 <localhost>
2287 host = 127.0.0.1
2288 db_list = mydb
2289 </localhost>
2290 </desc>
2291 The maximum number of mountpoints allowed for each URL is 9.
2293 host
2295 This is the hostname or IP address of the MongoDB server speci‐
2296 fied in its block.
2297 Default value: 127.0.0.1
2299 port
2301 This is the port number of the MongoDB server specified in its
2302 block.
2303 Default value:
2305 db_list
2307 This is a comma-separated list of databases to be monitored of
2308 the MongoDB server specified in its block.
2309 Default value: mydb
2311 Varnish cache statistics (varnish.pm)
2313 This graph monitors a local installation of the Varnish HTTP accelera‐
2314 tor.
2315 Only the limit and rigid values can be set here.
2317 PageSpeed Module statistics (pagespeed.pm)
2319 This graph is able to monitor an unlimited number of PageSpeed instal‐
2320 lations.
2321 list
2323 This is a comma-separated list of URLs of PageSpeed status
2324 pages.
2325 WARNING: Every time the number of entries in this option
2327 changes, Monitorix will resize the pagespeed.rrd file accord‐
2328 ingly, removing all historical data.
2329 Default value: http://modpagespeed.com/mod_pagespeed_statistics
2331 For more information please refer to https://develop‐
2333 ers.google.com/speed/pagespeed/module and http://stackover‐
2334 flow.com/questions/9115595/what-do-the-mod-pagespeed-statistics-mean
2335 Squid Proxy Web Cache (squid.pm)
2337 cmd
2338 This command displays statistics about the Squid HTTP proxy
2339 process and is the main command used to collect all data.
2340 Default value: squidclient -h 127.0.0.1
2342 graph_0
2344 graph_1
2345 These two lists hold the selected Squid result or status codes
2346 to be shown in each graph. Feel free to mix result status and
2347 code status in any of the two options.
2348 For more information about the list of all the result and status
2350 codes, please refer to http://wiki.squid-cache.org/Squid‐
2351 Faq/SquidLogs.
2352 Each graph has a limit number of 9 entries.
2354 NFS server statistics (nfss.pm)
2356 version
2357 This option specifies which NFS server version is running in the
2358 system in order to correctly gather the correct values.
2359 The possible values are:
2361 2 for NFS v2.
2362 3 for NFS v3.
2363 4 for NFS v4.
2364 Default value: 3
2366 graph_0
2368 graph_1
2369 graph_2
2370 These three lists hold the defined NFS server activity statis‐
2371 tics to be shown in each graph. Put every statistic name exactly
2372 as they appear in the output of the nfsstat(8) command.
2373 Each graph has a limit number of 10 entries.
2375 NFS client statistics (nfsc.pm)
2377 version
2378 This option specifies which NFS server version is running in the
2379 system in order to correctly gather the correct values.
2380 The possible values are:
2382 2 for NFS v2.
2383 3 for NFS v3.
2384 4 for NFS v4.
2385 Default value: 3
2387 graph_1
2389 graph_2
2390 graph_3
2391 graph_4
2392 graph_5
2393 These five lists hold the defined NFS client activity statistics
2394 to be shown in each graph. Put every statistic name exactly as
2395 they appear in the output of the nfsstat(8) command.
2396 Each graph has the following limit number of entries:
2398 graph_1 up to 10 entries.
2400 graph_2 up to 10 entries.
2401 graph_3 up to 4 entries.
2402 graph_4 up to 4 entries.
2403 graph_5 up to 4 entries.
2404 BIND statistics (bind.pm)
2406 This graph requires a BIND server with version 9.5 or higher, and in
2407 order to see all statistics provided by BIND you must configure the
2408 statistics-channels option like this:
2409 statistics-channels {
2411 inet 127.0.0.1 port 8053;
2412 };
2413 This graph is able to monitor an unlimited number of BIND servers.
2415 list
2417 This is a comma-separated list of URLs of BIND servers status
2418 pages.
2419 WARNING: Every time the number of entries in this option
2421 changes, Monitorix will resize the bind.rrd file accordingly,
2422 removing all historical data.
2423 Default value: http://localhost:8053/
2425 in_queries_list
2427 This is a comma-separated list of RR (Resource Records) types
2428 for each BIND server specified in list option. The RR types
2429 defined here will appear in the Incoming Queries graph which
2430 shows the number of incoming queries for each RR type.
2431 For a complete list of RR types check the BIND 9 Administrator
2433 Reference Manual at
2434 <http://ftp.isc.org/www/bind/arm95/Bv9ARM.html>.
2435 <in_queries_list>
2437 http://localhost:8053/ = A, AAAA, ANY, DS, MX, NS, PTR,
2438 SOA, SRV, TXT, NAPTR, A6, CNAME, SPF, KEY, DNSKEY, HINFO, WKS,
2439 PX, NSAP
2440 </in_queries_list>
2441 The maximum number of RR types allowed for this graph is 20.
2443 out_queries_list
2445 This is a comma-separated list of RR (Resource Records) types
2446 for each BIND server. The RR types defined here will appear in
2447 the Outgoing Queries graph (_default view) which shows the num‐
2448 ber of outgoing queries sent by the DNS server resolver for each
2449 RR type.
2450 <out_queries_list>
2452 http://localhost:8053/ = A, AAAA, ANY, DS, MX, NS, PTR,
2453 SOA, SRV, TXT, NAPTR, A6, CNAME, SPF, KEY, DNSKEY, HINFO, WKS,
2454 PX, NSAP
2455 </out_queries_list>
2456 The maximum number of RR types allowed for this graph is 20.
2458 server_stats_list
2460 This is a comma-separated list of counters about incoming
2461 request processing. The counters defined here will appear in the
2462 Server Statistics graph.
2463 <server_stats_list>
2465 http://localhost:8053/ = Requestv4, Requestv6, ReqEdns0,
2466 ReqBadEDNSVer, ReqTSIG, ReqSIG0, ReqBadSIG, ReqTCP, Response,
2467 QrySuccess, QryAuthAns, QryNoauthAns, QryReferral, QryNxrrset,
2468 QrySERVFAIL, QryNXDOMAIN, QryRecursion, QryDuplicate, Qry‐
2469 Dropped, QryFailure
2470 </server_stats_list>
2471 The maximum number of counters allowed for this graph is 20.
2473 resolver_stats_list
2475 This is a comma-separated list of counters about name resolution
2476 performed in the internal resolver. The counters defined here
2477 will appear in the Resolver Statistics graph (_default view).
2478 <resolver_stats_list>
2480 http://localhost:8053/ = Queryv4, Queryv6, Responsev4,
2481 Responsev6, NXDOMAIN, SERVFAIL, FORMERR, OtherError, EDNS0Fail,
2482 Truncated, Lame, Retry, QueryTimeout, GlueFetchv4, GlueFetchv6,
2483 GlueFetchv4Fail, GlueFetchv6Fail, ValAttempt, ValOk, ValNegOk
2484 </resolver_stats_list>
2485 The maximum number of counters allowed for this graph is 20.
2487 cache_rrsets_list
2489 This is a comma-separated list of RR (Resource Records) types
2490 for each BIND server. The RR types defined here will appear in
2491 the Cache DB RRsets graph (_default view) which shows the number
2492 of RRsets per RR type (positive or negative) and nonexistent
2493 names stored in the cache database.
2494 <cache_rrsets_list>
2496 http://localhost:8053/ = A, !A, AAAA, !AAAA, DLV, !DLV, DS,
2497 !DS, MX, NS, CNAME, !CNAME, SOA, !SOA, !ANY, PTR, RRSIG, NSEC,
2498 DNSKEY, NXDOMAIN
2499 </cache_rrsets_list>
2500 The maximum number of RR types allowed for this graph is 20.
2502 NTP statistics (ntp.pm)
2504 This graph is able to monitor an unlimited number of NTP servers.
2505 list
2507 This is a comma-separated list of NTP servers.
2508 WARNING: Every time the number of entries in this option
2510 changes, Monitorix will resize the ntp.rrd file accordingly,
2511 removing all historical data.
2512 Default value: localhost
2514 desc
2516 This is a list of groups of Reference Identifier and Kiss-
2517 o'-Death Codes for every hostname specified in the list option.
2518 For more information on these NTP codes:
2520 <http://www.iana.org/assignments/ntp-parameters/ntp-parame‐
2521 ters.xml>
2522 <http://www.iana.org/go/rfc5905>
2523 <desc>
2525 localhost = AUTH, AUTO, CRYP, DENY, GPS, INIT, NKEY, RATE,
2526 RMOT, RSTR
2527 </desc>
2528 The maximum number of codes allowed for each hostname is 10.
2530 extra_args
2532 This option includes any extra argument to the NTP command exe‐
2533 cuted by Monitorix, which is "ntpq -pn". This is specially use‐
2534 ful if you want to force using IPv4, in this case just define
2535 this option like this:
2536 extra_args = "-4"
2538 Monitorix will add this extra argument to the NTP command which
2540 will become as "ntpq -pn -4".
2541 Chrony statistics (chrony.pm)
2543 This graph is able to monitor an unlimited number of Chrony daemons.
2544 list
2546 This is a comma-separated list of hostnames with the network
2547 port running chronyd. The format is <hostname>:<port> being the
2548 port number optional.
2549 WARNING: Every time the number of entries in this option
2551 changes, Monitorix will resize the chrony.rrd file accordingly,
2552 removing all historical data.
2553 Default value: localhost
2555 Fail2ban statistics (fail2ban.pm)
2557 This graph is able to monitor an unlimited number of Fail2ban jails.
2558 list
2560 This is a comma-separated list that describes the groups of
2561 jails in desc. Put one description for each group. For every
2562 group specified you need to specify its description in the desc
2563 option.
2564 WARNING: Every time the number of entries in this option
2566 changes, Monitorix will resize the fail2ban.rrd file accord‐
2567 ingly, removing all historical data.
2568 An example would be:
2570 list = Security, Overload / Abuse
2572 desc
2574 This is a list of jails per group defined in your Fail2ban con‐
2575 figuration.
2576 <desc>
2578 0 = [apache], [apache-mod-security], [apache-overflows],
2579 [courierauth], [ssh], [pam-generic], [php-url-fopen], [vsftpd]
2580 1 = [apache-imdbphp], [apache-evasive], [apache-badbots],
2581 [apache-robots-txt], [communigate], [named-refused-udp], [named-
2582 refused-tcp], [trac-ticketspam]
2583 </desc>
2584 The maximum number of jails allowed for each group is 9.
2586 graphs_per_row
2588 This is the number of fail2ban graphs that will be put in a row.
2589 Default value: 2
2591 Icecast Streaming Media Server (icecast.pm)
2593 This graph is able to monitor an unlimited number of Icecast servers.
2594 list
2596 This is a list of URLs of Icecast server status pages.
2597 WARNING: Every time the number of entries in this option
2599 changes, Monitorix will resize the icecast.rrd file accordingly,
2600 removing all historical data.
2601 Default value: http://localhost:8000/status.xsl
2603 desc
2605 This is a comma-separated list of Mount Points configured for
2606 every URL specified in the list option. IMPORTANT: the Mount
2607 Points must be specified in the same order that appears in the
2608 Icecast Server Status page.
2609 <desc>
2611 http://localhost:8000/status.xsl = stream1, stream2,
2612 stream3
2613 </desc>
2614 The maximum number of mountpoints allowed for each URL is 9.
2616 graph_mode
2618 This changes the layout of the listeners graph, the possible
2619 values are r for a real graph, or s for a stacked graph (every
2620 line or area is stacked on top of the previous element).
2621 Default value: r
2623 Raspberry Pi sensor statistics (raspberrypi.pm)
2625 For more information please refer to
2626 http://elinux.org/RPI_vcgencmd_usage.
2627 cmd
2629 This is where the vcgencmd command is installed.
2630 Default value: /opt/vc/bin/vcgencmd
2632 clocks
2634 This is a comma-separated list of clock types that will be rep‐
2635 resented in the first graph.
2636 An example would be:
2638 clocks = arm, core, h264, isp, v3d, uart, emmc, pixel, hdmi
2640 The maximum number of clocks allowed is 9.
2642 volts
2644 This is a comma-separated list of voltage types that will be
2645 represented in the third graph.
2646 An example would be:
2648 volts = core, sdram_c, sdram_i, sdram_p
2650 The maximum number of clocks allowed is 6.
2652 Alternative PHP Cache statistics (phpapc.pm)
2654 This graph is able to monitor an unlimited number of PHP-APC installa‐
2655 tions.
2656 list
2658 This is a comma-separated list of URLs of PHP-APC status pages.
2659 WARNING: Every time the number of entries in this option
2661 changes, Monitorix will resize the phpapc.rrd file accordingly,
2662 removing all historical data.
2663 Default value: http://localhost/apc.php?auto
2665 Memcached statistics (memcached.pm)
2667 This graph is able to monitor an unlimited number of Memcached instal‐
2668 lations.
2669 list
2671 This is a comma-separated list of hostnames with network port
2672 running Memcached.
2673 WARNING: Every time the number of entries in this option
2675 changes, Monitorix will resize the memcached.rrd file accord‐
2676 ingly, removing all historical data.
2677 Default value: localhost:11211
2679 APC UPS statistics (apcupsd.pm)
2681 This graph is able to monitor an unlimited number of APC UPS (apcupsd)
2682 installations.
2683 cmd
2685 This is the command that will be used (with the values in list)
2686 to get the statistics.
2687 Default value: apcaccess
2689 list
2691 This is a comma-separated list of hostnames with the network
2692 port running apcupsd.
2693 WARNING: Every time the number of entries in this option
2695 changes, Monitorix will resize the apcupsd.rrd file accordingly,
2696 removing all historical data.
2697 Default value: localhost:3551
2699 Network UPS Tools statistics (nut.pm)
2701 This graph is able to monitor an unlimited number of Network UPS Tools
2702 (upsc) installations.
2703 list
2705 This is a comma-separated list of UPS names with optionally the
2706 hostname and the network port where it's running upsd. The for‐
2707 mat of each entry must be:
2708 upsname[@hostname[:port]]
2710 WARNING: Every time the number of entries in this option
2712 changes, Monitorix will resize the nut.rrd file accordingly,
2713 removing all historical data.
2714 Default value: ups@localhost
2716 Wowza Media Server (wowza.pm)
2718 This graph is able to monitor an unlimited number of Wowza servers.
2719 list
2721 This is a comma-separated list of URLs of Wowza server status
2722 pages. Each URL can include the Basic Authentication in the form
2723 of http://username:password@localhost:8086/connectioncounts.
2724 WARNING: Every time the number of entries in this option
2726 changes, Monitorix will resize the wowza.rrd file accordingly,
2727 removing all historical data.
2728 Default value: http://localhost:8086/connectioncounts
2730 desc
2732 This is a comma-separated list of applications configured for
2733 every URL specified in the list option.
2734 <desc>
2736 http://localhost:8086/connectioncounts = channel1, chan‐
2737 nel2, channel3
2738 </desc>
2739 The maximum number of applications allowed for each URL is 8.
2741 Devices interrupt activity (int.pm)
2743 Only the limit and rigid values can be set here.
2744 Verlihub statistics (verlihub.pm)
2746 This graph monitors the Verlihub software for DC++ network.
2747 Monitoring the Internet traffic of your LAN (traffacct.pm)
2749 If your server acts as the gateway for a group of PCs, devices or even
2750 whole networks in your local LAN, you may want to know how much Inter‐
2751 net traffic each one is generating.
2752 This graph requires the iptables(8) command on GNU/Linux systems, and
2754 the ipfw command on *BSD systems.
2755 The following are the options you will need to configure to accomplish
2757 all of this.
2758 enabled
2760 This option enables this feature.
2761 Default value: n
2763 max
2765 This is the number of LAN devices you want to monitor. There is
2766 no limit, but keep in mind that every time this number changes,
2767 Monitorix will resize the traffacct.rrd file, removing all his‐
2768 torical data.
2769 Default value: 10
2771 graphs_per_row
2773 If your horizontal screen resolution is pretty wide, you may
2774 want to increase the number of graphs that appear on each row.
2775 Default value: 2
2777 list
2779 This is a comma-separated list of names of PCs, LAN devices or
2780 whole networks that you want to monitor. The only requirement is
2781 that all they must utilize this server as their gateway.
2782 If the names in this list are able to be resolved by a DNS query
2784 then you don't need to define the desc list (below) with corre‐
2785 sponding IP addresses, unless you want monthly reports.
2786 An example would be:
2788 list = pc8, printer, scanner, lan3
2790 desc
2792 This is the list of IP addresses with network masks and email
2793 addresses corresponding to the entries defined in the list. This
2794 option is only used when the those entries are not resolvable
2795 through a DNS query.
2796 An example would be:
2798 <desc>
2800 0 = 192.168.1.101/32, ace@example.com
2801 1 = 192.168.1.102/32, gene@example.com
2802 2 = 192.168.1.103/32, paul@example.com
2803 3 = 192.168.1.104/32, peter@example.com
2804 </desc
2805 Monthly reports of Internet traffic (traffacct.pm)
2807 enabled
2808 If this option is set to y, Monitorix will send a report of all
2809 the monthly Internet activity of the defined devices in list to
2810 the specified email address on the first day of each month.
2811 Default value: n
2813 language
2815 Define here the language used in the monthly report.
2816 The current possible values are: ca, de, en, it, nl_NL, pl and
2818 zh_CN.
2819 Default value: en
2821 default_mail
2823 This is the default email address used to send the monthly
2824 reports. This option is only used if the second parameter in
2825 desc list is empty.
2826 Default value: root@localhost
2828 url_prefix
2830 This is the prefix of the same URL you use to connect to Moni‐
2831 torix. This is needed in order to get the graphs of the same
2832 machine.
2833 Default value: http://localhost:8080
2835 smtp_hostname
2837 This is the hostname that will be used as a SMTP relay to
2838 deliver the monthly report emails.
2839 Default value: localhost
2841 from_address
2843 This is the address that will be used as remitent for all the
2844 monthly report emails.
2845 Default value: noreply@example.com
2847 Monitoring remote servers (Multihost)
2849 The Multihost feature allows you to monitor an unlimitted number of
2850 remote servers that already have Monitorix installed. Make sure that
2851 all servers (local and remote) have the same version of Monitorix, oth‐
2852 erwise there would be some incompatibilities that would prevent showing
2853 correctly the graphs.
2854 enabled
2856 This option enables the Multihost feature.
2857 Default value: n
2859 footer_url
2861 If set to y Monitorix will show the original URL of each server
2862 at the bottom of the graph. Where security is important you may
2863 want to hide this information.
2864 Default value: y
2866 graphs_per_row
2868 If your horizontal screen resolution is pretty wide, you may
2869 want to increase the number of graphs that appear on each row.
2870 Default value: 2
2872 default_option_when_all
2874 If the user has defined a considerable amount of remote servers
2875 and it selects the option "All" in the Hostname list and "All
2876 graphs" in the Graph list, the browser may hang for a while due
2877 to the huge amount of images to download remotely from different
2878 servers.
2879 This option prevents precisely that this happens accidentally by
2881 setting a default value in the Graph list. Of course, the user
2882 is able to change it to "All graphs" at any moment.
2883 The value of this option may be any of the ones that appear in
2885 the <graphs> section (near the end) of the monitorix.conf file.
2886 Default value: "System load"
2888 remotehost_list
2890 This is a comma-separated list with descriptive names of remote
2891 servers with Monitorix already installed and working that you
2892 plan to monitor from here.
2893 An example of this list would be:
2895 remotehost_list = server 1, server 2, server 3
2897 remotehost_desc
2899 This is a numbered list that describes each of the names defined
2900 in the remotehost_list option and the remote values of base_url
2901 and base_cgi options.
2902 An example would be:
2904 <remotehost_desc>
2906 0 = http://www.example.com,/monitorix,/monitorix-cgi
2907 1 = http://10.0.0.1,/monitorix,/monitorix-cgi
2908 2 = http://192.168.0.100:8080,/,/
2909 </remotehost_desc>
2910 As you can see all these three entries use URLs to designate the
2912 location of each remote server. This means that each server most
2913 also have been enabled the HTTP built-in server, or have been
2914 installed a CGI capable web server like Apache.
2915 groups
2917 This enables the server grouping for those environments where
2918 there are too much servers to display at the same time. Hence,
2919 you can group them in order to show them separatedly.
2920 Default value: n
2922 remotegroup_list
2924 This is a list of groups of remote servers with Monitorix
2925 already installed and working that you plan to monitor from
2926 here.
2927 An example of this list would be:
2929 remotegroup_list = My Group
2931 remotegroup_desc
2933 This is a numbered list that describes each of the names defined
2934 in the remotegroup_list option.
2935 An example would be:
2937 <remotegroup_desc>
2939 0 = server2, server 3
2940 </remotegroup_desc>
2941 Automatic email reports (emailreports)
2943 This allows to send automatically selected graphs to one or more email
2944 addresses. This could be specially useful for some system administra‐
2945 tors who prefer receiving via email selected graphs instead of browsing
2946 to the remote servers every day.
2947 enabled
2949 This option enables this feature. Note that you still need to
2950 enable the same option for each time interval you want to acti‐
2951 vate: daily, weekly, monthly, yearly.
2952 Default value: n
2954 url_prefix
2956 This is the prefix of the same URL you use to connect to Moni‐
2957 torix. Such URL is needed in order to get the graphs of that
2958 machine.
2959 This option supports sending the credentials in the standard
2961 HTTP "Authorization" header, just like this:
2962 http://username:password@localhost:8080
2964 Default value: http://localhost:8080
2966 smtp_hostname
2968 This is the hostname that will be used as a SMTP relay to
2969 deliver the automatic email reports.
2970 method
2972 This option specifies the method of sending emails. The current
2973 valid options are smtp and relay. By default this option is not
2974 defined which is the same as if smtp option was defined.
2975 Default value:
2977 from_address
2979 This is the address that will be used as remitent for all the
2980 monthly report emails.
2981 Default value: noreply@example.com
2983 hour
2985 This is the hour (in 24h format) when the email reports will be
2986 sent.
2987 Default value: 0
2989 minute
2991 This is the minute when the email reports will be sent.
2992 Default value: 0
2994 daily
2996 weekly
2997 monthly
2998 yearly
2999 The email reports are sent based on the following schedule:
3000 daily reports will be sent every day at 00:00h.
3002 weekly reports will be sent the first Monday of each week.
3003 monthly reports will be sent the first day of each month.
3004 yearly reports will be sent the first day of each year.
3005 enabled
3007 This option enables each report individually.
3008 Default value: n
3010 graphs
3012 This is a comma-separated list of graph names you want to appear
3013 in the email report. The names are the same as their .rrd files.
3014 There is a list of them in the graph_name option in moni‐
3015 torix.conf.
3016 Default value: system, fs
3018 to
3020 This is a comma-separated list of recipient email addresses.
3021 addendum_script
3023 This is the full path name of an external script that will be
3024 executed during the creation of the report, and its output will
3025 be appended to the mail. This is useful for system administra‐
3026 tors that want to add extra system information to the reports.
3027 Default value:
3029 rigid and limit values
3031 rigid
3032 This value defines how the graph must be scaled. Its possible
3033 values are:
3034 0 No rigid, the graph will be scaled automatically. Only the
3036 lower-limit value will be used if it's defined.
3037 1 The graph will be scaled by default according the values in
3038 limit but without rigidness.
3039 2 The graph will be forced to scale using the contents of
3040 limit as its upper-limit and lower-limit values.
3041 limit
3043 This is where you can enter the upper-limit and lower-limit val‐
3044 ues (separated by a colon) for a graph. The lower-limit value is
3045 optional. Some examples would be:
3046 100:0 which means 100 as the upper-limit value and 0 for the
3048 lower-limit value. This is commonly used for percentage values.
3049 1000 which means 1000 as the upper-limit value and leaving
3050 undefined the lower-limit value. This can also be written as
3051 1000:.
3052
3054 Monitorix is written by Jordi Sanfeliu <jordi@fibranet.cat>
3055
3057 Copyright © 2005-2019 Jordi Sanfeliu
3058 Licensed under the GNU General Public License version 2 (GPLv2).
3059
3061 monitorix(8), rrdtool(1)
30623.11.0 Mar 2019 monitorix.conf(5)