src/utils_avltree.[ch]: Documented the interface of the AVL-tree.
[collectd.git] / src / collectd.conf.pod
1 =head1 NAME
2
3 collectd.conf - Configuration for the system statistics collection daemon B<collectd>
4
5 =head1 SYNOPSIS
6
7   BaseDir "/path/to/data/"
8   PIDFile "/path/to/pidfile/collectd.pid"
9   LogFile "/path/to/logfile/collectd.log"
10   Server  "123.123.123.123" 12345
11
12   LoadPlugin cpu
13   LoadPlugin load
14   LoadPlugin ping
15
16   <Plugin ping>
17     Host "example.org"
18     Host "provider.net"
19   </Plugin>
20
21 =head1 DESCRIPTION
22
23 This config file controls how the system statistics collection daemon
24 B<collectd> behaves. The most significant option is B<LoadPlugin>, which
25 controls which plugins to load. These plugins ultimately define collectd's
26 behavior.
27
28 The syntax of this config file is similar to the config file of the famos
29 B<Apache Webserver>. Each line containes either a key-value-pair or a
30 section-start or -end. Empty lines and everything after the hash-symbol `#' is
31 ignored. Values are either string, enclosed in double-quotes,
32 (floating-point-)numbers or a boolean extression, i.E<nbsp>e. either B<true> or
33 B<false>. String containing of only alphanumeric characters and underscores do
34 not need to be quoted.
35
36 =head1 GLOBAL OPTIONS
37
38 =over 4
39
40 =item B<BaseDir> I<Directory>
41
42 Sets the base directory. This is the directory beneath all RRD-files are
43 created. Possibly more subdirectories are created. This is also the working
44 directory for the daemon.
45
46 =item B<LoadPlugin> I<Plugin>
47
48 Loads the plugin I<Plugin>. There must be at least one such line or B<collectd>
49 will be mostly useless. The names of the plugins are listed in L<collectd(1)>.
50
51 =item B<PIDFile> I<File>
52
53 Sets where to write the PID file to. This file is overwritten when it exists
54 and deleted when the program ist stopped. Some init-scripts might override this
55 setting using the B<-P> commandline option.
56
57 =item B<LogFile> I<File>
58
59 Sets the file to write debugging output to. This is only used if compiled with
60 debugging enabled. It's ignored otherwise.
61
62 =back
63
64 =head1 PLUGIN OPTIONS
65
66 Some Plugins may register own options. These options must be inclosed in a
67 C<Plugin>-Section. Which options exist depends on the plugin used:
68
69 =head2 Plugin C<apache>
70
71 To configure the C<apache>-plugin you first need to configure the Apache
72 webserver correctly. The Apache-plugin C<mod_status> needs to be loaded and
73 working and the C<ExtendedStatus> directive needs to be B<enabled>. You can use
74 the following snipped to base your Apache config upon:
75
76   ExtendedStatus on
77   <IfModule mod_status.c>
78     <Location /mod_status>
79       SetHandler server-status
80     </Location>
81   </IfModule>
82
83 The following options are accepted by the C<apache>-plugin:
84
85 =over 4
86
87 =item B<URL> I<http://host/mod_status?auto>
88
89 Sets the URL of the C<mod_status> output. This needs to be the output generated
90 by C<ExtendedStatus on> and it needs to be the machine readable output
91 generated by appending the C<?auto> argument.
92
93 =item B<User> I<Username>
94
95 Optional user name needed for authentication.
96
97 =item B<Password> I<Password>
98
99 Optional password needed for authentication.
100
101 =item B<CACert> I<File>
102
103 File that holds one or more SSL certificates. If you want to use HTTPS you will
104 possibly need this option. What CA certificates come bundeled with C<libcurl>
105 and are checked by default depends on the distribution you use.
106
107 =back
108
109 =head2 Plugin C<apcups>
110
111 =over 4
112
113 =item B<Host> I<Hostname>
114
115 Hostname of the host running B<apcupsd>. Defaults to B<localhost>. Please note
116 that IPv6 support has been disabled unless someone can confirm or decline that
117 B<apcupsd> can handle it.
118
119 =item B<Port> I<Port>
120
121 TCP-Port to connect to. Defaults to B<3551>.
122
123 =back
124
125 =head2 Plugin C<df>
126
127 =over 4
128
129 =item B<Device> I<Device>
130
131 Select partitions based on the devicename.
132
133 =item B<MountPoint> I<Directory>
134
135 Select partitions based on the mountpoint.
136
137 =item B<FSType> I<FSType>
138
139 Select partitions based on the filesystem type.
140
141 =item B<IgnoreSelected> I<true>|I<false>
142
143 Invert the selection: If set to true, all partitions B<except> the ones that
144 match any one of the criteria are collected. By default only selected
145 partitions are collected if a selection is made. If no selection is conifured
146 at all, B<all> partitions are selected.
147
148 =back
149
150 =head2 Plugin C<dns>
151
152 =over 4
153
154 =item B<Interface> I<Interface>
155
156 The dns plugin uses B<libpcap> to capture dns traffic and analyses it. This
157 option sets the interface that should be used. If this option is not set, or
158 set to "any", the plugin will try to get packets from B<all> interfaces. This
159 may not work on certain platforms, such as MacE<nbsp>OSE<nbsp>X.
160
161 =item B<IgnoreSource> I<IP-address>
162
163 Ignore packets that originate from this address.
164
165 =back
166
167 =head2 Plugin C<email>
168
169 =over 4
170
171 =item B<SocketGroup> I<Group>
172
173 If running as root change the group of the UNIX-socket after it has been 
174 created. Defaults to B<collectd>.
175
176 =item B<SocketPerms> I<Permissions>
177
178 Change the file permissions of the UNIX-socket after it has been created. The
179 permissions must be given as a numeric, octal value as you would pass to
180 L<chmod(1)>. Defaults to B<0770>.
181
182 =item B<MaxConns> I<Number>
183
184 Sets the maximum number of connections that can be handled in parallel. Since
185 this many threads will be started immediately setting this to a very high
186 value will waste valuable resources. Defaults to B<5> and will be forced to be
187 at most B<16384> to prevent typos and dumb mistakes.
188
189 =back
190
191 =head2 Plugin C<hddtemp>
192
193 =over 4
194
195 =item B<Host> I<Hostname>
196
197 Hostname to connect to. Defaults to B<127.0.0.1>.
198
199 =item B<Port> I<Port>
200
201 TCP-Port to connect to. Defaults to B<7634>.
202
203 =back
204
205 =head2 Plugin C<mbmon>
206
207 =over 4
208
209 =item B<Host> I<Hostname>
210
211 Hostname to connect to. Defaults to B<127.0.0.1>.
212
213 =item B<Port> I<Port>
214
215 TCP-Port to connect to. Defaults to B<411>.
216
217 =back
218
219 =head2 Plugin C<mysql>
220
221 =over 4
222
223 =item B<Host> I<Hostname>
224
225 Hostname of the database server. Defaults to B<localhost>.
226
227 =item B<User> I<Username>
228
229 Username to use when connecting to the database.
230
231 =item B<Password> I<Password>
232
233 Password needed to log into the database.
234
235 =item B<Database> I<Database>
236
237 Select this database. Defaults to I<no database> which is a perfecly reasonable
238 option for what this plugin does.
239
240 =back
241
242 =head2 Plugin C<network>
243
244 =over 4
245
246 =item B<Listen> I<Host> [I<Port>]
247
248 =item B<Server> I<Host> [I<Port>]
249
250 The B<Server> statement sets the server to send datagrams B<to>.  The statement
251 may occur multiple times to send each datagram to multiple destinations.
252
253 The B<Listen> statement sets the interfaces to bind to. When multiple
254 statements are found the daemon will bind to multiple interfaces.
255
256 The argument I<Host> may be a hostname, an IPv4 address or an IPv6 address. If
257 the argument is a multicast address the daemon will join that multicast group.
258
259 If no B<Listen> statement is found the server tries join both, the default IPv6
260 multicast group and the default IPv4 multicast group. If no B<Server> statement
261 is found the client will try to send data to the IPv6 multicast group first. If
262 that failes the client will try the IPv4 multicast group.
263
264 The default IPv6 multicast group is C<ff18::efc0:4a42>. The default IPv4
265 multicast group is C<239.192.74.66>.
266
267 The optional I<Port> argument sets the port to use. It can either be given
268 using a numeric port number or a service name. If the argument is omited the
269 default port B<25826> is assumed.
270
271 =item B<TimeToLive> I<1-255>
272
273 Set the time-to-live of sent packets. This applies to all, unicast and
274 multicast, and IPv4 and IPv6 packets. The default is to not change this value.
275 That means that multicast packets will be sent with a TTL of C<1> (one) on most
276 operating systems.
277
278 =back
279
280 =head2 Plugin C<ntpd>
281
282 =over 4
283
284 =item B<Host> I<Hostname>
285
286 Hostname of the host running B<ntpd>. Defaults to B<localhost>.
287
288 =item B<Port> I<Port>
289
290 UDP-Port to connect to. Defaults to B<123>.
291
292 =back
293
294 =head2 Plugin C<ping>
295
296 =over 4
297
298 =item B<Host> I<IP-address>
299
300 Host to ping periodically. This option may be repeated several times to ping
301 multiple hosts.
302
303 =item B<TTL> I<0-255>
304
305 Sets the Time-To-Live of generated ICMP packets.
306
307 =back
308
309 =head2 Plugin C<rrdtool>
310
311 =over 4
312
313 =item B<CacheTimeout> I<Seconds>
314
315 If this option is set to a value greater than zero, the C<rrdtool>-plugin will
316 write values every I<Seconds> seconds to the RRD-files. Writing multiple values
317 at once reduces IO-operations and thus lessens the load produced by updating
318 the files. The tradeoff is that the graphs kind of "drag behind" and that more
319 memory is used.
320
321 =item B<DataDir> I<Directory>
322
323 Set the directory to store RRD-files under. Per default RRD-files are generated
324 beneath the daemon's working directory, i.E<nbsp>e. the B<BaseDir>.
325
326 =back
327
328 =head2 Plugin C<sensors>
329
330 =over 4
331
332 =item B<Sensor> I<chip-bus-address/type-feature>
333
334 Selects the name of the sensor which you want to collect or ignore, depending
335 on the B<IgnoreSelected> below. For example, the option "B<Sensor>
336 I<it8712-isa-0290/voltage-in1>" will cause collectd to gather data for the
337 voltage sensor I<in1> of the I<it8712> on the isa bus at the address 0290.
338
339 =item B<IgnoreSelected> I<true>|I<false>
340
341 If no configuration if given, the B<sensors>-plugin will collect data from all
342 sensors. This may not be practical, especially for uninteresting sensors.
343 Thus, you can use the B<Sensor>-option to pick the sensors you're interested
344 in. Sometimes, however, it's easier/prefered to collect all sensors I<except> a
345 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
346 I<true> the effect of B<Sensor> is inversed: All selected sensors are ignored
347 and all other sensors are collected.
348
349 =back
350
351 =head2 Plugin C<traffic>
352
353 =over 4
354
355 =item B<Interface> I<Interface>
356
357 Select this interface. By default these interfaces will then be collected. For a more detailed description see B<IgnoreSelected> below.
358
359 =item B<IgnoreSelected> I<true>|I<false>
360
361 If no configuration if given, the B<traffic>-plugin will collect data from
362 all interfaces. This may not be practical, especially for loopback- and
363 similar interfaces. Thus, you can use the B<Interface>-option to pick the
364 interfaces you're interested in. Sometimes, however, it's easier/prefered
365 to collect all interfaces I<except> a few ones. This option enables you to
366 do that: By setting B<IgnoreSelected> to I<true> the effect of
367 B<Interface> is inversed: All selected interfaces are ignored and all
368 other interfaces are collected.
369
370 =back
371
372 =head1 SEE ALSO
373
374 L<collectd(1)>
375
376 =head1 AUTHOR
377
378 Florian Forster E<lt>octo@verplant.orgE<gt>
379
380 =cut