fix configure.ac

[collectd.git] / src / collectd.conf.pod

diff --git a/src/collectd.conf.pod b/src/collectd.conf.pod
index 605ba05..c3e239b 100644 (file)
--- a/src/collectd.conf.pod
+++ b/src/collectd.conf.pod
@@ -404,13 +404,13 @@ There are a couple of limitations you should be aware of:
 
 =over 4
 
 
 =over 4
 

-=item
+=item *

 
 The I<Type> cannot be left unspecified, because it is not reasonable to add
 apples to oranges. Also, the internal lookup structure won't work if you try
 to group by type.
 
 
 The I<Type> cannot be left unspecified, because it is not reasonable to add
 apples to oranges. Also, the internal lookup structure won't work if you try
 to group by type.
 

-=item
+=item *

 
 There must be at least one unspecified, ungrouped field. Otherwise nothing
 will be aggregated.
 
 There must be at least one unspecified, ungrouped field. Otherwise nothing
 will be aggregated.


@@ -485,19 +485,19 @@ This will create the files:
 
 =over 4
 
 
 =over 4
 

-=item
+=item *

 
 foo.example.com/cpu-even-average/cpu-idle
 
 
 foo.example.com/cpu-even-average/cpu-idle
 

-=item
+=item *

 
 foo.example.com/cpu-even-average/cpu-system
 
 
 foo.example.com/cpu-even-average/cpu-system
 

-=item
+=item *

 
 foo.example.com/cpu-even-average/cpu-user
 
 
 foo.example.com/cpu-even-average/cpu-user
 

-=item
+=item *

 
 ...
 
 
 ...
 


@@ -1361,6 +1361,32 @@ at all, B<all> cgroups are selected.
 
 =back
 
 
 =back
 

+=head2 Plugin C<chrony>
+
+The C<chrony> plugin collects ntp data from a B<chronyd> server, such as clock
+skew and per-peer stratum.
+
+For talking to B<chronyd>, it mimics what the B<chronyc> control program does
+on the wire.
+
+Available configuration options for the C<chrony> plugin:
+
+=over 4
+
+=item B<Host> I<Hostname>
+
+Hostname of the host running B<chronyd>. Defaults to B<localhost>.
+
+=item B<Port> I<Port>
+
+UDP-Port to connect to. Defaults to B<323>.
+
+=item B<Timeout> I<Timeout>
+
+Connection timeout in seconds. Defaults to B<2>.
+
+=back
+

 =head2 Plugin C<conntrack>
 
 This plugin collects IP conntrack statistics.
 =head2 Plugin C<conntrack>
 
 This plugin collects IP conntrack statistics.


@@ -1381,11 +1407,11 @@ as Jiffies, using the C<cpu> type. Two aggregations are available:
 
 =over 4
 
 
 =over 4
 

-=item
+=item *

 
 Sum, per-state, over all CPUs installed in the system; and
 
 
 Sum, per-state, over all CPUs installed in the system; and
 

-=item
+=item *

 
 Sum, per-CPU, over all non-idle states of a CPU, creating an "active" state.
 
 
 Sum, per-CPU, over all non-idle states of a CPU, creating an "active" state.
 


