X-Git-Url: https://git.octo.it/?a=blobdiff_plain;f=src%2Fcollectd.conf.pod;h=9ae73106de75ac1a445f60799ff3f71f3a115bd4;hb=f0d468892e1c173b226f739be48291981473b4fb;hp=605ba0596a6056ab27ac6efb36c987df6a4c2cf3;hpb=5007fb256b4abbef2dbc675f9a15273554a3385e;p=collectd.git diff --git a/src/collectd.conf.pod b/src/collectd.conf.pod index 605ba059..9ae73106 100644 --- a/src/collectd.conf.pod +++ b/src/collectd.conf.pod @@ -404,13 +404,13 @@ There are a couple of limitations you should be aware of: =over 4 -=item +=item * The I cannot be left unspecified, because it is not reasonable to add apples to oranges. Also, the internal lookup structure won't work if you try to group by type. -=item +=item * There must be at least one unspecified, ungrouped field. Otherwise nothing will be aggregated. @@ -485,19 +485,19 @@ This will create the files: =over 4 -=item +=item * foo.example.com/cpu-even-average/cpu-idle -=item +=item * foo.example.com/cpu-even-average/cpu-system -=item +=item * foo.example.com/cpu-even-average/cpu-user -=item +=item * ... @@ -1361,6 +1361,32 @@ at all, B cgroups are selected. =back +=head2 Plugin C + +The C plugin collects ntp data from a B server, such as clock +skew and per-peer stratum. + +For talking to B, it mimics what the B control program does +on the wire. + +Available configuration options for the C plugin: + +=over 4 + +=item B I + +Hostname of the host running B. Defaults to B. + +=item B I + +UDP-Port to connect to. Defaults to B<323>. + +=item B I + +Connection timeout in seconds. Defaults to B<2>. + +=back + =head2 Plugin C This plugin collects IP conntrack statistics. @@ -1381,11 +1407,11 @@ as Jiffies, using the C type. Two aggregations are available: =over 4 -=item +=item * Sum, per-state, over all CPUs installed in the system; and -=item +=item * Sum, per-CPU, over all non-idle states of a CPU, creating an "active" state. @@ -1431,6 +1457,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 @@ -1457,7 +1493,7 @@ All cURL-based plugins support collection of generic, request-based statistics. These are disabled by default and can be enabled selectively for each page or URL queried from the curl, curl_json, or curl_xml plugins. See the documentation of those plugins for specific information. This section -describes the available metrics that can be configured with each plugin. All +describes the available metrics that can be configured for each plugin. All options are disabled by default. See L for more details. @@ -1484,7 +1520,7 @@ host was completed. =item B B -Time it took from the start until the file transfer is just about to begin. +Time it took from the start until just before the transfer begins. =item B B @@ -1637,6 +1673,9 @@ Beware that requests will get aborted if they take too long to complete. Adjust B accordingly if you expect B to report such slow requests. +This option is similar to enabling the B statistic but it's +measured by collectd instead of cURL. + =item B B|B Measure response code for the request. If this setting is enabled, B @@ -2372,7 +2411,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 @@ -2602,6 +2641,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 @@ -2640,11 +2751,6 @@ connections. =back -=item B I - -Number of threads to start for handling incoming connections. The default -value is B<5>. - =back =head2 Plugin C @@ -2706,6 +2812,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 @@ -3611,6 +3729,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" @@ -3620,12 +3743,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 @@ -3690,10 +3821,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 @@ -4650,11 +4807,11 @@ Sets the I to write to. Defaults to F -The C plugin collects per-peer ntpd data such as time offset and time +The C plugin collects per-peer ntp data such as time offset and time dispersion. For talking to B, it mimics what the B control program does on -wire - using B specific requests. This mode is deprecated with +the wire - using B specific requests. This mode is deprecated with newer B releases (4.2.7p230 and later). For the C plugin to work correctly with them, the ntp daemon must be explicitly configured to enable B (which is disabled by default). Refer to the I @@ -6427,6 +6584,22 @@ collected. If at least one B option is given and no B or set to B, B matching disks will be collected. If B is set to B, all disks are collected B the ones matched. +=item B B|B + +Normally, the C plugin will ignore disks that are reported to be asleep. +This option disables the sleep mode check and allows the plugin to collect data +from these disks anyway. This is useful in cases where libatasmart mistakenly +reports disks as asleep because it has not been updated to incorporate support +for newer idle states in the ATA spec. + +=item B B|B + +A disk's kernel name (e.g., sda) can change from one boot to the next. If this +option is enabled, the C plugin will use the disk's serial number (e.g., +HGST_HUH728080ALE600_2EJ8VH8X) instead of the kernel name as the key for +storing data. This ensures that the data for a given disk will be kept together +even if the kernel name changes. + =back =head2 Plugin C @@ -6992,7 +7165,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 @@ -7164,20 +7337,20 @@ The following methods are used to find the machine's UUID, in order: =over 4 -=item +=item * Check I (or I). -=item +=item * Check for UUID from HAL (L) if present. -=item +=item * Check for UUID from C / SMBIOS. -=item +=item * Check for UUID from Xen hypervisor. @@ -7764,14 +7937,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