Use libovsdb bindings for collecting ovs metrics

go-controller/Makefile

@@ -22,8 +22,8 @@ else
 CONTAINER_RUNTIME=docker
 endif
 CONTAINER_RUNNABLE ?= $(shell $(CONTAINER_RUNTIME) -v > /dev/null 2>&1; echo $$?)
-# FIXME(tssurya): In one week when OVN 24.09 is released change the schema version
 OVN_SCHEMA_VERSION ?= 8efac26f6637fc
+OVS_VERSION ?= v2.17.0
 ifeq ($(NOROOT),TRUE)
 C_ARGS = -e NOROOT=TRUE
 else
@@ -65,7 +65,7 @@ else
 	RACE=1 hack/test-go.sh
 endif
 
-modelgen: pkg/nbdb/ovn-nb.ovsschema pkg/sbdb/ovn-sb.ovsschema
+modelgen: pkg/nbdb/ovn-nb.ovsschema pkg/sbdb/ovn-sb.ovsschema pkg/vswitchd/vswitch.ovsschema
 	hack/update-modelgen.sh
 
 codegen:
@@ -86,6 +86,7 @@ clean:
 	rm -rf ${TEST_REPORT_DIR}
 	rm -f ./pkg/nbdb/ovn-nb.ovsschema
 	rm -f ./pkg/sbdb/ovn-sb.ovsschema
+	rm -f ./pkg/vswitchd/vswitch.ovsschema
 
 .PHONY: lint gofmt
 
@@ -109,6 +110,9 @@ pkg/nbdb/ovn-nb.ovsschema:
 pkg/sbdb/ovn-sb.ovsschema:
 	curl -sSL https://raw.githubusercontent.com/ovn-org/ovn/$(OVN_SCHEMA_VERSION)/ovn-sb.ovsschema -o $@
 
+pkg/vswitchd/vswitch.ovsschema:
+	curl -sSL https://raw.githubusercontent.com/openvswitch/ovs/${OVS_VERSION}/vswitchd/vswitch.ovsschema -o $@
+
 ${TOOLS_OUTPUT_DIR}:
 	mkdir -p ${TOOLS_OUTPUT_DIR}
 

go-controller/cmd/ovn-kube-util/app/ovs-exporter.go

@@ -6,13 +6,16 @@ import (
 	"net/http"
 	"time"
 
+	"github.com/ovn-org/ovn-kubernetes/go-controller/pkg/libovsdb"
 	"github.com/ovn-org/ovn-kubernetes/go-controller/pkg/metrics"
 	"github.com/ovn-org/ovn-kubernetes/go-controller/pkg/util"
 	"github.com/prometheus/client_golang/prometheus/promhttp"
 	"github.com/urfave/cli/v2"
 	kexec "k8s.io/utils/exec"
 )
 
