ovs_events: PR clean-up

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

diff --git a/src/collectd.conf.pod b/src/collectd.conf.pod
index e814af5..21a900b 100644 (file)
--- a/src/collectd.conf.pod
+++ b/src/collectd.conf.pod
@@ -5453,58 +5453,69 @@ refer to them from.
 
 =back
 
-=head2 Plugin C<ovs_link>
+=head2 Plugin C<ovs_events>
 
-
-The I<ovs_link> plugin monitors the link status of OVS connected interfaces and
-dispatches the values through collectd notification mechanism whenever the link
-state change occurs. This plugin uses OVSDB to get a link state change
+The I<ovs_events> plugin monitors the link status of OVS connected interfaces,
+dispatches the values to collectd and sends the notification whenever the link
+state change occurs. This plugin uses OVS DB to get a link state change
 notification.
 
 B<Synopsis:>
 
- <Plugin "ovs_link">
-   OvsDbServerUrl "tcp:127.0.0.1:6640"
+ <Plugin "ovs_events">
+   Port "6640"
+   Address "127.0.0.1"
+   Socket "/var/run/openvswitch/db.sock"
    Interfaces "br0" "veth0"
+   SendNotification false
  </Plugin>
 
 The plugin provides the following configuration options:
 
 =over 4
 
-=item B<OvsDbServerUrl> I<server>
-
-The URL is an 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 URL
-must take one of the following forms:
+=item B<Address> I<node>
 
-=over 4
+The address of the OVS DB server JSON-RPC interface used by the plugin. To
+enable the interface, OVS DB daemon should be running with '--remote=ptcp:'
+option. See L<ovsdb-server(1)> for more details. The option may be either
+network hostname, IPv4 numbers-and-dots notation or IPv6 hexadecimal string
+format. Defaults to 'localhost'.
 
-=item B<tcp:>I<ip>:I<port>
+=item B<Port> I<service>
 
-Connect to the given tcp I<port> on I<ip>, where I<ip> is IPv4 address
-of OVS DB server which is listening on TCP I<port> for incoming
-JSON-RPC client connection.
+TCP-port to connect to. Either a service name or a port number may be given.
+Please note that numerical port numbers must be given as a string. Defaults
+to "6640".
 
-=item B<unix:>I<file>
+=item B<Socket> I<path>
 
-Connect to the unix domain server socket named I<file> which is
-used by OVS DB for incoming JSON-RPC client connection.
-
-=back
-
-Default: C<tcp:127.0.0.1:6640>
+The UNIX domain socket path of OVS DB server JSON-RPC interface used by the
+plugin. To enable the interface, the OVS DB daemon should be running with
+'--remote=punix:' option. See L<ovsdb-server(1)> for more details. If this
+option is set, B<Address> and B<Port> options are ignored.
 
 =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.
+List of interface names to be monitored by this plugin. If this option is not
+specified or is 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