diff options
Diffstat (limited to 'collectors/python.d.plugin/unbound/README.md')
| -rw-r--r-- | collectors/python.d.plugin/unbound/README.md | 100 |
1 files changed, 52 insertions, 48 deletions
diff --git a/collectors/python.d.plugin/unbound/README.md b/collectors/python.d.plugin/unbound/README.md index d9cbc0b8c..d4ad3da15 100644 --- a/collectors/python.d.plugin/unbound/README.md +++ b/collectors/python.d.plugin/unbound/README.md @@ -4,37 +4,41 @@ Monitoring uses the remote control interface to fetch statistics. Provides the following charts: -1. **Queries Processed** - * Ratelimited - * Cache Misses - * Cache Hits - * Expired - * Prefetched - * Recursive - -2. **Request List** - * Average Size - * Max Size - * Overwritten Requests - * Overruns - * Current Size - * User Requests - -3. **Recursion Timings** - * Average recursion processing time - * Median recursion processing time +1. **Queries Processed** + + - Ratelimited + - Cache Misses + - Cache Hits + - Expired + - Prefetched + - Recursive + +2. **Request List** + + - Average Size + - Max Size + - Overwritten Requests + - Overruns + - Current Size + - User Requests + +3. **Recursion Timings** + +- Average recursion processing time +- Median recursion processing time If extended stats are enabled, also provides: -4. **Cache Sizes** - * Message Cache - * RRset Cache - * Infra Cache - * DNSSEC Key Cache - * DNSCrypt Shared Secret Cache - * DNSCrypt Nonce Cache +4. **Cache Sizes** + + - Message Cache + - RRset Cache + - Infra Cache + - DNSSEC Key Cache + - DNSCrypt Shared Secret Cache + - DNSCrypt Nonce Cache -### Configuration +## Configuration Unbound must be manually configured to enable the remote-control protocol. Check the Unbound documentation for info on how to do this. Additionally, @@ -78,27 +82,27 @@ that you use a UNIX socket as it provides far better performance. If you've configured the module and can't get it to work, make sure and check all of the following: -* If you're using autodetection, double check that your `unbound.conf` - file is actually using spaces instead of tabs, and that appropriate - indentation is present. Most Linux distributions ship a default config - for Unbound that uses tabs, and the plugin can't read such a config file - correctly. Also, make sure this file is actually readable by Netdata. -* Ensure that the control protocol is actually configured correctly. - You can check this quickly by running `unbound-control stats_noreset` - as root, which should print out a bunch of info about the internal - statistics of the server. If this returns an error, you don't have - the control protocol set up correctly. -* If using the regular control interface, make sure that the certificate - and key file you have configured in `unbound.conf` are readable by - Netdata. In general, it's preferred to use ACL's on the files to - provide the required permissions. -* If using a UNIX socket, make sure that the socket is both readable - _and_ writable by Netdata. Just like with the regular control - interface, it's preferred to use ACL's to provide these permissions. -* Make sure that SELinux, Apparmor, or any other mandatory access control - system isn't interfering with the access requirements mentioned above. - In some cases, you may have to add a local rule to allow this access. +- If you're using autodetection, double check that your `unbound.conf` + file is actually using spaces instead of tabs, and that appropriate + indentation is present. Most Linux distributions ship a default config + for Unbound that uses tabs, and the plugin can't read such a config file + correctly. Also, make sure this file is actually readable by Netdata. +- Ensure that the control protocol is actually configured correctly. + You can check this quickly by running `unbound-control stats_noreset` + as root, which should print out a bunch of info about the internal + statistics of the server. If this returns an error, you don't have + the control protocol set up correctly. +- If using the regular control interface, make sure that the certificate + and key file you have configured in `unbound.conf` are readable by + Netdata. In general, it's preferred to use ACL's on the files to + provide the required permissions. +- If using a UNIX socket, make sure that the socket is both readable + _and_ writable by Netdata. Just like with the regular control + interface, it's preferred to use ACL's to provide these permissions. +- Make sure that SELinux, Apparmor, or any other mandatory access control + system isn't interfering with the access requirements mentioned above. + In some cases, you may have to add a local rule to allow this access. --- -[]() +[](<>) |