X-Git-Url: https://git.octo.it/?a=blobdiff_plain;f=src%2Fcollectd.conf.pod;h=c3e239b643913b634b5dbd4e1e161941a83144d5;hb=73a6f82a63747f088352a61e201beac2d185b2ac;hp=32bb3261b5580753ad8a3e370191a770e69d5538;hpb=fd7ac9a6a47d864bd9663f8da9a10d4ee55578fb;p=collectd.git diff --git a/src/collectd.conf.pod b/src/collectd.conf.pod index 32bb3261..c3e239b6 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,15 @@ 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 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. + =head2 Plugin C =over 4 @@ -1451,6 +1486,92 @@ number. =back +=head2 cURL Statistics + +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 for each plugin. All +options are disabled by default. + +See L for more details. + +=over 4 + +=item B B + +Total time of the transfer, including name resolving, TCP connect, etc. + +=item B B + +Time it took from the start until name resolving was completed. + +=item B B + +Time it took from the start until the connect to the remote host (or proxy) +was completed. + +=item B B + +Time it took from the start until the SSL/SSH connect/handshake to the remote +host was completed. + +=item B B + +Time it took from the start until just before the transfer begins. + +=item B B + +Time it took from the start until the first byte was received. + +=item B B + +Time it took for all redirection steps include name lookup, connect, +pre-transfer and transfer before final transaction was started. + +=item B B + +The total number of redirections that were actually followed. + +=item B B + +The total amount of bytes that were uploaded. + +=item B B + +The total amount of bytes that were downloaded. + +=item B B + +The average download speed that curl measured for the complete download. + +=item B B + +The average upload speed that curl measured for the complete upload. + +=item B B + +The total size of all the headers received. + +=item B B + +The total size of the issued requests. + +=item B B + +The content-length of the download. + +=item B B + +The specified size of the upload. + +=item B B + +The number of new connections that were created to achieve the transfer. + +=back + =head2 Plugin C The curl plugin uses the B (L) to read web pages @@ -1551,11 +1672,21 @@ 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 blocks (see below) are optional. Disabled by default. +=item BStatisticsE> + +One B block can be used to specify cURL statistics to be collected +for each request to the remote web site. See the section "cURL Statistics" +above for details. If this setting is enabled, B blocks (see below) are +optional. + =item BMatchE> One or more B blocks that define how to match information in the data @@ -1668,6 +1799,12 @@ URL. By default the global B setting will be used. These options behave exactly equivalent to the appropriate options of the I plugin. Please see there for a detailed description. +=item BStatisticsE> + +One B block can be used to specify cURL statistics to be collected +for each request to the remote URL. See the section "cURL Statistics" above +for details. + =back The following options are valid within B blocks: @@ -1770,6 +1907,12 @@ Examples: These options behave exactly equivalent to the appropriate options of the I. Please see there for a detailed description. +=item BStatisticsE> + +One B block can be used to specify cURL statistics to be collected +for each request to the remote URL. See the section "cURL Statistics" above +for details. + =item EB IE Within each B block, there must be one or more B blocks. Each @@ -2500,7 +2643,7 @@ source, this is optional. Otherwise the option is required. =head2 Plugin C The I plugin provides an RPC interface to submit values to or query -values from collectd based on the open source gRPC framework. It exposes and +values from collectd based on the open source gRPC framework. It exposes an end-point for dispatching values to the daemon. The B homepage can be found at L. @@ -2510,11 +2653,31 @@ The B homepage can be found at L. =item B I I The B statement sets the network address to bind to. When multiple -statements are specified, the daemon will bin to all of them. If none are +statements are specified, the daemon will bind to all of them. If none are specified, it defaults to B<0.0.0.0:50051>. 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 I|I + +Whether to enable SSL for incoming 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 Number of threads to start for handling incoming connections. The default @@ -4525,11 +4688,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 @@ -6302,6 +6465,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 @@ -7039,20 +7218,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.