From: bert hubert Date: Sun, 6 Apr 2014 13:51:44 +0000 (+0200) Subject: remove some old wording from docs, plus document our carbon stats sending X-Git-Tag: rec-3.6.0-rc1~79 X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=29ad8e6fde93c4865e20176bf80ca88b7940d169;p=thirdparty%2Fpdns.git remove some old wording from docs, plus document our carbon stats sending --- diff --git a/pdns/docs/pdns.xml b/pdns/docs/pdns.xml index 29988bf80f..3332032354 100644 --- a/pdns/docs/pdns.xml +++ b/pdns/docs/pdns.xml @@ -25,10 +25,10 @@ - The PowerDNS dynamic nameserver + The PowerDNS Authoritative Server - The PowerDNS daemon is a versatile nameserver which supports a large number + The PowerDNS Authoritative Server is a versatile nameserver which supports a large number of backends. These backends can either be plain zone files or be more dynamic in nature. Additionally, through use of clever programming techniques, PowerDNS offers very high domain resolution performance. @@ -37,7 +37,7 @@ Prime examples of backends include relational databases, but also (geographical) load balancing and failover algorithms. - The company is called PowerDNS.COM BV, the nameserver daemon is called PDNS. + The company is called PowerDNS.COM BV, the nameserver daemons are called PowerDNS Authoritative Server and PowerDNS Recursor. Function & design of PDNS @@ -65,11 +65,11 @@ Another prime goal is security. By the use of language features, the PDNS source code - is very small (in the order of 10.000 lines) which makes auditing easy. In the same way, library features have been used + is reasonably which makes auditing easy. In the same way, library features have been used to mitigate the risks of buffer overflows. - Finally, PDNS is able to give a lot of statistics on its operation which is both helpful in + Finally, PowerDNS is able to give a lot of statistics on its operation which is both helpful in determining the scalability of an installation as well as for spotting problems. @@ -14179,6 +14179,20 @@ sql> insert into domainmetadata (domain_id, kind, content) values (6, 'TSIG-ALLO + carbon-ourname=... + + If sending carbon updates, if set, this will override our hostname. See . Available beyond 3.5.3. + + carbon-server=... + + If set to an IP or IPv6 address, will send all available metrics to this server + via the carbon protocol, which is used by graphite and metronome. See . Available beyond 3.5.3. + + carbon-interval=... + + If sending carbon updates, this is the interval between them in seconds. See . Available beyond 3.5.3. + + chroot If set, chroot to this directory for more security. See . @@ -15908,6 +15922,20 @@ To enable a Lua script for a particular slave zone, determine the domain_id for Seconds to store packets in the PacketCache. See . + carbon-ourname=... + + If sending carbon updates, if set, this will override our hostname. See . Available beyond 3.3.1. + + carbon-server=... + + If set to an IP or IPv6 address, will send all available metrics to this server + via the carbon protocol, which is used by graphite and metronome. See . Available beyond 3.3.1. + + carbon-interval=... + + If sending carbon updates, this is the interval between them in seconds. See . Available beyond 3.3.1. + + chroot=... If set, chroot to this directory for more security. See . @@ -17280,6 +17308,36 @@ This setting will make PowerDNS renotify the slaves after an AXFR is *received* + PowerDNS Metrics, and how to display them + + + Available in releases after PowerDNS Authoritative Server 3.3.1 and PowerDNS Recursor 3.5.3. + + + + Both PowerDNS daemons generate ample metrics which can be used to monitor performance. These metrics + can be polled using the rec_control and pdns_control commands, and they are also available via the http-based API. + Finally, they can be pushed to a Carbon/Graphite server, either native carbon, or our own Metronome implementation. + + + For carbon/graphite/metronome, we use the following namespace. Everything starts with 'pdns.', which is then followed + by the local hostname. Thirdly, we add either 'auth' or 'recursor' to siginify the daemon generating the metrics. + This is then rounded off with the actual name of the metric. As an example: 'pdns.ns1.recursor.questions'. + + + Care has been taken to make the sending of statistics as unobtrusive as possible, the daemons will not be + hindered by an unreachable carbon server, timeouts or connection refused situations. + + + To benefit from our carbon/graphite support, either install Graphite, or use our own lightweight + statistics daemon, Metronome, currently available on GitHub. + + + Secondly, set carbon-server, possibly carbon-interval, possibly carbon-ourname in the configuration. + + + + Backends in detail This appendix lists several of the available backends in more detail