From 4dd90d1544d98c964e1beb4324b85edbd5907c84 Mon Sep 17 00:00:00 2001 From: Florian Forster Date: Mon, 5 May 2008 17:30:33 +0200 Subject: [PATCH] collectd.conf(5): Documented the powerdns plugin. --- src/collectd.conf.pod | 133 ++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 133 insertions(+) diff --git a/src/collectd.conf.pod b/src/collectd.conf.pod index 781e2738..afa05711 100644 --- a/src/collectd.conf.pod +++ b/src/collectd.conf.pod @@ -909,6 +909,139 @@ Sets the Time-To-Live of generated ICMP packets. =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 -- 2.11.0