1 =head1 NAME
3 collectd.conf - Configuration for the system statistics collection daemon B<collectd>
5 =head1 SYNOPSIS
7 Mode Client
8 DataDir /path/to/data/
9 PIDFile /path/to/pidfile/collectd.pid
10 LogFile /path/to/logfile/collectd.log
11 Server 123.123.123.123 12345
13 LoadPlugin cpu
14 LoadPlugin load
15 LoadPlugin ping
17 <Plugin ping>
18 Host example.org
19 Host provider.net
20 </Plugin>
22 =head1 DESCRIPTION
24 This config file controls how the system statistics collection daemon
25 B<collectd> behaves. The most significant options are B<Mode>, which controlls
26 if the daemon will act as client, server or will be independent in local mode,
27 and B<LoadPlugin> which controls which plugins to load.
29 The syntax of this config file is similar to the config file of the famos
30 B<Apache Webserver>. Each line containes either a key-value-pair or a
31 section-start or -end. Empty lines and everything after the hash-symbol `#' is
32 ignored.
34 =head1 GLOBAL OPTIONS
36 =over 4
38 =item B<Mode> (B<Local>|B<Client>|B<Server>|B<Log>)
40 Sets the operating mode. See the section B<MODES> in L<collectd(1)> for a
41 description. This option determines which other options are allowed. Defaults
42 to B<Local>.
44 =item B<LoadPlugin> I<Plugin>
46 Loads the plugin I<Plugin>. There must be at least one such line or B<collectd>
47 will be mostly useless. The names of the plugins are listed in L<collectd(1)>.
49 =item B<PIDFile> I<File>
51 Sets where to write the PID file to. This file is overwritten when it exists
52 and deleted when the program ist stopped. Some init-scripts might override this
53 setting using the B<-P> commandline option. Available in B<all modes>.
55 =item B<DataDir> I<Directory>
57 Sets the data directory. This is the directory beneath all RRD-files are
58 created. Possibly more subdirectories are created. This is also the working
59 directory for the daemon. Available in B<all modes>, though the B<Client> mode
60 won't write to this directory.
62 =item B<LogFile> I<File>
64 Sets the file to write debugging output to. This is only used if compiled with
65 debugging enabled. It's ignored otherwise. Available in B<all modes>.
67 =item B<Listen> I<Host> [I<Port>]
69 =item B<Server> I<Host> [I<Port>]
71 In B<client mode> the B<Server> statement sets the server to send datagrams to.
72 The statement may occur multiple times to send each datagram to multiple
73 destinations.
75 In B<server mode> the B<Listen> statement sets the interfaces to bind to. When
76 multiple statements are found the daemon will bind to multiple interfaces.
78 The argument I<Host> may be a hostname, an IPv4 address or an IPv6 address. If
79 the argument is a multicast address the daemon will join that multicast group.
81 If no B<Listen> statement is found the server tries join both, the IPv6
82 multicast group and the IPv4 multicast group. If no B<Server> statement is
83 found the client will try to send data to the IPv6 multicast group first. If
84 that failes the client will try the IPv4 multicast group.
86 The default IPv6 multicast group is C<ff18::efc0:4a42>. The default IPv4
87 multicast group is C<239.192.74.66>.
89 The optional I<Port> argument sets the port to use. It can either be given
90 using a numeric port number or a service name. If the argument is omited the
91 default port B<25826> is assumed.
93 =item B<TimeToLive> I<1-255>
95 Set the time-to-live of sent packets. This applies to all, unicast and
96 multicast, and IPv4 and IPv6 packets. The default is to not change this value.
97 That means that multicast packets will be sent with a TTL of C<1> (one) on most
98 operating systems.
100 =back
102 =head1 PLUGIN OPTIONS
104 Some Plugins may register own options. These options must be inclosed in a
105 C<Plugin>-Section. Which options exist depends on the plugin used:
107 =head2 Plugin C<apache>
109 To configure the C<apache>-plugin you first need to configure the Apache
110 webserver correctly. The Apache-plugin C<mod_status> needs to be loaded and
111 working and the C<ExtendedStatus> directive needs to be B<enabled>. You can use
112 the following snipped to base your Apache config upon:
114 ExtendedStatus on
115 <IfModule mod_status.c>
116 <Location /mod_status>
117 SetHandler server-status
118 </Location>
119 </IfModule>
121 The following options are accepted by the C<apache>-plugin:
123 =over 4
125 =item B<URL> I<http://host/mod_status?auto>
127 Sets the URL of the C<mod_status> output. This needs to be the output generated
128 by C<ExtendedStatus on> and it needs to be the machine readable output
129 generated by appending the C<?auto> argument.
131 =item B<User> I<Username>
133 Optional user name needed for authentication.
135 =item B<Password> I<Password>
137 Optional password needed for authentication.
139 =item B<CACert> I<File>
141 File that holds one or more SSL certificates. If you want to use HTTPS you will
142 possibly need this option. What CA certificates come bundeled with C<libcurl>
143 and are checked by default depends on the distribution you use.
145 =back
147 =head2 Plugin C<apcups>
149 =over 4
151 =item B<Host> I<Hostname>
153 Hostname of the host running B<apcupsd>. Defaults to B<localhost>. Please note
154 that IPv6 support has been disabled unless someone can confirm or decline that
155 B<apcupsd> can handle it.
157 =item B<Port> I<Port>
159 TCP-Port to connect to. Defaults to B<3551>.
161 =back
163 =head2 Plugin C<hddtemp>
165 =over 4
167 =item B<Host> I<Hostname>
169 Hostname to connect to. Defaults to B<127.0.0.1>.
171 =item B<Port> I<Port>
173 TCP-Port to connect to. Defaults to B<7634>.
175 =back
177 =head2 Plugin C<ntpd>
179 =over 4
181 =item B<Host> I<Hostname>
183 Hostname of the host running B<ntpd>. Defaults to B<localhost>.
185 =item B<Port> I<Port>
187 UDP-Port to connect to. Defaults to B<123>.
189 =back
191 =head2 Plugin C<mysql>
193 =over 4
195 =item B<Host> I<Hostname>
197 Hostname of the database server. Defaults to B<localhost>.
199 =item B<User> I<Username>
201 Username to use when connecting to the database.
203 =item B<Password> I<Password>
205 Password needed to log into the database.
207 =item B<Database> I<Database>
209 Select this database. Defaults to I<no database> which is a perfecly reasonable
210 option for what this plugin does.
212 =back
214 =head2 Plugin C<ping>
216 =over 4
218 =item B<Host> I<IP-address>
220 Host to ping periodically. This option may be repeated several times to ping
221 multiple hosts.
223 =item B<TTL> I<0-255>
225 Sets the Time-To-Live of generated ICMP packets.
228 =head2 Plugin C<sensors>
230 =over 4
232 =item B<ExtendedSensorNaming> I<true>|I<false>
234 If set to I<true> this option switches on the extended sensors
235 and RRD files naming.
237 Sensors get names like I<chip-bus-address/type-feature>
238 (e.g. I<it8712-isa-0290/voltage-in1>) and RRD files are therefore
239 stored in a standalone directory inside the B<DataDir> directory and get
240 names like I<lm_sensors-chip-bus-address/type-feature.rrd>
241 (e.g. I<lm_sensors-it8712-isa-0290/voltage-in1.rrd>).
243 The B<ExtendedSensorNaming> option breaks the compatibility with previous
244 sensors and RRD files naming and the place where RRDs are stored. If you turn
245 it on the plugin will create new RRD files in a standalone directory inside
246 the B<DataDir> directory and without previous history. You can rename
247 previous RRD files to the new ones to continue collecting data into the same
248 RRDs.
250 If not set or set to I<false> the extended naming is not active. Sensors
251 get names like I<chip-feature> (e.g. I<it8712-in1>) and RRD files
252 are stored in the main B<DataDir> directory and get names like
253 I<sensors-chip-feature.rrd> (e.g. I<sensors-it8712-in1.rrd>).
254 You simply continue using the plugin the old way and additionally also
255 getting data for newly added sensors in this mode.
257 Default setting is I<false>.
259 =item B<Sensor> I<chip-feature> or B<Sensor> I<chip-bus-address/type-feature>
261 Both options select the name of the sensor which you want to collect.
262 The naming scheme is dependent on the state of the B<ExtendedSensorNaming>
263 option (see previous paragraph). Both options can also deselect the
264 sensor according to the B<IgnoreSelected> option (see below).
266 For example the option "B<Sensor> I<it8712-in1>" will cause
267 the collectd to gather data for the voltage sensor I<in1>
268 of the I<it8712> chip in case of the B<ExtendedSensorNaming> option
269 is set to I<false>.
271 And likewise the option "B<Sensor> I<it8712-isa-0290/voltage-in1>" will
272 cause the collectd to gather data for the voltage sensor I<in1> of the I<it8712>
273 on the isa bus at the address 0290 in case of the B<ExtendedSensorNaming>
274 option set to I<true>.
276 =item B<IgnoreSelected> I<true>|I<false>
278 If no configuration if given, the B<sensors>-plugin will collect data from
279 all sensors. This may not be practical, especially for uninteresting sensors.
280 Thus, you can use the B<Sensor>-option to pick the sensors you're
281 interested in. Sometimes, however, it's easier/prefered to collect all
282 sensors I<except> a few ones. This option enables you to
283 do that: By setting B<IgnoreSelected> to I<true> the effect of
284 B<Sensor> is inversed: All selected sensors are ignored and all
285 other sensors are collected.
287 =back
289 =head2 Plugin C<traffic>
291 =over 4
293 =item B<Interface> I<Interface>
295 Select this interface. By default these interfaces will then be collected. For a more detailed description see B<IgnoreSelected> below.
297 =item B<IgnoreSelected> I<true>|I<false>
299 If no configuration if given, the B<traffic>-plugin will collect data from
300 all interfaces. This may not be practical, especially for loopback- and
301 similar interfaces. Thus, you can use the B<Interface>-option to pick the
302 interfaces you're interested in. Sometimes, however, it's easier/prefered
303 to collect all interfaces I<except> a few ones. This option enables you to
304 do that: By setting B<IgnoreSelected> to I<true> the effect of
305 B<Interface> is inversed: All selected interfaces are ignored and all
306 other interfaces are collected.
308 =back
310 =head1 SEE ALSO
312 L<collectd(1)>
314 =head1 AUTHOR
316 Florian Forster E<lt>octo@verplant.orgE<gt>
318 =cut