Plugin OVS Events

Name:	OVS Events plugin
Type:	read
Callbacks:	config, init, read, shutdown
Status:	supported
FirstVersion:	5.8
Copyright:	2017–2018 Intel Corporation
License:
Manpage:	collectd.conf(5)
See also:	List of Plugins

Open vSwitch, sometimes abbreviated as OvS, is a production-quality open-source implementation of a distributed virtual multi-layer switch. The main purpose of Open vSwitch is to provide a switching stack for hardware virtualisation environments, while supporting multiple protocols and standards used in computer networks.

Synopsis

 LoadPlugin ovs_events    
 <Plugin "ovs_events">
     <Instance default>
         Port 6640
         Address "127.0.0.1"
         Socket "/var/run/openvswitch/db.sock"
         Interfaces "br0" "veth0
         DispatchValues false
     </Instance>
     SendNotification true
 </Plugin>

Parameters

The following configuration options should be supported by ovs_events collectd plugin:

Name	Description	Comment
Interval	The interval within which to retrieve statistics on monitored interfaces in seconds.	Interval option is supported by collectd and is defined in block. No additional functionality should be developed in ovs_events plugin to support this option.
SendNotification	If set to true, OVS link notifications (interface status and OVS DB connection terminate) are sent to collectd. Default value is true.	true/false
Instance	This block describes the OVS DB server configuration. The name of the instance must be provided by the user. If no instance is configured, the default instance with default configuration is used.	Block. E.g.: …

Instance block configuration options:

Name	Description	Comment
Address	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 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'.
Port	TCP-port to connect to. Either a service name or a port number may be given. Defaults to 6640.	true/false
Socket	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 ovsdb-server(1) for more details. If this option is set, Address and Port options are ignored.
Interfaces	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)	e.g: “br0”, “et0”
DispatchValues	Dispatch the OVS DB interface link status value with configured plugin interval. Defaults to false. Please note, if SendNotification and DispatchValues options are false, no OVS information will be provided by the plugin.	true/false
NotifyInterfaceAdd	Currently when a new interface is added a notification will show that the link status has change to down. This option allows the user to suppress this notification by setting NotifyInterfaceAdd to false.	true/false

Metrics

See also

• Plugin-Intel-PMU-Tests
• Openvswitch plugin high level design document