+var metricsScrapeInterval int
+
 var OvsExporterCommand = cli.Command{
 	Name:  "ovs-exporter",
 	Usage: "",
@@ -21,6 +24,12 @@ var OvsExporterCommand = cli.Command{
 			Name:  "metrics-bind-address",
 			Usage: `The IP address and port for the metrics server to serve on (default ":9310")`,
 		},
+		&cli.IntFlag{
+			Name:        "metrics-interval",
+			Usage:       "The interval in seconds at which ovs metrics are collected",
+			Value:       30,
+			Destination: &metricsScrapeInterval,
+		},
 	},
 	Action: func(ctx *cli.Context) error {
 		stopChan := make(chan struct{})
@@ -33,11 +42,17 @@ var OvsExporterCommand = cli.Command{
 			return err
 		}
 
+		// start the ovsdb client for ovs metrics monitoring
+		ovsClient, err := libovsdb.NewOVSClient(stopChan)
+		if err != nil {
+			klog.Errorf("Error initializing ovs client: %v", err)
+		}
+
 		mux := http.NewServeMux()
 		mux.Handle("/metrics", promhttp.Handler())
 
 		// register ovs metrics that will be served off of /metrics path
-		metrics.RegisterStandaloneOvsMetrics(stopChan)
+		metrics.RegisterStandaloneOvsMetrics(ovsClient, metricsScrapeInterval, stopChan)
 
 		server := &http.Server{Addr: bindAddress, Handler: mux}
 		go func() {

go-controller/cmd/ovnkube/ovnkube.go

@@ -566,10 +566,18 @@ func runOvnKube(ctx context.Context, runMode *ovnkubeRunMode, ovnClientset *util
 	// start the prometheus server to serve OVS and OVN Metrics (default port: 9476)
 	// Note: for ovnkube node mode dpu-host no metrics is required as ovs/ovn is not running on the node.
 	if config.OvnKubeNode.Mode != types.NodeModeDPUHost && config.Metrics.OVNMetricsBindAddress != "" {
+		metricsScrapeInterval := 30
+		defer cancel()
+
+		ovsClient, err := libovsdb.NewOVSClient(ctx.Done())
+		if err != nil {
+			return fmt.Errorf("failed to initialize libovsdb vswitchd client: %w", err)
+		}
 		if config.Metrics.ExportOVSMetrics {
-			metrics.RegisterOvsMetricsWithOvnMetrics(ctx.Done())
+			metrics.RegisterOvsMetricsWithOvnMetrics(ovsClient, metricsScrapeInterval, ctx.Done())
 		}
-		metrics.RegisterOvnMetrics(ovnClientset.KubeClient, runMode.identity, ctx.Done())
+		metrics.RegisterOvnMetrics(ovnClientset.KubeClient, runMode.identity,
+			ovsClient, metricsScrapeInterval, ctx.Done())
 		metrics.StartOVNMetricsServer(config.Metrics.OVNMetricsBindAddress,
 			config.Metrics.NodeServerCert, config.Metrics.NodeServerPrivKey, ctx.Done(), wg)
 	}

go-controller/hack/update-modelgen.sh

@@ -18,3 +18,4 @@ fi
 
 go generate ./pkg/nbdb
 go generate ./pkg/sbdb
+go generate ./pkg/vswitchd

go-controller/pkg/libovsdb/libovsdb.go

@@ -23,6 +23,7 @@ import (
 	"github.com/ovn-org/ovn-kubernetes/go-controller/pkg/nbdb"
 	"github.com/ovn-org/ovn-kubernetes/go-controller/pkg/sbdb"
 	"github.com/ovn-org/ovn-kubernetes/go-controller/pkg/types"
+	"github.com/ovn-org/ovn-kubernetes/go-controller/pkg/vswitchd"
 	"github.com/prometheus/client_golang/prometheus"
 	"gopkg.in/fsnotify/fsnotify.v1"
 	"gopkg.in/natefinch/lumberjack.v2"
@@ -226,6 +227,47 @@ func NewNBClientWithConfig(cfg config.OvnAuthConfig, promRegistry prometheus.Reg
 	return c, nil
 }
 
+// NewOVSClient creates a new openvswitch Database client
+func NewOVSClient(stopCh <-chan struct{}) (client.Client, error) {
+	cfg := &config.OvnAuthConfig{
+		Scheme:  config.OvnDBSchemeUnix,
+		Address: "unix:/var/run/openvswitch/db.sock",
+	}
+
+	return NewOVSClientWithConfig(*cfg, stopCh)
+}
+
+func NewOVSClientWithConfig(cfg config.OvnAuthConfig, stopCh <-chan struct{}) (client.Client, error) {
+	dbModel, err := vswitchd.FullDatabaseModel()
+	if err != nil {
+		return nil, err
+	}
+	c, err := newClient(cfg, dbModel, stopCh)
+	if err != nil {
+		return nil, err
+	}
+	ctx, cancel := context.WithTimeout(context.Background(), types.OVSDBTimeout)
+	go func() {
+		<-stopCh
+		cancel()
+	}()
+
+	_, err = c.Monitor(ctx,
+		c.NewMonitor(
+			client.WithTable(&vswitchd.OpenvSwitch{}),
+			client.WithTable(&vswitchd.Bridge{}),
+			client.WithTable(&vswitchd.Port{}),
+			client.WithTable(&vswitchd.Interface{}),
+		),
+	)
+	if err != nil {
+		c.Close()
+		return nil, err
+	}
+
+	return c, nil
+}
+
 func createTLSConfig(certFile, privKeyFile, caCertFile, serverName string) (*tls.Config, error) {
 	cert, err := tls.LoadX509KeyPair(certFile, privKeyFile)
 	if err != nil {

go-controller/pkg/libovsdb/ops/ovs/bridge.go

@@ -0,0 +1,17 @@
+package ovs
+
+import (
+	"context"
+	libovsdbclient "github.com/ovn-org/libovsdb/client"
+	"github.com/ovn-org/ovn-kubernetes/go-controller/pkg/types"
+	"github.com/ovn-org/ovn-kubernetes/go-controller/pkg/vswitchd"
+)
+
+// ListBridges looks up all ovs bridges from the cache
+func ListBridges(ovsClient libovsdbclient.Client) ([]*vswitchd.Bridge, error) {
+	ctx, cancel := context.WithTimeout(context.Background(), types.OVSDBTimeout)
+	defer cancel()
+	searchedBridges := []*vswitchd.Bridge{}
+	err := ovsClient.List(ctx, &searchedBridges)
+	return searchedBridges, err
+}

go-controller/pkg/libovsdb/ops/ovs/interface.go

@@ -0,0 +1,30 @@
+package ovs
+
+import (
+	"context"
+	libovsdbclient "github.com/ovn-org/libovsdb/client"
+	"github.com/ovn-org/ovn-kubernetes/go-controller/pkg/types"
+	"github.com/ovn-org/ovn-kubernetes/go-controller/pkg/vswitchd"
+)
+
+type interfacePredicate func(*vswitchd.Interface) bool
+
+// ListInterfaces looks up all ovs interfaces from the cache
+func ListInterfaces(ovsClient libovsdbclient.Client) ([]*vswitchd.Interface, error) {
+	ctx, cancel := context.WithTimeout(context.Background(), types.OVSDBTimeout)
+	defer cancel()
+	searchedInterfaces := []*vswitchd.Interface{}
+	err := ovsClient.List(ctx, &searchedInterfaces)
+	return searchedInterfaces, err
+}
+
+// FindInterfacesWithPredicate returns all the ovs interfaces in the cache
+// that matches the lookup function
+func FindInterfacesWithPredicate(ovsClient libovsdbclient.Client, p interfacePredicate) ([]*vswitchd.Interface, error) {
+	ctx, cancel := context.WithTimeout(context.Background(), types.OVSDBTimeout)
+	defer cancel()
+	searchedInterfaces := []*vswitchd.Interface{}
+
+	err := ovsClient.WhereCache(p).List(ctx, &searchedInterfaces)
+	return searchedInterfaces, err
+}

go-controller/pkg/libovsdb/ops/ovs/openvswitch.go

@@ -0,0 +1,25 @@
+package ovs
+
+import (
+	"context"
+	"fmt"
+	libovsdbclient "github.com/ovn-org/libovsdb/client"
+	"github.com/ovn-org/ovn-kubernetes/go-controller/pkg/types"
+	"github.com/ovn-org/ovn-kubernetes/go-controller/pkg/vswitchd"
+)
+
+// Get OpenvSwitch entry from the cache
+func GetOpenvSwitch(ovsClient libovsdbclient.Client) (*vswitchd.OpenvSwitch, error) {
+	ctx, cancel := context.WithTimeout(context.Background(), types.OVSDBTimeout)
+	defer cancel()
+	openvSwitchList := []*vswitchd.OpenvSwitch{}
+	err := ovsClient.List(ctx, &openvSwitchList)
+	if err != nil {
+		return nil, err
+	}
+	if len(openvSwitchList) == 0 {
+		return nil, fmt.Errorf("no openvSwitch entry found")
+	}
+
+	return openvSwitchList[0], err
+}

go-controller/pkg/metrics/metrics.go

@@ -15,6 +15,7 @@ import (
 	"sync"
 	"time"
 
+	libovsdbclient "github.com/ovn-org/libovsdb/client"
 	"github.com/ovn-org/ovn-kubernetes/go-controller/pkg/config"
 	"github.com/ovn-org/ovn-kubernetes/go-controller/pkg/util"
 	"github.com/prometheus/client_golang/prometheus"
@@ -560,8 +561,9 @@ func startMetricsServer(bindAddress, certFile, keyFile string, handler http.Hand
 	}()
 }
 
-func RegisterOvnMetrics(clientset kubernetes.Interface, k8sNodeName string, stopChan <-chan struct{}) {
+func RegisterOvnMetrics(clientset kubernetes.Interface, k8sNodeName string, ovsDBClient libovsdbclient.Client,
+	metricsScrapeInterval int, stopChan <-chan struct{}) {
 	go RegisterOvnDBMetrics(clientset, k8sNodeName, stopChan)
-	go RegisterOvnControllerMetrics(stopChan)
+	go RegisterOvnControllerMetrics(ovsDBClient, metricsScrapeInterval, stopChan)
 	go RegisterOvnNorthdMetrics(clientset, k8sNodeName, stopChan)
 }