collectd.conf(5): Updated the “GetSnapshot” entry.

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

diff --git a/src/collectd.conf.pod b/src/collectd.conf.pod
index f3f2f48..f7531cd 100644 (file)
--- a/src/collectd.conf.pod
+++ b/src/collectd.conf.pod
@@ -1682,6 +1682,7 @@ Required capabilities are documented below.
     </Disks>
     
     <VolumePerf>
     </Disks>
     
     <VolumePerf>

+      Interval 30

       GetIO      "volume0"
       IgnoreSelectedIO      false
       GetOps     "volume0"
       GetIO      "volume0"
       IgnoreSelectedIO      false
       GetOps     "volume0"


@@ -1691,11 +1692,12 @@ Required capabilities are documented below.
     </VolumePerf>
     
     <VolumeUsage>
     </VolumePerf>
     
     <VolumeUsage>

-      Capacity "vol0"
-      Capacity "vol1"
+      Interval 30
+      GetCapacity "vol0"
+      GetCapacity "vol1"

       IgnoreSelectedCapacity false
       IgnoreSelectedCapacity false

-      Snapshot "vol1"
-      Snapshot "vol3"
+      GetSnapshot "vol1"
+      GetSnapshot "vol3"

       IgnoreSelectedSnapshot false
     </VolumeUsage>
     
       IgnoreSelectedSnapshot false
     </VolumeUsage>
     


@@ -1775,16 +1777,10 @@ The following options are valid inside all blocks:
 
 =over 4
 
 
 =over 4
 

-=item B<Multiplier> I<Multiplier>
-
-The host specific interval between data collections is multiplied by this value
-for collecting these data.
-
-Optional
-
-Type: integer
+=item B<Interval> I<Seconds>

 
 

-Default: 1
+Collect the respective statistics every I<Seconds> seconds. Defaults to the
+host specific setting.

 
 =back
 
 
 =back
 


@@ -1984,6 +1980,10 @@ I<api-perf-object-get-instances> capability.
 
 =over 4
 
 
 =over 4
 

+=item B<Interval> I<Seconds>
+
+Collect volume performance data every I<Seconds> seconds.
+

 =item B<GetIO> I<Volume>
 
 =item B<GetOps> I<Volume>
 =item B<GetIO> I<Volume>
 
 =item B<GetOps> I<Volume>


@@ -2035,7 +2035,11 @@ capability.
 
 =over 4
 
 
 =over 4
 

-=item B<Capacity> I<VolumeName>
+=item B<Interval> I<Seconds>
+
+Collect volume usage statistics every I<Seconds> seconds.
+
+=item B<GetCapacity> I<VolumeName>

 
 The current capacity of the volume will be collected. This will result in two
 to four value lists, depending on the configuration of the volume. All data
 
 The current capacity of the volume will be collected. This will result in two
 to four value lists, depending on the configuration of the volume. All data


@@ -2057,23 +2061,34 @@ Repeat this option to specify multiple volumes.
 
 =item B<IgnoreSelectedCapacity> B<true>|B<false>
 
 
 =item B<IgnoreSelectedCapacity> B<true>|B<false>
 

-Specify whether to collect only the volumes selected by the B<Capacity> option
-or to ignore those volumes. B<IgnoreSelectedCapacity> defaults to B<false>.
-However, if no B<Capacity> option is specified at all, all capacities will be
-selected anyway.
+Specify whether to collect only the volumes selected by the B<GetCapacity>
+option or to ignore those volumes. B<IgnoreSelectedCapacity> defaults to
+B<false>. However, if no B<GetCapacity> option is specified at all, all
+capacities will be selected anyway.
+
+=item B<GetSnapshot> I<VolumeName>
+
+Select volumes from which to collect snapshot information.

 
 

-=item B<Snapshot> I<VolumeName>
+Usually, the space used for snapshots is included in the space reported as
+"used". If snapshot information is collected as well, the space used for
+snapshots is subtracted from the used space.

 
 

-B<Defunct!> Select volumes from which to collect snapshot information.
+To make things even more interesting, it is possible to reserve space to be
+used for snapshots. If the space required for snapshots is less than that
+reserved space, there is "reserved free" and "reserved used" space in addition
+to "free" and "used". If the space required for snapshots exceeds the reserved
+space, that part allocated in the normal space is subtracted from the "used"
+space again.

 
 Repeat this option to specify multiple volumes.
 
 =item B<IgnoreSelectedSnapshot>
 
 
 Repeat this option to specify multiple volumes.
 
 =item B<IgnoreSelectedSnapshot>
 

-Specify whether to collect only the volumes selected by the B<Snapshot> option
-or to ignore those volumes. B<IgnoreSelectedSnapshot> defaults to B<false>.
-However, if no B<Snapshot> option is specified at all, all capacities will be
-selected anyway.
+Specify whether to collect only the volumes selected by the B<GetSnapshot>
+option or to ignore those volumes. B<IgnoreSelectedSnapshot> defaults to
+B<false>. However, if no B<GetSnapshot> option is specified at all, all
+capacities will be selected anyway.

 
 =back
 
 
 =back