=head1 SYNOPSIS
- Mode Client
+ Mode Client
DataDir /path/to/data/
PIDFile /path/to/pidfile/collectd.pid
LogFile /path/to/logfile/collectd.log
=head1 DESCRIPTION
-The syntax of collectd's config file is similar to the config file of the famos
-I<Apache Webserver>. Each line either ... FIXME
+This config file controls how the system statistics collection daemon
+B<collectd> behaves. The most significant options are B<Mode>, which controlls
+if the daemon will act as client, server or will be independent in local mode,
+and B<LoadPlugin> which controls which plugins to load.
-=head1 OPTIONS
+The syntax of this config file is similar to the config file of the famos
+B<Apache Webserver>. Each line containes either a key-value-pair or a
+section-start or -end. Empty lines and everything after the hash-symbol `#' is
+ignored.
-The available options.. Blah blah blah
-
-=head2 Glocal Options
+=head1 GLOBAL OPTIONS
=over 4
-=item B<Mode> (B<Local>|B<Client>|B<Server>)
+=item B<Mode> (B<Local>|B<Client>|B<Server>|B<Log>)
Sets the operating mode. See the section B<MODES> in L<collectd(1)> for a
-description. This option determines which other options are allowed.
+description. This option determines which other options are allowed. Defaults
+to B<Local>.
=item B<LoadPlugin> I<Plugin>
Sets the data directory. This is the directory beneath all RRD-files are
created. Possibly more subdirectories are created. This is also the working
-directory for the daemon. Available in B<all modes>, though the B<Server> mode
+directory for the daemon. Available in B<all modes>, though the B<Client> mode
won't write to this directory.
=item B<LogFile> I<File>
Sets the file to write debugging output to. This is only used if compiled with
debugging enabled. It's ignored otherwise. Available in B<all modes>.
-=item B<Server> I<Hostname or IP-address>
+=item B<Listen> I<Host> [I<Port>]
+
+=item B<Server> I<Host> [I<Port>]
+
+In B<client mode> the B<Server> statement sets the server to send datagrams to.
+The statement may occur multiple times to send each datagram to multiple
+destinations.
+
+In B<server mode> the B<Listen> statement sets the interfaces to bind to. When
+multiple statements are found the daemon will bind to multiple interfaces.
+
+The argument I<Host> may be a hostname, an IPv4 address or an IPv6 address. If
+the argument is a multicast address the daemon will join that multicast group.
+
+If no B<Listen> statement is found the server tries join both, the IPv6
+multicast group and the IPv4 multicast group. If no B<Server> statement is
+found the client will try to send data to the IPv6 multicast group first. If
+that failes the client will try the IPv4 multicast group.
+
+The default IPv6 multicast group is C<ff18::efc0:4a42>. The default IPv4
+multicast group is C<239.192.74.66>.
+
+The optional I<Port> argument sets the port to use. It can either be given
+using a numeric port number or a service name. If the argument is omited the
+default port B<25826> is assumed.
+
+=item B<TimeToLive> I<1-255>
+
+Set the time-to-live of sent packets. This applies to all, unicast and
+multicast, and IPv4 and IPv6 packets. The default is to not change this value.
+That means that multicast packets will be sent with a TTL of C<1> (one) on most
+operating systems.
+
+=back
+
+=head1 PLUGIN OPTIONS
+
+Some Plugins may register own options. These options must be inclosed in a
+C<Plugin>-Section. Which options exist depends on the plugin used:
+
+=head2 Plugin C<apache>
+
+=over 4
+
+=item B<URL> I<http://host/mod_status?auto>
+
+Sets the URL of the C<mod_status> output. This needs to be the output generated
+by C<ExtendedStatus on> and it needs to be the machine readable output
+generated by appending the C<?auto> argument.
+
+=item B<User> I<Username>
+
+Optional user name needed for authentication.
-The server to send data to. B<This is not yet implemented!> Maybe a better name
-for this was B<Receiver>, since I plan on detecting multicast groups
-automatically. On the other hand a extra MulticastGroup-option would be of
-interest for the server process. Anyhow, right now this is available for the
-B<Client> mode only.
+=item B<Password> I<Password>
-=item B<Port> I<Port number>
+Optional password needed for authentication.
-(UDP-)Port to send packages to or to bind to and wait for packages. This option
-is available in the B<Client> and B<Server> mode.
+=back
+
+=head2 Plugin C<hddtemp>
+
+=over 4
+
+=item B<Host> I<Hostname>
+
+Hostname to connect to. Defaults to B<127.0.0.1>.
+
+=item B<Port> I<Port>
+
+TCP-Port to connect to. Defaults to B<7634>.
=back
-=head2 Plugin options
+=head2 Plugin C<mysql>
+
+=over 4
+
+=item B<Host> I<Hostname>
-=over
+Hostname of the database server. Defaults to B<localhost>.
-=item B<ping>-Plugin
+=item B<User> I<Username>
+
+Username to use when connecting to the database.
+
+=item B<Password> I<Password>
+
+Password needed to log into the database.
+
+=item B<Database> I<Database>
+
+Select this database. Defaults to I<no database> which is a perfecly reasonable
+option for what this plugin does.
+
+=back
+
+=head2 Plugin C<ping>
=over 4
-=item B<Host> I<Hostname or IP-address>
+=item B<Host> I<IP-address>
Host to ping periodically. This option may be repeated several times to ping
multiple hosts.
-=back
+=item B<TTL> I<0-255>
+
+Sets the Time-To-Live of generated ICMP packets.
=back
projects / collectd.git / blobdiff