@@ -1431,6 +1457,15 @@ installed) to get the current CPU frequency. If this file does not exist make
 sure B<cpufreqd> (L<http://cpufreqd.sourceforge.net/>) or a similar tool is
 installed and an "cpu governor" (that's a kernel module) is loaded.
 
 sure B<cpufreqd> (L<http://cpufreqd.sourceforge.net/>) or a similar tool is
 installed and an "cpu governor" (that's a kernel module) is loaded.
 

+=head2 Plugin C<cpusleep>
+
+This plugin doesn't have any options. It reads CLOCK_BOOTTIME and
+CLOCK_MONOTONIC and reports the differences between these
+clocks. Since BOOTTIME clock increments while device is suspended and
+MONOTONIC clock does not, the derivative of the difference between
+these clocks gives the relative amount of time the device has spent in
+suspend state. The recorded value is in milliseconds / seconds.
+

 =head2 Plugin C<csv>
 
 =over 4
 =head2 Plugin C<csv>
 
 =over 4


@@ -1457,7 +1492,7 @@ All cURL-based plugins support collection of generic, request-based
 statistics. These are disabled by default and can be enabled selectively for
 each page or URL queried from the curl, curl_json, or curl_xml plugins. See
 the documentation of those plugins for specific information. This section
 statistics. These are disabled by default and can be enabled selectively for
 each page or URL queried from the curl, curl_json, or curl_xml plugins. See
 the documentation of those plugins for specific information. This section

-describes the available metrics that can be configured with each plugin. All
+describes the available metrics that can be configured for each plugin. All

 options are disabled by default.
 
 See L<http://curl.haxx.se/libcurl/c/curl_easy_getinfo.html> for more details.
 options are disabled by default.
 
 See L<http://curl.haxx.se/libcurl/c/curl_easy_getinfo.html> for more details.


@@ -1484,7 +1519,7 @@ host was completed.
 
 =item B<PretransferTime> B<true|false>
 
 
 =item B<PretransferTime> B<true|false>
 

-Time it took from the start until the file transfer is just about to begin.
+Time it took from the start until just before the transfer begins.

 
 =item B<StarttransferTime> B<true|false>
 
 
 =item B<StarttransferTime> B<true|false>
 


@@ -1637,6 +1672,9 @@ Beware that requests will get aborted if they take too long to complete. Adjust
 B<Timeout> accordingly if you expect B<MeasureResponseTime> to report such slow
 requests.
 
 B<Timeout> accordingly if you expect B<MeasureResponseTime> to report such slow
 requests.
 

+This option is similar to enabling the B<TotalTime> statistic but it's
+measured by collectd instead of cURL.
+

 =item B<MeasureResponseCode> B<true>|B<false>
 
 Measure response code for the request. If this setting is enabled, B<Match>
 =item B<MeasureResponseCode> B<true>|B<false>
 
 Measure response code for the request. If this setting is enabled, B<Match>


@@ -4650,11 +4688,11 @@ Sets the I<command file> to write to. Defaults to F</usr/local/nagios/var/rw/nag
 
 =head2 Plugin C<ntpd>
 
 
 =head2 Plugin C<ntpd>
 

-The C<ntpd> plugin collects per-peer ntpd data such as time offset and time
+The C<ntpd> plugin collects per-peer ntp data such as time offset and time

 dispersion.
 
 For talking to B<ntpd>, it mimics what the B<ntpdc> control program does on
 dispersion.
 
 For talking to B<ntpd>, it mimics what the B<ntpdc> control program does on

-wire - using B<mode 7> specific requests. This mode is deprecated with
+the wire - using B<mode 7> specific requests. This mode is deprecated with

 newer B<ntpd> releases (4.2.7p230 and later). For the C<ntpd> plugin to work
 correctly with them, the ntp daemon must be explicitly configured to
 enable B<mode 7> (which is disabled by default). Refer to the I<ntp.conf(5)>
 newer B<ntpd> releases (4.2.7p230 and later). For the C<ntpd> plugin to work
 correctly with them, the ntp daemon must be explicitly configured to
 enable B<mode 7> (which is disabled by default). Refer to the I<ntp.conf(5)>


@@ -6427,6 +6465,22 @@ collected. If at least one B<Disk> option is given and no B<IgnoreSelected> or
 set to B<false>, B<only> matching disks will be collected. If B<IgnoreSelected>
 is set to B<true>, all disks are collected B<except> the ones matched.
 
 set to B<false>, B<only> matching disks will be collected. If B<IgnoreSelected>
 is set to B<true>, all disks are collected B<except> the ones matched.
 

+=item B<IgnoreSleepMode> B<true>|B<false>
+
+Normally, the C<smart> plugin will ignore disks that are reported to be asleep.
+This option disables the sleep mode check and allows the plugin to collect data
+from these disks anyway. This is useful in cases where libatasmart mistakenly
+reports disks as asleep because it has not been updated to incorporate support
+for newer idle states in the ATA spec.
+
+=item B<UseSerial> B<true>|B<false>
+
+A disk's kernel name (e.g., sda) can change from one boot to the next. If this
+option is enabled, the C<smart> plugin will use the disk's serial number (e.g.,
+HGST_HUH728080ALE600_2EJ8VH8X) instead of the kernel name as the key for
+storing data. This ensures that the data for a given disk will be kept together
+even if the kernel name changes.
+

 =back
 
 =head2 Plugin C<snmp>
 =back
 
 =head2 Plugin C<snmp>


@@ -7164,20 +7218,20 @@ The following methods are used to find the machine's UUID, in order:
 
 =over 4
 
 
 =over 4
 

-=item
+=item *

 
 Check I</etc/uuid> (or I<UUIDFile>).
 
 
 Check I</etc/uuid> (or I<UUIDFile>).
 

-=item
+=item *

 
 Check for UUID from HAL (L<http://www.freedesktop.org/wiki/Software/hal>) if
 present.
 
 
 Check for UUID from HAL (L<http://www.freedesktop.org/wiki/Software/hal>) if
 present.
 

-=item
+=item *

 
 Check for UUID from C<dmidecode> / SMBIOS.
 
 
 Check for UUID from C<dmidecode> / SMBIOS.
 

-=item
+=item *

 
 Check for UUID from Xen hypervisor.
 
 
 Check for UUID from Xen hypervisor.