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 enable_parallelizing
185 This option will fork an independent process for each graph in
186 order to speed up graph generation in multi-core systems. It's
187 best to keep it disabled on unicore processors.
188 Default value: y
190 include_dir
192 The main configuration file is usually called monitorix.conf and
193 its location is provided as part of the command line arguments.
194 In addition, other configuration files may be loaded placing
195 them in the directory pointed by this option. The names must end
196 with .conf to be included.
197 This option is mainly intended to include third-party modules
199 with their own configuration files without having to modify any
200 file from your Monitorix installation. All modules are located
201 in /usr/lib/monitorix (in some operating systems that path can
202 change).
203 All the configuration files in there will be loaded in alpha‐
205 betic order, so the last file loaded will overwrite any previous
206 option.
207 Default value: /etc/monitorix/conf.d
209 ip_default_table
211 This option will define in which table Monitorix will put all
212 iptables rules for network traffic accounting monitoring. It
213 only works on Linux.
214 Although this is a global option, only the graphs port, nginx
216 and traffacct are affected by it.
217 Default value: filter
219 ipv6_disabled
221 This option enables or disables the use of the ip6tables com‐
222 mand. It only works on Linux.
223 Although this is a global option, only the graph port is cur‐
225 rently affected by it.
226 Default value: n
228 url_prefix_proxy
230 This option forces monitorix.cgi to bypass the URL building.
231 This is specially usefull when Monitorix is used behind a
232 reverse proxy.
233 An example would be: http://myexternalwebsite.com
235 Default value:
237 enable_hourly_view
239 This option enables or disables the ability to select the hourly
240 view in the main page.
241 No .rrd file will change by selecting this option and the his‐
243 torical data won't be affected.
244 Default value: n
246 user_agent_id
248 This option defines the string to be used to identify Monitorix
249 in the HTTP requests. Its value will be sent as the "User-Agent"
250 header.
251 The default value will depend on the current Perl version in
253 your system. An example would be libwww-perl/5.833.
254 enable_back_button
256 This option enables or disables the ability to go back to the
257 main page from the graphs page without using the browser's back
258 button.
259 It will show a back arrow in the upper-left corner and it is
261 specially useful for people using the browser in full-screen
262 mode.
263 Default value: n
265 rrdtool_extra_options
267 This option permits create a comma-separated list of RRDtool
268 options that will be included in all graphs. This is specially
269 useful if you want to take advantage of an specific RRDtool
270 graphics option.
271 An example would be:
273 rrdtool_extra_options = "--grid-dash=1:0, --no-legend"
275 use_external_firewall
277 By default, Monitorix creates a set of iptables rules to collect
278 the amount of network activity that some graphs (port.pm and
279 nginx.pm) need. This might be a problem for people using an
280 external firewall that could eventually remove such iptables
281 rules created by Monitorix. In these cases, you may want to set
282 this option as y to tell Monitorix to not create such iptables
283 rules, but expect that they will be already created by an exter‐
284 nal software.
285 Keep in mind that the rule names created in your firewall must
287 coincide with the names that Monitorix expects to find for each
288 case. Familiarize yourself with the iptables rules created auto‐
289 matically by Monitorix before enabling this option.
290 Default value: n
292 base_dir
294 This is the absolute path to the directory where all the web
295 elements are located:
296 cgi/ directory where resides monitorix.cgi.
298 imgs/ directory for the .png graph images.
299 index.html Monitorix main page.
300 logo_bot.png Monitorix bottom logo.
301 logo_top.png Monitorix top logo.
302 monitorixico.png Monitorix favicon logo.
303 Default value: /var/lib/monitorix/www/
305 (depends on the operating system)
306 base_lib
308 This is the absolute path to the directory where all of the
309 monthly reports, daily traffic usage, and RRD files are located:
310 reports/ monthly reports localization directory.
312 usage/ daily traffic usage data directory.
313 *.rrd RRD files.
314 Default value: /var/lib/monitorix/
316 (depends on the operating system)
317 base_url
319 This is the URL prefix that Monitorix utilizes when refering to
320 its own pages and files.
321 Default value: /monitorix
323 base_cgi
325 This is the URL prefix that Monitorix utilizes when refering to
326 monitorix.cgi.
327 Default value: /monitorix-cgi
329 HTTP built-in server
331 enabled
332 This enables or disables the HTTP server that Monitorix has
333 built-in. This is specially useful for system administrators
334 that don't want to install a web server (Apache, Lighttpd,
335 Nginx, etc.) to see the Monitorix graphs.
336 Default value: y
338 host
340 This option takes an optional host address for this server to
341 bind to. If none is specified (default) it will bind to all
342 interfaces.
343 Default value:
345 port
347 This is the network port from where the HTTP server will listen
348 on.
349 Default value: 8080
351 user/group
353 This sets the user and group that the HTTP server will run as.
354 Default value for user: nobody
356 Default value for group: nobody
357 log_file
359 This is the path to the HTTP server log file.
360 Default value: /var/log/monitorix-httpd
362 hosts_deny
364 This is a comma delimited set of IP addresses which are not per‐
365 mitted to access Monitorix graphs. There is the special keyword
366 called all that can be used to deny all IP addresses.
367 The access control uses the same approach as in the TCP-Wrap‐
369 pers; the search stops at the first match:
370 - Access will be granted when an IP address matches an
372 entry in the hosts_allow list.
373 - Otherwise, access will be denied when an IP address
374 matches an entry in the hosts_deny list.
375 - Otherwise, access will be granted.
376 Default value:
378 hosts_allow
380 This is the opposite of hosts_deny option. IP addresses listed
381 here are permitted to access Monitorix graphs. There is also the
382 special keyword called all that can be used to allow access to
383 all IP addresses.
384 Default value:
386 https_url
388 This will force to use the prefix https:// in all links. This is
389 special useful if you plan to use a reverse-proxy HTTPS server
390 in front of the Monitorix HTTP built-in server.
391 Default value: n
393 autocheck_responsiveness
395 There is a well known problem with the HTTP built-in server that
396 Monitorix implements using the Perl module 'HTTP::Server::Sim‐
397 ple'. It looks like it's pretty weak to the common attacks that
398 any web server receives every day. As a consequence of that, it
399 just hangs, and when you want to see the stats of your server,
400 you just see your browser waiting for a response that never
401 comes, which ends up with a timeout. In these cases, you are
402 forced to login to your server and restart Monitorix, in order
403 to refresh the HTTP built-in server.
404 So in order to mitigate (hopefully) all this annoying hangups,
406 this options acts like an autocheck to control the responsive‐
407 ness of the HTTP server on every minute, and in case of no
408 response then it will be restarted automatically.
409 Default value: y
411 HTTP built-in server with access authentication
413 enabled
414 This enables or disables the authentication mechanism to control
415 access to pages and other resources. The only allowed mechanism
416 is Basic and uses the 401 status code and the WWW-Authenticate
417 response header.
418 It's highly recommended to set this option according your needs
420 before start Monitorix.
421 For more information about the Basic access authentication mech‐
423 anism and its security implications, please refer to
424 http://en.wikipedia.org/wiki/Basic_access_authentication.
425 Default value: n
427 msg
429 This option sets the Realm to be used in the authentication.
430 That message should appear in the client dialog box to help user
431 to identify the secure area.
432 Default value: Monitorix: Restricted access
434 htpasswd
436 This option sets the path to the password file that was created
437 with the help of the htpasswd.pl script. That script encrypts
438 and validates passwords using the system's crypt() routine. If
439 your Monitorix package doesn't come with that script, you may
440 use the similar htpasswd(1) program provided with the Apache web
441 server.
442 The format of the password file consist of one or more lines
444 with a username and password separated by a colon.
445 The following is an example of a password file:
447 paul:oGkEsQK6RYIII
449 peter:HF1r7qRL4Kg6E
450 Since the script uses the crypt() algorithm, only the first 8
452 characters of the password are used to form the password. If the
453 supplied password is longer, the extra characters will be
454 silently discarded.
455 WARNING: don't use the character colon ':' as part of your name
457 or password since this character is used as field separator.
458 Default value: /var/lib/monitorix/htpasswd
460 Log files pathnames
462 log_file
463 This is the path to the Monitorix log file. Please check this
464 file periodically and especially after every update to confirm
465 proper operation.
466 Default value: /var/log/monitorix
468 secure_log
470 This is the path to the system log (also known as auth.log,
471 etc.) Monitorix uses this file to report SSH, POP3, FTP and Tel‐
472 net successful logins.
473 Default value: /var/log/secure
475 mail_log
477 This is the path to the mail log file. Monitorix uses this file
478 to report messages sent (supporting Sendmail and Postfix for‐
479 mats), and the MailScanner log format for spam-mail and virus-
480 mail alerts.
481 Default value: /var/log/maillog
483 milter_gl
485 This is the path to the dump file of milter-greylist.
486 Default value: /var/milter-greylist/greylist.db
488 imap_log
490 This is the path to the IMAP (Dovecot or UW-IMAP) log file. Mon‐
491 itorix uses this file to report IMAP and POP3 successful logins.
492 Default value: /var/log/imap
494 hylafax_log
496 This is the path to the Hylafax log file. Monitorix uses this
497 file to report successful FAX dispatches.
498 Default value: /var/spool/hylafax/etc/xferfaxlog
500 cups_log
502 This is the path to the CUPS page log file. Monitorix uses this
503 file to report on print jobs.
504 Default value: /var/log/cups/page_log
506 ftp_log
508 This is the path to the FTP server (ProFTPD, vsftpd or Pure-
509 FTPd) log. Monitorix uses this file to report FTP successful
510 logins and other FTP-related information.
511 Default value: /var/log/proftpd/access.log
513 fail2ban_log
515 This is the path to the Fail2ban log file. Monitorix uses this
516 file only if the option graph_mode has the value rate.
517 Default value: /var/log/fail2ban.log
519 spamassassin_log
521 This is the path to the Spamassassin log file. Monitorix uses
522 this file to report spam-mail alerts.
523 Default value: /var/log/maillog
525 clamav_log
527 This is the path to the Clamav log file. Monitorix uses this
528 file to report virus-mail alerts.
529 Default value: /var/log/clamav/clamav.log
531 cg_logdir
533 This is the path to the CommuniGate logs directory. Monitorix
534 uses these files to report the number of mail messages success‐
535 fully received and sent, and to report IMAP and POP3 successful
536 logins.
537 Default value: /var/CommuniGate/SystemLogs/
539 squid_log
541 This is the path to the Squid log file. Monitorix uses this file
542 to report on Squid Proxy requests.
543 Default value: /var/log/squid/access.log
545 imap_log_date_format
547 This is the Dovecot date format as it appears in the imap_log
548 file.
549 Default value: %b %d
551 secure_log_date_format
553 This is secure_log date format.
554 Default value: %b %e
556 Piwik tracking code
558 enabled
559 This enables the inclusion of the Piwik tracking code in the
560 main index.html file. Please refer to
561 http://piwik.org/docs/tracking-api/ for more information on how
562 to fill these fields.
563 Default value: n
565 Enable or disable graphs
567 graph_enable
568 This enables or disables the monitoring of each graph. Placing a
569 y on a desired graph and restarting Monitorix will automatically
570 create the RRD file for that graph and start gathering informa‐
571 tion according to its settings.
572 System load average and usage (system.pm)
574 This graph shows information about system load average (classical UNIX
575 triplet), memory allocation, active processes (on Linux brought
576 directly from the /proc directory), entropy and the system uptime.
577 loadavg_enabled
579 This section enables or disables the alert capabilities for this
580 graph. Only the alert for the average CPU load is currently
581 implemented. It works as follows:
582 This alert uses the minimum value between the second and the
584 third load averages (those that represent the last 5 and 15 min‐
585 utes), and if it reaches the loadavg_threshold value for the
586 interval of time defined in loadavg_timeintvl, Monitorix will
587 execute the external alert script defined in loadavg_script.
588 The idea to use min(load5, load15) is to obtain a more symmetric
590 curve and a sooner cancellation of the alert.
591 The default Monitorix installation includes an example of a
593 shell-script alert called monitorix-alert.sh which you can use
594 as a base for your own script.
595 Default value: n
597 loadavg_timeintvl
599 This is the period of time (in seconds) that the threshold needs
600 to be exceeded before the external alert script is executed.
601 Default value: 3600
603 loadavg_threshold
605 This is the value that needs to be reached or exceeded within
606 the specified time period in loadavg_timeintvl to trigger the
607 mechanism for a particular action, which in this case is the
608 execution of an external alert script.
609 The value of this option is compared against the last 15 minutes
611 of CPU load average.
612 Default value: 5.0
614 loadavg_script
616 This is the full path name of the script that will be executed
617 by this alert.
618 It will receive the following three parameters:
620 1st - the value currently defined in loadavg_timeintvl.
622 2nd - the value currently defined in loadavg_threshold.
623 3rd - the current 15min CPU load average.
624 Default value: /path/to/script.sh
626 Global kernel usage (kern.pm)
628 Note that the VFS graph is just informative of how the kernel is bal‐
629 ancing its tables. graph_mode
630 This changes the layout of the kernel usage graph, the possible
631 values are r for a real graph, or s for a stacked graph (every
632 line or area is stacked on top of the previous element).
633 Default value: r
635 list
637 This is the list of values offered in modern Linux kernels.
638 Older Linux kernels or other Operating Systems may not have all
639 of them. Placing a y or an n will enable or disable the value in
640 the graph.
641 Kernel usage per processor (proc.pm)
643 max
644 This is the number of processors or cores that your system has.
645 There is no limit, however keep in mind that every time this
646 number is changed Monitorix will resize the proc.rrd file
647 accordingly, removing all historical data.
648 Default value: 4
650 graphs_per_row
652 This is the number of processor graphs that will be put in a
653 row. Consider the interaction of this parameter with the size
654 and data options (below) in order to adjust the size and number
655 of graphs in relation to your horizontal screen size.
656 Default value: 2
658 size
660 This option sets the size of all processors graphs.
661 The possible values are:
663 main for 450x150 graphs.
664 medium for 325x150 graphs.
665 medium2 for 325x70 graphs.
666 small for 200x66 graphs.
667 mini for 183x66 graphs.
668 tiny for 110x40 graphs.
669 Default value: medium
671 DATA
673 This option will completely enable or disable the legend in the
674 processor graphs.
675 Default value: y
677 HP ProLiant System Health (hptemp.pm)
679 list
680 This list will hold the defined temperature sensors for each
681 graph. You must have installed the command hplog that comes with
682 HP ProLiant System Health Application and Command Line Utili‐
683 ties.
684 Each graph has a limited number of IDs:
686 graph_0 up to 8 IDs.
688 graph_1 up to 6 IDs.
689 graph_2 up to 6 IDs.
690 The following is a configuration example of selected IDs:
692 # hplog -t
694 ID TYPE LOCATION STATUS CURRENT THRESHOLD
695 1 Basic Sensor Ambient Normal 75F/ 24C 107F/ 42C
696 2 Basic Sensor CPU (1) Normal 104F/ 40C 179F/ 82C
697 3 Basic Sensor CPU (2) Normal ---F/---C 179F/ 82C
698 4 Basic Sensor Memory Board Normal ---F/---C 188F/ 87C
699 5 Basic Sensor Memory Board Normal 82F/ 28C 188F/ 87C
700 6 Basic Sensor Memory Board Normal ---F/---C 188F/ 87C
701 7 Basic Sensor System Board Normal 89F/ 32C 192F/ 89C
702 8 Basic Sensor System Board Normal ---F/---C 192F/ 89C
703 9 Basic Sensor System Board Normal 84F/ 29C 192F/ 89C
704 10 Basic Sensor System Board Normal 118F/ 48C 230F/110C
705 11 Basic Sensor System Board Normal 96F/ 36C 192F/ 89C
706 12 Basic Sensor System Board Normal 84F/ 29C 154F/ 68C
707 13 Basic Sensor System Board Normal 87F/ 31C 154F/ 68C
708 14 Basic Sensor System Board Normal 89F/ 32C 156F/ 69C
709 15 Basic Sensor System Board Normal 93F/ 34C 161F/ 72C
710 16 Basic Sensor Ambient Normal ---F/---C 192F/ 89C
711 17 Basic Sensor System Board Normal ---F/---C 192F/ 89C
712 18 Basic Sensor SCSI Backplane Normal 32F/ 0C 140F/ 60C
713 <list>
715 graph_0 = 2, 3
716 graph_1 = 1, 5, 18
717 graph_2 = 7, 9, 10, 11, 12, 13
718 </list>
719 alerts
721 This optional list enables the alert capabilities for this graph
722 and complements with the list option. Each alert has three
723 fields separated by comma: the time interval, the threshold and
724 the path to the script to be executed.
725 The time interval is the period of time (in seconds) that the
727 threshold needs to be exceeded before the external script is
728 executed.
729 The threshold is the temperature that needs to be reached or
731 exceeded within the specified time in time interval to execute
732 the external script.
733 The script is the full path name of the script that will be exe‐
735 cuted by this alert.
736 Each defined sensor has its own alert.
738 The default Monitorix installation includes an example of a
740 shell-script alert called monitorix-alert.sh which you can use
741 as a base for your own script.
742 The following is an example of an alert defined for the first
744 temperature sensor:
745 <alerts>
747 2 = 3600, 40, /path/to/script.sh
748 </alerts>
749 Such alert means that if the value of the sensor number 2
751 reaches or exceeds 40 during at least one hour (3600 seconds)
752 the script in /path/to/script.sh will be executed.
753 The external script will receive the following arguments:
755 1st - the value defined as time interval.
757 2nd - the value defined as threshold.
758 3rd - the value of the sensor.
759 LM-Sensors and GPU temperatures (lmsens.pm)
761 list
762 In this list you may specify the sensors you want to monitor
763 with the same names as they appear in your sensors(1) command.
764 For example, imagine a sensors(1) output like this:
766 # sensors
768 coretemp-isa-0000
769 Adapter: ISA adapter
770 Core 0: +51.0°C (high = +78.0°C, crit = +100.0°C)
771 coretemp-isa-0001
773 Adapter: ISA adapter
774 Core 1: +49.0°C (high = +78.0°C, crit = +100.0°C)
775 f71882fg-isa-0a00
777 Adapter: ISA adapter
778 3.3V: +3.30 V
779 Vcore: +1.21 V (max = +2.04 V)
780 Vdimm: +1.82 V
781 Vchip: +1.38 V
782 +5V: +5.00 V
783 12V: +14.37 V
784 5VSB: +4.33 V
785 3VSB: +3.30 V
786 Battery: +3.22 V
787 CPU: 2035 RPM
788 System: 1765 RPM ALARM
789 Power: 2110 RPM ALARM
790 Aux: 2080 RPM ALARM
791 M/B Temp: +36.00 C
792 CPU Temp: +29.00 C
793 Then you may want to configure that list as:
795 <list>
797 core0 = Core 0
798 core1 = Core 1
799 mb0 = M/B Temp
800 cpu0 = CPU Temp
801 fan0 = CPU
802 fan1 = System
803 fan2 = Power
804 fan3 = Aux
805 volt0 = 3.3V
806 volt1 = VCore
807 volt2 = Vdimm
808 volt3 = Vchip
809 volt4 = \+5V
810 volt5 = 12V
811 volt6 = 5VSB
812 volt7 = 3VSB
813 volt8 = Battery
814 gpu0 = nvidia
815 </list>
816 Note that you need to escape the plus and minus signs in the
818 voltage labels. It also recommended to enclose the values using
819 double quotes.
820 The last one, gpu0, is set here just in case you have a sup‐
822 ported graphics card and want to monitor its temperature. Cur‐
823 rently only NVIDIA and ATI graphic cards are supported; with the
824 values nvidia and ati respectively. It requires the official
825 NVIDIA or ATI drivers.
826 This list has the following maximums allowed:
828 Up to 16 core keys (from core0 to core15).
830 Up to 2 mb keys (mb0 and mb1).
831 Up to 4 cpu keys (from cpu0 to cpu3).
832 Up to 9 fan keys (from fan0 to fan8).
833 Up to 12 volt keys (from volt0 to volt11).
834 Up to 9 gpu keys (from gpu0 to gpu8).
835 desc
837 This list complements the list option. It basically allows you
838 to change the name that will appear in the graph, hiding the
839 real name of the sensor. If no association is defined, then Mon‐
840 itorix will display the name of the key (left side) in the desc
841 option (in uppercase in some graphs).
842 <desc>
844 mb0 = M/B
845 fan0 = CPUFan
846 gpu0 = ATI
847 </desc>
848 Please note that in the default graph all names are limited to 5
850 characters in order to fit up to 9 different values. In the
851 zoomed graphs the limit is 8 characters.
852 alerts
854 This optional list enables the alert capabilities for this graph
855 and complements with the list option. Each alert has three
856 fields separated by comma: the time interval, the threshold and
857 the path to the script to be executed.
858 The time interval is the period of time (in seconds) that the
860 threshold needs to be exceeded before the external script is
861 executed.
862 The threshold is the temperature or volts, or whatever that
864 needs to be reached or exceeded within the specified time in
865 time interval to execute the external script.
866 The script is the full path name of the script that will be exe‐
868 cuted by this alert.
869 Each defined sensor has its own alert.
871 The default Monitorix installation includes an example of a
873 shell-script alert called monitorix-alert.sh which you can use
874 as a base for your own script.
875 The following is an example of an alert defined for the first
877 temperature sensor:
878 <alerts>
880 core0 = 3600, 40, /path/to/script.sh
881 </alerts>
882 Such alert means that if the value of the sensor core0 reaches
884 or exceeds 40 during at least one hour (3600 seconds) the script
885 in /path/to/script.sh will be executed.
886 The external script will receive the following arguments:
888 1st - the value defined as time interval.
890 2nd - the value defined as threshold.
891 3rd - the value of the sensor.
892 Generic sensors statistics (gensens.pm)
894 This graph helps to monitor up to three (so far) different sensors:
895 temperatures, CPU frequencies and battery status which, depending of
896 your machine, they should appear in the /sys directory.
897 list
899 This is a list of an unlimited number of groups to define the
900 sensors to monitor. Each group is numbered starting from 0, and
901 each one can hold up to 9 different entries separated by comma
902 which corresponds to the names of the sensors present in your
903 computer that you want to monitor. This module is capable to
904 identify the type of the group by searching the substrings temp,
905 cpu and bat, so it will put automatically the vertical label in
906 the graph accordingly (Celsius or Fahrenheit, Hz or Charge
907 respectively). Of course, it cannot supports mixed sensors in a
908 same group. For example, if you need to monitor more than 9 tem‐
909 perature sensors just create a new group in list.
910 An example would be:
912 <list>
914 0 = temp0, temp1
915 1 = cpu0, cpu1, cpu2, cpu3
916 2 = bat0
917 </list>
918 title
919 In this option you must associate a title with the group number
920 specified in list. This is the title that will appear as the
921 name of the graph. Following the settings in the example above:
922 <title>
924 0 = Temperatures
925 1 = CPU frequency
926 2 = Battery status
927 </title>
928 desc
929 In this option you must associate the complete pathname of the
930 file from where to get the value of each entry defined in the
931 list option. Following the settings in the example above:
932 <desc>
934 temp0 = /sys/devices/virtual/thermal/ther‐
935 mal_zone0/temp
936 temp1 = /sys/devices/virtual/thermal/ther‐
937 mal_zone1/temp
938 cpu0 = /sys/devices/system/cpu/cpu0/cpufreq/scal‐
939 ing_cur_freq
940 cpu1 = /sys/devices/system/cpu/cpu1/cpufreq/scal‐
941 ing_cur_freq
942 cpu2 = /sys/devices/system/cpu/cpu2/cpufreq/scal‐
943 ing_cur_freq
944 cpu3 = /sys/devices/system/cpu/cpu3/cpufreq/scal‐
945 ing_cur_freq
946 bat0 = /sys/class/power_supply/BAT0/capacity
947 </desc>
948 unit
949 With this option you can define the order of magnitude associ‐
950 ated to a specific value. This is used in both temperatures and
951 CPU frequencies, since this kind of temperature sensors tend to
952 give the value in 1000ths of degrees Celsius. In the case of CPU
953 frequencies the values come in Mhz which means that they need to
954 be converted to Hz by multiplying them by 1000. Since the bat‐
955 tery value represents a percentage, it doesn't need any special
956 calculation. Therefore you can define something like this:
957 <unit>
959 temp0 = 1000
960 temp1 = 1000
961 cpu0 = 0.001
962 cpu1 = 0.001
963 cpu2 = 0.001
964 cpu3 = 0.001
965 bat0 = 1
966 </unit>
967 map
968 With this option you can optionally rename any of the sensor
969 names defined in the list option. Following the above example:
970 <map>
972 temp0 = Temperature Zone 0
973 temp1 = Temperature Zone 1
974 cpu0 = CPU0 frequency
975 cpu1 = CPU1 frequency
976 cpu2 = CPU2 frequency
977 cpu3 = CPU3 frequency
978 bat0 = Battery 0
979 </map>
980 All names are limited to 20 characters.
982 alerts
984 This optional list enables the alert capabilities for this graph
985 and complements with the list option. Each alert has four fields
986 separated by comma: the time interval, the threshold, the path
987 to the script to be executed and when the alert must be trig‐
988 gered. the last field is optional.
989 The time interval is the period of time (in seconds) that the
991 threshold needs to be exceeded before the external script is
992 executed.
993 The threshold is the value (temperature, Hz or battery charge)
995 that needs to be reached or exceeded within the specified time
996 in time interval to execute the external script. It can be spec‐
997 ified as a unique value or as a range of two values separated by
998 a dash.
999 The script is the full path name of the script that will be exe‐
1001 cuted by this alert.
1002 The when value specifies when the alert must be triggered (above
1004 or below) the threshold, being above the default value when it's
1005 not specified. This forth parameter is only relevant when the
1006 threshold value is not a range.
1007 Each defined sensor has its own alert.
1009 The default Monitorix installation includes an example of a
1011 shell-script alert called monitorix-alert.sh which you can use
1012 as a base for your own script.
1013 The following is an example of an alert defined for the first
1015 temperature sensor:
1016 <alerts>
1018 temp0 = 3600, 40, /path/to/script.sh, above
1019 temp1 = 3600, 10, /path/to/script.sh, below
1020 temp2 = 3600, 40-60, /path/to/script.sh
1021 </alerts>
1022 The first alert means that if the value of the sensor temp0
1024 exceeds above 40 during at least one hour (3600 seconds) the
1025 script in /path/to/script.sh will be executed.
1026 The second alert means that if the value of the sensor temp1
1028 exceeds below 10 during at least one hour (3600 seconds) the
1029 script in /path/to/script.sh will be executed.
1030 The third alert means that if the value of the sensor temp2
1032 exceeds either below 40 or above of 60 during at least one hour
1033 (3600 seconds) the script in /path/to/script.sh will be exe‐
1034 cuted.
1035 The external script will receive the following arguments:
1037 1st - the value defined as time interval.
1039 2nd - the value defined as threshold.
1040 3rd - the value of the sensor.
1041 4th - the direction or when that alert was triggered by
1042 (above or below).
1043 IPMI sensor statistics (ipmi.pm)
1045 This graph is able to monitor an unlimited number of IPMI sensors (tem‐
1046 peratures, fans and voltages).
1047 list
1049 This is a comma-separated list that describes the groups of sen‐
1050 sors in desc. Put one description for each group. For every
1051 group specified you need to specify its sensors in the desc
1052 option.
1053 WARNING: Every time the number of entries in this option
1055 changes, Monitorix will resize the ipmi.rrd file accordingly,
1056 removing all historical data.
1057 An example would be:
1059 list = Temperatures, Fans, Voltages
1061 desc
1063 This is a list of sensors per group defined.
1064 <desc>
1066 0 = CPU Temp, System Temp
1067 1 = FAN 1
1068 2 = Vcore, 3.3VCC, 12V, VDIMM, 5VCC, CPU VTT, VBAT, VSB,
1069 AVCC
1070 </desc>
1071 The maximum number of sensors allowed for each group is 9.
1073 units
1075 This is the type of sensor in each group. It's important to not
1076 mix different type of sensors in a same group. This value is
1077 informative only, it's mostly used as a title for the y-axis in
1078 the graphs and should match with the output of the ipmitool com‐
1079 mand.
1080 map
1082 This list complements the desc option. It basically allows you
1083 to change the name that will appear in the graph, hiding the
1084 real name of the sensor. If no association is defined, then Mon‐
1085 itorix will display the name specified in the desc option. Note,
1086 this only works in names that don't include whitespaces.
1087 alerts
1089 This optional list enables the alert capabilities for this graph
1090 and complements with the desc option. Each alert has three
1091 fields separated by comma: the time interval, the threshold and
1092 the path to the script to be executed.
1093 The time interval is the period of time (in seconds) that the
1095 threshold needs to be exceeded before the external script is
1096 executed.
1097 The threshold is the temperature that needs to be reached or
1099 exceeded within the specified time in time interval to execute
1100 the external script.
1101 The script is the full path name of the script that will be exe‐
1103 cuted by this alert.
1104 Each defined sensor has its own alert.
1106 The default Monitorix installation includes an example of a
1108 shell-script alert called monitorix-alert.sh which you can use
1109 as a base for your own script.
1110 The following is an example of an alert defined for the first
1112 temperature sensor:
1113 <alerts>
1115 CPU_Temp = 3600, 40, /path/to/script.sh
1116 </alerts>
1117 Notice that the spaces in the sensor's name must be con‐
1119 verted to underscores, since a variable can hold spaces
1120 in its name.
1121 Such alert means that if the value of the sensor CPU_Temp
1123 reaches or exceeds 40 during at least one hour (3600 seconds)
1124 the script in /path/to/script.sh will be executed.
1125 The external script will receive the following arguments:
1127 1st - the value defined as time interval.
1129 2nd - the value defined as threshold.
1130 3rd - the value of the sensor.
1131 graphs_per_row
1133 This is the number of graphs that will be put in a row.
1134 Default value: 2
1136 extra_args
1138 This option includes any extra argument to the ipmitool command
1139 executed by Monitorix, which is "ipmitool <extra_args> sdr".
1140 This is specially useful if you need to monitor a remote server.
1141 An example would be:
1142 extra_args = -H <remote_ip> -U root -P <password>
1144 Default value: none
1146 Ambient sensor statistics (ambsens.pm)
1148 This graph is able to monitor an unlimited number of ambient sensors
1149 (temperatures, humidity, barometer, etc.).
1150 list
1152 This is a comma-separated list that describes the type of sen‐
1153 sors in desc. Put one description for each type. For every type
1154 specified you need to specify its sensors in the desc option.
1155 Each one most be referenced as a numeric value starting from
1156 zero in the desc option. There you will define all the sensors
1157 than come with that type of sensor.
1158 WARNING: Every time the number of entries in this option
1160 changes, Monitorix will resize the ambsens.rrd file accordingly,
1161 removing all historical data.
1162 An example would be:
1164 list = Ambient temperature, Humidity
1166 desc
1168 This is a list of sensors per type defined. The name is irrele‐
1169 vant.
1170 <desc>
1172 0 = at1, at2, at3
1173 1 = h0
1174 </desc>
1175 The maximum number of sensors allowed for each type is 9.
1177 units
1179 This is the class of sensor for each type. It's important to not
1180 mix different type of sensors in a same group. This value is
1181 informative only, it's mostly used as a title for the y-axis in
1182 the graphs.
1183 cmd
1185 This list complements the desc option. It basically allows you
1186 to associate a script or program that will be executed to
1187 retrieve the value for each sensor.
1188 map
1190 This list complements the desc option. It basically allows you
1191 to change the name that will appear in the graph, hiding the
1192 real name of the sensor. If no association is defined, then Mon‐
1193 itorix will display the name specified in the desc option. Note,
1194 this only works in names that don't include whitespaces.
1195 alerts
1197 This optional list enables the alert capabilities for this graph
1198 and complements with the list option. Each alert has four fields
1199 separated by comma: the time interval, the threshold, the path
1200 to the script to be executed and when the alert must be trig‐
1201 gered. the last field is optional.
1202 The time interval is the period of time (in seconds) that the
1204 threshold needs to be exceeded before the external script is
1205 executed.
1206 The threshold is the value (temperature, etc.) that needs to be
1208 reached or exceeded within the specified time in time interval
1209 to execute the external script. It can be specified as a unique
1210 value or as a range of two values separated by a dash.
1211 The script is the full path name of the script that will be exe‐
1213 cuted by this alert.
1214 The when value specifies when the alert must be triggered (above
1216 or below) the threshold, being above the default value when it's
1217 not specified. This forth parameter is only relevant when the
1218 threshold value is not a range.
1219 Each defined sensor has its own alert.
1221 The default Monitorix installation includes an example of a
1223 shell-script alert called monitorix-alert.sh which you can use
1224 as a base for your own script.
1225 The following is an example of an alert defined for the first
1227 temperature sensor:
1228 <alerts>
1230 temp0 = 3600, 40, /path/to/script.sh, above
1231 temp1 = 3600, 10, /path/to/script.sh, below
1232 temp2 = 3600, 40-60, /path/to/script.sh
1233 </alerts>
1234 The first alert means that if the value of the sensor temp0
1236 exceeds above 40 during at least one hour (3600 seconds) the
1237 script in /path/to/script.sh will be executed.
1238 The second alert means that if the value of the sensor temp1
1240 exceeds below 10 during at least one hour (3600 seconds) the
1241 script in /path/to/script.sh will be executed.
1242 The third alert means that if the value of the sensor temp2
1244 either exceeds below 40 or above of 60 during at least one hour
1245 (3600 seconds) the script in /path/to/script.sh will be exe‐
1246 cuted.
1247 The external script will receive the following arguments:
1249 1st - the value defined as time interval.
1251 2nd - the value defined as threshold.
1252 3rd - the value of the sensor.
1253 4th - the direction or when that alert was triggered by
1254 (above or below).
1255 graphs_per_row
1257 This is the number of graphs that will be put in a row.
1258 Default value: 2
1260 NVIDIA temperatures and usage (nvidia.pm)
1262 This graph requires to have installed the official NVIDIA drivers.
1263 max
1265 This is the number of NVIDIA cards currently plugged in your
1266 system.
1267 The maximum allowed is 9.
1269 Default value: 1
1271 Disk drive temperatures and health (disk.pm)
1273 This graph is able to monitor an unlimited number of disk drives.
1274 list
1276 This is a list of groups of disk drives that you want to moni‐
1277 tor. Each group will become a graph and there may be an unlim‐
1278 ited number of groups. You can define device names or paths to
1279 devices like /dev/disk/by-path/pci-0000:00:11.0-scsi-0:0:0:0.
1280 WARNING: Every time the number of groups in this option changes,
1282 Monitorix will resize the disk.rrd file accordingly, removing
1283 all historical data.
1284 To collect the disk drive temperatures and health the smartmon‐
1286 tools or the hddtemp command are required.
1287 It is recommended that you first check if either smartctl(8) or
1289 hddtemp are able to collect data from the disk drive(s) that you
1290 plan to monitor. You may test this with the following command:
1291 # hddtemp /dev/sdb
1293 /dev/sdb: WDC WD1600AABS-00M1A0: 48°C
1294 If you see good results as above, you can add it to the group 0
1296 like this:
1297 <list>
1299 0 = /dev/sda, /dev/sdb
1300 </list>
1301 The maximum number of disk device names allowed per group is 8.
1303 realloc_enabled
1305 This section enables or disables one of the alert capabilities
1306 for this graph; the alert for the number of reallocated sectors
1307 in disk. It works as follows:
1308 If the number of reallocated sectors in any of the specified
1310 disk device names reaches the realloc_threshold (the interval of
1311 time is not used here), Monitorix will execute the external
1312 alert script defined in realloc_script.
1313 The default Monitorix installation includes an example of a
1315 shell-script alert called monitorix-alert.sh which you can use
1316 as a base for your own script.
1317 Default value: n
1319 realloc_timeintvl
1321 Not used in this alert.
1322 Default value: 0
1324 realloc_threshold
1326 This is the value that needs to be reached or exceeded to trig‐
1327 ger the mechanism for a particular action, which in this case is
1328 the execution of an external alert script.
1329 Default value: 1
1331 realloc_script
1333 This is the full path name of the script that will be executed
1334 by this alert.
1335 It will receive the following three parameters:
1337 1st - the value currently defined in realloc_timeintvl.
1339 2nd - the value currently defined in realloc_threshold.
1340 3rd - the current number of reallocated sectors.
1341 Default value: /path/to/script.sh
1343 pendsect_enabled
1345 This section enables or disables one of the alert capabilities
1346 for this graph; the alert for the number of current pending sec‐
1347 tors (or bad sectors) in disk. It works as follows:
1348 If the number of current pending sectors in any of the specified
1350 disk device names reaches the pendsect_threshold (the interval
1351 of time is not used here), Monitorix will execute the external
1352 alert script defined in pendsect_script.
1353 The default Monitorix installation includes an example of a
1355 shell-script alert called monitorix-alert.sh which you can use
1356 as a base for your own script.
1357 Default value: n
1359 pendsect_timeintvl
1361 Not used in this alert.
1362 Default value: 0
1364 pendsect_threshold
1366 This is the value that needs to be reached or exceeded to trig‐
1367 ger the mechanism for a particular action, which in this case is
1368 the execution of an external alert script.
1369 Default value: 1
1371 pendsect_script
1373 This is the full path name of the script that will be executed
1374 by this alert.
1375 It will receive the following three parameters:
1377 1st - the value currently defined in pendsect_timeintvl.
1379 2nd - the value currently defined in pendsect_threshold.
1380 3rd - the current number of pending sectors.
1381 Default value: /path/to/script.sh
1383 accept_invalid_disk
1385 During the init stage this graph verifies that every defined
1386 device name does exist in the system. If not, then the graph
1387 disables itself.
1388 This option changes this behavior and permits to continue work‐
1390 ing even if the device names defined doesn't exist. Keep in mind
1391 that you will continue seeing error messages in the logfile.
1392 Default value: n
1394 Filesystem usage and I/O activity (fs.pm)
1396 This graph is able to monitor an unlimited number of filesystems.
1397 list
1399 This is a list of groups of mounted filesystems that you want to
1400 monitor. Each group will become a graph and there may be an
1401 unlimited number of groups.
1402 WARNING: Every time the number of groups in this option changes,
1404 Monitorix will resize the fs.rrd file accordingly, removing all
1405 historical data.
1406 Take special care to use the same name as appears in the output
1408 of the df(1) command (the swap device is a special case). An
1409 example would be:
1410 <list>
1412 0 = /, swap, boot, home, /mnt/backup
1413 </list>
1414 The maximum number of filesystems allowed per group is 8.
1416 desc
1418 This list complements the list option. It basically allows you
1419 to change the name that will appear in the graph, hiding the
1420 real name of the mount point. If no association is defined, then
1421 Monitorix will display the name specified in the list option.
1422 <desc>
1424 / = Root FS
1425 /home = My Home
1426 /mnt/backup = Backups
1427 </desc>
1428 You can define as much entries as you want.
1430 devmap
1432 This optional list complements the list option. When Monitorix
1433 is started, and in order to be able to show I/O activity, it
1434 attempts to detect the mapping of devices specified in list, as
1435 defined in the df command output column "Mounted on". In the
1436 event that devices are not detected by Monitorix, the devmap
1437 option shall be used to manually define them, according to the
1438 underlying OS:
1439 Linux (kernel > 2.4)
1441 <devmap> device must match a device listed in the
1442 "/proc/diskstats" file.
1443 Linux (kernel <= 2.4)
1445 <devmap> is not used, but because something is
1446 defined in <devmap>, Monitorix will extract
1447 "disk_io" lines from the "/proc/stat" file.
1448 FreeBSD
1450 <devmap> device recognized by the output of
1451 "iostat -xI <dev>" command.
1452 OpenBSD and NetBSD
1454 <devmap> is not used, but because something is
1455 defined in <devmap>, Monitorix will use the output
1456 of "iostat -DI" command.
1457 Just an example:
1459 <devmap>
1460 /mnt/home = dm-1
1461 /mnt/backup = cciss/c0d2p6
1462 </devmap>
1463 You can define as much entries as you want.
1465 alerts
1467 This optional list enables the alert capabilities for this graph
1468 and complements with the list option. Each alert has three
1469 fields separated by comma: the time interval, the threshold and
1470 the path to the script to be executed.
1471 The time interval is the period of time (in seconds) that the
1473 threshold needs to be exceeded before the external script is
1474 executed.
1475 The threshold is the percentage of disk space used in the file
1477 system that needs to be reached or exceeded within the specified
1478 time in time interval to execute the external script.
1479 The script is the full path name of the script that will be exe‐
1481 cuted by this alert.
1482 Each defined filesystem has its own alert.
1484 The default Monitorix installation includes an example of a
1486 shell-script alert called monitorix-alert.sh which you can use
1487 as a base for your own script.
1488 The following is an example of an alert defined for the root
1490 filesystem:
1491 <alerts>
1493 / = 3600, 98, /path/to/script.sh
1494 </alerts>
1495 Such alert means that if the percentage of disk space used in
1497 the root filesystem reaches or exceeds 98 (more than 98) during
1498 at least one hour (3600 seconds) the script in
1499 /path/to/script.sh will be executed.
1500 The external script will receive the following arguments:
1502 1st - the value defined as time interval.
1504 2nd - the value defined as threshold.
1505 3rd - the filesystem disk usage.
1506 ZFS statistics (zfs.pm)
1508 This graph is able to monitor an unlimited number of pools.
1509 max_pools
1511 This is the maximum number of pools that you can define in list.
1512 There is no limit to the number of pools monitored, but keep in
1513 mind that every time this number changes, Monitorix will resize
1514 the zfs.rrd file accordingly, removing all historical data.
1515 Default value: 5
1517 list
1519 This is a comma-separated list of pool names. The number of pool
1520 names defined here can't be greater than the number defined in
1521 max_pools.
1522 Directory usage statistics (du.pm)
1524 This graph is able to monitor the usage of an unlimited number of
1525 directories.
1526 IMPORTANT NOTE: The du command makes intensive disk I/O access that
1528 might slow down the whole system. Moreover, continued executions of
1529 this command will affect the buffer cache mechanism and this will also
1530 increase the system response time.
1531 list
1533 This is a comma-separated list that describes the groups of
1534 directories in desc. Put one description for each group. For
1535 every group specified you need to specify its directories in the
1536 desc option.
1537 WARNING: Every time the number of entries in this option
1539 changes, Monitorix will resize the du.rrd file accordingly,
1540 removing all historical data.
1541 An example would be:
1543 list = System, Users
1545 desc
1547 This is a list of directories per group defined.
1548 <desc>
1550 0 = /var/spool/mail, /var/spool/mqueue, /etc, /var/ftp,
1551 /tmp
1552 1 = /home/ace, /home/gene, /home/paul, /home/peter
1553 </desc>
1554 The maximum number of directories allowed for each group is 9.
1556 type
1558 This specifies the information that will be presented for each
1559 directory specified in each list. It accepts two possible val‐
1560 ues:
1561 size for the directory size (which is the default
1563 option).
1564 files for the number of files inside the directory.
1565 An example would be:
1567 <type>
1569 0 = size
1570 1 = files
1571 </type>
1572 dirmap
1574 This list complements the desc option. It basically allows you
1575 to change the name that will appear in the graph, hiding the
1576 real name of the directory. If no association is defined, then
1577 Monitorix will display the name specified in the desc option.
1578 graphs_per_row
1580 This is the number of graphs that will be put in a row.
1581 Default value: 2
1583 extra_args
1585 This option includes any extra argument to the du command exe‐
1586 cuted by Monitorix, which is "du -ks". This is specially useful
1587 if you want to skip directories on differents file systems, in
1588 this case just define this option like this:
1589 extra_args = "-x"
1591 IMPORTANT NOTICE: Keep in mind that including certain flags like
1593 '-h' (which gives results in human readable format) could make
1594 Monitorix unable to interpret the results.
1595 Network traffic and usage (net.pm)
1597 max
1598 This is the maximum number of network interfaces that you can
1599 define in list. There is no limit, but keep in mind that every
1600 time this number changes, Monitorix will resize the net.rrd file
1601 accordingly, removing all historical data.
1602 Default value: 10
1604 list
1606 This is a comma-separated list of network interfaces that you
1607 may want to monitor. An example would be:
1608 list = eth0, eth1
1610 desc
1612 This is the option where each network interface specified in
1613 list is described. Each definition consists of three parameters
1614 separated by comma: the description of the interface and the
1615 rigid and limit values.
1616 Put one description for each interface listed. An example would
1618 be:
1619 <desc>
1621 eth0 = FastEthernet LAN, 0, 1000
1622 eth1 = ADSL 10Mbs Internet, 0, 1000
1623 </desc>
1624 gateway
1626 This is where the network interface that acts as the gateway for
1627 this server is defined. This is mainly used if you plan to moni‐
1628 tor network traffic usage of your devices/networks using the
1629 traffacct graph below.
1630 Netstat statistics (netstat.pm)
1632 This graph shows the state of the all IPv4 and IPv6 network connec‐
1633 tions.
1634 Only the command to be used can be set here, besides the limit and
1636 rigid values.
1637 cmd
1639 This is the command that will be used to gather statistics.
1640 There are two possible values:
1641 ss
1643 netstat
1644 Default value: ss
1646 Traffic Control statistics (tc.pm)
1648 This graph is able to monitor an unlimited number of network interfaces
1649 managed by the tc command.
1650 list
1652 This is a comma-separated list of network interfaces that you
1653 may want to monitor. An example would be:
1654 list = eth0, eth1
1656 desc
1658 This is the option where you define the queue disciplines you
1659 want to monitor for each network interface specified in list.
1660 An example would be:
1662 <desc>
1664 eth0 = cbq 1, sfq 10, sfq 20, sfq 30, ingress ffff
1665 eth1 = htb 1, pfifo 20, pfifo 21, pfifo 22
1666 </desc>
1667 The maximum number of qdiscs allowed is 9.
1669 map
1671 This option complements the desc option. It basically allows you
1672 to change the name of the qdiscs that will appear in the graphs.
1673 If no association is defined, then Monitorix will show the name
1674 as specified in the desc option.
1675 Since the qdisc names have the space character in their names,
1677 they can't be used as the key in the association, instead you
1678 must the use their position number (starting by 0) in the desc
1679 option.
1680 An example would be:
1682 <map>
1684 <eth0>
1685 0 = Class Based Queueing
1686 1 = Stochastic Fairness Queueing 10
1687 </eth0>
1688 <eth1>
1689 0 = Hierarchical Token Bucket
1690 </eth1>
1691 </map>
1692 Libvirt statistics (libvirt.pm)
1694 This graph is able to monitor an unlimited number of virtual machines
1695 managed by Libvirt.
1696 cmd
1698 This is the command that will be used to gather statistics from
1699 each virtual machine listed in list.
1700 Default value: virsh
1702 An example would be:
1704 cmd = virsh -r -c qemu:///session
1706 list
1708 This is a list of groups of virtual machines that you want to
1709 monitor. Each group will become a graph and there may be an
1710 unlimited number of groups.
1711 WARNING: Every time the number of groups in this option changes,
1713 Monitorix will resize the libvirt.rrd file accordingly, removing
1714 all historical data.
1715 An example would be:
1717 <list>
1719 0 = centos6, winxp
1720 </list>
1721 The maximum number of virtual machines allowed per group is 8.
1723 desc
1725 This list complements the list option and is mandatory for every
1726 virtual machine listed. You must define the virtual block device
1727 and the MAC address of the virtual network device that you want
1728 to monitor for every virtual machine. Just like this:
1729 <desc>
1731 centos6 = CentOS 6, vda, 52:54:00:45:d0:e7
1732 winxp = MS Windows XP, hda, 52:54:00:97:1c:e5
1733 </desc>
1734 You might also define this list using sections for each virtual
1736 machine, this way you'll be able to define multiple disks and
1737 multiple network interfaces for each virtual machine. Just like
1738 this:
1739 <desc>
1741 <centos6>
1742 desc = "CentOS 6"
1743 disk = vda, vdb, vdc
1744 net = 52:54:00:45:d0:e7, 52:54:00:45:d0:e8
1745 </centos6>
1746 </desc>
1747 To obtain all these values you might want to use the following
1749 commands:
1750 # virsh domblklist centos6
1752 Target Source
1753 ------------------------------------------------
1754 vda /home/jordi/kvm/centos6.img
1755 hdc -
1756 # virsh domiflist centos6
1758 Interface Type Source Model MAC
1759 -------------------------------------------------------
1760 vnet3 network default virtio 52:54:00:45:d0:e7
1761 This option also allows you to change the name that will appear
1763 in the graph, hiding the real name of the virtual machine. If no
1764 association is defined, then Monitorix will display the name
1765 specified in the list option.
1766 Process statistics (process.pm)
1768 This graph is able to monitor an unlimited number of processes. This
1769 graph requires a Linux kernel version 2.6.20 at least to support
1770 process I/O accounting. Some systems with older kernels might also have
1771 been ported it though.
1772 list
1774 This is a list of groups of processes that you want to monitor.
1775 Each group will become a graph and there may be an unlimited
1776 number of groups.
1777 WARNING: Every time the number of groups in this option changes,
1779 Monitorix will resize the process.rrd file accordingly, removing
1780 all historical data.
1781 Monitorix uses the following command to find the processes
1783 listed in this option:
1784 # ps -eo pid,comm,command
1786 Therefore names in the process list can be either exactly to the
1788 process name as it appears in the comm columns, or just a sub‐
1789 string of the process name that appears in the command column.
1790 An example of this option would be:
1792 <list>
1794 0 = httpd, sshd, ntpd, mysqld, proftpd, clamd, imap,
1795 sendmail, named, bash
1796 </list>
1797 The maximum number of processes allowed per group is 10.
1799 desc
1801 This list complements the list option. It basically allows you
1802 to change the name that will appear in the graph, hiding the
1803 real name of the process. If no association is defined, then
1804 Monitorix will display the name specified in the list option.
1805 <desc>
1807 httpd = Apache
1808 imap = Dovecot
1809 named = Bind
1810 </desc>
1811 You can define as much entries as you want.
1813 System services demand (serv.pm)
1815 This graph requires either MailScanner or amavisd-new mail scanners in
1816 order to account spam and virus emails.
1817 mode
1819 This option toggles the way the System Services Demand data is
1820 represented in the graph. There are two possible values:
1821 i for incremental style.
1823 l for load (peaks) style.
1824 Default value: i
1826 Mail statistics (mail.pm)
1828 This graph requires either MailScanner or amavisd-new mail scanners in
1829 order to account spam and virus emails. Spamassassin and Clamav
1830 antivirus are also used for spam and virus email accounting.
1831 mta
1833 This option specifies the MTA that Monitorix will use to collect
1834 mail statistics. The currently supported MTAs are:
1835 Sendmail
1836 Postfix
1837 Exim
1838 NOTE: the pflogsumm utility is required when using the Postfix
1840 MTA.
1841 Default value: sendmail
1843 greylist
1845 This option specifies the Greylisting implementation that Moni‐
1846 torix will use to collect statistical information.
1847 The currently supported Greylisting software is:
1849 milter-greylist
1850 postgrey
1851 In the case of milter-greylist, Monitorix shows the same data
1853 that appears at the end of the file greylist.db.
1854 In the case of Postgrey, Monitorix reads the mail_log file and
1856 searches for a specific type of lines. Lines of type
1857 "action=greylist, reason=new" appear as Greylisted in the graph.
1858 Lines of type "action=greylist, reason=early-retry" appear as
1859 Delayed in the graph. Lines of type "action=pass, reason=triplet
1860 found" appear as Passed in the graph. And finally, lines of type
1861 "action=pass, reason=client whitelist" appear as Whitelisted in
1862 the graph.
1863 Default value: milter-greylist
1865 stats_rate
1867 This option only affects the Mail Statistics and the Greylisting
1868 graphs, and it specifies the rate in which the values are saved
1869 and shown. This option has two possible values:
1870 real
1871 per_second
1872 If it's set to its default value (real), it will show the mes‐
1874 sages as in a 'per minute' rate. Since Monitorix collects data
1875 on every minute, this should be the preferred way to see the
1876 results.
1877 In the other hand, and in order to keep backwards compatibility,
1879 if this option is missing in the configuration file, it will act
1880 as if it was set up as per_second, which means that the number
1881 of messages collected in each minute will be divided by 60.
1882 Default value: real
1884 delvd_enabled
1886 This section enables or disables one of the alert capabilities
1887 for this graph; the alert for the number of delivered messages.
1888 It works as follows:
1889 If the number of delivered messages reaches the delvd_threshold
1891 value for the interval of time defined in delvd_timeintvl, Moni‐
1892 torix will execute the external alert script defined in
1893 delvd_script.
1894 The default Monitorix installation includes an example of a
1896 shell-script alert called monitorix-alert.sh which you can use
1897 as a base for your own script.
1898 Default value: n
1900 delvd_timeintvl
1902 This is the period of time (in seconds) that the threshold needs
1903 to be exceeded before the external alert script is executed.
1904 Default value: 60
1906 delvd_threshold
1908 This is the value that needs to be reached or exceeded within
1909 the specified time period in delvd_timeintvl to trigger the
1910 mechanism for a particular action, which in this case is the
1911 execution of an external alert script.
1912 The value of this option is compared against the number of
1914 delivered messages since the last delvd_timeintvl seconds.
1915 Default value: 100
1917 delvd_script
1919 This is the full path name of the script that will be executed
1920 by this alert.
1921 It will receive the following three parameters:
1923 1st - the value currently defined in delvd_timeintvl.
1925 2nd - the value currently defined in delvd_threshold.
1926 3rd - the number of delivered messages.
1927 Default value: /path/to/script.sh
1929 mqueued_enabled
1931 This section enables or disables one of the alert capabilities
1932 for this graph; the alert for the number of queued messages. It
1933 works as follows:
1934 If the number of queued messages reaches the mqueued_threshold
1936 value for the interval of time defined in mqueued_timeintvl,
1937 Monitorix will execute the external alert script defined in
1938 mqueued_script.
1939 The default Monitorix installation includes an example of a
1941 shell-script alert called monitorix-alert.sh which you can use
1942 as a base for your own script.
1943 Default value: n
1945 mqueued_timeintvl
1947 This is the period of time (in seconds) that the threshold needs
1948 to be exceeded before the external alert script is executed.
1949 Default value: 3600
1951 mqueued_threshold
1953 This is the value that needs to be reached or exceeded within
1954 the specified time period in mqueued_timeintvl to trigger the
1955 mechanism for a particular action, which in this case is the
1956 execution of an external alert script.
1957 The value of this option is compared with the number of messages
1959 in the mail queue.
1960 Default value: 100
1962 mqueued_script
1964 This is the full path name of the script that will be executed
1965 by this alert.
1966 It will receive the following three parameters:
1968 1st - the value currently defined in mqueued_timeintvl.
1970 2nd - the value currently defined in mqueued_threshold.
1971 3rd - the number of messages in the mail queue.
1972 Default value: /path/to/script.sh
1974 Network port traffic (port.pm)
1976 This graph requires the iptables(8) command and optionally the
1977 ip6tables(8) command on Linux systems and the ipfw command on *BSD sys‐
1978 tems.
1979 max
1981 This is the number of network ports that you want to monitor.
1982 There is no limit to the number of ports monitored, but keep in
1983 mind that every time this number changes, Monitorix will resize
1984 the port.rrd file accordingly, removing all historical data.
1985 Default value: 9
1987 rule
1989 This is the rule number that Monitorix will use when using the
1990 ipfw command to manage network port activity on *BSD systems.
1991 Change it if you think it might conflict with any other rule
1992 number.
1993 Default value: 24000
1995 list
1997 You may define here up to max network port numbers. If you need
1998 to monitor the same network port with TCP and UDP protocols, you
1999 can add your own suffix to the port number (e.g: 443t and 443u)
2000 in order to distinguish it from the double definition in the
2001 <desc> block. It also support port ranges (e.g: 49152:65534) to
2002 be able to monitor the traffic of a number of consecutive ports
2003 summarized on a unique graph.
2004 If you see a red color in the background of a network port
2006 graph, it means that there is not a daemon listening on that
2007 port. This can be useful to know if some service gone down unex‐
2008 pectedly. Of course, this is only valid on a single port, not
2009 ranged ports.
2010 desc
2012 This is the option where each network port specified in list is
2013 described. Each port definition consists of six parameters sepa‐
2014 rated by comma:
2015 - an small port description.
2016 - the network protocol (tcp or udp).
2017 - the connection type (in, out or in/out).
2018 - the rigid value.
2019 - the limit value.
2020 - the L optional option which specifies that this port
2021 should be listening and Monitorix will advice it, by
2022 changing the background color of the graph to red, if
2023 finds it down. This option has no effect on ranged ports.
2024 There is also support (Linux only) for IPv6 network ports activ‐
2026 ity by using protocol names as tcp6 or udp6.
2027 An example would be:
2029 list = 25, 25ip6, 80, 53t, 53u, 49152:65534
2030 <desc>
2031 25 = SMTP, tcp, in/out, 0, 1000, L
2032 25ip6 = SMTP, tcp6, in/out, 0, 1000, L
2033 80 = HTTP, tcp, in, 0, 1000, L
2034 53t = DNS, tcp, in, 0, 1000, L
2035 53u = DNS, udp, in, 0, 1000, L
2036 49152:65534 = FTP_PSV, tcp, in, 0, 1000
2037 </desc>
2038 As you can see, you cannot use the same port number twice.
2040 Instead, you must distinguish it with some suffix. Monitorix
2041 will automatically extract all the first numeric digits, and
2042 will use that value as the network port number.
2043 graphs_per_row
2045 This is the number of graphs that will be put in a row. Consider
2046 the interaction of this parameter with the max option in order
2047 to adjust the size and number of graphs in relation to your hor‐
2048 izontal screen size.
2049 Default value: 3
2051 Users using the system (user.pm)
2053 Only the limit and rigid values can be set here.
2054 FTP statistics (ftp.pm)
2056 This graph supports currently ProFTPD, vsftpd and Pure-FTPd log file
2057 formats.
2058 For best results with the ProFTPD server I recommend to add the follow‐
2060 ing line in its configuration file:
2061 ExtendedLog /var/log/proftpd/access.log AUTH,DIRS,READ,WRITE
2063 For best results with the vsftpd server I recommend to setup the option
2065 xferlog_std_format to NO, and the option ftp_log to
2066 /var/log/vsftpd.log.
2067 Pure-FTPd users might want to consider using the system syslog logfile.
2069 server
2071 This option specifies the FTP server. The currently supported
2072 FTP servers are:
2073 ProFTPD
2074 vsftpd
2075 Pure-FTPd
2076 Default value: proftpd
2078 anon_user
2080 This option lists the different names (separated by comma) that
2081 can adopt the Anonymous user in the FTP server defined in
2082 server.
2083 Default value: anonymous, ftp
2085 Apache statistics (apache.pm)
2087 This graph requires that mod_status be loaded and ExtendedStatus option
2088 set to On in order to collect full status information of the Apache web
2089 server.
2090 This graph is able to monitor an unlimited number of local and remote
2092 Apache web servers.
2093 list
2095 This is a comma-separated list of URLs of the monitored Apache
2096 web servers.
2097 WARNING: Every time the number of entries in this option
2099 changes, Monitorix will resize the apache.rrd file accordingly,
2100 removing all historical data.
2101 Default value: http://localhost/server-status?auto
2103 alerts
2105 This optional list enables the alert capabilities for this graph
2106 and complements with the list option. Each alert has three
2107 fields separated by comma: the time interval, the threshold and
2108 the path to the script to be executed.
2109 The time interval is the period of time (in seconds) that the
2111 threshold needs to be exceeded before the external script is
2112 executed.
2113 The threshold is the number of remaining free slots that needs
2115 to be reached or exceeded within the specified time in time
2116 interval to execute the external script.
2117 The script is the full path name of the script that will be exe‐
2119 cuted by this alert.
2120 Each defined Apache has its own alert.
2122 The default Monitorix installation includes an example of a
2124 shell-script alert called monitorix-alert.sh which you can use
2125 as a base for your own script.
2126 The following is an example of an alert defined for the local
2128 Apache:
2129 <alerts>
2131 http://localhost/server-status?auto = 3600, 5,
2132 /path/to/script.sh
2133 </alerts>
2134 Such alert means that if the remaining free slots reaches or
2136 exceeds 5 (less than 5) during at least one hour (3600 seconds)
2137 the script in /path/to/script.sh will be executed.
2138 The external script will receive the following arguments:
2140 1st - the value defined as time interval.
2142 2nd - the value defined as threshold.
2143 3rd - the remaining free slots.
2144 Nginx statistics (nginx.pm)
2146 This graph may require adding some lines in the configuration file
2147 nginx.conf. Please see the README.nginx file to determine the exact
2148 steps needed to configure Nginx to get status information.
2149 This graph requires the iptables(8) command on Linux systems, and the
2151 ipfw command on *BSD systems.
2152 url
2154 This is the URL to be used to collect Nginx stats.
2155 Default value: http://localhost/nginx_status
2157 port
2159 This is the network port the Nginx web server is listening on.
2160 It will be used for traffic (with iptables), and for nginx_sta‐
2161 tus if url is not specified. If port of nginx_status is differ‐
2162 ent from port then specify it in the url
2163 (http://host:port/nginx_status)
2164 Default value: 80
2166 rule
2168 This is the rule number that Monitorix will use when using the
2169 ipfw command to manage Nginx network activity on *BSD systems.
2170 Change it if you think it might conflict with any other rule
2171 number.
2172 Default value: 24100
2174 Lighttpd statistics (lighttpd.pm)
2176 This graph requires that mod_status is loaded in order to collect sta‐
2177 tus information from the Lighttpd web server.
2178 This graph is able to monitor an unlimited number of local and remote
2180 Lighttpd web servers.
2181 list
2183 This is a comma-separated list of URLs of the monitored Lighttpd
2184 web servers.
2185 WARNING: Every time the number of entries of this option
2187 changes, Monitorix will resize the lighttpd.rrd file accord‐
2188 ingly, removing all historical data.
2189 Default value: http://localhost/server-status?auto
2191 MySQL statistics (mysql.pm)
2193 This graph requires that you create a password protected MySQL user
2194 that is NOT granted privileges on any DB.
2195 Example:
2197 mysql> CREATE USER 'user'@'localhost' IDENTIFIED BY 'password';
2199 mysql> FLUSH PRIVILEGES;
2200 where user is the new user name and password is the password that will
2202 be used for that user.
2203 This graph is able to monitor an unlimited number of local and remote
2205 MySQL web servers.
2206 NOTE: It is strongly recommended that you restart the MySQL service in
2208 order to avoid high peaks that could prevent correct display of the
2209 first plotted data.
2210 conn_type
2212 This option toggles the way how Monitorix establishes the con‐
2213 nection with the MySQL server. There are two possible values:
2214 host using the network (hostname and IP address).
2216 socket using a socket file.
2217 Default value: host
2219 list
2221 This is a comma-separated list of hostnames or path to sockets
2222 of MySQL servers.
2223 WARNING: Every time the number of entries of this option change
2225 Monitorix will resize the mysql.rrd file accordingly, removing
2226 all historical data.
2227 Default value: localhost
2229 desc
2231 This is the option where each entry specified in the list is
2232 described. Each definition consists of three parameters sepa‐
2233 rated by comma: the port, the username and the password.
2234 An example using the host type would be:
2236 <desc>
2237 localhost = 3306, user, secret
2238 </desc>
2239 When using the socket type the network port is, of course,
2241 irrelevant but its field is still mandatory. This means that you
2242 must respect the three comma-separated values.
2243 Some of the values shown in the graphs are the result of a cal‐
2245 culation of two values from either SHOW [GLOBAL] STATUS or SHOW
2246 VARIABLES. The following is an explanation of them:
2247 Thread Cache Hit Rate
2249 (1 - (Threads_created / Connections)) * 100
2250 When an application connects to a MySQL database, the database
2251 has to create a thread to manage the connection and the queries
2252 that will be sent in that connection. The database instructs the
2253 kernel to create a new thread, and the kernel allocates
2254 resources and creates the thread, then returns it to the MySQL
2255 service. When the connection is terminated by the application,
2256 MySQL tells the kernel to destroy the thread and free the
2257 resources. This create/destroy mechanism causes considerable
2258 overhead if the MySQL server has many new connections per sec‐
2259 ond.
2260 If MySQL doesn't destroy the thread when the connection is ter‐
2261 minated, but reuses it and assigns it to the next connection
2262 then this will decrease the kernel overhead. This is why a high
2263 Thread Cache Hit Rate improves MySQL performance and decreases
2264 the system's CPU usage.
2265 Setting the parameter thread_cache_size in the my.cnf file
2266 accordingly will help to correctly balance between having a
2267 great thread cache and keeping MySQL memory consumption reason‐
2268 able.
2269 Higher is better.
2270 Query Cache Hit Rate
2272 Qcache_hits / (Qcache_hits + Com_select) * 100
2273 Higher should be considered better.
2274 A query cache size increase is recommended if the query cache
2275 usage is very close to 100% and the query cache hit rate is far
2276 from 100%. But sometimes a size increase will not lead to a bet‐
2277 ter hit rate: this means that the increase was not needed and
2278 that the application do not run enough cacheable SELECT queries.
2279 This value should grow proportionally with the number of exe‐
2280 cuted queries as long as the query cache is performing well.
2281 Please also have a look at the Query cache usage percentage to
2282 know if your query_cache configuration is appropriate.
2283 For more information please refer to http://www.databasejour‐
2285 nal.com/features/mysql/article.php/3808841/Optimizing-the-MySQL-
2286 Query-Cache.htm
2287 Query Cache Usage
2289 (1 - (Qcache_free_memory / query_cache_size)) * 100
2290 This value should be reasonably far from 100%, otherwise con‐
2291 sider incrementing the query_cache_size parameter in my.cnf.
2292 Connections Usage
2294 (Max_used_connections / max_connections) * 100
2295 This value should be reasonably far from 100%, otherwise con‐
2296 sider incrementing the max_connections parameter in my.cnf.
2297 Key Buffer Usage
2299 (Key_blocks_used / (Key_blocks_used + Key_blocks_unused)) * 100
2300 This value should be reasonably far from 100%, otherwise con‐
2301 sider incrementing the key_buffer_size parameter in my.cnf.
2302 InnoDB Buffer Pool Usage
2304 (1 - (Innodb_buffer_pool_pages_free / Innodb_buf‐
2305 fer_pool_pages_total)) * 100
2306 This value should be reasonably far from 100%, otherwise con‐
2307 sider incrementing the innodb_buffer_pool_size parameter in
2308 my.cnf.
2309 Temp. Tables To Disk
2311 (Created_temp_disk_tables / Created_temp_disk_tables + Cre‐
2312 ated_temp_tables)) * 100
2313 During operation, MySQL has to create some temporary tables
2314 (that can be explicit, so created by the web application, or
2315 implicit, so for example MySQL has to create one when he runs
2316 some "SELECT DISTINCT", "UNION" or "VIEW" queries). MySQL will
2317 prefer to save this tmp tables to memory, for a fast access. But
2318 if tmp_table_size gets saturated, he has to write them on the
2319 disk instead, making the access slower.
2320 Note that if you modify the value of tmp_table_size in the MySQL
2321 configuration file, you should also modify the value of
2322 max_heap_table_size as well, since both values should have the
2323 same value because MySQL uses the minimum of both, so raising
2324 one of them is useless.
2325 Therefore this value helps to know how many tmp tables go to the
2326 disk instead than to the memory. Keep in mind that some large
2327 queries, involving TEXT and BLOB columns, are directly written
2328 to the disk instead than to the memory, because they would be
2329 too big. So you probably will want to avoid having a high % of
2330 tmp tables written to the disk, but you will never reach 0% on a
2331 big site, and this is fine.
2332 Lower is better ... but 0% is not reachable and you should not
2333 try to reach it, usually.
2334 MongoDB statistics (mongodb.pm)
2336 This graph is able to monitor an unlimited number of MongoDB servers.
2337 list
2339 This is a comma-separated list of names of MongoDB servers.
2340 WARNING: Every time the number of entries in this option
2342 changes, Monitorix will resize the mongodb.rrd file accordingly,
2343 removing all historical data.
2344 Default value: localhost
2346 max_db
2348 This is the maximum number of databases to be monitored in a
2349 MongoDB server. There is no limitation, just specify here the
2350 number of entries of the db_list option that has the most
2351 entries.
2352 WARNING: Every time the number of entries in this option
2354 changes, Monitorix will resize the mongodb.rrd file accordingly,
2355 removing all historical data.
2356 Default value: 1
2358 desc
2360 This is a list of blocks of names specified in the list option.
2361 <desc>
2363 <localhost>
2364 host = 127.0.0.1
2365 db_list = mydb
2366 </localhost>
2367 </desc>
2368 The maximum number of mountpoints allowed for each URL is 9.
2370 host
2372 This is the hostname or IP address of the MongoDB server speci‐
2373 fied in its block.
2374 Default value: 127.0.0.1
2376 port
2378 This is the port number of the MongoDB server specified in its
2379 block.
2380 Default value:
2382 username
2384 This is the username for authentication of the MongoDB server
2385 specified in its block.
2386 password
2388 This is the password for authentication of the MongoDB server
2389 specified in its block.
2390 db_list
2392 This is a comma-separated list of databases to be monitored of
2393 the MongoDB server specified in its block.
2394 Default value: mydb
2396 Varnish cache statistics (varnish.pm)
2398 This graph monitors a local installation of the Varnish HTTP accelera‐
2399 tor.
2400 Only the limit and rigid values can be set here.
2402 PageSpeed Module statistics (pagespeed.pm)
2404 This graph is able to monitor an unlimited number of PageSpeed instal‐
2405 lations.
2406 list
2408 This is a comma-separated list of URLs of PageSpeed status
2409 pages.
2410 WARNING: Every time the number of entries in this option
2412 changes, Monitorix will resize the pagespeed.rrd file accord‐
2413 ingly, removing all historical data.
2414 Default value: http://modpagespeed.com/mod_pagespeed_statistics
2416 For more information please refer to https://develop‐
2418 ers.google.com/speed/pagespeed/module and http://stackover‐
2419 flow.com/questions/9115595/what-do-the-mod-pagespeed-statistics-mean
2420 Squid Proxy Web Cache (squid.pm)
2422 cmd
2423 This command displays statistics about the Squid HTTP proxy
2424 process and is the main command used to collect all data.
2425 Default value: squidclient -h 127.0.0.1
2427 graph_0
2429 graph_1
2430 These two lists hold the selected Squid result or status codes
2431 to be shown in each graph. Feel free to mix result status and
2432 code status in any of the two options.
2433 For more information about the list of all the result and status
2435 codes, please refer to http://wiki.squid-cache.org/Squid‐
2436 Faq/SquidLogs.
2437 Each graph has a limit number of 9 entries.
2439 NFS server statistics (nfss.pm)
2441 version
2442 This option specifies which NFS server version is running in the
2443 system in order to correctly gather the correct values.
2444 The possible values are:
2446 2 for NFS v2.
2447 3 for NFS v3.
2448 4 for NFS v4.
2449 Default value: 3
2451 graph_0
2453 graph_1
2454 graph_2
2455 These three lists hold the defined NFS server activity statis‐
2456 tics to be shown in each graph. Put every statistic name exactly
2457 as they appear in the output of the nfsstat(8) command.
2458 Each graph has a limit number of 10 entries.
2460 NFS client statistics (nfsc.pm)
2462 version
2463 This option specifies which NFS server version is running in the
2464 system in order to correctly gather the correct values.
2465 The possible values are:
2467 2 for NFS v2.
2468 3 for NFS v3.
2469 4 for NFS v4.
2470 Default value: 3
2472 graph_1
2474 graph_2
2475 graph_3
2476 graph_4
2477 graph_5
2478 These five lists hold the defined NFS client activity statistics
2479 to be shown in each graph. Put every statistic name exactly as
2480 they appear in the output of the nfsstat(8) command.
2481 Each graph has the following limit number of entries:
2483 graph_1 up to 10 entries.
2485 graph_2 up to 10 entries.
2486 graph_3 up to 4 entries.
2487 graph_4 up to 4 entries.
2488 graph_5 up to 4 entries.
2489 BIND statistics (bind.pm)
2491 This graph requires a BIND server with version 9.5 or higher, and in
2492 order to see all statistics provided by BIND you must configure the
2493 statistics-channels option like this:
2494 statistics-channels {
2496 inet 127.0.0.1 port 8053;
2497 };
2498 This graph is able to monitor an unlimited number of BIND servers.
2500 list
2502 This is a comma-separated list of URLs of BIND servers status
2503 pages.
2504 WARNING: Every time the number of entries in this option
2506 changes, Monitorix will resize the bind.rrd file accordingly,
2507 removing all historical data.
2508 Default value: http://localhost:8053/
2510 in_queries_list
2512 This is a comma-separated list of RR (Resource Records) types
2513 for each BIND server specified in list option. The RR types
2514 defined here will appear in the Incoming Queries graph which
2515 shows the number of incoming queries for each RR type.
2516 For a complete list of RR types check the BIND 9 Administrator
2518 Reference Manual at
2519 <http://ftp.isc.org/www/bind/arm95/Bv9ARM.html>.
2520 <in_queries_list>
2522 http://localhost:8053/ = A, AAAA, ANY, DS, MX, NS, PTR,
2523 SOA, SRV, TXT, NAPTR, A6, CNAME, SPF, KEY, DNSKEY, HINFO, WKS,
2524 PX, NSAP
2525 </in_queries_list>
2526 The maximum number of RR types allowed for this graph is 20.
2528 out_queries_list
2530 This is a comma-separated list of RR (Resource Records) types
2531 for each BIND server. The RR types defined here will appear in
2532 the Outgoing Queries graph (_default view) which shows the num‐
2533 ber of outgoing queries sent by the DNS server resolver for each
2534 RR type.
2535 <out_queries_list>
2537 http://localhost:8053/ = A, AAAA, ANY, DS, MX, NS, PTR,
2538 SOA, SRV, TXT, NAPTR, A6, CNAME, SPF, KEY, DNSKEY, HINFO, WKS,
2539 PX, NSAP
2540 </out_queries_list>
2541 The maximum number of RR types allowed for this graph is 20.
2543 server_stats_list
2545 This is a comma-separated list of counters about incoming
2546 request processing. The counters defined here will appear in the
2547 Server Statistics graph.
2548 <server_stats_list>
2550 http://localhost:8053/ = Requestv4, Requestv6, ReqEdns0,
2551 ReqBadEDNSVer, ReqTSIG, ReqSIG0, ReqBadSIG, ReqTCP, Response,
2552 QrySuccess, QryAuthAns, QryNoauthAns, QryReferral, QryNxrrset,
2553 QrySERVFAIL, QryNXDOMAIN, QryRecursion, QryDuplicate, Qry‐
2554 Dropped, QryFailure
2555 </server_stats_list>
2556 The maximum number of counters allowed for this graph is 20.
2558 resolver_stats_list
2560 This is a comma-separated list of counters about name resolution
2561 performed in the internal resolver. The counters defined here
2562 will appear in the Resolver Statistics graph (_default view).
2563 <resolver_stats_list>
2565 http://localhost:8053/ = Queryv4, Queryv6, Responsev4,
2566 Responsev6, NXDOMAIN, SERVFAIL, FORMERR, OtherError, EDNS0Fail,
2567 Truncated, Lame, Retry, QueryTimeout, GlueFetchv4, GlueFetchv6,
2568 GlueFetchv4Fail, GlueFetchv6Fail, ValAttempt, ValOk, ValNegOk
2569 </resolver_stats_list>
2570 The maximum number of counters allowed for this graph is 20.
2572 cache_rrsets_list
2574 This is a comma-separated list of RR (Resource Records) types
2575 for each BIND server. The RR types defined here will appear in
2576 the Cache DB RRsets graph (_default view) which shows the number
2577 of RRsets per RR type (positive or negative) and nonexistent
2578 names stored in the cache database.
2579 <cache_rrsets_list>
2581 http://localhost:8053/ = A, !A, AAAA, !AAAA, DLV, !DLV, DS,
2582 !DS, MX, NS, CNAME, !CNAME, SOA, !SOA, !ANY, PTR, RRSIG, NSEC,
2583 DNSKEY, NXDOMAIN
2584 </cache_rrsets_list>
2585 The maximum number of RR types allowed for this graph is 20.
2587 Unbound statistics (unbound.pm)
2589 This graph monitors a local installation of an Unbound name server. It
2590 requires you to configure the options extended-statistics as yes and
2591 statistics-cumulative as no.
2592 queries_type
2594 This is a comma-separated list of query types. The types defined
2595 here will appear in the Queries by type graph.
2596 Default value: queries_type = A, AAAA, ANY, DS, MX, NS, PTR,
2598 SOA, SRV, TXT, NAPTR, A6, CNAME, SPF, KEY, DNSKEY, HINFO, WKS,
2599 PX, NSAP
2600 The maximum number of types allowed for this graph is 20.
2602 NTP statistics (ntp.pm)
2604 This graph is able to monitor an unlimited number of NTP servers.
2605 list
2607 This is a comma-separated list of NTP servers.
2608 WARNING: Every time the number of entries in this option
2610 changes, Monitorix will resize the ntp.rrd file accordingly,
2611 removing all historical data.
2612 Default value: localhost
2614 desc
2616 This is a list of groups of Reference Identifier and Kiss-
2617 o'-Death Codes for every hostname specified in the list option.
2618 For more information on these NTP codes:
2620 <http://www.iana.org/assignments/ntp-parameters/ntp-parame‐
2621 ters.xml>
2622 <http://www.iana.org/go/rfc5905>
2623 <desc>
2625 localhost = AUTH, AUTO, CRYP, DENY, GPS, INIT, NKEY, RATE,
2626 RMOT, RSTR
2627 </desc>
2628 The maximum number of codes allowed for each hostname is 10.
2630 extra_args
2632 This option includes any extra argument to the NTP command exe‐
2633 cuted by Monitorix, which is "ntpq -pn". This is specially use‐
2634 ful if you want to force using IPv4, in this case just define
2635 this option like this:
2636 extra_args = "-4"
2638 Monitorix will add this extra argument to the NTP command which
2640 will become as "ntpq -pn -4".
2641 Chrony statistics (chrony.pm)
2643 This graph is able to monitor an unlimited number of Chrony daemons.
2644 list
2646 This is a comma-separated list of hostnames with the network
2647 port running chronyd. The format is <hostname>:<port> being the
2648 port number optional.
2649 WARNING: Every time the number of entries in this option
2651 changes, Monitorix will resize the chrony.rrd file accordingly,
2652 removing all historical data.
2653 Default value: localhost
2655 Fail2ban statistics (fail2ban.pm)
2657 This graph is able to monitor an unlimited number of Fail2ban jails.
2658 list
2660 This is a comma-separated list that describes the groups of
2661 jails in desc. Put one description for each group. For every
2662 group specified you need to specify its description in the desc
2663 option.
2664 WARNING: Every time the number of entries in this option
2666 changes, Monitorix will resize the fail2ban.rrd file accord‐
2667 ingly, removing all historical data.
2668 An example would be:
2670 list = Security, Overload / Abuse
2672 desc
2674 This is a list of jails per group defined in your Fail2ban con‐
2675 figuration.
2676 <desc>
2678 0 = [apache], [apache-mod-security], [apache-overflows],
2679 [courierauth], [ssh], [pam-generic], [php-url-fopen], [vsftpd]
2680 1 = [apache-imdbphp], [apache-evasive], [apache-badbots],
2681 [apache-robots-txt], [communigate], [named-refused-udp], [named-
2682 refused-tcp], [trac-ticketspam]
2683 </desc>
2684 The maximum number of jails allowed for each group is 9.
2686 graphs_per_row
2688 This is the number of fail2ban graphs that will be put in a row.
2689 Default value: 2
2691 graph_mode
2693 This option changes how the values are represented in the graph.
2694 It has two possible values: absolute which is the default, and
2695 rate. The former takes the values directly from the command
2696 fail2ban-client status <JAIL> and so the values in the graph
2697 will appear as absolute. The later option shows the values in a
2698 rating format per minute.
2699 Default value: absolute
2701 Icecast Streaming Media Server (icecast.pm)
2703 This graph is able to monitor an unlimited number of Icecast servers.
2704 list
2706 This is a list of URLs of Icecast server status pages.
2707 WARNING: Every time the number of entries in this option
2709 changes, Monitorix will resize the icecast.rrd file accordingly,
2710 removing all historical data.
2711 Default value: http://localhost:8000/status.xsl
2713 desc
2715 This is a comma-separated list of Mount Points configured for
2716 every URL specified in the list option. IMPORTANT: the Mount
2717 Points must be specified in the same order that appears in the
2718 Icecast Server Status page.
2719 <desc>
2721 http://localhost:8000/status.xsl = stream1, stream2,
2722 stream3
2723 </desc>
2724 The maximum number of mountpoints allowed for each URL is 9.
2726 graph_mode
2728 This changes the layout of the listeners graph, the possible
2729 values are r for a real graph, or s for a stacked graph (every
2730 line or area is stacked on top of the previous element).
2731 Default value: r
2733 Raspberry Pi sensor statistics (raspberrypi.pm)
2735 For more information please refer to
2736 http://elinux.org/RPI_vcgencmd_usage.
2737 cmd
2739 This is where the vcgencmd command is installed.
2740 Default value: /opt/vc/bin/vcgencmd
2742 clocks
2744 This is a comma-separated list of clock types that will be rep‐
2745 resented in the first graph.
2746 An example would be:
2748 clocks = arm, core, h264, isp, v3d, uart, emmc, pixel, hdmi
2750 The maximum number of clocks allowed is 9.
2752 volts
2754 This is a comma-separated list of voltage types that will be
2755 represented in the third graph.
2756 An example would be:
2758 volts = core, sdram_c, sdram_i, sdram_p
2760 The maximum number of clocks allowed is 6.
2762 Alternative PHP Cache statistics (phpapc.pm)
2764 This graph is able to monitor an unlimited number of PHP-APC installa‐
2765 tions.
2766 list
2768 This is a comma-separated list of URLs of PHP-APC status pages.
2769 WARNING: Every time the number of entries in this option
2771 changes, Monitorix will resize the phpapc.rrd file accordingly,
2772 removing all historical data.
2773 Default value: http://localhost/apc.php?auto
2775 Memcached statistics (memcached.pm)
2777 This graph is able to monitor an unlimited number of Memcached instal‐
2778 lations.
2779 list
2781 This is a comma-separated list of hostnames with network port
2782 running Memcached.
2783 WARNING: Every time the number of entries in this option
2785 changes, Monitorix will resize the memcached.rrd file accord‐
2786 ingly, removing all historical data.
2787 Default value: localhost:11211
2789 PHP-FPM statistics (phpfpm.pm)
2791 This graph is able to monitor an unlimited number of PHP-FPM pools.
2792 group
2794 This is a list of names (separated by comma) of the groups of
2795 pools that you want to monitor. The pools included in each group
2796 will be defined in the list option. You can define unlimited
2797 number of groups.
2798 WARNING: Every time the number of groups changes, Monitorix will
2800 resize the phpfpm.rrd file accordingly, removing all historical
2801 data.
2802 An example of this option would be:
2804 <group>
2806 0 = First group of domains
2807 1 = Second group of domains
2808 </group>
2809 list
2811 This is a list of pool names that you want to monitor for each
2812 group defined in group.
2813 An example of this option would be:
2815 <list>
2817 0 = example1, example2, example3
2818 1 = example10, example11
2819 </list>
2820 The maximum number of pools allowed per group is 8.
2822 desc
2824 This list complements the list option, it defines where and how
2825 Monitorix must gather the statistics for each pool defined.
2826 An example of this option would be:
2828 <desc>
2830 example1 = http://www.example1.com/php_fpm_status
2831 example2 = http://www.example2.com/php_fpm_status
2832 example3 = http://www.example3.com/php_fpm_status
2833 example10 = http://www.example10.com/php_fpm_status
2834 example11 = http://www.example11.com/php_fpm_status
2835 </desc>
2836 map
2838 This list also complements the list option. It basically allows
2839 you to change the name that will appear in the graph, hiding the
2840 real name of the pool. If no association is defined, then Moni‐
2841 torix will display the name specified in the list option.
2842 An example of this option would be:
2844 <map>
2846 example1 = DOMAIN4
2847 example12 = DOMAIN55
2848 </map>
2849 APC UPS statistics (apcupsd.pm)
2851 This graph is able to monitor an unlimited number of APC UPS (apcupsd)
2852 installations.
2853 cmd
2855 This is the command that will be used (with the values in list)
2856 to get the statistics.
2857 Default value: apcaccess
2859 list
2861 This is a comma-separated list of hostnames with the network
2862 port running apcupsd.
2863 WARNING: Every time the number of entries in this option
2865 changes, Monitorix will resize the apcupsd.rrd file accordingly,
2866 removing all historical data.
2867 Default value: localhost:3551
2869 Network UPS Tools statistics (nut.pm)
2871 This graph is able to monitor an unlimited number of Network UPS Tools
2872 (upsc) installations.
2873 list
2875 This is a comma-separated list of UPS names with optionally the
2876 hostname and the network port where it's running upsd. The for‐
2877 mat of each entry must be:
2878 upsname[@hostname[:port]]
2880 WARNING: Every time the number of entries in this option
2882 changes, Monitorix will resize the nut.rrd file accordingly,
2883 removing all historical data.
2884 Default value: ups@localhost
2886 Wowza Media Server (wowza.pm)
2888 This graph is able to monitor an unlimited number of Wowza servers.
2889 list
2891 This is a comma-separated list of URLs of Wowza server status
2892 pages. Each URL can include the Basic Authentication in the form
2893 of http://username:password@localhost:8086/connectioncounts.
2894 WARNING: Every time the number of entries in this option
2896 changes, Monitorix will resize the wowza.rrd file accordingly,
2897 removing all historical data.
2898 Default value: http://localhost:8086/connectioncounts
2900 desc
2902 This is a comma-separated list of applications configured for
2903 every URL specified in the list option.
2904 <desc>
2906 http://localhost:8086/connectioncounts = channel1, chan‐
2907 nel2, channel3
2908 </desc>
2909 The maximum number of applications allowed for each URL is 8.
2911 Devices interrupt activity (int.pm)
2913 Only the limit and rigid values can be set here.
2914 Verlihub statistics (verlihub.pm)
2916 This graph monitors the Verlihub software for DC++ network.
2917 Monitoring the Internet traffic of your LAN (traffacct.pm)
2919 If your server acts as the gateway for a group of PCs, devices or even
2920 whole networks in your local LAN, you may want to know how much Inter‐
2921 net traffic each one is generating.
2922 This graph requires the iptables(8) command on GNU/Linux systems, and
2924 the ipfw command on *BSD systems.
2925 The following are the options you will need to configure to accomplish
2927 all of this.
2928 enabled
2930 This option enables this feature.
2931 Default value: n
2933 max
2935 This is the number of LAN devices you want to monitor. There is
2936 no limit, but keep in mind that every time this number changes,
2937 Monitorix will resize the traffacct.rrd file, removing all his‐
2938 torical data.
2939 Default value: 10
2941 graphs_per_row
2943 If your horizontal screen resolution is pretty wide, you may
2944 want to increase the number of graphs that appear on each row.
2945 Default value: 2
2947 list
2949 This is a comma-separated list of names of PCs, LAN devices or
2950 whole networks that you want to monitor. The only requirement is
2951 that all they must utilize this server as their gateway.
2952 If the names in this list are able to be resolved by a DNS query
2954 then you don't need to define the desc list (below) with corre‐
2955 sponding IP addresses, unless you want monthly reports.
2956 An example would be:
2958 list = pc8, printer, scanner, lan3
2960 desc
2962 This is the list of IP addresses with network masks and email
2963 addresses corresponding to the entries defined in the list. This
2964 option is only used when the those entries are not resolvable
2965 through a DNS query.
2966 An example would be:
2968 <desc>
2970 0 = 192.168.1.101/32, ace@example.com
2971 1 = 192.168.1.102/32, gene@example.com
2972 2 = 192.168.1.103/32, paul@example.com
2973 3 = 192.168.1.104/32, peter@example.com
2974 </desc
2975 Monthly reports of Internet traffic (traffacct.pm)
2977 enabled
2978 If this option is set to y, Monitorix will send a report of all
2979 the monthly Internet activity of the defined devices in list to
2980 the specified email address on the first day of each month.
2981 Default value: n
2983 language
2985 Define here the language used in the monthly report.
2986 The current possible values are: ca, de, en, it, nl_NL, pl and
2988 zh_CN.
2989 Default value: en
2991 default_mail
2993 This is the default email address used to send the monthly
2994 reports. This option is only used if the second parameter in
2995 desc list is empty.
2996 Default value: root@localhost
2998 url_prefix
3000 This is the prefix of the same URL you use to connect to Moni‐
3001 torix. This is needed in order to get the graphs of the same
3002 machine.
3003 Default value: http://localhost:8080
3005 smtp_hostname
3007 This is the hostname that will be used as a SMTP relay to
3008 deliver the monthly report emails.
3009 Default value: localhost
3011 from_address
3013 This is the address that will be used as remitent for all the
3014 monthly report emails.
3015 Default value: noreply@example.com
3017 Monitoring remote servers (Multihost)
3019 The Multihost feature allows you to monitor an unlimitted number of
3020 remote servers that already have Monitorix installed. Make sure that
3021 all servers (local and remote) have the same version of Monitorix, oth‐
3022 erwise there would be some incompatibilities that would prevent showing
3023 correctly the graphs.
3024 enabled
3026 This option enables the Multihost feature.
3027 Default value: n
3029 footer_url
3031 If set to y Monitorix will show the original URL of each server
3032 at the bottom of the graph. Where security is important you may
3033 want to hide this information.
3034 Default value: y
3036 graphs_per_row
3038 If your horizontal screen resolution is pretty wide, you may
3039 want to increase the number of graphs that appear on each row.
3040 Default value: 2
3042 default_option_when_all
3044 If the user has defined a considerable amount of remote servers
3045 and it selects the option "All" in the Hostname list and "All
3046 graphs" in the Graph list, the browser may hang for a while due
3047 to the huge amount of images to download remotely from different
3048 servers.
3049 This option prevents precisely that this happens accidentally by
3051 setting a default value in the Graph list. Of course, the user
3052 is able to change it to "All graphs" at any moment.
3053 The value of this option may be any of the ones that appear in
3055 the <graphs> section (near the end) of the monitorix.conf file.
3056 Default value: "System load"
3058 remotehost_list
3060 This is a comma-separated list with descriptive names of remote
3061 servers with Monitorix already installed and working that you
3062 plan to monitor from here.
3063 An example of this list would be:
3065 remotehost_list = server 1, server 2, server 3
3067 remotehost_desc
3069 This is a numbered list that describes each of the names defined
3070 in the remotehost_list option and the remote values of base_url
3071 and base_cgi options.
3072 An example would be:
3074 <remotehost_desc>
3076 0 = http://www.example.com,/monitorix,/monitorix-cgi
3077 1 = http://10.0.0.1,/monitorix,/monitorix-cgi
3078 2 = http://192.168.0.100:8080,/,/
3079 </remotehost_desc>
3080 As you can see all these three entries use URLs to designate the
3082 location of each remote server. This means that each server most
3083 also have been enabled the HTTP built-in server, or have been
3084 installed a CGI capable web server like Apache.
3085 groups
3087 This enables the server grouping for those environments where
3088 there are too much servers to display at the same time. Hence,
3089 you can group them in order to show them separatedly.
3090 Default value: n
3092 remotegroup_list
3094 This is a list of groups of remote servers with Monitorix
3095 already installed and working that you plan to monitor from
3096 here.
3097 An example of this list would be:
3099 remotegroup_list = My Group
3101 remotegroup_desc
3103 This is a numbered list that describes each of the names defined
3104 in the remotegroup_list option.
3105 An example would be:
3107 <remotegroup_desc>
3109 0 = server2, server 3
3110 </remotegroup_desc>
3111 Automatic email reports (emailreports)
3113 This allows to send automatically selected graphs to one or more email
3114 addresses. This could be specially useful for some system administra‐
3115 tors who prefer receiving via email selected graphs instead of browsing
3116 to the remote servers every day.
3117 enabled
3119 This option enables this feature. Note that you still need to
3120 enable the same option for each time interval you want to acti‐
3121 vate: daily, weekly, monthly, yearly.
3122 Default value: n
3124 url_prefix
3126 This is the prefix of the same URL you use to connect to Moni‐
3127 torix. Such URL is needed in order to get the graphs of that
3128 machine.
3129 This option supports sending the credentials in the standard
3131 HTTP "Authorization" header, just like this:
3132 http://username:password@localhost:8080
3134 Default value: http://localhost:8080
3136 smtp_hostname
3138 This is the hostname that will be used as a SMTP relay to
3139 deliver the automatic email reports.
3140 method
3142 This option specifies the method of sending emails. The current
3143 valid options are smtp and relay. By default this option is not
3144 defined which is the same as if smtp option was defined.
3145 Default value:
3147 from_address
3149 This is the address that will be used as remitent for all the
3150 monthly report emails.
3151 Default value: noreply@example.com
3153 subject_prefix
3155 This is a string that will be prefixed in the Subject of all
3156 emails that will be sent.
3157 Default value: Monitorix:
3159 hour
3161 This is the hour (in 24h format) when the email reports will be
3162 sent.
3163 Default value: 0
3165 minute
3167 This is the minute when the email reports will be sent.
3168 Default value: 0
3170 daily
3172 weekly
3173 monthly
3174 yearly
3175 The email reports are sent based on the following schedule:
3176 daily reports will be sent every day at 00:00h.
3178 weekly reports will be sent the first Monday of each week.
3179 monthly reports will be sent the first day of each month.
3180 yearly reports will be sent the first day of each year.
3181 enabled
3183 This option enables each report individually.
3184 Default value: n
3186 graphs
3188 This is a comma-separated list of graph names you want to appear
3189 in the email report. The names are the same as their .rrd files.
3190 There is a list of them in the graph_name option in moni‐
3191 torix.conf.
3192 Default value: system, fs
3194 to
3196 This is a comma-separated list of recipient email addresses.
3197 addendum_script
3199 This is the full path name of an external script that will be
3200 executed during the creation of the report, and its output will
3201 be appended to the mail. This is useful for system administra‐
3202 tors that want to add extra system information to the reports.
3203 Default value:
3205 rigid and limit values
3207 rigid
3208 This value defines how the graph must be scaled. Its possible
3209 values are:
3210 0 No rigid, the graph will be scaled automatically. Only the
3212 lower-limit value will be used if it's defined.
3213 1 The graph will be scaled by default according the values in
3214 limit but without rigidness.
3215 2 The graph will be forced to scale using the contents of
3216 limit as its upper-limit and lower-limit values.
3217 limit
3219 This is where you can enter the upper-limit and lower-limit val‐
3220 ues (separated by a colon) for a graph. The lower-limit value is
3221 optional. Some examples would be:
3222 100:0 which means 100 as the upper-limit value and 0 for the
3224 lower-limit value. This is commonly used for percentage values.
3225 1000 which means 1000 as the upper-limit value and leaving
3226 undefined the lower-limit value. This can also be written as
3227 1000:.
3228
3230 Monitorix is written by Jordi Sanfeliu <jordi@fibranet.cat>
3231
3233 Copyright © 2005-2020 Jordi Sanfeliu
3234 Licensed under the GNU General Public License version 2 (GPLv2).
3235
3237 monitorix(8), rrdtool(1)
32383.12.0 Feb 2020 monitorix.conf(5)