174
174
Optional password needed for authentication.
176
=item B<VerifyPeer> B<true|false>
178
Enable or disable peer SSL certificate verification. See
179
L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
181
=item B<VerifyHost> B<true|false>
183
Enable or disable peer host name verification. If enabled, the plugin checks
184
if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
185
certificate matches the host name provided by the B<URL> option. If this
186
identity check fails, the connection is aborted. Obviously, only works when
187
connecting to a SSL enabled server. Enabled by default.
176
189
=item B<CACert> I<File>
178
191
File that holds one or more SSL certificates. If you want to use HTTPS you will
213
=head2 Plugin C<ascent>
215
This plugin collects information about an Ascent server, a free server for the
216
"World of Warcraft" game. This plugin gathers the information by fetching the
217
XML status page using C<libcurl> and parses it using C<libxml2>.
219
The configuration options are the same as for the C<apache> plugin above:
223
=item B<URL> I<http://localhost/ascent/status/>
225
Sets the URL of the XML status output.
227
=item B<User> I<Username>
229
Optional user name needed for authentication.
231
=item B<Password> I<Password>
233
Optional password needed for authentication.
235
=item B<CACert> I<File>
237
File that holds one or more SSL certificates. If you want to use HTTPS you will
238
possibly need this option. What CA certificates come bundled with C<libcurl>
239
and are checked by default depends on the distribution you use.
200
243
=head2 Plugin C<cpufreq>
202
245
This plugin doesn't have any options. It reads
293
=head2 Plugin C<disk>
295
The C<disk> plugin collects information about the usage of physical disks and
296
logical disks (partitions). Values collected are the number of octets written
297
to and read from a disk or partition, the number of read/write operations
298
issued to the disk and a rather complex "time" it took for these commands to be
301
Using the following two options you can ignore some disks or configure the
302
collection only of specific disks.
306
=item B<Disk> I<Name>
308
Select the disk I<Name>. Whether it is collected or ignored depends on the
309
B<IgnoreSelected> setting, see below. As with other plugins that use the
310
daemon's ignorelist functionality, a string that starts and ends with a slash
311
is interpreted as a regular expression. Examples:
316
=item B<IgnoreSelected> B<true>|B<false>
318
Sets whether selected disks, i.E<nbsp>e. the ones matches by any of the B<Disk>
319
statements, are ignored or if all other disks are ignored. The behavior
320
(hopefully) is intuitive: If no B<Disk> option is configured, all disks are
321
collected. If at least one B<Disk> option is given and no B<IgnoreSelected> or
322
set to B<false>, B<only> matching disks will be collected. If B<IgnoreSelected>
323
is set to B<true>, all disks are collected B<except> the ones matched.
250
327
=head2 Plugin C<dns>
760
837
Optional password needed for authentication.
839
=item B<VerifyPeer> B<true|false>
841
Enable or disable peer SSL certificate verification. See
842
L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
844
=item B<VerifyHost> B<true|false>
846
Enable or disable peer host name verification. If enabled, the plugin checks
847
if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
848
certificate matches the host name provided by the B<URL> option. If this
849
identity check fails, the connection is aborted. Obviously, only works when
850
connecting to a SSL enabled server. Enabled by default.
762
852
=item B<CACert> I<File>
764
854
File that holds one or more SSL certificates. If you want to use HTTPS you will
912
=head2 Plugin C<powerdns>
914
The C<powerdns> plugin queries statistics from an authoritative PowerDNS
915
nameserver and/or a PowerDNS recursor. Since both offer a wide variety of
916
values, many of which are probably meaningless to most users, but may be useful
917
for some. So you may chose which values to collect, but if you don't, some
918
reasonable defaults will be collected.
921
<Server "server_name">
923
Collect "udp-answers" "udp-queries"
924
Socket "/var/run/pdns.controlsocket"
926
<Recursor "recursor_name">
928
Collect "cache-hits" "cache-misses"
929
Socket "/var/run/pdns_recursor.controlsocket"
931
LocalSocket "/opt/collectd/var/run/collectd-powerdns"
936
=item B<Server> and B<Recursor> block
938
The B<Server> block defines one authoritative server to query, the B<Recursor>
939
does the same for an recursing server. The possible options in both blocks are
940
the same, though. The argument defines a name for the serverE<nbsp>/ recursor
945
=item B<Collect> I<Field>
947
Using the B<Collect> statement you can select which values to collect. Here,
948
you specify the name of the values as used by the PowerDNS servers, e.E<nbsp>g.
949
C<dlg-only-drops>, C<answers10-100>.
951
The method of getting the values differs for B<Server> and B<Recursor> blocks:
952
When querying the server a C<SHOW *> command is issued in any case, because
953
that's the only way of getting multiple values out of the server at once.
954
collectd then picks out the values you have selected. When querying the
955
recursor, a command is generated to query exactly these values. So if you
956
specify invalid fields when querying the recursor, a syntax error may be
957
returned by the daemon and collectd may not collect any values at all.
959
If no B<Collect> statement is given, the following B<Server> values will be
966
=item packetcache-hit
968
=item packetcache-miss
970
=item packetcache-size
972
=item query-cache-hit
974
=item query-cache-miss
976
=item recursing-answers
978
=item recursing-questions
990
The following B<Recursor> values will be collected by default:
994
=item noerror-answers
996
=item nxdomain-answers
998
=item servfail-answers
1016
Please note that up to that point collectd doesn't know what values are
1017
available on the server and values that are added do not need a change of the
1018
mechanism so far. However, the values must be mapped to collectd's naming
1019
scheme, which is done using a lookup table that lists all known values. If
1020
values are added in the future and collectd does not know about them, you will
1021
get an error much like this:
1023
powerdns plugin: submit: Not found in lookup table: foobar = 42
1025
In this case please file a bug report with the collectd team.
1027
=item B<Socket> I<Path>
1029
Configures the path to the UNIX domain socket to be used when connecting to the
1030
daemon. By default C</var/run/pdns.controlsocket> will be used for an
1031
authoritative server and C</var/run/pdns_recursor.controlsocket> will be used
1036
=item B<LocalSocket> I<Path>
1038
Querying the recursor is done using UDP. When using UDP over UNIX domain
1039
sockets, the client socket needs a name in the file system, too. You can set
1040
this local name to I<Path> using the B<LocalSocket> option. The default is
1041
C<I<prefix>/var/run/collectd-powerdns>.
822
1045
=head2 Plugin C<processes>
1189
=head2 Plugin C<tail>
1191
The C<tail plugin> plugins follows logfiles, just like L<tail(1)> does, parses
1192
each line and dispatches found values. What is matched can be configured by the
1193
user using (extended) regular expressions, as described in L<regex(7)>.
1196
<File "/var/log/exim4/mainlog">
1199
Regex "S=([1-9][0-9]*)"
1205
Regex "\\<R=local_user\\>"
1208
Instance "local_user"
1213
The config consists of one or more B<File> blocks, each of which configures one
1214
logfile to parse. Within each B<File> block, there are one or more B<Match>
1215
blocks, which configure a regular expression to search for.
1217
The B<Instance> option in the B<File> block may be used to set the plugin
1218
instance. So in the above example the plugin name C<tail-foo> would be used.
1219
This plugin instance is for all B<Match> blocks that B<follow> it, until the
1220
next B<Instance> option. This way you can extract several plugin instances from
1221
one logfile, handy when parsing syslog and the like.
1223
Each B<Match> block has the following options to describe how the match should
1228
=item B<Regex> I<regex>
1230
Sets the regular expression to use for matching against a line. The first
1231
subexpression has to match something that can be turned into a number by
1232
L<strtoll(3)> or L<strtod(3)>, depending on the value of C<CounterAdd>, see
1233
below. Because B<extended> regular expressions are used, you do not need to use
1234
backslashes for subexpressions! If in doubt, please consult L<regex(7)>. Due to
1235
collectd's config parsing you need to escape backslashes, though. So if you
1236
want to match literal parentheses you need to do the following:
1238
Regex "SPAM \\(Score: (-?[0-9]+\\.[0-9]+)\\)"
1240
=item B<DSType> I<Type>
1242
Sets how the values are cumulated. I<Type> is one of:
1246
=item B<GaugeAverage>
1248
Calculate the average.
1252
Use the smallest number only.
1256
Use the greatest number only.
1260
Use the last number found.
1264
The matched number is a counter. Simply sets the internal counter to this
1269
Add the matched value to the internal counter.
1273
Increase the internal counter by one. This B<DSType> is the only one that does
1274
not use the matched subexpression, but simply counts the number of matched
1275
lines. Thus, you may use a regular expression without submatch in this case.
1279
As you'd expect the B<Gauge*> types interpret the submatch as a floating point
1280
number, using L<strtod(3)>. The B<CounterSet> and B<CounterAdd> interpret the
1281
submatch as an integer using L<strtoll(3)>. B<CounterInc> does not use the
1282
submatch at all and it may be omitted in this case.
1284
=item B<Type> I<Type>
1286
Sets the type used to dispatch this value. Detailed information about types and
1287
their configuration can be found in L<types.db(5)>.
1289
=item B<Instance> I<TypeInstance>
1291
This optional setting sets the type instance to use.
1295
=head2 Plugin C<teamspeak2>
1297
The C<teamspeak2 plugin> connects to the query port of a teamspeak2 server and
1298
polls interesting global and virtual server data. The plugin can query only one
1299
physical server but unlimited virtual servers. You can use the following
1300
options to configure it:
1304
=item B<Host> I<hostname/ip>
1306
The hostname or ip which identifies the physical server.
1309
=item B<Port> I<port>
1311
The query port of the physical server. This needs to be a string.
1314
=item B<Server> I<port>
1316
This option has to be added once for every virtual server the plugin should
1317
query. If you want to query the virtual server on port 8767 this is what the
1318
option would look like:
1322
This option, although numeric, needs to be a string, i.E<nbsp>e. you B<must>
1323
use quotes around it! If no such statement is given only global information
966
1326
=head2 Plugin C<tcpconns>
968
1328
The C<tcpconns plugin> counts the number of currently established TCP
1428
=head2 Plugin C<vmem>
1430
The C<vmem> plugin collects information about the usage of virtual memory.
1431
Since the statistics provided by the Linux kernel are very detailed, they are
1432
collected very detailed. However, to get all the details, you have to switch
1433
them on manually. Most people just want an overview over, such as the number of
1434
pages read from swap space.
1438
=item B<Verbose> B<true>|B<false>
1440
Enables verbose collection of information. This will start collecting page
1441
"actions", e.E<nbsp>g. page allocations, (de)activations, steals and so on.
1442
Part of these statistics are collected on a "per zone" basis.
1066
1446
=head2 Plugin C<vserver>
1068
1448
This plugin doesn't have any options. B<VServer> support is only available for
1164
1545
be created. If the value is less than B<WarningMin> but greater than (or equal
1165
1546
to) B<FailureMin> a B<WARNING> notification will be created.
1548
=item B<DataSource> I<DSName>
1550
Some data sets have more than one "data source". Interesting examples are the
1551
C<if_octets> data set, which has received (C<rx>) and sent (C<tx>) bytes and
1552
the C<disk_ops> data set, which holds C<read> and C<write> operations. The
1553
system load data set, C<load>, even has three data sources: C<shortterm>,
1554
C<midterm>, and C<longterm>.
1556
Normally, all data sources are checked against a configured threshold. If this
1557
is undesirable, or if you want to specify different limits for each data
1558
source, you can use the B<DataSource> option to have a threshold apply only to
1167
1561
=item B<Invert> B<true>|B<false>
1169
1563
If set to B<true> the range of acceptable values is inverted, i.E<nbsp>e.
added
removed
src/collectd.conf.pod
