X-Git-Url: https://git.octo.it/?a=blobdiff_plain;f=src%2Fcollectd.conf.pod;h=cf7ccd0190e32fa81a2f55ad892bc7a96ee36299;hb=9d5c9e04aac3689f49098cba0e630128c0ef4caa;hp=fde349314729b9273c4185c8b78dc05f6a63202a;hpb=58460a77fa55b50a84b040c917e63d46a31c95bd;p=collectd.git diff --git a/src/collectd.conf.pod b/src/collectd.conf.pod index fde34931..cf7ccd01 100644 --- a/src/collectd.conf.pod +++ b/src/collectd.conf.pod @@ -38,7 +38,7 @@ i.e. a CPluginE...E> block. The syntax of this config file is similar to the config file of the famous I webserver. Each line contains either an option (a key and a list of one or more values) or a section-start or -end. Empty lines and everything -after a non-quoted hash-symbol (C<#>) is ignored. I are unquoted +after a non-quoted hash-symbol (C<#>) are ignored. I are unquoted strings, consisting only of alphanumeric characters and the underscore (C<_>) character. Keys are handled case insensitive by I itself and all plugins included with it. I can either be an I, a @@ -70,7 +70,7 @@ CB ...E> block. =item B I -Sets the base directory. This is the directory beneath all RRD-files are +Sets the base directory. This is the directory beneath which all RRD-files are created. Possibly more subdirectories are created. This is also the working directory for the daemon. @@ -83,7 +83,7 @@ I will be mostly useless. Only the first B statement or block for a given plugin name has any effect. This is useful when you want to split up the configuration into smaller files and want each file to be "self contained", i.e. it contains a B -block I then appropriate B statement. The downside is that if +block I the appropriate B statement. The downside is that if you have multiple conflicting B blocks, e.g. when they specify different intervals, only one of them (the first one encountered) will take effect and all others will be silently ignored. @@ -127,13 +127,13 @@ the average user from ever having to deal with this low level linking stuff. =item B I Sets a plugin-specific interval for collecting metrics. This overrides the -global B setting. If a plugin provides own support for specifying an -interval, that setting will take precedence. +global B setting. If a plugin provides its own support for specifying +an interval, that setting will take precedence. =item B I -Specifies the the interval, in seconds, to call the flush callback if it's -defined in this plugin. By default, this is disabled +Specifies the interval, in seconds, to call the flush callback if it's +defined in this plugin. By default, this is disabled. =item B I @@ -214,7 +214,7 @@ matching C<*.conf> in any subdirectory of C: =back -If more than one files are included by a single B option, the files +If more than one file is included by a single B option, the files will be included in lexicographical order (as defined by the C function). Thus, you can e.Eg. use numbered prefixes to specify the order in which the files are loaded. @@ -255,7 +255,7 @@ magic! (Assuming you're using the I or I plugin.) =item B I -Read plugin doubles interval between queries after each failed attempt +A read plugin doubles the interval between queries after each failed attempt to get data. This options limits the maximum value of the interval. The default value is @@ -2531,7 +2531,7 @@ a more detailed description see B below. =item B I|I -If no configuration if given, the B-plugin will collect data from +If no configuration if given, the B-plugin will collect data from all interfaces. This may not be practical, especially for loopback- and similar interfaces. Thus, you can use the B-option to pick the interfaces you're interested in. Sometimes, however, it's easier/preferred @@ -4500,6 +4500,18 @@ Sets the I to write to. Defaults to F +The C plugin collects per-peer ntpd 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 +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 +manual page for details. + +Available configuration options for the C plugin: + =over 4 =item B I