openvswitch_exporter

Command openvswitch_exporter implements a Prometheus exporter for Open vSwitch by DigitalOcean. Apache 2.0 licensed.

Build

Fetch dependenices and build:

➜  openvswitch_exporter git:(master) dep ensure
➜  openvswitch_exporter git:(master) go build .
➜  openvswitch_exporter git:(master) ll
total 23352
-rw-r--r--  1 user  staff   140B Aug  5 11:24 AUTHORS
-rw-r--r--  1 user  staff   1.2K Aug  5 11:24 CONTRIBUTING.md
-rw-r--r--  1 user  staff   3.6K Aug  5 12:03 Gopkg.lock
-rw-r--r--  1 user  staff   824B Aug  5 12:00 Gopkg.toml
-rw-r--r--  1 user  staff    10K Aug  5 11:24 LICENSE.md
-rw-r--r--  1 user  staff   2.9K Aug  5 12:03 README.md
-rw-r--r--  1 user  staff   1.8K Aug  5 11:55 main.go
-rwxr-xr-x  1 user  staff    11M Aug  5 12:03 openvswitch_exporter
drwxr-xr-x  4 user  staff   128B Aug  5 11:40 ovsexporter
drwxr-xr-x  4 user  staff   128B Aug  5 12:03 vendor
➜  openvswitch_exporter git:(master) 

Usage

Available flags for openvswitch_exporter include:

$ ./openvswitch_exporter -h
Usage of ./openvswitch_exporter:
  -metrics.addr string
        address for Open vSwitch exporter (default ":9310")
  -metrics.path string
        URL path for surfacing collected metrics (default "/metrics")

Overview

openvswitch_exporter currently exposes a variety of metrics related to the Linux kernel Open vSwitch datapath, using the generic netlink ovs_datapath family.

The exported metrics are similar to those found in ovs-dpctl show:

hypervisor $ ovs-dpctl show | head -n 4
system@ovs-system:
        lookups: hit:111615762 missed:1312004 lost:0
        flows: 12
        masks: hit:151608278 total:8 hit/pkt:1.34

To see the metrics that are currently available, use curl:

hypervisor $ curl -s http://localhost:9310/metrics | grep openvswitch
# HELP openvswitch_datapath_megaflow_stats_mask_hits_total Number of megaflow masks used for flow lookups.
# TYPE openvswitch_datapath_megaflow_stats_mask_hits_total counter
openvswitch_datapath_megaflow_stats_mask_hits_total{datapath="ovs-system"} 1.51606216e+08
# HELP openvswitch_datapath_megaflow_stats_masks Number of megaflow masks present.
# TYPE openvswitch_datapath_megaflow_stats_masks counter
openvswitch_datapath_megaflow_stats_masks{datapath="ovs-system"} 9
# HELP openvswitch_datapath_stats_flows Number of flows present.
# TYPE openvswitch_datapath_stats_flows gauge
openvswitch_datapath_stats_flows{datapath="ovs-system"} 21
# HELP openvswitch_datapath_stats_hits_total Number of flow table matches.
# TYPE openvswitch_datapath_stats_hits_total counter
openvswitch_datapath_stats_hits_total{datapath="ovs-system"} 1.11614549e+08
# HELP openvswitch_datapath_stats_lost_total Number of flow table misses not sent to userspace.
# TYPE openvswitch_datapath_stats_lost_total counter
openvswitch_datapath_stats_lost_total{datapath="ovs-system"} 0
# HELP openvswitch_datapath_stats_misses_total Number of flow table misses.
# TYPE openvswitch_datapath_stats_misses_total counter
openvswitch_datapath_stats_misses_total{datapath="ovs-system"} 1.311983e+06

To calculate the "hit/pkt" metric from ovs-dpctl show (average number of masks visited per packet), you can use the following PromQL query:

openvswitch_datapath_megaflow_stats_mask_hits_total / (openvswitch_datapath_stats_hits_total + openvswitch_datapath_stats_misses_total)