OVS events: Fix multiple interface config issue

[collectd.git] / src / collectd.conf.pod

diff --git a/src/collectd.conf.pod b/src/collectd.conf.pod
index 2f29713..061c4ba 100644 (file)
--- a/src/collectd.conf.pod
+++ b/src/collectd.conf.pod
@@ -5453,6 +5453,71 @@ refer to them from.
 
 =back
 
+=head2 Plugin C<ovs_events>
+
+The I<ovs_events> plugin monitors the link status of OVS connected interfaces,
+dispatches the values to collectd and send the notification whenever the link
+state change occurs. This plugin uses OVS DB to get a link state change
+notification.
+
+B<Synopsis:>
+
+ <Plugin "ovs_events">
+   OvsDbAddress "127.0.0.1" "6640"
+   Interfaces "br0" "veth0"
+   SendNotification false
+ </Plugin>
+
+The plugin provides the following configuration options:
+
+=over 4
+
+=item B<OvsDbAddress> I<node> I<service>
+
+The address of OVS DB server JSON-RPC interface used by the plugin.
+To enable the interface, OVS DB daemon should be running with '--remote=ptcp:'
+or '--remote=punix:' option. See L<ovsdb-server(1)> for more details. The
+address arguments must take one of the following forms:
+
+=over 4
+
+=item I<node>
+
+The I<node> argument of the address can be either network hostname, IPv4
+numbers-and-dots notation or IPv6 hexadecimal string format. In case of Unix
+domain socket, the "I<unix:>file" format should be used, where I<file> is
+the full name of OVS DB Unix domain socket.
+
+=item I<service>
+
+The I<service> argument of the address specifies the service name used to
+connect to OVS DB. See L<services(5)> for more details. This argument is
+skipped if Unix domain address is used.
+
+=back
+
+Default: C<"localhost" "6640">
+
+=item B<Interfaces> [I<ifname> ...]
+
+List of interface names to be monitored by this plugin. If this option is missed
+or it's empty then all OVS connected interfaces on all bridges are monitored.
+
+Default: empty (all interfaces on all bridges are monitored)
+
+=item B<SendNotification> I<true|false>
+
+If set to true, OVS link notifications (interface status and OVS DB connection
+terminate) are sent to collectd. Default value is false.
+
+=back
+
+B<Note:> By default, the global interval setting is used within which to
+retrieve the OVS link status. To configure a plugin-specific interval, please
+use B<Interval> option of the OVS B<LoadPlugin> block settings. For milliseconds
+simple divide the time by 1000 for example if the desired interval is 50ms, set
+interval to 0.05.
+
 =head2 Plugin C<perl>
 
 This plugin embeds a Perl-interpreter into collectd and provides an interface