X-Git-Url: https://git.octo.it/?a=blobdiff_plain;f=src%2Fcollectd.conf.pod;h=7ae1da24675333454de248c66433750b6d9f6362;hb=91743fc0c8785f84f3976d5f5d430b1b3a7d4918;hp=e7943199111fd29e1d5e7495f03dbb0c57330e78;hpb=d3a409674a26075fe127e6800e2bc96ba389c102;p=collectd.git diff --git a/src/collectd.conf.pod b/src/collectd.conf.pod index e7943199..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 @@ -1072,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 @@ -3454,15 +3466,23 @@ 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. +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. -The following options are accepted by the I: +Synopsis: -=over 4 + + + User "collectd" + Password "weCh3ik0" + + -=item B I +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. -Set the URL location where values will be sent. +=over 4 =item B I @@ -3472,6 +3492,33 @@ Optional user name needed for authentication. 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