X-Git-Url: https://git.octo.it/?a=blobdiff_plain;f=src%2Fcollectd.conf.pod;h=d5045c169115f943707603766d8e5f4c535c23e6;hb=f876292e5ce4be40ab5b031b2bcfb347f00da1f8;hp=c3e239b643913b634b5dbd4e1e161941a83144d5;hpb=73a6f82a63747f088352a61e201beac2d185b2ac;p=collectd.git diff --git a/src/collectd.conf.pod b/src/collectd.conf.pod index c3e239b6..d5045c16 100644 --- a/src/collectd.conf.pod +++ b/src/collectd.conf.pod @@ -1447,6 +1447,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 @@ -1460,11 +1465,12 @@ 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 differences 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 / seconds. +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 @@ -1769,6 +1775,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. @@ -2410,7 +2421,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 @@ -2640,6 +2651,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 @@ -2650,6 +2733,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 @@ -2667,22 +2777,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 @@ -2708,6 +2813,32 @@ 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 I|I + +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 I|I + +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. + +=back + =head2 Plugin C =over 4 @@ -2744,6 +2875,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 @@ -2998,6 +3141,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. @@ -3649,6 +3798,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" @@ -3658,12 +3812,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 @@ -3728,10 +3890,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 @@ -7046,7 +7234,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 @@ -7818,14 +8006,23 @@ Define which SSL protocol version must be used. By default C will attempt to figure out the remote SSL protocol version. See L for more details. -=item B B|B +=item B B|B|B Format of the output to generate. If set to B, will create output that is understood by the I and I plugins. When set to B, will -create output in the I (JSON). +create output in the I (JSON). When set to KAIROSDB +, will create output in the KairosDB format. 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