diff options
Diffstat (limited to 'collectors/nfacct.plugin/README.md')
| -rw-r--r-- | collectors/nfacct.plugin/README.md | 47 |
1 files changed, 41 insertions, 6 deletions
diff --git a/collectors/nfacct.plugin/README.md b/collectors/nfacct.plugin/README.md index 5f1ee2e7c..b60fc6a44 100644 --- a/collectors/nfacct.plugin/README.md +++ b/collectors/nfacct.plugin/README.md @@ -1,12 +1,47 @@ # nfacct.plugin -This plugin that collects NFACCT statistics. +`nfacct.plugin` collects Netfilter statistics. -It is currently disabled by default, because it requires root access. -We have to move the code to an external plugin to setuid just the plugin not the whole netdata server. +## Prerequisites -You can build netdata with it to test it though. -Just run `./configure` (or `netdata-installer.sh`) with the option `--enable-plugin-nfacct` (and any other options you may need). -Remember, you have to tell netdata you want it to run as `root` for this plugin to work. +1. install `libmnl-dev` and `libnetfilter_acct-dev` using the package manager of your system. + +2. re-install netdata from source. The installer will detect that the required libraries are now available and will also build netdata.plugin. + +Keep in mind that NFACCT requires root access, so the plugin is setuid to root. + +## Charts + +The plugin provides Netfilter connection tracker statistics and nfacct packet and bandwidth accounting: + +Connection tracker: +1. Connections. +2. Changes. +3. Expectations. +4. Errors. +5. Searches. + +Netfilter accounting: +1. Packets. +2. Bandwidth. + +## Configuration + +If you need to disable NFACCT for netdata, edit /etc/netdata/netdata.conf and set: + +``` +[plugins] + nfacct = no +``` + +## Debugging + +You can run the plugin by hand: + +``` +sudo /usr/libexec/netdata/plugins.d/nfacct.plugin 1 debug +``` + +You will get verbose output on what the plugin does. []() |