X-Git-Url: https://git.octo.it/?a=blobdiff_plain;f=src%2Fcollectd.conf.pod;h=c92e3fdeb2a3bfd565d716cfd8ffd28c6d667123;hb=8f699d27b3ee4b4ab3377ac4d5c2edab064f23ac;hp=b392baa3b3fd5dcb3ec8504c75dbd3a164a1c9c5;hpb=c0e8b0392fed8ee776db4942af52be4d4b83069d;p=collectd.git diff --git a/src/collectd.conf.pod b/src/collectd.conf.pod index b392baa3..c92e3fde 100644 --- a/src/collectd.conf.pod +++ b/src/collectd.conf.pod @@ -1624,6 +1624,7 @@ finance page and dispatch the value to collectd. + Plugin "quotes" URL "http://finance.google.com/finance?q=NYSE%3AAMD" User "foo" Password "bar" @@ -1655,6 +1656,11 @@ The following options are valid within B blocks: =over 4 +=item B I + +Use I as the plugin name when submitting values. +Defaults to C. + =item B I URL of the web site to retrieve. Since a regular expression will be used to @@ -1815,6 +1821,11 @@ The following options are valid within B blocks: Use I as the host name when submitting values. Defaults to the global host name setting. +=item B I + +Use I as the plugin name when submitting values. +Defaults to C. + =item B I Sets the plugin instance to I. @@ -1877,6 +1888,7 @@ The B uses B (L) and B Host "my_host" + #Plugin "curl_xml" Instance "some_instance" User "collectd" Password "thaiNg0I" @@ -1890,6 +1902,7 @@ The B uses B (L) and B Type "magic_level" #InstancePrefix "prefix-" InstanceFrom "td[1]" + #PluginInstanceFrom "td[1]" ValuesFrom "td[2]/span[@class=\"level\"]" @@ -1915,10 +1928,16 @@ Within the B block the following options are accepted: Use I as the host name when submitting values. Defaults to the global host name setting. +=item B I + +Use I as the plugin name when submitting values. +Defaults to 'curl_xml'. + =item B I -Use I as the plugin instance when submitting values. Defaults to an -empty string (no plugin instance). +Use I as the plugin instance when submitting values. +May be overridden by B option inside B blocks. +Defaults to an empty string (no plugin instance). =item B I I @@ -1989,9 +2008,19 @@ Specifies a XPath expression to use for determining the I. The XPath expression must return exactly one element. The element's value is then used as I, possibly prefixed with I (see above). -This value is required. As a special exception, if the "base XPath expression" -(the argument to the B block) returns exactly one argument, then this -option may be omitted. +=item B I + +Specifies a XPath expression to use for determining the I. The +XPath expression must return exactly one element. The element's value is then +used as I. + +=back + +If the "base XPath expression" (the argument to the B block) returns +exactly one argument, then I and I may be omitted. +Otherwise, at least one of I or I is required. + +=over 4 =item B I [I ...] @@ -2000,6 +2029,7 @@ number of XPath expressions must match the number of data sources in the I specified with B (see above). Each XPath expression must return exactly one element. The element's value is then parsed as a number and used as value for the appropriate value in the value list dispatched to the daemon. +This option is required. =back @@ -2030,6 +2060,7 @@ than those of other plugins. It usually looks something like this: + #Plugin "warehouse" Driver "mysql" Interval 120 DriverOption "host" "localhost" @@ -2211,6 +2242,11 @@ the daemon. Other than that, that name is not used. =over 4 +=item B I + +Use I as the plugin name when submitting query results from +this B. Defaults to C. + =item B I Sets the interval (in seconds) in which the values will be collected from this @@ -2798,6 +2834,11 @@ Controls whether or not to include "hidden" files and directories in the count. "Hidden" files and directories are those, whose name begins with a dot. Defaults to I, i.e. by default hidden files and directories are ignored. +=item B I|I + +Controls whether or not to include only regular files in the count. +Defaults to I, i.e. by default non regular files are ignored. + =item B I Sets the type used to dispatch files combined size. Empty value ("") disables @@ -3315,8 +3356,43 @@ This option is only available on Solaris. =head2 Plugin C +The B allows to monitor server platform status using the Intelligent +Platform Management Interface (IPMI). Local and remote interfaces are supported. + +The plugin configuration consists of one or more B blocks which +specify one I connection each. Each block requires one unique string +argument as the instance name. If instances are not configured, an instance with +the default option values will be created. + +For backwards compatibility, any option other than B block will trigger +legacy config handling and it will be treated as an option within B +block. This support will go away in the next major version of Collectd. + +Within the B blocks, the following options are allowed: + =over 4 +=item B
I
+ +Hostname or IP to connect to. If not specified, plugin will try to connect to +local management controller (BMC). + +=item B I + +=item B I + +The username and the password to use for the connection to remote BMC. + +=item B I|I + +Forces the authentication type to use for the connection to remote BMC. +By default most secure type is seleted. + +=item B I + +Sets the B field of dispatched values. Defaults to the global hostname +setting. + =item B I Selects sensors to collect or to ignore, depending on B. @@ -3345,6 +3421,24 @@ If a sensor disappears a notification is sent. If you have for example dual power supply and one of them is (un)plugged then a notification is sent. +=item B I|I + +If a IPMI connection state changes after initialization time of a minute +a notification is sent. Defaults to B. + +=item B I|I + +If system event log (SEL) is enabled, plugin will listen for sensor threshold +and discrete events. When event is received the notification is sent. +Defaults to B. + +=item B I|I + +If SEL clear event is enabled, plugin will delete event from SEL list after +it is received and successfully handled. In this case other tools that are +subscribed for SEL events will receive an empty event. +Defaults to B. + =back =head2 Plugin C @@ -3673,6 +3767,7 @@ Synopsis of the configuration: Server "localhost" Key "page_key" + Plugin "plugin_name" Regex "(\\d+) bytes sent" DSType CounterAdd @@ -3700,6 +3795,11 @@ B block. When connected to the memcached server, asks for the page I. +=item B I + +Use I as the plugin name when submitting values. +Defaults to C. + =item EBE Match blocks define which strings to look for and how matches substrings are @@ -5748,6 +5848,7 @@ plugin's documentation above for details. + #Plugin "warehouse" ConnectID "db01" Username "oracle" Password "secret" @@ -5770,6 +5871,11 @@ values submitted to the daemon. Other than that, that name is not used. =over 4 +=item B I + +Use I as the plugin name when submitting query results from +this B. Defaults to C. + =item B I Defines the "database alias" or "service name" to connect to. Usually, these @@ -5825,7 +5931,7 @@ The address of the OVS DB server JSON-RPC interface used by the plugin. To enable the interface, OVS DB daemon should be running with C<--remote=ptcp:> option. See L for more details. The option may be either network hostname, IPv4 numbers-and-dots notation or IPv6 hexadecimal string -format. Defaults to B<'localhost'>. +format. Defaults to C. =item B I @@ -5891,7 +5997,7 @@ The address of the OVS DB server JSON-RPC interface used by the plugin. To enable the interface, OVS DB daemon should be running with C<--remote=ptcp:> option. See L for more details. The option may be either network hostname, IPv4 numbers-and-dots notation or IPv6 hexadecimal string -format. Defaults to B<'localhost'>. +format. Defaults to C. =item B I @@ -6123,6 +6229,7 @@ L. + Plugin "kingdom" Host "hostname" Port "5432" User "username" @@ -6444,6 +6551,11 @@ activating this option. The draw-back is, that data covering the specified amount of time will be lost, for example, if a single statement within the transaction fails or if the database server crashes. +=item B I + +Use I as the plugin name when submitting query results from +this B. Defaults to C. + =item B I Specify the plugin instance name that should be used instead of the database @@ -7710,6 +7822,7 @@ user using (extended) regular expressions, as described in L. + Plugin "mail" Instance "exim" Interval 60 @@ -7742,11 +7855,13 @@ The config consists of one or more B blocks, each of which configures one logfile to parse. Within each B block, there are one or more B blocks, which configure a regular expression to search for. -The B option in the B block may be used to set the plugin -instance. So in the above example the plugin name C would be used. -This plugin instance is for all B blocks that B it, until the -next B option. This way you can extract several plugin instances from -one logfile, handy when parsing syslog and the like. +The B and B options in the B block may be used to set +the plugin name and instance respectively. So in the above example the plugin name +C would be used. + +These options are applied for all B blocks that B it, until the +next B or B option. This way you can extract several plugin +instances from one logfile, handy when parsing syslog and the like. The B option allows you to define the length of time between reads. If this is not set, the default Interval will be used. @@ -7934,7 +8049,8 @@ B Index 1 - Instance "snort-eth0" + Plugin "snortstats" + Instance "eth0" Interval 600 Collect "snort-dropped" @@ -7986,6 +8102,11 @@ I block but there can be multiple if you have multiple CSV files. =over 4 +=item B I + +Use I as the plugin name when submitting values. +Defaults to C. + =item B I Sets the I used when dispatching the values. @@ -8362,6 +8483,7 @@ Synopsis: CollectManagement false CollectSMF false CollectVBE false + CollectMSE false @@ -8437,11 +8559,9 @@ log messages which is flushed to disk when full. True by default. =item B B|B malloc or umem (umem_alloc(3MALLOC) based) storage statistics. The umem storage -component is Solaris specific. -Note: SMA and SMF share counters, enable only the one used by the Varnish -instance. -Only available with Varnish 2.x. False by -default. +component is Solaris specific. Note: SMA, SMF and MSE share counters, enable +only the one used by the Varnish instance. Only available with Varnish 2.x. +False by default. =item B B|B @@ -8489,9 +8609,8 @@ Backend counters. Only available with Varnish 4.x. False by default. =item B B|B file (memory mapped file) storage statistics. Only available with Varnish 4.x. -Note: SMA and SMF share counters, enable only the one used by the Varnish -instance. -Used to be called SM in Varnish 2.x. False by default. +Note: SMA, SMF and MSE share counters, enable only the one used by the Varnish +instance. Used to be called SM in Varnish 2.x. False by default. =item B B|B @@ -8505,6 +8624,13 @@ Lock counters. Only available with Varnish 4.x. False by default. Memory pool counters. Only available with Varnish 4.x. False by default. +=item B B|B + +Varnish Massive Storage Engine 2.0 (MSE2) is an improved storage backend for +Varnish, replacing the traditional malloc and file storages. Only available +with Varnish-Plus 4.x. Note: SMA, SMF and MSE share counters, enable only the +one used by the Varnish instance. False by default. + =back =head2 Plugin C @@ -9149,6 +9275,12 @@ Sets the Cassandra ttl for the data points. Please refer to L +=item B I + +Only available for the KAIROSDB output format. + +Sets the metrics prefix I. Defaults to I. + =item B B|B Controls whether I are POSTed to this location. Defaults to B. @@ -9330,6 +9462,7 @@ Synopsis: Prefix "collectd/" Database 1 MaxSetSize -1 + MaxSetDuration -1 StoreRates true @@ -9392,6 +9525,12 @@ to C<0>. The B option limits the number of items that the I can hold. Negative values for I sets no limit, which is the default behavior. +=item B I + +The B option limits the duration of items that the +I can hold. Negative values for I sets no duration, which +is the default behavior. + =item B B|B If set to B (the default), convert counter values to rates. If set to