X-Git-Url: https://git.tokkee.org/?a=blobdiff_plain;ds=sidebyside;f=src%2Fcollectd.conf.pod;h=274e38879feef8eb50bbafc2cec1eb4908ac1ac3;hb=1676cc920f366dfa38dbddce8be5f6b6c64754e7;hp=cc448a0ec06476381f07bcab313fb99e441eb3f6;hpb=2bdaa472d6955a8c93c6aa77f11748d4c611558e;p=collectd.git
diff --git a/src/collectd.conf.pod b/src/collectd.conf.pod
index cc448a0e..274e3887 100644
--- a/src/collectd.conf.pod
+++ b/src/collectd.conf.pod
@@ -57,6 +57,33 @@ directory for the daemon.
Loads the plugin I. There must be at least one such line or B
will be mostly useless.
+Starting with collectd 4.9, this may also be a block in which further options
+affecting the behavior of B may be specified. The following
+options are allowed inside a B block:
+
+
+ Globals true
+
+
+=over 4
+
+=item B B
+
+If enabled, collectd will export all global symbols of the plugin (and of all
+libraries loaded as dependencies of the plugin) and, thus, makes those symbols
+available for resolving unresolved symbols in subsequently loaded plugins if
+that is supported by your system. By default, this is disabled.
+
+This is useful (or possibly even required), e.Eg., when loading a plugin
+that embeds some scripting language into the daemon (e.Eg. the C
+or C plugins). Scripting languages usually provide means to load
+extensions written in C. Those extensions require symbols provided by the
+interpreter, which is loaded as a dependency of the respective collectd
+plugin. See the documentation of those plugins (e.Eg.,
+L or L) for details.
+
+=back
+
=item B I
If I points to a file, includes that file. If I points to a
@@ -102,6 +129,10 @@ Configures the interval in which to query the read plugins. Obviously smaller
values lead to a higher system load produced by collectd, while higher values
lead to more coarse statistics.
+B You should set this once and then never touch it again. If you do,
+I or know some serious RRDtool
+magic! (Assuming you're using the I or I plugin.)
+
=item B I
Consider a value list "missing" when no update has been read or received for
@@ -654,7 +685,7 @@ The B uses B (L) and B
In the B block, there may be one or more B blocks, each defining a
-URL to be fetched via HTTP (using libcurl). Within each B block there are
+URL to be fetched using libcurl. Within each B block there are
options which specify the connection parameters, for example authentication
information, and one or more B blocks.
@@ -1880,8 +1911,10 @@ Hostname of the database server. Defaults to B.
=item B I
Username to use when connecting to the database. The user does not have to be
-granted any privileges (which is synonym to granting the C privilege).
-Any existing MySQL user will do.
+granted any privileges (which is synonym to granting the C privilege),
+unless you want to collectd replication statistics (see B and
+B below). In this case, the user needs the C
+(or C) privileges. Else, any existing MySQL user will do.
=item B I
@@ -1913,7 +1946,9 @@ C function for details.
=item B I
-Enable the collection of master / slave statistics in a replication setup.
+Enable the collection of master / slave statistics in a replication setup. In
+order to be able to get access to these statistics, the user needs special
+privileges. See the B documentation above.
=item B I
@@ -2467,10 +2502,18 @@ The default IPv6 multicast group is C. The default IPv4
multicast group is C<239.192.74.66>. The default I port is B<25826>.
Both, B and B can be used as single option or as block. When
-used as block, given options are valid for this socket only. For example:
+used as block, given options are valid for this socket only. The following
+example will export the metrics twice: Once to an "internal" server (without
+encryption and signing) and one to an external server (with cryptographic
+signature):
+ # Export to an internal server
+ # (demonstrates usage without additional options)
Server "collectd.internal.tld"
+
+ # Export to an external server
+ # (demonstrates usage with signature options)
SecurityLevel "sign"
Username "myhostname"
@@ -2681,7 +2724,8 @@ and are checked by default depends on the distribution you use.
This plugin sends a desktop notification to a notification daemon, as defined
in the Desktop Notification Specification. To actually display the
notifications, B is required and B has to be
-able to access the X server.
+able to access the X server (i.Ee., the C and C
+environment variables have to be set correctly) and the D-Bus message bus.
The Desktop Notification Specification can be found at
L.
@@ -4175,25 +4219,37 @@ Use the last number found.
=item B
-The matched number is a counter. Simply sets the internal counter to this
-value.
+=item B
+
+=item B
+
+The matched number is a counter. Simply I the internal counter to this
+value. Variants exist for C, C, and C data sources.
=item B
-Add the matched value to the internal counter.
+=item B
+
+Add the matched value to the internal counter. In case of B, the
+matched number may be negative, which will effectively subtract from the
+internal counter.
=item B
-Increase the internal counter by one. This B is the only one that does
-not use the matched subexpression, but simply counts the number of matched
+=item B
+
+Increase the internal counter by one. These B are the only ones that do
+not use the matched subexpression, but simply count the number of matched
lines. Thus, you may use a regular expression without submatch in this case.
=back
As you'd expect the B types interpret the submatch as a floating point
-number, using L. The B and B interpret the
-submatch as an integer using L. B does not use the
-submatch at all and it may be omitted in this case.
+number, using L. The B and B types interpret
+the submatch as an unsigned integer using L. The B types
+interpret the submatch as a signed integer using L. B
+and B do not use the submatch at all and it may be omitted in this
+case.
=item B I
@@ -4648,6 +4704,34 @@ 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