X-Git-Url: https://git.octo.it/?a=blobdiff_plain;f=src%2Fcollectd.conf.pod;h=94774e27aa0ef6b4ffb3c8ecea50c7a3158edbd9;hb=806fa5b74de3c38fa1a8be339653da2e108ac543;hp=3b9d664d201403706195b778d28ffd5c02a9b15b;hpb=9ea04e3e99a0b14e001ad1be6030815a236dc91c;p=collectd.git diff --git a/src/collectd.conf.pod b/src/collectd.conf.pod index 3b9d664d..94774e27 100644 --- a/src/collectd.conf.pod +++ b/src/collectd.conf.pod @@ -1888,6 +1888,7 @@ The B uses B (L) and B Host "my_host" + #Plugin "curl_xml" Instance "some_instance" User "collectd" Password "thaiNg0I" @@ -1901,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\"]" @@ -1926,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 @@ -2000,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 ...] @@ -2011,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 @@ -2041,6 +2060,7 @@ than those of other plugins. It usually looks something like this: + #Plugin "warehouse" Driver "mysql" Interval 120 DriverOption "host" "localhost" @@ -2222,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 @@ -2547,6 +2572,8 @@ B MemoryChannels "4" FilePrefix "rte" SocketMemory "1024" + LogLevel "7" + RteDriverLibPath "/usr/lib/dpdk-pmd" SharedMemObj "dpdk_collectd_stats_0" EnabledPortMask 0xffff @@ -2579,6 +2606,20 @@ The prefix text used for hugepage filenames. The filename will be set to A string containing amount of Memory to allocate from hugepages on specific sockets in MB. This is an optional value. +=item B I + +A string containing log level number. This parameter is optional. +If parameter is not present then default value "7" - (INFO) is used. +Value "8" - (DEBUG) can be set to enable debug traces. + +=item B I + +A string containing path to shared pmd driver lib or path to directory, +where shared pmd driver libs are available. This parameter is optional. +This parameter enable loading of shared pmd driver libs from defined path. +E.g.: "/usr/lib/dpdk-pmd/librte_pmd_i40e.so" +or "/usr/lib/dpdk-pmd" + =back =over 3 @@ -2809,6 +2850,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 @@ -3326,8 +3372,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. @@ -3356,6 +3437,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 @@ -5765,6 +5864,7 @@ plugin's documentation above for details. + #Plugin "warehouse" ConnectID "db01" Username "oracle" Password "secret" @@ -5787,6 +5887,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 @@ -6140,6 +6245,7 @@ L. + Plugin "kingdom" Host "hostname" Port "5432" User "username" @@ -6152,7 +6258,7 @@ L. Interval 300 Service "service_name" - Query backend # predefined + Query backends # predefined Query rt36_tickets @@ -6461,6 +6567,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 @@ -6714,39 +6825,81 @@ C/var/run/collectd-powerdns>. =head2 Plugin C -=over 4 +Collects information about processes of local system. -=item B I +By default, with no process matches configured, only general statistics is +collected: the number of processes in each state and fork rate. + +Process matches can be configured by B and B options. +These may also be a block in which further options may be specified. -Select more detailed statistics of processes matching this name. The statistics -collected for these selected processes are: +The statistics collected for matched processes are: - size of the resident segment size (RSS) - user- and system-time used - number of processes - number of threads - number of open files (under Linux) + - number of memory mapped files (under Linux) - io data (where available) - context switches (under Linux) - minor and major pagefaults. -Some platforms have a limit on the length of process names. I must stay -below this limit. +B + + + CollectFileDescriptor true + CollectContextSwitch true + Process "name" + ProcessMatch "name" "regex" + + CollectFileDescriptor false + CollectContextSwitch false + + + CollectFileDescriptor false + CollectContextSwitch true + + + +=over 4 + +=item B I + +Select more detailed statistics of processes matching this name. + +Some platforms have a limit on the length of process names. +I must stay below this limit. =item B I I -Similar to the B option this allows one to select more detailed -statistics of processes matching the specified I (see L for -details). The statistics of all matching processes are summed up and -dispatched to the daemon using the specified I as an identifier. This -allows one to "group" several processes together. I must not contain -slashes. +Select more detailed statistics of processes matching the specified I +(see L for details). The statistics of all matching processes are +summed up and dispatched to the daemon using the specified I as an +identifier. This allows one to "group" several processes together. +I must not contain slashes. =item B I -Collect context switch of the process. +Collect the number of context switches for matched processes. +Disabled by default. + +=item B I + +Collect number of file descriptors of matched processes. +Disabled by default. + +=item B I + +Collect the number of memory mapped files of the process. +The limit for this number is configured via F in +the Linux kernel. =back +Options B and B may be used inside +B and B blocks - then they affect corresponding match +only. Otherwise they set the default value for subsequent matches. + =head2 Plugin C Collects a lot of information about various network protocols, such as I, @@ -7537,6 +7690,8 @@ Calculate and dispatch various values out of I metrics received during an interval. If set to B, the default, these values aren't calculated / dispatched. +Please note what reported timer values less than 0.001 are ignored in all B reports. + =back =head2 Plugin C @@ -8381,6 +8536,7 @@ Synopsis: CollectManagement false CollectSMF false CollectVBE false + CollectMSE false @@ -8456,11 +8612,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 @@ -8508,9 +8662,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 @@ -8524,6 +8677,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 @@ -9168,6 +9328,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.