From: Florian Forster Date: Mon, 12 Feb 2007 18:52:06 +0000 (+0100) Subject: src/collectd.conf.{in,pod}: Update the sample config and the config's documentation. X-Git-Tag: collectd-4.0.0~190 X-Git-Url: https://git.verplant.org/?a=commitdiff_plain;h=5eb954cc19e178f5502156c7cfe0f0c756f6085e;p=collectd.git src/collectd.conf.{in,pod}: Update the sample config and the config's documentation. --- diff --git a/src/collectd.conf.in b/src/collectd.conf.in index 55f9ad6a..90e20bad 100644 --- a/src/collectd.conf.in +++ b/src/collectd.conf.in @@ -47,29 +47,29 @@ @BUILD_MODULE_WIRELESS_TRUE@LoadPlugin wireless # -# URL http://localhost/status?auto -# User www-user -# Password secret -# CACert /etc/ssl/ca.crt +# URL "http://localhost/status?auto" +# User "www-user" +# Password "secret" +# CACert "/etc/ssl/ca.crt" # # -# Host localhost -# Port 3551 +# Host "localhost" +# Port "3551" # # -# Interface eth0 -# IgnoreSource 192.168.0.1 +# Interface "eth0" +# IgnoreSource "192.168.0.1" # # -# Host 127.0.0.1 +# Host "127.0.0.1" # Port 7634 # # -# Host 127.0.0.1 +# Host "127.0.0.1" # Port 411 # @@ -82,23 +82,23 @@ # # -# Host localhost +# Host "localhost" # Port 123 # # -# Host database.serv.er -# User db_user -# Password secret -# Database db_name +# Host "database.serv.er" +# User "db_user" +# Password "secret" +# Database "db_name" # # -# Host host.foo.bar +# Host "host.foo.bar" # # -# Process name +# Process "name" # # @@ -109,20 +109,14 @@ ## backwards compatibility. The `extended naming' is prefered, but not the ## default for this reason. See `collectd.conf(5)' for more information. # -# ExtendedSensorNaming false -# Sensor it8712-temp1 -# Sensor it8712-fan3 -# Sensor it8712-in8 -## -- OR -- -# ExtendedSensorNaming true -# Sensor it8712-isa-0290/temperature-temp1 -# Sensor it8712-isa-0290/fanspeed-fan3 -# Sensor it8712-isa-0290/voltage-in8 +# Sensor "it8712-isa-0290/temperature-temp1" +# Sensor "it8712-isa-0290/fanspeed-fan3" +# Sensor "it8712-isa-0290/voltage-in8" # # IgnoreSelected false # # -# Interface eth0 +# Interface "eth0" # IgnoreSelected false # diff --git a/src/collectd.conf.pod b/src/collectd.conf.pod index 5c8de4fb..45acb682 100644 --- a/src/collectd.conf.pod +++ b/src/collectd.conf.pod @@ -4,42 +4,44 @@ collectd.conf - Configuration for the system statistics collection daemon B - Host example.org - Host provider.net + Host "example.org" + Host "provider.net" =head1 DESCRIPTION This config file controls how the system statistics collection daemon -B behaves. The most significant options are B, which controlls -if the daemon will act as client, server or will be independent in local mode, -and B which controls which plugins to load. +B behaves. The most significant option is B, which +controls which plugins to load. These plugins ultimately define collectd's +behavior. The syntax of this config file is similar to the config file of the famos B. Each line containes either a key-value-pair or a section-start or -end. Empty lines and everything after the hash-symbol `#' is -ignored. +ignored. Values are either string, enclosed in double-quotes, +(floating-point-)numbers or a boolean extression, i.Ee. either B or +B. String containing of only alphanumeric characters and underscores do +not need to be quoted. =head1 GLOBAL OPTIONS =over 4 -=item B (B|B|B|B) +=item B I -Sets the operating mode. See the section B in L for a -description. This option determines which other options are allowed. Defaults -to B. +Sets the base 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. =item B I @@ -50,52 +52,12 @@ will be mostly useless. The names of the plugins are listed in L. Sets where to write the PID file to. This file is overwritten when it exists and deleted when the program ist stopped. Some init-scripts might override this -setting using the B<-P> commandline option. Available in B. - -=item B I - -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, though the B mode -won't write to this directory. +setting using the B<-P> commandline option. =item B I Sets the file to write debugging output to. This is only used if compiled with -debugging enabled. It's ignored otherwise. Available in B. - -=item B I [I] - -=item B I [I] - -In B the B statement sets the server to send datagrams to. -The statement may occur multiple times to send each datagram to multiple -destinations. - -In B the B statement sets the interfaces to bind to. When -multiple statements are found the daemon will bind to multiple interfaces. - -The argument I 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 statement is found the server tries join both, the IPv6 -multicast group and the IPv4 multicast group. If no B 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. The default IPv4 -multicast group is C<239.192.74.66>. - -The optional I 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 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. +debugging enabled. It's ignored otherwise. =back @@ -254,20 +216,6 @@ TCP-Port to connect to. Defaults to B<411>. =back -=head2 Plugin C - -=over 4 - -=item B I - -Hostname of the host running B. Defaults to B. - -=item B I - -UDP-Port to connect to. Defaults to B<123>. - -=back - =head2 Plugin C =over 4 @@ -291,6 +239,58 @@ option for what this plugin does. =back +=head2 Plugin C + +=over 4 + +=item B I [I] + +=item B I [I] + +The B statement sets the server to send datagrams B. The statement +may occur multiple times to send each datagram to multiple destinations. + +The B statement sets the interfaces to bind to. When multiple +statements are found the daemon will bind to multiple interfaces. + +The argument I 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 statement is found the server tries join both, the default IPv6 +multicast group and the default IPv4 multicast group. If no B 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. The default IPv4 +multicast group is C<239.192.74.66>. + +The optional I 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 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 + +=head2 Plugin C + +=over 4 + +=item B I + +Hostname of the host running B. Defaults to B. + +=item B I + +UDP-Port to connect to. Defaults to B<123>. + +=back + =head2 Plugin C =over 4