Skip to content

ovs_stats plugin
Plugin name ovs_stats
Type read
Callbacks config, init, read, shutdown
Status supported
Since 5.8
Copyright 2017–2018 Intel Corporation
Configuration collectd.conf(5)

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_stats    
 <Plugin "ovs_stats">
     <Instance default>
         Port 6640
         Address "127.0.0.1"
         Socket "/var/run/openvswitch/db.sock"
         Bridges "br0" "br_ext"
     </Instance>
 </Plugin>

Parameters

The following configuration options should be supported by ovs_stats 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_stats plugin to support this option.


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.



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.



Bridges


List of OVS bridge names to be monitored by this plugin. If this option is omitted or is empty then all OVS bridges will be monitored.)


e.g: “br0”, “br_ext”

Metrics

See also

Configuration

Configuration options · from collectd.conf(5)

See this section in the full configuration reference

The ovs_stats plugin collects statistics of OVS connected interfaces. This plugin uses OVSDB management protocol (RFC7047) monitor mechanism to get statistics from OVSDB

Synopsis:

<Plugin "ovs_stats">
  Port 6640
  Address "127.0.0.1"
  Socket "/var/run/openvswitch/db.sock"
  Bridges "br0" "br_ext"
  InterfaceStats false
</Plugin>

The plugin provides the following configuration options:

Address node
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 service
TCP-port to connect to. Either a service name or a port number may be given. Defaults to 6640.
Socket path
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.
Bridges [brname ...]

List of OVS bridge names to be monitored by this plugin. If this option is omitted or is empty then all OVS bridges will be monitored.

Default: empty (monitor all bridges)

InterfaceStats false|true
Indicates that the plugin should gather statistics for individual interfaces in addition to ports. This can be useful when monitoring an OVS setup with bond ports, where you might wish to know individual statistics for the interfaces included in the bonds. Defaults to false.