3e4b958749338074022440114c216a560ccfff27
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
12 Port 12345
14 LoadPlugin cpu
15 LoadPlugin load
16 LoadPlugin ping
18 <Plugin ping>
19 Host example.org
20 Host provider.net
21 </Plugin>
23 =head1 DESCRIPTION
25 This config file controls how the system statistics collection daemon
26 B<collectd> behaves. The most significant options are B<Mode>, which controlls
27 if the daemon will act as client, server or will be independent in local mode,
28 and B<LoadPlugin> which controls which plugins to load.
30 The syntax of this config file is similar to the config file of the famos
31 B<Apache Webserver>. Each line containes either a key-value-pair or a
32 section-start or -end. Empty lines and everything after the hash-symbol `#' is
33 ignored.
35 =head1 GLOBAL OPTIONS
37 =over 4
39 =item B<Mode> (B<Local>|B<Client>|B<Server>)
41 Sets the operating mode. See the section B<MODES> in L<collectd(1)> for a
42 description. This option determines which other options are allowed. Defaults
43 to B<Local>.
45 =item B<LoadPlugin> I<Plugin>
47 Loads the plugin I<Plugin>. There must be at least one such line or B<collectd>
48 will be mostly useless. The names of the plugins are listed in L<collectd(1)>.
50 =item B<PIDFile> I<File>
52 Sets where to write the PID file to. This file is overwritten when it exists
53 and deleted when the program ist stopped. 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<Server> 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<hddtemp>
109 =over 4
111 =item B<Host> I<Hostname>
113 Hostname to connect to. Defaults to B<127.0.0.1>.
115 =item B<Port> I<Port>
117 TCP-Port to connect to. Defaults to B<7634>.
119 =back
121 =head2 Plugin C<mysql>
123 =over 4
125 =item B<Host> I<Hostname>
127 Hostname of the database server. Defaults to B<localhost>.
129 =item B<User> I<Username>
131 Username to use when connecting to the database.
133 =item B<Password> I<Password>
135 Password needed to log into the database.
137 =item B<Database> I<Database>
139 Select this database. Defaults to I<no database> which is a perfecly reasonable
140 option for what this plugin does.
142 =back
144 =head2 Plugin C<ping>
146 =over 4
148 =item B<Host> I<IP-address>
150 Host to ping periodically. This option may be repeated several times to ping
151 multiple hosts.
153 =back
155 =head1 SEE ALSO
157 L<collectd(1)>
159 =head1 AUTHOR
161 Florian Forster E<lt>octo@verplant.orgE<gt>
163 =cut