X-Git-Url: https://git.verplant.org/?a=blobdiff_plain;f=src%2Fcollectd.conf.pod;h=29a1d1457ca3367587fb80293ec92c06dac54101;hb=4a9d11514a7e95d89dafc3f7f5f4610e707ae9e3;hp=18b7378347bca12fe1c583e833044aecd71f49fe;hpb=184f1db5791939c13d7e65bb1d05dd2ff0f9ae6d;p=collectd.git
diff --git a/src/collectd.conf.pod b/src/collectd.conf.pod
index 18b73783..29a1d145 100644
--- a/src/collectd.conf.pod
+++ b/src/collectd.conf.pod
@@ -483,6 +483,7 @@ Synopsis:
URL "http://localhost:8053/"
+ ParseTime false
OpCodes true
QTypes true
@@ -509,35 +510,44 @@ The bind plugin accepts the following configuration options:
URL from which to retrieve the XML data. If not specified,
C will be used.
-=item B I|I
+=item B B|B
+
+When set to B, the time provided by BIND will be parsed and used to
+dispatch the values. When set to B, the local time source is queried.
+
+This setting is set to B by default for backwards compatibility; setting
+this to B is I to avoid problems with timezones and
+localization.
+
+=item B B|B
When enabled, statistics about the I<"OpCodes">, for example the number of
C packets, are collected.
Default: Enabled.
-=item B I|I
+=item B B|B
When enabled, the number of I queries by query types (for example
C, C, C) is collected.
Default: Enabled.
-=item B I|I
+=item B B|B
Collect global server statistics, such as requests received over IPv4 and IPv6,
successful queries, and failed updates.
Default: Enabled.
-=item B I|I
+=item B B|B
Collect zone maintenance statistics, mostly information about notifications
(zone updates) and zone transfers.
Default: Enabled.
-=item B I|I
+=item B B|B
Collect resolver statistics, i.Ee. statistics about outgoing requests
(e.Eg. queries over IPv4, lame servers). Since the global resolver
@@ -566,21 +576,21 @@ configured, no detailed view statistics will be collected.
=over 4
-=item B I|I
+=item B B|B
If enabled, the number of I queries by query type (e.Eg. C,
C) is collected.
Default: Enabled.
-=item B I|I
+=item B B|B
Collect resolver statistics, i.Ee. statistics about outgoing requests
(e.Eg. queries over IPv4, lame servers).
Default: Enabled.
-=item B I|I
+=item B B|B
If enabled, the number of entries (I<"RR sets">) in the view's cache by query
type is collected. Negative entries (queries which resulted in an error, for
@@ -1262,6 +1272,41 @@ at most B<16384> to prevent typos and dumb mistakes.
=back
+=head2 Plugin C
+
+The I collects information about network interface cards (NICs)
+by talking directly with the underlying kernel driver using L.
+
+B
+
+
+ Interface "eth0"
+ Map "rx_csum_offload_errors" "if_rx_errors" "checksum_offload"
+ Map "multicast" "if_multicast"
+
+
+B
+
+=over 4
+
+=item B I
+
+Collect statistical information about interface I.
+
+=item B
+
+ Statement "SELECT collectd_insert($1, $2, $3, $4, $5, $6, $7, $8, $9);"
+ StoreRates true
+
+
Host "hostname"
Port "5432"
@@ -3401,6 +3507,12 @@ L.
Query backend # predefined
Query rt36_tickets
+
+
+ # ...
+ Writer sqlstore
+ CommitInterval 10
+
The B block defines one database query which may later be used by a
@@ -3562,6 +3674,84 @@ This query collects the on-disk size of the database in bytes.
=back
+The B block defines a PostgreSQL writer backend. It accepts a single
+mandatory argument specifying the name of the writer. This will then be used
+in the B specification in order to activate the writer instance. The
+names of all writers have to be unique. The following options may be
+specified:
+
+=over 4
+
+=item B I
+
+This mandatory option specifies the SQL statement that will be executed for
+each submitted value. A single SQL statement is allowed only. Anything after
+the first semicolon will be ignored.
+
+Nine parameters will be passed to the statement and should be specified as
+tokens B<$1>, B<$2>, through B<$9> in the statement string. The following
+values are made available through those parameters:
+
+=over 4
+
+=item B<$1>
+
+The timestamp of the queried value as a floating point number.
+
+=item B<$2>
+
+The hostname of the queried value.
+
+=item B<$3>
+
+The plugin name of the queried value.
+
+=item B<$4>
+
+The plugin instance of the queried value. This value may be B if there
+is no plugin instance.
+
+=item B<$5>
+
+The type of the queried value (cf. L).
+
+=item B<$6>
+
+The type instance of the queried value. This value may be B if there is
+no type instance.
+
+=item B<$7>
+
+An array of names for the submitted values (i.Ee., the name of the data
+sources of the submitted value-list).
+
+=item B<$8>
+
+An array of types for the submitted values (i.Ee., the type of the data
+sources of the submitted value-list; C, C, ...). Note, that if
+B is enabled (which is the default, see below), all types will be
+C.
+
+=item B<$9>
+
+An array of the submitted values. The dimensions of the value name and value
+arrays match.
+
+=back
+
+In general, it is advisable to create and call a custom function in the
+PostgreSQL database for this purpose. Any procedural language supported by
+PostgreSQL will do (see chapter "Server Programming" in the PostgreSQL manual
+for details).
+
+=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.Ee. as an increasing integer
+number.
+
+=back
+
The B block defines one PostgreSQL database for which to collect
statistics. It accepts a single mandatory argument which specifies the
database name. None of the other options are required. PostgreSQL will use
@@ -3577,6 +3767,17 @@ for details.
Specify the interval with which the database should be queried. The default is
to use the global B setting.
+=item B I
+
+This option may be used for database connections which have "writers" assigned
+(see above). If specified, it causes a writer to put several updates into a
+single transaction. This transaction will last for the specified amount of
+time. By default, each update will be executed in a separate transaction. Each
+transaction generates a fair amount of overhead which can, thus, be reduced by
+activating this option. The draw-back is, that data covering the specified
+amount of time will be lost, for example, if a single statement within the
+transaction fails or if the database server crashes.
+
=item B I
Specify the hostname or IP of the PostgreSQL server to connect to. If the
@@ -4149,6 +4350,11 @@ L.
=over 4
+=item B I
+
+Read the I configuration from I. When unset (recommended),
+the library's default will be used.
+
=item B I
Selects the name of the sensor which you want to collect or ignore, depending
@@ -4206,6 +4412,15 @@ syslog-daemon.
Please note that B is only available if collectd has been compiled with
debugging support.
+=item B B|B|B
+
+Controls which notifications should be sent to syslog. The default behaviour is
+not to send any. Less severe notifications always imply logging more severe
+notifications: Setting this to B means all notifications will be sent to
+syslog, setting this to B will send B and B
+notifications but will dismiss B notifications. Setting this option to
+B will only send failures to syslog.
+
=back
=head2 Plugin C
@@ -4758,8 +4973,11 @@ iptables to feed data for the guest IPs into the iptables plugin.
=head2 Plugin C
-The C plugin writes data to I, the storage layer of
-I.
+The C plugin writes data to I, an open-source metrics
+storage and graphing project. The plugin connects to I, the data layer
+of I, and sends data via the "line based" protocol (per default using
+portE2003). The data will be sent in blocks of at most 1428 bytes to
+minimize the number of network packets.
Synopsis:
@@ -4800,10 +5018,17 @@ underscore (C<_>).
=item B B|B
-If set to B, convert counter values to rates. If set to B (the
-default) counter values are stored as is, i.Ee. as an increasing integer
+If set to B (the default), convert counter values to rates. If set to
+B counter values are stored as is, i.Ee. as an increasing integer
number.
+=item B B|B
+
+If set to B, the plugin instance and type instance will be in their own
+path component, for example C. If set to B (the
+default), the plugin and plugin instance (and likewise the type and type
+instance) are put into once component, for example C.
+
=item B B|B
If set the B, append the name of the I (DS) to the "metric"
@@ -4812,6 +5037,49 @@ more than one DS.
=back
+=head2 Plugin C
+
+The I will send values to I, a schema-less
+NoSQL database.
+
+B
+
+
+
+ Host "localhost"
+ Port "27017"
+ Timeout 1000
+ StoreRates true
+
+
+
+The plugin can send values to multiple instances of I by specifying
+one B block for each instance. Within the B blocks, the following
+options are available:
+
+=over 4
+
+=item B I
+
+Hostname or address to connect to. Defaults to C.
+
+=item B I
+
+Service name or port number to connect to. Defaults to C<27017>.
+
+=item B I
+
+Set the timeout for each operation on I to I milliseconds.
+Setting this option to zero means no timeout, which is the default.
+
+=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
+
=head2 Plugin C
This output plugin submits values to an http server by POST them using the
@@ -4876,6 +5144,170 @@ number.
=back
+=head1 THRESHOLD CONFIGURATION
+
+Starting with version C<4.3.0> collectd has support for B. By that
+we mean that the values are not only stored or sent somewhere, but that they
+are judged and, if a problem is recognized, acted upon. The only action
+collectd takes itself is to generate and dispatch a "notification". Plugins can
+register to receive notifications and perform appropriate further actions.
+
+Since systems and what you expect them to do differ a lot, you can configure
+B for your values freely. This gives you a lot of flexibility but
+also a lot of responsibility.
+
+Every time a value is out of range a notification is dispatched. This means
+that the idle percentage of your CPU needs to be less then the configured
+threshold only once for a notification to be generated. There's no such thing
+as a moving average or similar - at least not now.
+
+Also, all values that match a threshold are considered to be relevant or
+"interesting". As a consequence collectd will issue a notification if they are
+not received for B iterations. The B configuration option is
+explained in section L<"GLOBAL OPTIONS">. If, for example, B is set to
+"2" (the default) and some hosts sends it's CPU statistics to the server every
+60 seconds, a notification will be dispatched after about 120 seconds. It may
+take a little longer because the timeout is checked only once each B
+on the server.
+
+When a value comes within range again or is received after it was missing, an
+"OKAY-notification" is dispatched.
+
+Here is a configuration example to get you started. Read below for more
+information.
+
+
+
+ WarningMin 0.00
+ WarningMax 1000.00
+ FailureMin 0.00
+ FailureMax 1200.00
+ Invert false
+ Instance "bar"
+
+
+
+ Instance "eth0"
+
+ FailureMax 10000000
+ DataSource "rx"
+
+
+
+
+
+ Instance "idle"
+ FailureMin 10
+
+
+
+
+ Instance "cached"
+ WarningMin 100000000
+
+
+
+
+
+There are basically two types of configuration statements: The C,
+C, and C blocks select the value for which a threshold should be
+configured. The C and C blocks may be specified further using the
+C option. You can combine the block by nesting the blocks, though
+they must be nested in the above order, i.Ee. C may contain either
+C and C blocks, C may only contain C blocks and
+C may not contain other blocks. If multiple blocks apply to the same
+value the most specific block is used.
+
+The other statements specify the threshold to configure. They B be
+included in a C block. Currently the following statements are recognized:
+
+=over 4
+
+=item B I
+
+=item B I
+
+Sets the upper bound of acceptable values. If unset defaults to positive
+infinity. If a value is greater than B a B notification
+will be created. If the value is greater than B but less than (or
+equal to) B a B notification will be created.
+
+=item B I
+
+=item B I
+
+Sets the lower bound of acceptable values. If unset defaults to negative
+infinity. If a value is less than B a B notification will
+be created. If the value is less than B but greater than (or equal
+to) B a B notification will be created.
+
+=item B I
+
+Some data sets have more than one "data source". Interesting examples are the
+C data set, which has received (C) and sent (C) bytes and
+the C data set, which holds C and C operations. The
+system load data set, C, even has three data sources: C,
+C, and C.
+
+Normally, all data sources are checked against a configured threshold. If this
+is undesirable, or if you want to specify different limits for each data
+source, you can use the B option to have a threshold apply only to
+one data source.
+
+=item B B|B
+
+If set to B the range of acceptable values is inverted, i.Ee.
+values between B and B (B and
+B) are not okay. Defaults to B.
+
+=item B B|B
+
+Sets how often notifications are generated. If set to B one notification
+will be generated for each value that is out of the acceptable range. If set to
+B (the default) then a notification is only generated if a value is out
+of range but the previous value was okay.
+
+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.
+
+=item B I
+
+Delay creating the notification until the threshold has been passed I
+times. When a notification has been generated, or when a subsequent value is
+inside the threshold, the counter is reset. If, for example, a value is
+collected once every 10Eseconds and B is set to 3, a notification
+will be dispatched at most once every 30Eseconds.
+
+This is useful when short bursts are not a problem. If, for example, 100% CPU
+usage for up to a minute is normal (and data is collected every
+10Eseconds), you could set B to B<6> to account for this.
+
+=item B I
+
+When set to non-zero, a hysteresis value is applied when checking minimum and
+maximum bounds. This is useful for values that increase slowly and fluctuate a
+bit while doing so. When these values come close to the threshold, they may
+"flap", i.e. switch between failure / warning case and okay case repeatedly.
+
+If, for example, the threshold is configures as
+
+ WarningMax 100.0
+ Hysteresis 1.0
+
+then a I notification is created when the value exceeds I<101> and the
+corresponding I notification is only created once the value falls below
+I<99>, thus avoiding the "flapping".
+
+=back
+
=head1 FILTER CONFIGURATION
Starting with collectd 4.6 there is a powerful filtering infrastructure
@@ -5501,7 +5933,7 @@ convert counter values to rates.
Please note that these placeholders are B!
-=item B B<"FATAL">|B<"WARNING">|B<"OKAY">
+=item B B<"FAILURE">|B<"WARNING">|B<"OKAY">
Sets the severity of the message. If omitted, the severity B<"WARNING"> is
used.