netapp plugin: Refactor the VolumePerf collection.
[collectd.git] / src / collectd.conf.pod
index fa38b89..f3f2f48 100644 (file)
@@ -1667,13 +1667,7 @@ Required capabilities are documented below.
     User          "username"
     Password      "aef4Aebe"
     Interval      30
-    <System>
-      Interval 30
-      GetCPULoad     true
-      GetInterfaces  true
-      GetDiskOps     true
-      GetDiskIO      true
-    </System>
+    
     <WAFL>
       Interval 30
       GetNameCache   true
@@ -1681,14 +1675,37 @@ Required capabilities are documented below.
       GetBufferCache true
       GetInodeCache  true
     </WAFL>
+    
     <Disks>
       Interval 30
       GetBusy true
     </Disks>
-    <GetVolumePerfData>
-    </GetVolumePerfData>
-    <GetVolumeData>
-    </GetVolumeData>
+    
+    <VolumePerf>
+      GetIO      "volume0"
+      IgnoreSelectedIO      false
+      GetOps     "volume0"
+      IgnoreSelectedOps     false
+      GetLatency "volume0"
+      IgnoreSelectedLatency false
+    </VolumePerf>
+    
+    <VolumeUsage>
+      Capacity "vol0"
+      Capacity "vol1"
+      IgnoreSelectedCapacity false
+      Snapshot "vol1"
+      Snapshot "vol3"
+      IgnoreSelectedSnapshot false
+    </VolumeUsage>
+    
+    <System>
+      Interval 30
+      GetCPULoad     true
+      GetInterfaces  true
+      GetDiskOps     true
+      GetDiskIO      true
+    </System>
    </Host>
  </Plugin>
 
@@ -1955,80 +1972,70 @@ Result: One value list of type "percent" and type instance "disk_busy".
 
 =back
 
-=head3 The GetVolumePerfData block
+=head3 The VolumePerf block
 
 This will collect various performance data about the individual volumes.
 
-All of these options take a list of volumes as parameters. In this case
-"volume" means just the name of the volume, without the "/vol/" prefix or
-anything like that.
-
-The special values "-" and "+" are supported. "-" means "don't collect values
-for any volumes". "+" means "collect values for all volumes, even volumes that
-are created after collectd was started." Additionally you can prefix a volume
-name with a "-" sign to exclude this one volume. Eg '"+" "-vol0"' collectes
-values for all volumes except vol0.  The order of the parameters is important.
-'"-vol0" "+"' doesn't make sense because the "+" overrides the earlier "-vol0".
+You can select which data to collect about which volume using the following
+options. They follow the standard ignorelist semantic.
 
 B<Note:> To get this data the collectd user needs the
-"api-perf-object-get-instances" capability.
+I<api-perf-object-get-instances> capability.
 
 =over 4
 
-=item B<GetIO> I<Volume> [I<Volume> ...]
-The current IO throughput will be read for every volume specified here.
-
-Optional
+=item B<GetIO> I<Volume>
 
-Type: list of strings
+=item B<GetOps> I<Volume>
 
-Default: "+"
+=item B<GetLatency> I<Volume>
 
-Result: Data sources of type "disk_octets" and the name of the volume as
-plugin_instance.
+Select the given volume for IO, operations or latency statistics collection.
+The argument is the name of the volume without the C</vol/> prefix.
 
-=item B<GetOps> I<Volume> [I<Volume> ...]
+Since the standard ignorelist functionality is used here, you can use a string
+starting and ending with a slash to specify regular expression matching: To
+match the volumes "vol0", "vol2" and "vol7", you can use this regular
+expression:
 
-The current number of operation will be read for every volume specified here. 
+  GetIO "/^vol[027]$/"
 
-Optional
+If no regular expression is specified, an exact match is required. Both,
+regular and exact matching are case sensitive.
 
-Type: list of strings
+If no volume was specified at all for either of the three options, that data
+will be collected for all available volumes.
 
-Default: "+"
+=item B<IgnoreSelectedIO> B<true>|B<false>
 
-Result: Data sources of type "disk_ops" and the name of the volume as
-plugin_instance.
+=item B<IgnoreSelectedOps> B<true>|B<false>
 
-=item B<GetLatency> I<Volume> [I<Volume> ...]
+=item B<IgnoreSelectedLatency> B<true>|B<false>
 
-The current latency for volume access in microseconds will be read for every
-volume specified here. 
+When set to B<true>, the volumes selected for IO, operations or latency
+statistics collection will be ignored and the data will be collected for all
+other volumes.
 
-Optional
+When set to B<false>, data will only be collected for the specified volumes and
+all other volumes will be ignored.
 
-Type: list of strings
+If no volumes have been specified with the above B<Get*> options, all volumes
+will be collected regardless of the B<IgnoreSelected*> option.
 
-Default: "+"
-
-Result: Data sources of type "disk_latency" and the name of the volume as
-plugin_instance.
+Defaults to B<false>
 
 =back
 
-=head3 The GetVolumeData block
+=head3 The VolumeUsage block
 
 This will collect capacity data about the individual volumes.
 
-All of these options take a list of volumes as parameters, just like the
-GetVolumePerfData options.
-
-B<Note:> To get this data the collectd user needs the "api-volume-list-info"
+B<Note:> To get this data the collectd user needs the I<api-volume-list-info>
 capability.
 
 =over 4
 
-=item B<GetDiskUtil>
+=item B<Capacity> 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
@@ -2046,15 +2053,27 @@ reported as a 32E<nbsp>bit number. This plugin tries to guess the correct
 number which works most of the time.  If you see strange values here, bug
 NetApp support to fix this.
 
-Optional
+Repeat this option to specify multiple volumes.
 
-Type: list of strings
+=item B<IgnoreSelectedCapacity> B<true>|B<false>
 
-Default: "+"
+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.
 
-=item B<GetSnapData>
+=item B<Snapshot> I<VolumeName>
 
-B<TODO>
+B<Defunct!> Select volumes from which to collect snapshot information.
+
+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.
 
 =back