X-Git-Url: https://git.octo.it/?a=blobdiff_plain;f=src%2Fcollectd.conf.pod;h=00cd781abc8846a8c5e7f88ea93dc297b93ad334;hb=e1bfa71aca1f37c2f293dc9adb44065c6e7a9ad9;hp=b154387101f5e29779c7cd9f0d627d00d6ba592f;hpb=6e2f4268da0fc4b3d71e2a558e112a367806d975;p=collectd.git diff --git a/src/collectd.conf.pod b/src/collectd.conf.pod index b1543871..00cd781a 100644 --- a/src/collectd.conf.pod +++ b/src/collectd.conf.pod @@ -241,6 +241,12 @@ Path to the plugins (shared objects) of collectd. Set one or more files that contain the data-set descriptions. See L for a description of the format of this file. +If this option is not specified, a default file is read. If you need to define +custom types in addition to the types defined in the default file, you need to +explicitly load both. In other words, if the B option is encountered +the default behavior is disabled and if you need the default types you have to +also explicitly load them. + =item B I Configures the interval in which to query the read plugins. Obviously smaller @@ -1108,6 +1114,13 @@ When set to B, the battery plugin will report three values: B and "remaining capacity") and B (difference between "design capacity" and "last full capacity"). +=item B B|B + +When set to B, the battery plugin will only read statistics +related to battery performance as exposed by StateFS at +/run/state. StateFS is used in Mer-based Sailfish OS, for +example. + =back =head2 Plugin C @@ -1447,6 +1460,11 @@ are set to B. In this case, by default, metrics will be reported as Jiffies. By setting this option to B, you can request percentage values in the un-aggregated (per-CPU, per-state) mode as well. +=item B B|B + +When set to B, reports the number of available CPUs. +Defaults to B. + =back =head2 Plugin C @@ -1457,6 +1475,16 @@ installed) to get the current CPU frequency. If this file does not exist make sure B (L) or a similar tool is installed and an "cpu governor" (that's a kernel module) is loaded. +=head2 Plugin C + +This plugin doesn't have any options. It reads CLOCK_BOOTTIME and +CLOCK_MONOTONIC and reports the difference between these clocks. Since +BOOTTIME clock increments while device is suspended and MONOTONIC +clock does not, the derivative of the difference between these clocks +gives the relative amount of time the device has spent in suspend +state. The recorded value is in milliseconds of sleep per seconds of +wall clock. + =head2 Plugin C =over 4 @@ -1760,6 +1788,11 @@ The following options are valid within B blocks: =over 4 +=item B I + +Use I as the host name when submitting values. Defaults to the global +host name setting. + =item B I Sets the plugin instance to I. @@ -2351,41 +2384,57 @@ extended NIC stats API in DPDK. B - Interval 1 Coremask "0x4" MemoryChannels "4" ProcessType "secondary" FilePrefix "rte" + EnabledPortMask 0xffff + PortName "interface1" + PortName "interface2" B =over 4 -=item B I - -The interval within which to retrieve stats in seconds. For milliseconds simple -divide the time by 1000 for example if the desired interval is 50ms, set -interval to 0.05. - =item B I -An hexadecimal bit mask of the cores to run on. Note that core numbering can -change between platforms and should be determined beforehand. +A string containing an hexadecimal bit mask of the cores to run on. Note that +core numbering can change between platforms and should be determined beforehand. =item B I -Number of memory channels per processor socket. +A string containing a number of memory channels per processor socket. =item B I -The type of DPDK process instance. +A string containing the type of DPDK process instance. =item B I The prefix text used for hugepage filenames. The filename will be set to /var/run/._config where prefix is what is passed in by the user. +=item B I + +A string containing amount of Memory to allocate from hugepages on specific +sockets in MB + +=item B I + +A hexidecimal bit mask of the DPDK ports which should be enabled. A mask +of 0x0 means that all ports will be disabled. A bitmask of all Fs means +that all ports will be enabled. This is an optional argument - default +is all ports enabled. + +=item B I + +A string containing an optional name for the enabled DPDK ports. Each PortName +option should contain only one port name; specify as many PortName options as +desired. Default naming convention will be used if PortName is blank. If there +are less PortName options than there are enabled ports, the default naming +convention will be used for the additional ports. + =back =head2 Plugin C @@ -2446,7 +2495,7 @@ I will be used. =item B B|B -When set to B, only metrics that can be mapped to to a I will be +When set to B, only metrics that can be mapped to a I will be collected, all other metrics will be ignored. Defaults to B. =back @@ -2676,6 +2725,78 @@ source, this is optional. Otherwise the option is required. =back +=head2 Plugin C + +The C connects to gpsd on the host machine. +The host, port, timeout and pause are configurable. + +This is useful if you run an NTP server using a GPS for source and you want to +monitor it. + +Mind your GPS must send $--GSA for having the data reported! + +The following elements are collected: + +=over 4 + +=item B + +Number of satellites used for fix (type instance "used") and in view (type +instance "visible"). 0 means no GPS satellites are visible. + +=item B + +Vertical and horizontal dilution (type instance "horizontal" or "vertical"). +It should be between 0 and 3. +Look at the documentation of your GPS to know more. + +=back + +Synopsis: + + LoadPlugin gps + + # Connect to localhost on gpsd regular port: + Host "127.0.0.1" + Port "2947" + # 15 ms timeout + Timeout 0.015 + # PauseConnect of 5 sec. between connection attempts. + PauseConnect 5 + + +Available configuration options: + +=over 4 + +=item B I + +The host on which gpsd daemon runs. Defaults to B. + +=item B I + +Port to connect to gpsd on the host machine. Defaults to B<2947>. + +=item B I + +Timeout in seconds (default 0.015 sec). + +The GPS data stream is fetch by the plugin form the daemon. +It waits for data to be available, if none arrives it times out +and loop for another reading. +Mind to put a low value gpsd expects value in the micro-seconds area +(recommended is 500 us) since the waiting function is blocking. +Value must be between 500 us and 5 sec., if outside that range the +default value is applied. + +This only applies from gpsd release-2.95. + +=item B I + +Pause to apply between attempts of connection to gpsd in seconds (default 5 sec). + +=back + =head2 Plugin C The I plugin provides an RPC interface to submit values to or query @@ -2686,6 +2807,33 @@ The B homepage can be found at L. =over 4 +=item B I I + +The B statement sets the address of a server to which to send metrics +via the C function. + +The argument I may be a hostname, an IPv4 address, or an IPv6 address. + +Optionally, B may be specified as a configuration block which supports +the following options: + +=over 4 + +=item B B|B + +Whether to require SSL for outgoing connections. Default: false. + +=item B I + +=item B I + +=item B I + +Filenames specifying SSL certificate and key material to be used with SSL +connections. + +=back + =item B I I The B statement sets the network address to bind to. When multiple @@ -2703,22 +2851,17 @@ supports the following options: Whether to enable SSL for incoming connections. Default: false. -=item B I +=item B I -=item B I +=item B I -=item B I +=item B I Filenames specifying SSL certificate and key material to be used with SSL connections. =back -=item B I - -Number of threads to start for handling incoming connections. The default -value is B<5>. - =back =head2 Plugin C @@ -2744,6 +2887,47 @@ TCP-Port to connect to. Defaults to B<7634>. =back +=head2 Plugin C + +To collect B information, collectd reads directories +"/sys/devices/system/node/*/hugepages" and +"/sys/kernel/mm/hugepages". +Reading of these directories can be disabled by the following +options (default is enabled). + +=over 4 + +=item B B|B + +If enabled, information will be collected from the hugepage +counters in "/sys/devices/system/node/*/hugepages". +This is used to check the per-node hugepage statistics on +a NUMA system. + +=item B B|B + +If enabled, information will be collected from the hugepage +counters in "/sys/kernel/mm/hugepages". +This can be used on both NUMA and non-NUMA systems to check +the overall hugepage statistics. + +=item B B|B + +Whether to report hugepages metrics in number of pages. +Defaults to B. + +=item B B|B + +Whether to report hugepages metrics in bytes. +Defaults to B. + +=item B B|B + +Whether to report hugepages metrics as percentage. +Defaults to B. + +=back + =head2 Plugin C =over 4 @@ -2780,6 +2964,18 @@ This will ignore the loopback interface, all interfaces with names starting with I and all interfaces with names starting with I followed by at least one digit. +=item B I|I + +When set to I, only interfaces with non-zero traffic will be +reported. Note that the check is done by looking into whether a +package was sent at any time from boot and the corresponding counter +is non-zero. So, if the interface has been sending data in the past +since boot, but not during the reported time-interval, it will still +be reported. + +The default value is I and results in collection of the data +from all interfaces that are selected by B and +B options. =item B I|I @@ -3034,6 +3230,12 @@ Defaults to false. =back +=head2 Plugin C + +This plugin embeds a Lua interpreter into collectd and provides an interface +to collectd's plugin system. See L for its documentation. + + =head2 Plugin C The C uses mbmon to retrieve temperature, voltage, etc. @@ -3685,6 +3887,11 @@ Synopsis: Port "3306" MasterStats true ConnectTimeout 10 + SSLKey "/path/to/key.pem" + SSLCert "/path/to/cert.pem" + SSLCA "/path/to/ca.pem" + SSLCAPath "/path/to/cas/" + SSLCipher "DHE-RSA-AES256-SHA" @@ -3694,12 +3901,20 @@ Synopsis: SlaveStats true SlaveNotifications true + + + Alias "galera" + Host "localhost" + Socket "/var/run/mysql/mysqld.sock" + WsrepStats true + A B block defines one connection to a MySQL database. It accepts a single argument which specifies the name of the database. None of the other options are required. MySQL will use default values as documented in the -section "mysql_real_connect()" in the B. +"mysql_real_connect()" and "mysql_ssl_set()" sections in the +B. =over 4 @@ -3764,10 +3979,36 @@ privileges. See the B documentation above. Defaults to B. If enabled, the plugin sends a notification if the replication slave I/O and / or SQL threads are not running. Defaults to B. +=item B I + + Enable the collection of wsrep plugin statistics, used in Master-Master + replication setups like in MySQL Galera/Percona XtraDB Cluster. + User needs only privileges to execute 'SHOW GLOBAL STATUS' + =item B I Sets the connect timeout for the MySQL client. +=item B I + +If provided, the X509 key in PEM format. + +=item B I + +If provided, the X509 cert in PEM format. + +=item B I + +If provided, the CA file in PEM format (check OpenSSL docs). + +=item B I + +If provided, the CA directory (check OpenSSL docs). + +=item B I + +If provided, the SSL cipher to use. + =back =head2 Plugin C @@ -5567,7 +5808,7 @@ values are made available through those parameters: =item B<$1> -The timestamp of the queried value as a floating point number. +The timestamp of the queried value as an RFC 3339-formatted local time. =item B<$2> @@ -7082,7 +7323,7 @@ port in numeric form. =item B I|I If this option is set to I a summary of statistics from all connections -are collectd. This option defaults to I. +are collected. This option defaults to I. =back @@ -7659,6 +7900,32 @@ If set to B, append the name of the I (DS) to the "metric" identifier. If set to B (the default), this is only done when there is more than one DS. +=item B B|B + +If set to B, detect and remove duplicate components in Graphite metric +names. For example, the metric name C will +be shortened to C. + +=back + +=head2 Plugin C + +The C plugin writes metrics as INFO log messages. + +This plugin supports two output formats: I and I. + +Synopsis: + + + Format Graphite + + +=over 4 + +=item B I + +The output format to use. Can be one of C or C. + =back =head2 Plugin C @@ -7863,6 +8130,14 @@ create output in the I (JSON). When set to KAIROSDB Defaults to B. +=item B B|B + +Controls whether I are POSTed to this location. Defaults to B. + +=item B B|B + +Controls whether I are POSTed to this location. Defaults to B. + =item B B If set to B, convert counter values to rates. If set to B (the @@ -8926,6 +9201,8 @@ Available options: =item B I +=item B I I + Match values where the given regular expressions match the various fields of the identifier of a value. If multiple regular expressions are given, B regexen must match for a value to match. @@ -9214,6 +9491,10 @@ Available options: =item B I I +=item B I I I + +=item B I I + Match the appropriate field with the given regular expression I. If the regular expression matches, that part that matches is replaced with I. If multiple places of the input buffer match a given regular @@ -9250,11 +9531,39 @@ Available options: =item B I -=item B I I +=item B I I + +Set the appropriate field to the given string. The strings for plugin instance, +type instance, and meta data may be empty, the strings for host and plugin may +not be empty. It's currently not possible to set the type of a value this way. + +The following placeholders will be replaced by an appropriate value: + +=over 4 + +=item B<%{host}> + +=item B<%{plugin}> + +=item B<%{plugin_instance}> + +=item B<%{type}> + +=item B<%{type_instance}> + +These placeholders are replaced by the identifier field of the same name. + +=item B<%{meta:>IB<}> + +These placeholders are replaced by the meta data value with the given name. + +=back + +Please note that these placeholders are B! + +=item B I -Set the appropriate field to the given string. The strings for plugin instance -and type instance may be empty, the strings for host and plugin may not be -empty. It's currently not possible to set the type of a value this way. +Delete the named meta data field. =back