diff options
author | Austin S. Hemmelgarn <ahferroin7@gmail.com> | 2019-02-28 13:41:47 -0500 |
---|---|---|
committer | GitHub <noreply@github.com> | 2019-02-28 13:41:47 -0500 |
commit | 7938af8e6c6570e1def6baa001fca72f84a40330 (patch) | |
tree | 9c8261e98e24dde3669e630f4181da2aed3c43e5 | |
parent | 01eb819ff49cb918f157c183b7d50c3d925ddb04 (diff) |
Update unbound module documenttion with troubleshooting section. (#5528)
-rw-r--r-- | collectors/python.d.plugin/unbound/README.md | 28 |
1 files changed, 27 insertions, 1 deletions
diff --git a/collectors/python.d.plugin/unbound/README.md b/collectors/python.d.plugin/unbound/README.md index e213683cab..d9cbc0b8c3 100644 --- a/collectors/python.d.plugin/unbound/README.md +++ b/collectors/python.d.plugin/unbound/README.md @@ -34,7 +34,7 @@ If extended stats are enabled, also provides: * 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, @@ -73,6 +73,32 @@ local: While it's a bit more complicated to set up correctly, it is recommended that you use a UNIX socket as it provides far better performance. +### Troubleshooting + +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. + --- [![analytics](https://www.google-analytics.com/collect?v=1&aip=1&t=pageview&_s=1&ds=github&dr=https%3A%2F%2Fgithub.com%2Fnetdata%2Fnetdata&dl=https%3A%2F%2Fmy-netdata.io%2Fgithub%2Fcollectors%2Fpython.d.plugin%2Funbound%2FREADME&_u=MAC~&cid=5792dfd7-8dc4-476b-af31-da2fdb9f93d2&tid=UA-64295674-3)]() |