From 8b71c571461f4e893bafbc041c3a44975439b282 Mon Sep 17 00:00:00 2001 From: Florian Forster Date: Thu, 27 Aug 2009 09:46:09 +0200 Subject: [PATCH] collectd.conf(5): Renamed the couchdb plugin to curl_json here, too. --- src/collectd.conf.pod | 203 +++++++++++++++++++++++++------------------------- 1 file changed, 103 insertions(+), 100 deletions(-) diff --git a/src/collectd.conf.pod b/src/collectd.conf.pod index 49a3b781..bb95c31c 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 @@ -610,6 +510,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 -- 2.11.0