X-Git-Url: https://git.octo.it/?a=blobdiff_plain;ds=sidebyside;f=src%2Fcollectd.conf.pod;h=781e273823730d9265dfeea6dc15f0f3729c5ad9;hb=c84dfcbfe5971d55fbcbc88a88f2845fbeb8dfb3;hp=92a5e2545e78a7756ad5263c1d46c6ace3f6dcf5;hpb=da933ca8f0bd3d3ec9ee5681f0e88f3b46e884d3;p=collectd.git
diff --git a/src/collectd.conf.pod b/src/collectd.conf.pod
index 92a5e254..781e2738 100644
--- a/src/collectd.conf.pod
+++ b/src/collectd.conf.pod
@@ -53,11 +53,26 @@ directory for the daemon.
Loads the plugin I. There must be at least one such line or B
will be mostly useless.
-=item B I
+=item B I
-Includes the file I as if it was copy and pasted here. To prevent loops
-and shooting yourself in the foot in interesting ways the nesting is limited to
-a depth of 8Elevels, which should be sufficient for most uses.
+If I points to a file, includes that file. If I points to a
+directory, recursively includes all files within that directory and its
+subdirectories. If the C function is available on your system,
+shell-like wildcards are expanded before files are included. This means you can
+use statements like the following:
+
+ Include "/etc/collectd.d/*.conf"
+
+If more than one files are included by a single B option, the files
+will be included in lexicographical order (as defined by the C
+function). Thus, you can e.Eg. use numbered prefixes to specify the
+order in which the files are loaded.
+
+To prevent loops and shooting yourself in the foot in interesting ways the
+nesting is limited to a depth of 8Elevels, which should be sufficient for
+most uses. Since symlinks are followed it is still possible to crash the daemon
+by looping symlinks. In our opinion significant stupidity should result in an
+appropriate amount of pain.
It is no problem to have a block like CPlugin fooE> in more than one
file, but you cannot include files from within blocks.
@@ -158,6 +173,19 @@ Optional user name needed for authentication.
Optional password needed for authentication.
+=item 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
@@ -182,6 +210,36 @@ TCP-Port to connect to. Defaults to B<3551>.
=back
+=head2 Plugin C
+
+This plugin collects information about an Ascent server, a free server for the
+"World of Warcraft" game. This plugin gathers the information by fetching the
+XML status page using C and parses it using C.
+
+The configuration options are the same as for the C plugin above:
+
+=over 4
+
+=item B I
+
+Sets the URL of the XML status output.
+
+=item B I
+
+Optional user name needed for authentication.
+
+=item B I
+
+Optional password needed for authentication.
+
+=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
+
=head2 Plugin C
This plugin doesn't have any options. It reads
@@ -232,6 +290,40 @@ at all, B partitions are selected.
=back
+=head2 Plugin C
+
+The C plugin collects information about the usage of physical disks and
+logical disks (partitions). Values collected are the number of octets written
+to and read from a disk or partition, the number of read/write operations
+issued to the disk and a rather complex "time" it took for these commands to be
+issued.
+
+Using the following two options you can ignore some disks or configure the
+collection only of specific disks.
+
+=over 4
+
+=item B I
+
+Select the disk I. Whether it is collected or ignored depends on the
+B setting, see below. As with other plugins that use the
+daemon's ignorelist functionality, a string that starts and ends with a slash
+is interpreted as a regular expression. Examples:
+
+ Disk "sdd"
+ Disk "/hda[34]/"
+
+=item B B|B
+
+Sets whether selected disks, i.Ee. the ones matches by any of the B
+statements, are ignored or if all other disks are ignored. The behavior
+(hopefully) is intuitive: If no B option is configured, all disks are
+collected. If at least one B option is given and no B or
+set to B, B matching disks will be collected. If B
+is set to B, all disks are collected B the ones matched.
+
+=back
+
=head2 Plugin C
=over 4
@@ -289,8 +381,6 @@ output that is expected from it.
=item B I[:[I]] I [IargE> [IargE> ...]]
-=item B I[:[I]] I [IargE> [IargE> ...]]
-
Execute the executable I as user I. If the user name is
followed by a colon and a group name, the effective group is set to that group.
The real group and saved-set group will be set to the default group of that
@@ -307,10 +397,9 @@ program. Please note that due to the configuration parsing numbers and boolean
values may be changed. If you want to be absolutely sure that something is
passed as-is please enclose it in quotes.
-The B, B, and B statements change the
-semantics of the programs executed, i.Ee. the data passed to them and the
-response expected from them. This is documented in great detail in
-L.
+The B and B statements change the semantics of the
+programs executed, i.Ee. the data passed to them and the response
+expected from them. This is documented in great detail in L.
=back
@@ -335,6 +424,13 @@ Hostname to connect to. Defaults to B<127.0.0.1>.
TCP-Port to connect to. Defaults to B<7634>.
+=item B I|I
+
+If enabled, translate the disk names to major/minor device numbers
+(e.Eg. "8-0" for /dev/sda). For backwards compatibility this defaults to
+I but it's recommended to disable it as it will probably be removed in
+the next major version.
+
=back
=head2 Plugin C
@@ -426,7 +522,8 @@ seconds. Setting this to be the same or smaller than the I will cause
the list of domains and devices to be refreshed on every iteration.
Refreshing the devices in particular is quite a costly operation, so if your
-virtualization setup is static you might consider increasing this.
+virtualization setup is static you might consider increasing this. If this
+option is set to 0, refreshing is disabled completely.
=item B I
@@ -739,6 +836,19 @@ Optional user name needed for authentication.
Optional password needed for authentication.
+=item 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
@@ -943,6 +1053,143 @@ debugging support.
=back
+=head2 Plugin C
+
+The C plugins follows logfiles, just like L does, parses
+each line and dispatches found values. What is matched can be configured by the
+user using (extended) regular expressions, as described in L.
+
+
+
+ Instance "exim"
+
+ Regex "S=([1-9][0-9]*)"
+ DSType "CounterAdd"
+ Type "ipt_bytes"
+ Instance "total"
+
+
+ Regex "\\"
+ DSType "CounterInc"
+ Type "email_count"
+ Instance "local_user"
+
+
+
+
+The config consists of one or more B blocks, each of which configures one
+logfile to parse. Within each B block, there are one or more B
+blocks, which configure a regular expression to search for.
+
+The B option in the B block may be used to set the plugin
+instance. So in the above example the plugin name C would be used.
+This plugin instance is for all B blocks that B it, until the
+next B option. This way you can extract several plugin instances from
+one logfile, handy when parsing syslog and the like.
+
+Each B block has the following options to describe how the match should
+be performed:
+
+=over 4
+
+=item B I
+
+Sets the regular expression to use for matching against a line. The first
+subexpression has to match something that can be turned into a number by
+L or L, depending on the value of C, see
+below. Because B regular expressions are used, you do not need to use
+backslashes for subexpressions! If in doubt, please consult L. Due to
+collectd's config parsing you need to escape backslashes, though. So if you
+want to match literal parentheses you need to do the following:
+
+ Regex "SPAM \\(Score: (-?[0-9]+\\.[0-9]+)\\)"
+
+=item B I
+
+Sets how the values are cumulated. I is one of:
+
+=over 4
+
+=item B
+
+Calculate the average.
+
+=item B
+
+Use the smallest number only.
+
+=item B
+
+Use the greatest number only.
+
+=item B
+
+Use the last number found.
+
+=item B
+
+The matched number is a counter. Simply sets the internal counter to this
+value.
+
+=item B
+
+Add the matched value to 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
+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.
+
+=item B I
+
+Sets the type used to dispatch this value. Detailed information about types and
+their configuration can be found in L.
+
+=item B I
+
+This optional setting sets the type instance to use.
+
+=back
+
+=head2 Plugin C
+
+The C connects to the query port of a teamspeak2 server and
+polls interesting global and virtual server data. The plugin can query only one
+physical server but unlimited virtual servers. You can use the following
+options to configure it:
+
+=over 4
+
+=item B I
+
+The hostname or ip which identifies the physical server.
+Default: 127.0.0.1
+
+=item B I
+
+The query port of the physical server. This needs to be a string.
+Default: "51234"
+
+=item B I
+
+This option has to be added once for every virtual server the plugin should
+query. If you want to query the virtual server on port 8767 this is what the
+option would look like:
+
+ Server "8767"
+
+This option, although numeric, needs to be a string, i.Ee. you B
+use quotes around it! If no such statement is given only global information
+will be collected.
+
=head2 Plugin C
The C counts the number of currently established TCP
@@ -953,6 +1200,8 @@ fine-tune the ports you are interested in:
=over 4
+=back
+
=item B I|I
If this option is set to I, statistics for all local ports for which a
@@ -1043,6 +1292,24 @@ Take the UUID from the given file (default I).
=back
+=head2 Plugin C
+
+The C plugin collects information about the usage of virtual memory.
+Since the statistics provided by the Linux kernel are very detailed, they are
+collected very detailed. However, to get all the details, you have to switch
+them on manually. Most people just want an overview over, such as the number of
+pages read from swap space.
+
+=over 4
+
+=item B B|B
+
+Enables verbose collection of information. This will start collecting page
+"actions", e.Eg. page allocations, (de)activations, steals and so on.
+Part of these statistics are collected on a "per zone" basis.
+
+=back
+
=head2 Plugin C
This plugin doesn't have any options. B support is only available for
@@ -1094,6 +1361,7 @@ information.
Instance "eth0"
FailureMax 10000000
+ DataSource "rx"
@@ -1144,6 +1412,19 @@ 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.