X-Git-Url: https://git.octo.it/?a=blobdiff_plain;f=src%2Fcollectd.conf.pod;h=884298dc3f7bc07cbde2e8e26e8a8ac61d6a5aa7;hb=c71b8d22d731098030a81dd974f2f76ac7f7b32e;hp=781e273823730d9265dfeea6dc15f0f3729c5ad9;hpb=6b49eec15d421a74935fb1165c3e9fdb80ca838e;p=collectd.git diff --git a/src/collectd.conf.pod b/src/collectd.conf.pod index 781e2738..884298dc 100644 --- a/src/collectd.conf.pod +++ b/src/collectd.conf.pod @@ -232,6 +232,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 @@ -450,7 +463,7 @@ similar interfaces. Thus, you can use the B-option to pick the interfaces you're interested in. Sometimes, however, it's easier/preferred to collect all interfaces I a few ones. This option enables you to do that: By setting B to I the effect of -B is inversed: All selected interfaces are ignored and all +B is inverted: All selected interfaces are ignored and all other interfaces are collected. =back @@ -490,7 +503,7 @@ irqs. This may not be practical, especially if no interrupts happen. Thus, you can use the B-option to pick the interrupt you're interested in. Sometimes, however, it's easier/preferred to collect all interrupts I a few ones. This option enables you to do that: By setting B to -I the effect of B is inversed: All selected interrupts are ignored +I the effect of B is inverted: All selected interrupts are ignored and all other interrupts are collected. =back @@ -749,7 +762,7 @@ Here are some examples to help you understand the above text more easily: The behaviour is the same as with all other similar plugins: If nothing is selected at all, everything is collected. If some things are selected using the options described above, only these statistics are collected. If you set -B to B, this behavior is inversed, i.Ee. the +B to B, this behavior is inverted, i.Ee. the specified statistics will not be collected. =back @@ -857,6 +870,32 @@ and are checked by default depends on the distribution you use. =back +=head2 Plugin C + +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. + +The Desktop Notification Specification can be found at +L. + +=over 4 + +=item B I + +=item B I + +=item B I + +Set the I, in milliseconds, after which to expire the notification +for C, C and C severities respectively. If zero has +been specified, the displayed notification will not be closed at all - the +user has to do so herself. These options default to 5000. If a negative number +has been specified, the default is used as well. + +=back + =head2 Plugin C =over 4 @@ -889,6 +928,46 @@ L. =back +=head2 Plugin C + +The C plugin uses the B library from the B project +L to read sensors connected via the onewire bus. + +=over 4 + +=item B I + +Sets the device to read the values from. This can either be a "real" hardware +device, such as a serial port or an USB port, or the address of the +L socket, usually B. + +Though the documentation claims to automatically recognize the given address +format, with versionE2.7p4 we had to specify the type explicitly. So +with that version, the following configuration worked for us: + + + Device "-s localhost:4304" + + +=item B I + +Selects sensors to collect or to ignore, depending on B, see +below. Sensors are specified without the family byte at the beginning, to you'd +use C, and B include the leading C<10.> family byte and +point. + +=item B I|I + +If no configuration if given, the B plugin will collect data from all +sensors found. This may not be practical, especially if sensors are added and +removed regularly. Sometimes, however, it's easier/preferred to collect only +specific sensors or all sensors I a few specified ones. This option +enables you to do that: By setting B to I the effect of +B is inverted: All selected interfaces are ignored and all other +interfaces are collected. + +=back + =head2 Plugin C This plugin embeds a Perl-interpreter into collectd and provides an interface @@ -909,6 +988,243 @@ Sets the Time-To-Live of generated ICMP packets. =back +=head2 Plugin C + +The C plugin queries statistics from PostgreSQL databases. It +keeps a persistent connection to all configured databases and tries to +reconnect if the connection has been interrupted. The statistics are collected +from PostgreSQL's B which thus has to be enabled for +this plugin to work correctly. This should usually be the case by default. +See the section "The Statistics Collector" of the B +for details. + +The B manual can be found at +L. + + + + Host "hostname" + Port "5432" + User "username" + Password "secret" + SSLMode "prefer" + KRBSrvName "kerberos_service_name" + + + Service "service_name" + + + +=over 4 + +=item B block + +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 +default values as documented in the section "CONNECTING TO A DATABASE" in the +L manpage. However, be aware that those defaults may be influenced by +the user collectd is run as and special environment variables. See the manpage +for details. + +=item B I + +Specify the hostname or IP of the PostgreSQL server to connect to. If the +value begins with a slash, it is interpreted as the directory name in which to +look for the UNIX domain socket. + +This option is also used to determine the hostname that is associated with a +collected data set. If it has been omitted or either begins with with a slash +or equals B it will be replaced with the global hostname definition +of collectd. Any other value will be passed literally to collectd when +dispatching values. Also see the global B and B options. + +=item B I + +Specify the TCP port or the local UNIX domain socket file extension of the +server. + +=item B I + +Specify the username to be used when connecting to the server. + +=item B I + +Specify the password to be used when connecting to the server. + +=item B I|I|I|I + +Specify whether to use an SSL connection when contacting the server. The +following modes are supported: + +=over 4 + +=item I + +Do not use SSL at all. + +=item I + +First, try to connect without using SSL. If that fails, try using SSL. + +=item I (default) + +First, try to connect using SSL. If that fails, try without using SSL. + +=item I + +Use SSL only. + +=back + +=item B I + +Specify the Kerberos service name to use when authenticating with Kerberos 5 +or GSSAPI. See the sections "Kerberos authentication" and "GSSAPI" of the +B for details. + +=item B I + +Specify the PostgreSQL service name to use for additional parameters. That +service has to be defined in F and holds additional +connection parameters. See the section "The Connection Service File" in the +B for details. + +=back + +=head2 Plugin C + +The C plugin queries statistics from an authoritative PowerDNS +nameserver and/or a PowerDNS recursor. Since both offer a wide variety of +values, many of which are probably meaningless to most users, but may be useful +for some. So you may chose which values to collect, but if you don't, some +reasonable defaults will be collected. + + + + Collect "latency" + Collect "udp-answers" "udp-queries" + Socket "/var/run/pdns.controlsocket" + + + Collect "questions" + Collect "cache-hits" "cache-misses" + Socket "/var/run/pdns_recursor.controlsocket" + + LocalSocket "/opt/collectd/var/run/collectd-powerdns" + + +=over 4 + +=item B and B block + +The B block defines one authoritative server to query, the B +does the same for an recursing server. The possible options in both blocks are +the same, though. The argument defines a name for the serverE/ recursor +and is required. + +=over 4 + +=item B I + +Using the B statement you can select which values to collect. Here, +you specify the name of the values as used by the PowerDNS servers, e.Eg. +C, C. + +The method of getting the values differs for B and B blocks: +When querying the server a C command is issued in any case, because +that's the only way of getting multiple values out of the server at once. +collectd then picks out the values you have selected. When querying the +recursor, a command is generated to query exactly these values. So if you +specify invalid fields when querying the recursor, a syntax error may be +returned by the daemon and collectd may not collect any values at all. + +If no B statement is given, the following B values will be +collected: + +=over 4 + +=item latency + +=item packetcache-hit + +=item packetcache-miss + +=item packetcache-size + +=item query-cache-hit + +=item query-cache-miss + +=item recursing-answers + +=item recursing-questions + +=item tcp-answers + +=item tcp-queries + +=item udp-answers + +=item udp-queries + +=back + +The following B values will be collected by default: + +=over 4 + +=item noerror-answers + +=item nxdomain-answers + +=item servfail-answers + +=item sys-msec + +=item user-msec + +=item qa-latency + +=item cache-entries + +=item cache-hits + +=item cache-misses + +=item questions + +=back + +Please note that up to that point collectd doesn't know what values are +available on the server and values that are added do not need a change of the +mechanism so far. However, the values must be mapped to collectd's naming +scheme, which is done using a lookup table that lists all known values. If +values are added in the future and collectd does not know about them, you will +get an error much like this: + + powerdns plugin: submit: Not found in lookup table: foobar = 42 + +In this case please file a bug report with the collectd team. + +=item B I + +Configures the path to the UNIX domain socket to be used when connecting to the +daemon. By default C will be used for an +authoritative server and C will be used +for the recursor. + +=back + +=item B I + +Querying the recursor is done using UDP. When using UDP over UNIX domain +sockets, the client socket needs a name in the file system, too. You can set +this local name to I using the B option. The default is +C/var/run/collectd-powerdns>. + +=back + =head2 Plugin C =over 4 @@ -1027,7 +1343,7 @@ sensors. This may not be practical, especially for uninteresting sensors. Thus, you can use the B-option to pick the sensors you're interested in. Sometimes, however, it's easier/preferred to collect all sensors I a few ones. This option enables you to do that: By setting B to -I the effect of B is inversed: All selected sensors are ignored +I the effect of B is inverted: All selected sensors are ignored and all other sensors are collected. =back @@ -1230,6 +1546,32 @@ port in numeric form. =back +=head2 Plugin C + +=over 4 + +=item B I|I + +By default, the C plugin tries to read the statistics from the Linux +C interface. If that is not available, the plugin falls back to the +C interface. By setting this option to I, you can force the +plugin to use the latter. This option defaults to I. + +=item B I + +Selects the name of the thermal device that you want to collect or ignore, +depending on the value of the B option. This option may be +used multiple times to specify a list of devices. + +=item B I|I + +Invert the selection: If set to true, all devices B the ones that +match the device names specified by the B option are collected. By +default only selected devices are collected if a selection is made. If no +selection is configured at all, B devices are selected. + +=back + =head2 Plugin C =over 4 @@ -1454,6 +1796,7 @@ L, L, L, L, +L, L, L