From: Florian Forster <octo@collectd.org>
Date: Mon, 12 Mar 2012 06:38:19 +0000 (+0100)
Subject: ethstat plugin: Add documentation.
X-Git-Tag: collectd-5.1.0~9^2~3
X-Git-Url: https://git.verplant.org/?a=commitdiff_plain;h=f11e2883892c641404e10c54b977328820769d7b;p=collectd.git

ethstat plugin: Add documentation.
---

diff --git a/AUTHORS b/AUTHORS
index b7eda463..90560e34 100644
--- a/AUTHORS
+++ b/AUTHORS
@@ -54,6 +54,9 @@ Christophe Kalt <collectd at klb.taranis.org>
  - The version 3 `log' mode.
  - Many Solaris related hints and fixes.
 
+Cyril Feraudet <cyril at feraudet.com>
+ - ethstat plugin.
+
 Dan Berrange <berrange at redhat.com>
  - uuid plugin.
 
diff --git a/README b/README
index e65f46bf..67cac046 100644
--- a/README
+++ b/README
@@ -83,6 +83,9 @@ Features
     - entropy
       Amount of entropy available to the system.
 
+    - ethstat
+      Network interface card statistics.
+
     - exec
       Values gathered by a custom program or script.
       See collectd-exec(5).
diff --git a/src/collectd.conf.in b/src/collectd.conf.in
index 0e1dc2e4..01f024dd 100644
--- a/src/collectd.conf.in
+++ b/src/collectd.conf.in
@@ -73,6 +73,7 @@
 #@BUILD_PLUGIN_DNS_TRUE@LoadPlugin dns
 #@BUILD_PLUGIN_EMAIL_TRUE@LoadPlugin email
 #@BUILD_PLUGIN_ENTROPY_TRUE@LoadPlugin entropy
+#@BUILD_PLUGIN_ETHSTAT_TRUE@LoadPlugin ethstat
 #@BUILD_PLUGIN_EXEC_TRUE@LoadPlugin exec
 #@BUILD_PLUGIN_FILECOUNT_TRUE@LoadPlugin filecount
 #@BUILD_PLUGIN_FSCACHE_TRUE@LoadPlugin fscache
@@ -335,6 +336,10 @@
 #	MaxConns 5
 #</Plugin>
 
+#<Plugin ethstat>
+#	Interface "eth0"
+#</Plugin>
+
 #<Plugin exec>
 #	Exec "user:group" "/path/to/exec"
 #	NotificationExec "user:group" "/path/to/exec"
diff --git a/src/collectd.conf.pod b/src/collectd.conf.pod
index 139919f4..765d2ac7 100644
--- a/src/collectd.conf.pod
+++ b/src/collectd.conf.pod
@@ -1272,6 +1272,27 @@ at most B<16384> to prevent typos and dumb mistakes.
 
 =back
 
+=head2 Plugin C<ethstat>
+
+The I<ethstat plugin> collects information about network interface cards (NICs)
+by talking directly with the underlying kernel driver using L<ioctl(2)>.
+
+B<Synopsis:>
+
+ <Plugin "ethstat">
+   Interface "eth0"
+ </Plugin>
+
+B<Options:>
+
+=over 4
+
+=item B<Interface> I<Name>
+
+Collect statistical information about interface I<Name>.
+
+=back
+
 =head2 Plugin C<exec>
 
 Please make sure to read L<collectd-exec(5)> before using this plugin. It