monitorix(8)

1monitorix(8)              Monitorix collector daemon              monitorix(8)
2
3
4

NAME

6       monitorix - a lightweight system monitoring tool
7

SYNOPSIS

9       monitorix  -c  configfile  [-p pidfile] [-d none | graph[,graph] | all]
10       [-v] [-n] [-u] [-s splitpolicy]
11

DESCRIPTION

13       This Perl daemon starts the main Monitorix process, which gathers  sta‐
14       tistics  about  the system it is running on and stores this information
15       in a set of RRD files.
16

OPTIONS

18       -c configfile
19              The default location of the main configuration file  varies  de‐
20              pending on the operating system:
21
22              Linux:        /etc/monitorix/monitorix.conf
23              FreeBSD:      /usr/local/etc/monitorix.conf
24
25              Extra   configuration   files   can   be  placed  in  /etc/moni‐
26              torix/conf.d, they will be loaded right after the main  configu‐
27              ration file (overriding previous options).
28
29       -p pidfile
30              Stores the daemon's process ID into the specified file.
31
32       -d none | graph[,graph] | all
33              Logs  more information about what monitorix is doing internally.
34              The keys reflect if the data collected must be displayed on each
35              case.  If  all  is  defined,  the  data collected of all enabled
36              graphs will be shown. If none is defined no data collected  will
37              be  shown.  Finally  it is also possible to define a comma-sepa‐
38              rated list of graph names from which show their data collected.
39              For a reference of all graph names check the  option  graph_name
40              in the monitorix.conf configuration file.
41
42       -v     Displays version information.
43
44       -n     This  argument  will  prevent  Monitorix  from  daemonizing, and
45              hence, forcing it to run in foreground. This is specially useful
46              for debugging purposes.
47
48       -u     This  option  will force Monitorix to run under the regular user
49              who started it. It's necessary to make sure that this user  will
50              have write permissions to the directory and files pointed by the
51              options base_dir, base_lib and log_file  (either  for  monitorix
52              and for the HTTP built-in server). Also, you must know that some
53              graphs might not work because only the 'root' user is capable to
54              get  such  statistics.  Check the log files after starting Moni‐
55              torix in this mode.
56
57       -s splitpolicy
58              This option decides which part of a line in the config file will
59              be the key and which one will be the value. The split policy ac‐
60              cepts the values guess (which is the default), whitespace (which
61              causes  the  Monitorix  to  split  by  whitespace) and equalsign
62              (which causes it to split strictly by equal sign).
63

SIGNALS

65       On receipt of a SIGHUP, monitorix will close and reopen  its  log  file
66       (provided  that  it  has a filename defined). This is useful in scripts
67       which rotate and age log files.
68
69       Note that the configuration file is not re-read.
70

FILES

72       The following set of the files are created on every startup:
73
74       <base_dir>/cgi/monitorix.conf.path
75               Stores the path of configfile and other information.
76
77       <base_dir>/cgi/monitorix.hplog
78               Stores the output of hplog command.
79
80       <base_dir>/index.html
81               HTML main page.
82

AUTHOR

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

COPYRIGHT

87       Copyright © 2005-2022 Jordi Sanfeliu
88       Licensed under the GNU General Public License version 2 (GPLv2).
89