X-Git-Url: https://git.octo.it/?a=blobdiff_plain;f=src%2Fcollectd.conf.pod;h=7ae1da24675333454de248c66433750b6d9f6362;hb=be99a844a40d7037a910d37a894988b807631a6e;hp=80f26b66c09deb5455d108ca97c95c8d1f7d8ef7;hpb=496d4e6272689604c4f4daab6823c99dd4e4fb50;p=collectd.git diff --git a/src/collectd.conf.pod b/src/collectd.conf.pod index 80f26b66..7ae1da24 100644 --- a/src/collectd.conf.pod +++ b/src/collectd.conf.pod @@ -409,106 +409,6 @@ By default no detailed zone information is collected. =back -=head2 Plugin C - -The couchdb plugin uses B (L) and B -(L) to collect values from CouchDB -documents (stored JSON notation). - -The following example will collect several values from the built-in `_stats' -runtime statistics module (L). - - - - Instance "httpd" - - Type "http_requests" - - - - Type "http_request_methods" - - - - Type "http_response_codes" - - - - -The following example will collect the status values from each database: - - - Instance "dbs" - - Type "gauge" - - - Type "counter" - - - Type "bytes" - - - -In the B block, there may be one or more B blocks, each defining -a URL to be fetched via HTTP (libcurl) and one or more B blocks. -The B string argument must be in a path format, of which is used to collect -a value from a JSON map object. If a B path element is that of a I<*> wildcard, -the values for all keys will be collectd. - -The following options are valid within B blocks: - -=over 4 - -=item B I - -Sets the plugin instance to I. - -=item B I - -Username to use if authorization is required to read the page. - -=item B I - -Password to use if authorization is required to read the page. - -=item B B|B - -Enable or disable peer SSL certificate verification. See -L for details. Enabled by default. - -=item B B|B - -Enable or disable peer host name verification. If enabled, the plugin checks if -the C or a C field of the SSL certificate -matches the host name provided by the B option. If this identity check -fails, the connection is aborted. Obviously, only works when connecting to a -SSL enabled server. Enabled by default. - -=item B I - -File that holds one or more SSL certificates. If you want to use HTTPS you will -possibly need this option. What CA certificates come bundled with C -and are checked by default depends on the distribution you use. - -=back - -The following options are valid within B blocks: - -=over 4 - -=item B I - -Sets the type used to dispatch the values to the daemon. Detailed information -about types and their configuration can be found in L. This -option is mandatory. - -=item B I - -Type-instance to use. Defaults to the current map key or current string array element value. - -=back - =head2 Plugin C This plugin doesn't have any options. It reads @@ -601,6 +501,10 @@ File that holds one or more SSL certificates. If you want to use HTTPS you will possibly need this option. What CA certificates come bundled with C and are checked by default depends on the distribution you use. +=item B B|B + +Measure response time for the request. Disabled by default. + =item BMatchE> One or more B blocks that define how to match information in the data @@ -610,6 +514,109 @@ plugin below on how matches are defined. =back +=head2 Plugin C + +The B uses B (L) and +B (L) to retrieve JSON data +via cURL. This can be used to collect values from CouchDB documents (which are +stored JSON notation), for example. + +The following example will collect several values from the built-in `_stats' +runtime statistics module of CouchDB +(L). + + + + Instance "httpd" + + Type "http_requests" + + + + Type "http_request_methods" + + + + Type "http_response_codes" + + + + +Another CouchDB example: +The following example will collect the status values from each database: + + + Instance "dbs" + + Type "gauge" + + + Type "counter" + + + Type "bytes" + + + +In the B block, there may be one or more B blocks, each defining +a URL to be fetched via HTTP (using libcurl) and one or more B blocks. +The B string argument must be in a path format, of which is used to collect +a value from a JSON map object. If a B path element is that of a I<*> wildcard, +the values for all keys will be collectd. + +The following options are valid within B blocks: + +=over 4 + +=item B I + +Sets the plugin instance to I. + +=item B I + +Username to use if authorization is required to read the page. + +=item B I + +Password to use if authorization is required to read the page. + +=item B B|B + +Enable or disable peer SSL certificate verification. See +L for details. Enabled by default. + +=item B B|B + +Enable or disable peer host name verification. If enabled, the plugin checks if +the C or a C field of the SSL certificate +matches the host name provided by the B option. If this identity check +fails, the connection is aborted. Obviously, only works when connecting to a +SSL enabled server. Enabled by default. + +=item B I + +File that holds one or more SSL certificates. If you want to use HTTPS you will +possibly need this option. What CA certificates come bundled with C +and are checked by default depends on the distribution you use. + +=back + +The following options are valid within B blocks: + +=over 4 + +=item B I + +Sets the type used to dispatch the values to the daemon. Detailed information +about types and their configuration can be found in L. This +option is mandatory. + +=item B I + +Type-instance to use. Defaults to the current map key or current string array element value. + +=back + =head2 Plugin C This plugin uses the B library (L) to @@ -870,6 +877,12 @@ match any one of the criteria are collected. By default only selected partitions are collected if a selection is made. If no selection is configured at all, B partitions are selected. +=item B I|I + +Report using the device name rather than the mountpoint. i.e. with this I, +(the default), it will report a disk as "root", but with it I, it will be +"sda1" (or whichever). + =back =head2 Plugin C @@ -1066,6 +1079,11 @@ Controls whether or not to recurse into subdirectories. Enabled by default. =back +=head2 Plugin C + +The I is written in I and therefore documented in +L. + =head2 Plugin C The I plugin received the multicast traffic sent by B, the @@ -1826,6 +1844,11 @@ multicast, and IPv4 and IPv6 packets. The default is to not change this value. That means that multicast packets will be sent with a TTL of C<1> (one) on most operating systems. +=item B I<1024-65535> + +Set the maximum size for datagrams received over the network. Packets larger +than this will be truncated. + =item B I If set to I, write packets that were received via the network plugin to @@ -2779,7 +2802,7 @@ matching values will be ignored. =head2 Plugin C -The C plugin uses the RRDTool accelerator daemon, L, +The C plugin uses the RRDtool accelerator daemon, L, to store values to RRD files in an efficient manner. The combination of the C B and the C B is very similar to the way the C plugin works (see below). The added abstraction layer @@ -2831,7 +2854,7 @@ expected. Default is B. You can use the settings B, B, B, and B to fine-tune your RRD-files. Please read L if you encounter problems -using these settings. If you don't want to dive into the depths of RRDTool, you +using these settings. If you don't want to dive into the depths of RRDtool, you can safely ignore these settings. =over 4 @@ -2928,6 +2951,14 @@ updates per second, writing all values to disk will take approximately "collection3" you'll end up with a responsive and fast system, up to date graphs and basically a "backup" of your values every hour. +=item B I + +When set, the actual timeout for each value is chosen randomly between +I-I and I+I. The +intention is to avoid high load situations that appear when many values timeout +at the same time. This is especially a problem shortly after the daemon starts, +because all values were added to the internal cache at roughly the same time. + =back =head2 Plugin C @@ -3432,6 +3463,64 @@ traffic (e.Eg. due to headers and retransmission). If you want to collect on-wire traffic you could, for example, use the logging facilities of iptables to feed data for the guest IPs into the iptables plugin. +=head2 Plugin C + +This output plugin submits values to an http server by POST them using the +PUTVAL plain-text protocol. Each destination you want to post data to needs to +have one B block, within which the destination can be configured further, +for example by specifying authentication data. + +Synopsis: + + + + User "collectd" + Password "weCh3ik0" + + + +B blocks need one string argument which is used as the URL to which data +is posted. The following options are understood within B blocks. + +=over 4 + +=item B I + +Optional user name needed for authentication. + +=item B I + +Optional password needed for authentication. + +=item B B|B + +Enable or disable peer SSL certificate verification. See +L for details. Enabled by default. + +=item B B + +Enable or disable peer host name verification. If enabled, the plugin checks if +the C or a C field of the SSL certificate +matches the host name provided by the B option. If this identity check +fails, the connection is aborted. Obviously, only works when connecting to a +SSL enabled server. Enabled by default. + +=item B I + +File that holds one or more SSL certificates. If you want to use HTTPS you will +possibly need this option. What CA certificates come bundled with C +and are checked by default depends on the distribution you use. + +=item 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). + +Defaults to B. + +=back + =head1 THRESHOLD CONFIGURATION Starting with version C<4.3.0> collectd has support for B. By that @@ -3557,6 +3646,13 @@ This applies to missing values, too: If set to B a notification about a missing value is generated once every B seconds. If set to B only one such notification is generated until the value appears again. +=item B B|B + +If set to B, the minimum and maximum values given are interpreted as +percentage value, relative to the other data sources. This is helpful for +example for the "df" type, where you may want to issue a warning when less than +5E% of the total space is available. Defaults to B. + =back =head1 FILTER CONFIGURATION @@ -4050,6 +4146,19 @@ Example: Satisfy "Any" +=item B + +Matches all values with one or more data sources of type B and where +all counter values are zero. These counters usually I increased since +they started existing (and are therefore uninteresting), or got reset recently +or overflowed and you had really, I bad luck. + +Please keep in mind that ignoring such counters can result in confusing +behavior: Counters which hardly ever increase will be zero for long periods of +time. If the counter is reset for some reason (machine or service restarted, +usually), the graph will be empty (NAN) for a long time. People may not +understand why. + =back =head2 Available targets