From: Pavel Rochnyack Date: Thu, 12 May 2016 12:34:56 +0000 (+0600) Subject: postgresql plugin: Improve documentation about Result blocks X-Git-Tag: collectd-5.6.0~292^2~1 X-Git-Url: https://git.verplant.org/?a=commitdiff_plain;h=a913eef84f82fad7860b625009cfb7c103e5994e;p=collectd.git postgresql plugin: Improve documentation about Result blocks --- diff --git a/src/collectd.conf.pod b/src/collectd.conf.pod index b7a4f46c..823dbbd2 100644 --- a/src/collectd.conf.pod +++ b/src/collectd.conf.pod @@ -5131,13 +5131,12 @@ The B block defines one database query which may later be used by a database definition. It accepts a single mandatory argument which specifies the name of the query. The names of all queries have to be unique (see the B and B options below for an exception to this -rule). The following configuration options are available to define the query: +rule). -In each B block, there is one or more B blocks. B -blocks define how to handle the values returned from the query. They define -which column holds which value and how to dispatch that value to the daemon. -Multiple B blocks may be used to extract multiple values from a single -query. +In each B block, there is one or more B blocks. Multiple +B blocks may be used to extract multiple values from a single query. + +The following configuration options are available to define the query: =over 4 @@ -5155,7 +5154,7 @@ allowed as long as a single non-empty command has been specified only. The returned lines will be handled separately one after another. -=item B I|I|I|I +=item B I|I|I|I|I Specify the parameters which should be passed to the SQL query. The parameters are referred to in the SQL query as B<$1>, B<$2>, etc. in the same order as @@ -5192,6 +5191,28 @@ specific or global B options). Please note that parameters are only supported by PostgreSQL's protocol version 3 and above which was introduced in version 7.4 of PostgreSQL. +=item B I + +=item B I + +Specify the minimum or maximum version of PostgreSQL that this query should be +used with. Some statistics might only be available with certain versions of +PostgreSQL. This allows you to specify multiple queries with the same name but +which apply to different versions, thus allowing you to use the same +configuration in a heterogeneous environment. + +The I has to be specified as the concatenation of the major, minor +and patch-level versions, each represented as two-decimal-digit numbers. For +example, version 8.2.3 will become 80203. + +=back + +The B block defines how to handle the values returned from the query. +It defines which column holds which value and how to dispatch that value to +the daemon. + +=over 4 + =item B I The I name to be used when dispatching the values. The type describes @@ -5199,7 +5220,7 @@ how to handle the data and where to store it. See L for more details on types and their configuration. The number and type of values (as selected by the B option) has to match the type of the given name. -This option is required inside a B block. +This option is mandatory. =item B I @@ -5235,20 +5256,6 @@ This option is required inside a B block and may be specified multiple times. If multiple B options are specified, the columns are read in the given order. -=item B I - -=item B I - -Specify the minimum or maximum version of PostgreSQL that this query should be -used with. Some statistics might only be available with certain versions of -PostgreSQL. This allows you to specify multiple queries with the same name but -which apply to different versions, thus allowing you to use the same -configuration in a heterogeneous environment. - -The I has to be specified as the concatenation of the major, minor -and patch-level versions, each represented as two-decimal-digit numbers. For -example, version 8.2.3 will become 80203. - =back The following predefined queries are available (the definitions can be found