X-Git-Url: https://git.octo.it/?a=blobdiff_plain;f=src%2Fcollectd.conf.pod;h=f7531cd8805ae575f140c82eabd6ecfd3fb8d54e;hb=6f4e737d0e88e41e94d422f54509f12cac365be6;hp=cdfb9ac8bbe6f193f2176edf2dea4cf7f3c33b8c;hpb=2cd802b86c3fbf7f67fc8a874a28fde87fbf6cab;p=collectd.git
diff --git a/src/collectd.conf.pod b/src/collectd.conf.pod
index cdfb9ac8..f7531cd8 100644
--- a/src/collectd.conf.pod
+++ b/src/collectd.conf.pod
@@ -1667,18 +1667,47 @@ Required capabilities are documented below.
User "username"
Password "aef4Aebe"
Interval 30
-
-
-
-
+
+
+ Interval 30
+ GetNameCache true
+ GetDirCache true
+ GetBufferCache true
+ GetInodeCache true
+
+
Interval 30
GetBusy true
-
-
-
-
+
+
+ Interval 30
+ GetIO "volume0"
+ IgnoreSelectedIO false
+ GetOps "volume0"
+ IgnoreSelectedOps false
+ GetLatency "volume0"
+ IgnoreSelectedLatency false
+
+
+
+ Interval 30
+ GetCapacity "vol0"
+ GetCapacity "vol1"
+ IgnoreSelectedCapacity false
+ GetSnapshot "vol1"
+ GetSnapshot "vol3"
+ IgnoreSelectedSnapshot false
+
+
+
+ Interval 30
+ GetCPULoad true
+ GetInterfaces true
+ GetDiskOps true
+ GetDiskIO true
+
@@ -1748,20 +1777,14 @@ The following options are valid inside all blocks:
=over 4
-=item B I
-
-The host specific interval between data collections is multiplied by this value
-for collecting these data.
-
-Optional
-
-Type: integer
+=item B I
-Default: 1
+Collect the respective statistics every I seconds. Defaults to the
+host specific setting.
=back
-=head3 The GetSystemPerfData block
+=head3 The System block
This will collect various performance data about the whole system.
@@ -1770,6 +1793,10 @@ B To get this data the collectd user needs the
=over 4
+=item B I
+
+Collect disk statistics every I seconds.
+
=item B B|B
If you set this option to true the current CPU usage will be read. This will be
@@ -1845,7 +1872,7 @@ type instance.
=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.
@@ -1859,6 +1886,10 @@ releases.
=over 4
+=item B I
+
+Collect disk statistics every I seconds.
+
=item B B|B
Optional
@@ -1891,7 +1922,7 @@ Default: true
Result: One value list of type "cache_ratio" and type instance
"inode_cache_hit".
-=item B B|B
+=item B B|B
B This is the same value that the NetApp CLI command "sysstat" returns
in the "Cache hit" field.
@@ -1937,80 +1968,78 @@ 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 To get this data the collectd user needs the
-"api-perf-object-get-instances" capability.
+I capability.
=over 4
-=item B I [I ...]
-The current IO throughput will be read for every volume specified here.
+=item B I
-Optional
+Collect volume performance data every I seconds.
-Type: list of strings
+=item B I
-Default: "+"
+=item B I
-Result: Data sources of type "disk_octets" and the name of the volume as
-plugin_instance.
+=item B I
-=item B I [I ...]
+Select the given volume for IO, operations or latency statistics collection.
+The argument is the name of the volume without the C prefix.
-The current number of operation will be read for every volume specified here.
+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:
-Optional
+ GetIO "/^vol[027]$/"
-Type: list of strings
+If no regular expression is specified, an exact match is required. Both,
+regular and exact matching are case sensitive.
-Default: "+"
+If no volume was specified at all for either of the three options, that data
+will be collected for all available volumes.
-Result: Data sources of type "disk_ops" and the name of the volume as
-plugin_instance.
+=item B B|B
-=item B I [I ...]
+=item B B|B
-The current latency for volume access in microseconds will be read for every
-volume specified here.
+=item B B|B
-Optional
+When set to B, the volumes selected for IO, operations or latency
+statistics collection will be ignored and the data will be collected for all
+other volumes.
-Type: list of strings
+When set to B, data will only be collected for the specified volumes and
+all other volumes will be ignored.
-Default: "+"
+If no volumes have been specified with the above B options, all volumes
+will be collected regardless of the B option.
-Result: Data sources of type "disk_latency" and the name of the volume as
-plugin_instance.
+Defaults to B
=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 To get this data the collectd user needs the "api-volume-list-info"
+B To get this data the collectd user needs the I
capability.
=over 4
-=item B
+=item B I
+
+Collect volume usage statistics every I seconds.
+
+=item B I
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 +2057,38 @@ reported as a 32Ebit 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 B|B
-Default: "+"
+Specify whether to collect only the volumes selected by the B
+option or to ignore those volumes. B defaults to
+B. However, if no B option is specified at all, all
+capacities will be selected anyway.
-=item B
+=item B I
-B
+Select volumes from which to collect snapshot information.
+
+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.
+
+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
+
+Specify whether to collect only the volumes selected by the B
+option or to ignore those volumes. B defaults to
+B. However, if no B option is specified at all, all
+capacities will be selected anyway.
=back