X-Git-Url: https://git.octo.it/?a=blobdiff_plain;f=src%2Fcollectd.conf.pod;h=b992eac126a140fc4f42051a31526df13eb18cca;hb=4d6ff066b1c60a8e6654e4c74370ef951f37b5f3;hp=aaeeaf419b703913392ef5e78448ffa76fc451dc;hpb=06efe4f50bbdfbade922b8a3ee4576eb2cc4562c;p=collectd.git diff --git a/src/collectd.conf.pod b/src/collectd.conf.pod index aaeeaf41..b992eac1 100644 --- a/src/collectd.conf.pod +++ b/src/collectd.conf.pod @@ -159,12 +159,27 @@ plugins that don't provide any configuration, e.g. the I. When set to B, various statistics about the I daemon will be collected, with "collectd" as the I. Defaults to B. -The "write_queue" I reports the number of elements currently -queued and the number of elements dropped off the queue by the -B/B mechanism. +The following metrics are reported: -The "cache" I reports the number of elements in the value list -cache (the cache you can interact with using L). +=over 4 + +=item C + +The number of metrics currently in the write queue. You can limit the queue +length with the B and B options. + +=item C + +The number of metrics dropped due to a queue length limitation. +If this value is non-zero, your system can't handle all incoming metrics and +protects itself against overload by dropping metrics. + +=item C + +The number of elements in the metric cache (the cache you can interact with +using L). + +=back =item B I [I] @@ -1827,6 +1842,7 @@ than those of other plugins. It usually looks something like this: Driver "mysql" + Interval 120 DriverOption "host" "localhost" DriverOption "username" "collectd" DriverOption "password" "aZo6daiw" @@ -2006,6 +2022,11 @@ the daemon. Other than that, that name is not used. =over 4 +=item B I + +Sets the interval (in seconds) in which the values will be collected from this +database. By default the global B setting will be used. + =item B I Specifies the driver to use to connect to the database. In many cases those @@ -2519,6 +2540,17 @@ do that: By setting B to I the effect of B is inverted: All selected interfaces are ignored and all other interfaces are collected. +=item B I|I + +Interface name is not unique on Solaris (KSTAT), interface name is unique +only within a module/instance. Following tuple is considered unique: + (ks_module, ks_instance, ks_name) +If this option is set to true, interface name contains above three fields +separated by an underscore. For more info on KSTAT, visit +L + +This option is only available on Solaris. + =back =head2 Plugin C @@ -2559,9 +2591,13 @@ a notification is sent. =item B I I [I [I]] -Select the rules to count. If only I
and I are given, this plugin -will collect the counters of all rules which have a comment-match. The comment -is then used as type-instance. +=item B I
I [I [I]] + +Select the iptables/ip6tables filter rules to count packets and bytes from. + +If only I
and I are given, this plugin will collect the counters +of all rules which have a comment-match. The comment is then used as +type-instance. If I or I is given, only the rule with the matching comment or the Ith rule will be collected. Again, the comment (or the number) will be @@ -3341,6 +3377,38 @@ Configures the topic(s) to subscribe to. You can use the single level C<+> and multi level C<#> wildcards. Defaults to B, i.e. all topics beneath the B branch. +=item B I + +Path to the PEM-encoded CA certificate file. Setting this option enables TLS +communication with the MQTT broker, and as such, B should be the TLS-enabled +port of the MQTT broker. +A valid TLS configuration requires B, B and B. + +=item B I + +Path to the PEM-encoded certificate file to use as client certificate when +connecting to the MQTT broker. +A valid TLS configuration requires B, B and B. + +=item B I + +Path to the unencrypted PEM-encoded key file corresponding to B. +A valid TLS configuration requires B, B and B. + +=item B I + +If configured, this specifies the string protocol version (e.g. C, +C) to use for the TLS connection to the broker. If not set a default +version is used which depends on the version of OpenSSL the Mosquitto library +was linked against. + +=item B I + +A string describing the ciphers available for use. See L and the +C utility for more information. If unset, the default ciphers +will be used. + + =back =head2 Plugin C @@ -4398,6 +4466,21 @@ Default: C =back +=head2 Plugin C + +The I plugin writes notifications to Nagios' I as +a I. + +Available configuration options: + +=over 4 + +=item B I + +Sets the I to write to. Defaults to F. + +=back + =head2 Plugin C =over 4 @@ -4904,6 +4987,13 @@ Default: B<0.9> Sets the Time-To-Live of generated ICMP packets. +=item B I + +Sets the size of the data payload in ICMP packet to specified I (it +will be filled with regular ASCII pattern). If not set, default 56 byte +long string is used so that the packet size of an ICMPv4 packet is exactly +64 bytes, similar to the behaviour of normal ping(1) command. + =item B I Sets the source address to use. I may either be a numerical network @@ -6179,6 +6269,12 @@ rate of counters and size of sets will be zero, timers report C and gauges are unchanged. If set to B, the such metrics are not dispatched and removed from the internal cache. +=item B B|B + +When enabled, create a C metric which reports the change since the last +read. This option primarily exists for compatibility with the I +impelemtation by Etsy. + =item B I Calculate and dispatch the configured percentile, i.e. compute the latency, so @@ -7133,14 +7229,18 @@ setting B. B
means use the interface's mac address. This is useful since the interface path might change between reboots of a guest or across migrations. -=item B B +=item B B When the virt plugin logs data, it sets the plugin_instance of the collected -data according to this setting. The default is to use the guest name as provided -by the hypervisor, which is equal to setting B. +data according to this setting. The default is to not set the plugin_instance. +B means use the guest's name as provided by the hypervisor. B means use the guest's UUID. +You can also specify combinations of the B and B fields. +For example B means to concatenate the guest name and UUID +(with a literal colon character between, thus I<"foo:1234-1234-1234-1234">). + =back =head2 Plugin C @@ -7214,6 +7314,14 @@ Service name or port number to connect to. Defaults to C<2003>. Protocol to use when connecting to I. Defaults to C. +=item B I + +When set to non-zero, forces the connection to the Graphite backend to be +closed and re-opend periodically. This behavior is desirable in environments +where the connection to the Graphite backend is done through load balancers, +for example. When set to zero, the default, the connetion is kept open for as +long as possible. + =item B B|B If set to B (the default), logs errors when sending data to I. @@ -7482,6 +7590,10 @@ complete. When this limit is reached, the POST operation will be aborted, and all the data in the current send buffer will probably be lost. Defaults to 0, which means the connection never times out. +=item B B|B + +Enables printing of HTTP error code to log. Turned off by default. + The C plugin regularly submits the collected values to the HTTP server. How frequently this happens depends on how much data you are collecting and the size of B. The optimal value to set B to is @@ -7610,6 +7722,8 @@ Synopsis: Timeout 1000 Prefix "collectd/" Database 1 + MaxSetSize -1 + StoreRates true @@ -7618,7 +7732,7 @@ the timestamp as the score. Retrieving a date range can then be done using the C I command. Additionally, all the identifiers of these I are kept in a I called C (or C<${prefix}/values> if the B option was specified) and can be retrieved -using the C I command. You can specify the database to use +using the C I command. You can specify the database to use with the B parameter (default is C<0>). See L and L for details. @@ -7663,7 +7777,18 @@ is recommended but not required to include a trailing slash in I. =item B I -This index selects the redis database to use for writing operations. Defaults to C<0>. +This index selects the redis database to use for writing operations. Defaults +to C<0>. + +=item B I + +The B option limits the number of items that the I can +hold. Negative values for I sets no limit, which is the default behavior. + +=item B B|B + +If set to B (the default), convert counter values to rates. If set to +B counter values are stored as is, i.e. as an increasing integer number. =back @@ -7744,7 +7869,7 @@ C. =item B B|B -If set the B, append the name of the I (DS) to the +If set to B, append the name of the I (DS) to the "service", i.e. the field that, together with the "host" field, uniquely identifies a metric in I. If set to B (the default), this is only done when there is more than one DS.