1monitorix(8) Monitorix collector daemon monitorix(8)
2
6 monitorix - a lightweight system monitoring tool
7
9 monitorix -c configfile [-p pidfile] [-d none | graph[,graph] | all]
10 [-v] [-n] [-u] [-s splitpolicy] [-e report=<time‐
11 frame>,graphs=<graph>[+graph][+graph...],to=<email>]
12
14 This Perl daemon starts the main Monitorix process, which gathers sta‐
15 tistics about the system it is running on and stores this information
16 in a set of RRD files.
17
19 -c configfile
20 The default location of the main configuration file varies de‐
21 pending on the operating system:
22 Linux: /etc/monitorix/monitorix.conf
24 FreeBSD: /usr/local/etc/monitorix.conf
25 Extra configuration files can be placed in /etc/moni‐
27 torix/conf.d, they will be loaded right after the main configu‐
28 ration file (overriding previous options).
29 -p pidfile
31 Stores the daemon's process ID into the specified file.
32 -d none | graph[,graph] | all
34 Logs more information about what monitorix is doing internally.
35 The keys reflect if the data collected must be displayed on each
36 case. If all is defined, the data collected of all enabled
37 graphs will be shown. If none is defined no data collected will
38 be shown. Finally it is also possible to define a comma-sepa‐
39 rated list of graph names from which show their data collected.
40 For a reference of all graph names check the option graph_name
41 in the monitorix.conf configuration file.
42 -v Displays version information.
44 -n This argument will prevent Monitorix from daemonizing, and
46 hence, forcing it to run in foreground. This is specially useful
47 for debugging purposes.
48 -u This option will force Monitorix to run under the regular user
50 who started it. It's necessary to make sure that this user will
51 have write permissions to the directory and files pointed by the
52 options base_dir, base_lib and log_file (either for monitorix
53 and for the HTTP built-in server). Also, you must know that some
54 graphs might not work because only the 'root' user is capable to
55 get such statistics. Check the log files after starting Moni‐
56 torix in this mode.
57 -s splitpolicy
59 This option decides which part of a line in the config file will
60 be the key and which one will be the value. The split policy ac‐
61 cepts the values guess (which is the default), whitespace (which
62 causes the Monitorix to split by whitespace) and equalsign
63 (which causes it to split strictly by equal sign).
64 -e report=timeframe,graphs=graph[+graph][+graph...],to=email
66 This option permits to send email reports unscheduled (i.e: at
67 any time). You don't need to stop your current Monitorix in‐
68 stance, just execute a new one with the new parameter -e and
69 once the job is done it will terminate itself, without affecting
70 your current Monitorix instance. The following is an example of
71 how to send an email report that includes the last day of sys‐
72 tem, kernel and hptemp graphs to the user@example.com email ad‐
73 dress:
74 # monitorix -c </etc/monitorix/conf.d/local.conf> -e re‐
76 port=daily,graphs=system+kern+hptemp,to=user@example.com
77 This option requires to have previously enabled the emailreports
79 module.
80
82 On receipt of a SIGHUP, monitorix will close and reopen its log file
83 (provided that it has a filename defined). This is useful in scripts
84 which rotate and age log files.
85 Note that the configuration file is not re-read.
87
89 The following set of the files are created on every startup:
90 <base_dir>/cgi/monitorix.conf.path
92 Stores the path of configfile and other information.
93 <base_dir>/cgi/monitorix.hplog
95 Stores the output of hplog command.
96 <base_dir>/index.html
98 HTML main page.
99
101 Monitorix is written by Jordi Sanfeliu <jordi@fibranet.cat>
102
104 Copyright © 2005-2022 Jordi Sanfeliu
105 Licensed under the GNU General Public License version 2 (GPLv2).
106
108 monitorix.conf(5)
1093.15.0 Dec 2022 monitorix(8)