Merge pull request #2097 from YmrDtnJu/zfs_arc

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

diff --git a/src/collectd.conf.pod b/src/collectd.conf.pod
index 061c4ba..d4aa9ef 100644 (file)
--- a/src/collectd.conf.pod
+++ b/src/collectd.conf.pod
@@ -5455,15 +5455,17 @@ refer to them from.
 
 =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.
+The I<ovs_events> plugin monitors the link status of I<Open vSwitch> (OVS)
+connected interfaces, dispatches the values to collectd and sends the
+notification whenever the link state change occurs. This plugin uses OVS
+database to get a link state change notification.
 
 B<Synopsis:>
 
  <Plugin "ovs_events">
-   OvsDbAddress "127.0.0.1" "6640"
+   Port 6640
+   Address "127.0.0.1"
+   Socket "/var/run/openvswitch/db.sock"
    Interfaces "br0" "veth0"
    SendNotification false
  </Plugin>
@@ -5472,36 +5474,31 @@ The plugin provides the following configuration options:
 
 =over 4
 
-=item B<OvsDbAddress> I<node> I<service>
+=item B<Address> I<node>
 
-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:
+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 C<--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 B<'localhost'>.
 
-=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 B<Port> I<service>
 
-=item I<service>
+TCP-port to connect to. Either a service name or a port number may be given.
+Defaults to B<6640>.
 
-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
+=item B<Socket> I<path>
 
-Default: C<"localhost" "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
+C<--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)