X-Git-Url: https://git.octo.it/?a=blobdiff_plain;f=src%2Fcollectd.conf.pod;h=e2cb799ee1238f2707f5dcf35f7689824681341b;hb=5ad3a491af300d7336112607e20b0364d1f3f2bb;hp=f3f2f48f7bb266cb056f36e4cbe6d8bc48c737a0;hpb=9a9d3f9ca9e26aa0dd3eb61a75a0729b915190a1;p=collectd.git diff --git a/src/collectd.conf.pod b/src/collectd.conf.pod index f3f2f48f..e2cb799e 100644 --- a/src/collectd.conf.pod +++ b/src/collectd.conf.pod @@ -503,14 +503,16 @@ and are checked by default depends on the distribution you use. =item B B|B -Measure response time for the request. Disabled by default. +Measure response time for the request. If this setting is enabled, B +blocks (see below) are optional. Disabled by default. =item BMatchE> One or more B blocks that define how to match information in the data returned by C. The C plugin uses the same infrastructure that's used by the C plugin, so please see the documentation of the C -plugin below on how matches are defined. +plugin below on how matches are defined. If the B option +is set to B, B blocks are optional. =back @@ -870,19 +872,44 @@ Select partitions based on the mountpoint. Select partitions based on the filesystem type. -=item B I|I +=item B B|B Invert the selection: If set to true, all partitions B the ones that match any one of the criteria are collected. By default only selected partitions are collected if a selection is made. If no selection is configured at all, B partitions are selected. -=item B I|I +=item B B|B Report using the device name rather than the mountpoint. i.e. with this I, (the default), it will report a disk as "root", but with it I, it will be "sda1" (or whichever). +=item B B|B + +When enabled, the blocks reserved for root are reported separately. When +disabled (the default for backwards compatibility reasons) the reserved space +will be included in the "free" space. + +When disabled, the "df" type will be used to store "free" and "used" space. The +mount point or disk name (see option B) is used as type +instance in this case (again: backwards compatibility). + +When enabled, the type "df_complex" is used and three files are created. The +mount point or disk name is used as plugin instance and the type instance is +set to "free", "reserved" and "used" as appropriate. + +Enabling this option is recommended. + +=item B B|B + +Enables or disables reporting of free, reserved and used inodes. Defaults to +inode collection being disabled. + +Enable this option if inodes are a scarce resource for you, usually because +many small files are stored on the disk. This is a usual scenario for mail +transfer agents and web caches. + =back =head2 Plugin C @@ -1649,6 +1676,15 @@ or SQL threads are not running. The netapp plugin can collect various performance and capacity informations from a NetApp filer using the NetApp API. +Please note that NetApp has a wide line of products and a lot of different +software versions for each of these products. This plugin was developed for a +NetApp FAS3040 running OnTap 7.2.3P8 and tested on FAS2050 7.3.1.1L1, +FAS3140 7.2.5.1 and FAS3020 7.2.4P9. It I work for most combinations of +model and software version but it is very hard to test this. +If you have used this plugin with other models and/or software version, feel +free to send us a mail to tell us about the results, even if it's just a short +"It works". + To collect these data collectd will log in to the NetApp via HTTP(S) and HTTP basic authentication. @@ -1682,6 +1718,7 @@ Required capabilities are documented below. + Interval 30 GetIO "volume0" IgnoreSelectedIO false GetOps "volume0" @@ -1691,11 +1728,12 @@ Required capabilities are documented below. - Capacity "vol0" - Capacity "vol1" + Interval 30 + GetCapacity "vol0" + GetCapacity "vol1" IgnoreSelectedCapacity false - Snapshot "vol1" - Snapshot "vol3" + GetSnapshot "vol1" + GetSnapshot "vol3" IgnoreSelectedSnapshot false @@ -1775,16 +1813,10 @@ 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 @@ -1984,6 +2016,10 @@ I capability. =over 4 +=item B I + +Collect volume performance data every I seconds. + =item B I =item B I @@ -2035,7 +2071,11 @@ capability. =over 4 -=item B I +=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 @@ -2057,23 +2097,34 @@ Repeat this option to specify multiple volumes. =item B B|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. +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 I +=item B I -B Select volumes from which to collect snapshot information. +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. +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 @@ -2301,6 +2352,14 @@ normally doesn't do much, this value should not be too small. The default is 1800 seconds, but setting this to 86400 seconds (one day) will not do much harm either. +=item B B|B + +The network plugin cannot only receive and send statistics, it can also create +statistics about itself. Collected data included the number of received and +sent octets and packets, the length of the receive queue and the number of +values handled. When set to B, the I will make these +statistics available. Defaults to B. + =back =head2 Plugin C @@ -2602,6 +2661,12 @@ Available options: Specifies the location of the status file. +=item B B|B + +Sets whether or not statistics about the compression used by OpenVPN should be +collected. This information is only available in I mode. Enabled by +default. + =back =head2 Plugin C @@ -2711,6 +2776,24 @@ Default: B<0.9> Sets the Time-To-Live of generated ICMP packets. +=item B I + +Sets the source address to use. I may either be a numerical network +address or a network hostname. + +=item B I + +Sets the outgoing network device to be used. I has to specify an +interface name (e.Eg. C). This might not be supported by all +operating systems. + +=item B I + +Trigger a DNS resolv after the host has not replied to I packets. This +enables the use of dynamic DNS services (like dyndns.org) with the ping plugin. + +Default: B<-1> (disabled) + =back =head2 Plugin C @@ -3187,7 +3270,7 @@ C/var/run/collectd-powerdns>. Select more detailed statistics of processes matching this name. The statistics collected for these selected processes are size of the resident segment size (RSS), user- and system-time used, number of processes and number of threads, -and minor and major pagefaults. +io data (where available) and minor and major pagefaults. =item B I I @@ -3233,6 +3316,71 @@ matching values will be ignored. =back +=head2 Plugin C + +This plugin embeds a Python-interpreter into collectd and provides an interface +to collectd's plugin system. See L for its documentation. + +=head2 Plugin C + +The C plugin connects to a device running I, the +Linux-based operating system for routers by I. The plugin uses +I to connect and reads information about the interfaces and +wireless connections of the device. The configuration supports querying +multiple routers: + + + + Host "router0.example.com" + User "collectd" + Password "secr3t" + CollectInterface true + + + Host "router1.example.com" + User "collectd" + Password "5ecret" + CollectInterface true + CollectRegistrationTable true + + + +As you can see above, the configuration of the I plugin consists of +one or more BRouterE> blocks. Within each block, the following +options are understood: + +=over 4 + +=item B I + +Hostname or IP-address of the router to connect to. + +=item B I + +Port name or port number used when connecting. If left unspecified, the default +will be chosen by I, currently "8728". This option expects a +string argument, even when a numeric port number is given. + +=item B I + +Use the user name I to authenticate. Defaults to "admin". + +=item B I + +Set the password used to authenticate. + +=item B B|B + +When set to B, interface statistics will be collected for all interfaces +present on the device. Defaults to B. + +=item B B|B + +When set to B, information about wireless LAN connections will be +collected. Defaults to B. + +=back + =head2 Plugin C The C plugin uses the RRDtool accelerator daemon, L, @@ -4592,6 +4740,77 @@ time. If the counter is reset for some reason (machine or service restarted, usually), the graph will be empty (NAN) for a long time. People may not understand why. +=item B + +Calculates a hash value of the host name and matches values according to that +hash value. This makes it possible to divide all hosts into groups and match +only values that are in a specific group. The intended use is in load +balancing, where you want to handle only part of all data and leave the rest +for other servers. + +The hashing function used tries to distribute the hosts evenly. First, it +calculates a 32Ebit hash value using the characters of the hostname: + + hash_value = 0; + for (i = 0; host[i] != 0; i++) + hash_value = (hash_value * 251) + host[i]; + +The constant 251 is a prime number which is supposed to make this hash value +more random. The code then checks the group for this host according to the +I and I arguments: + + if ((hash_value % Total) == Match) + matches; + else + does not match; + +Please note that when you set I to two (i.Ee. you have only two +groups), then the least significant bit of the hash value will be the XOR of +all least significant bits in the host name. One consequence is that when you +have two hosts, "server0.example.com" and "server1.example.com", where the host +name differs in one digit only and the digits differ by one, those hosts will +never end up in the same group. + +Available options: + +=over 4 + +=item B I I + +Divide the data into I groups and match all hosts in group I as +described above. The groups are numbered from zero, i.Ee. I must +be smaller than I. I must be at least one, although only values +greater than one really do make any sense. + +You can repeat this option to match multiple groups, for example: + + Match 3 7 + Match 5 7 + +The above config will divide the data into seven groups and match groups three +and five. One use would be to keep every value on two hosts so that if one +fails the missing data can later be reconstructed from the second host. + +=back + +Example: + + # Operate on the pre-cache chain, so that ignored values are not even in the + # global cache. + + + + # Divide all received hosts in seven groups and accept all hosts in + # group three. + Match 3 7 + + # If matched: Return and continue. + Target "return" + + # If not matched: Return and stop. + Target "stop" + + =back =head2 Available targets