netapp plugin: Refactored volume usage statistics.

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

diff --git a/src/collectd.conf.pod b/src/collectd.conf.pod
index cdfb9ac..f1d1ad9 100644 (file)
--- a/src/collectd.conf.pod
+++ b/src/collectd.conf.pod
@@ -1667,18 +1667,39 @@ Required capabilities are documented below.
     User          "username"
     Password      "aef4Aebe"
     Interval      30
     User          "username"
     Password      "aef4Aebe"
     Interval      30

-    <GetSystemPerfData>
-    </GetSystemPerfData>
-    <GetWaflPerfData>
-    </GetWaflPerfData>
+    
+    <WAFL>
+      Interval 30
+      GetNameCache   true
+      GetDirCache    true
+      GetBufferCache true
+      GetInodeCache  true
+    </WAFL>
+    

     <Disks>
       Interval 30
       GetBusy true
     </Disks>
     <Disks>
       Interval 30
       GetBusy true
     </Disks>

+    

     <GetVolumePerfData>
     </GetVolumePerfData>
     <GetVolumePerfData>
     </GetVolumePerfData>

-    <GetVolumeData>
-    </GetVolumeData>
+    
+    <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>
 
    </Host>
  </Plugin>
 


@@ -1761,7 +1782,7 @@ Default: 1
 
 =back
 
 
 =back
 

-=head3 The GetSystemPerfData block
+=head3 The System block

 
 This will collect various performance data about the whole system.
 
 
 This will collect various performance data about the whole system.
 


@@ -1770,6 +1791,10 @@ B<Note:> To get this data the collectd user needs the
 
 =over 4
 
 
 =over 4
 

+=item B<Interval> I<Seconds>
+
+Collect disk statistics every I<Seconds> seconds.
+

 =item B<GetCPULoad> B<true>|B<false>
 
 If you set this option to true the current CPU usage will be read. This will be
 =item B<GetCPULoad> B<true>|B<false>
 
 If you set this option to true the current CPU usage will be read. This will be


@@ -1845,7 +1870,7 @@ type instance.
 
 =back
 
 
 =back
 

-=head3 The GetWaflPerfData block
+=head3 The WAFL block

 
 This will collect various performance data about the WAFL file system. At the
 moment this just means cache performance.
 
 This will collect various performance data about the WAFL file system. At the
 moment this just means cache performance.


@@ -1859,6 +1884,10 @@ releases.
 
 =over 4
 
 
 =over 4
 

+=item B<Interval> I<Seconds>
+
+Collect disk statistics every I<Seconds> seconds.
+

 =item B<GetNameCache> B<true>|B<false>
 
 Optional
 =item B<GetNameCache> B<true>|B<false>
 
 Optional


@@ -1891,7 +1920,7 @@ Default: true
 Result: One value list of type "cache_ratio" and type instance
 "inode_cache_hit".
 
 Result: One value list of type "cache_ratio" and type instance
 "inode_cache_hit".
 

-=item B<GetBufCache> B<true>|B<false>
+=item B<GetBufferCache> B<true>|B<false>

 
 B<Note:> This is the same value that the NetApp CLI command "sysstat" returns
 in the "Cache hit" field.
 
 B<Note:> This is the same value that the NetApp CLI command "sysstat" returns
 in the "Cache hit" field.


@@ -1998,19 +2027,16 @@ plugin_instance.
 
 =back
 
 
 =back
 

-=head3 The GetVolumeData block
+=head3 The VolumeUsage block

 
 This will collect capacity data about the individual volumes.
 
 
 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
 
 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
 
 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


@@ -2028,15 +2054,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.
 
 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
 
 
 =back