From: Pierre Lebleu <pme.lebleu@gmail.com>
Date: Tue, 9 Jul 2019 13:56:26 +0000 (+0200)
Subject: UBI plugin: add documentation
X-Git-Tag: collectd-5.11.0~34^2~2
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=85b87890acfe6fd7fb925736b0ed76e010020169;p=thirdparty%2Fcollectd.git

UBI plugin: add documentation

Update the README, the collectd.conf.in and collectd.conf.pod
---

diff --git a/README b/README
index f28d49922..15c1de3b0 100644
--- a/README
+++ b/README
@@ -428,6 +428,10 @@ Features
       Reads CPU frequency and C-state residency on modern Intel
       turbo-capable processors.
 
+    - ubi
+      Reads the count of bad physical eraseblocks and the current
+      maximum erase counter value on UBI volumes.
+
     - uptime
       System uptime statistics.
 
diff --git a/src/collectd.conf.in b/src/collectd.conf.in
index f09f373d3..c3a27d84d 100644
--- a/src/collectd.conf.in
+++ b/src/collectd.conf.in
@@ -1602,6 +1602,11 @@
 #	RunningAveragePowerLimit "7"
 #</Plugin>
 
+#<Plugin ubi>
+#	Device "ubi0"
+#	IgnoreSelected false
+#</Plugin>
+
 #<Plugin unixsock>
 #	SocketFile "@prefix@/var/run/@PACKAGE_NAME@-unixsock"
 #	SocketGroup "collectd"
diff --git a/src/collectd.conf.pod b/src/collectd.conf.pod
index ed49195e4..91dd6cc5d 100644
--- a/src/collectd.conf.pod
+++ b/src/collectd.conf.pod
@@ -8973,6 +8973,38 @@ L<https://bugzilla.kernel.org/show_bug.cgi?id=151821>
 
 =back
 
+=head2 Plugin C<ubi>
+
+The I<Ubi plugin> collects some statistics about the UBI (Unsorted Block Image).
+Values collected are the number of bad physical eraseblocks on the underlying MTD
+(Memory Technology Device) and the maximum erase counter value concerning one volume.
+
+See following links for details:
+
+L<http://www.linux-mtd.infradead.org/doc/ubi.html>
+L<http://www.linux-mtd.infradead.org/doc/ubifs.html>
+L<https://www.kernel.org/doc/Documentation/ABI/stable/sysfs-class-ubi>
+
+=over 4
+
+=item B<Device> I<Name>
+
+Select the device I<Name> of the UBI volume. Whether it is collected or ignored
+depends on the B<IgnoreSelected> setting, see below.
+
+See F</"IGNORELISTS"> for details.
+
+=item B<IgnoreSelected> B<true>|B<false>
+
+Sets whether selected devices, i.E<nbsp>e. the ones matches by any of the B<Device>
+statements, are ignored or if all other devices are ignored. If no B<Device> option
+is configured, all devices are collected. If at least one B<Device> is given and no
+B<IgnoreSelected> or set to B<false>, B<only> matching disks will be collected. If
+B<IgnoreSelected>is set to B<true>, all devices are collected B<except> the ones
+matched.
+
+=back
+
 =head2 Plugin C<unixsock>
 
 =over 4