Merge pull request #603 from pliurh/metric

SDN-4179: Metrics: Add metric for multicast enabled netnamespaces

Author: openshift-merge-bot[bot]

pkg/network/common/common.go

@@ -279,3 +279,8 @@ func GetNodeInternalIP(node *corev1.Node) string {
 	}
 	return nodeIP
 }
+
+func NetnsIsMulticastEnabled(netns *osdnv1.NetNamespace) bool {
+	enabled, ok := netns.Annotations[osdnv1.MulticastEnabledAnnotation]
+	return enabled == "true" && ok
+}

pkg/network/master/metrics/record.go

@@ -18,3 +18,8 @@ func RecordEgressFirewallRuleCount(count float64) {
 func RecordEgressIPCount(count float64) {
 	metricEgressIPCount.Set(count)
 }
+
+// RecordMulticastEnabledNamespaceCount records the number of namespaces with multicast enabled.
+func RecordMulticastEnabledNamespaceCount(count float64) {
+	metricMulticastEnabledNamespaceCount.Set(count)
+}

pkg/network/master/metrics/register.go

@@ -32,10 +32,19 @@ var metricEgressFirewallCount = prometheus.NewGauge(prometheus.GaugeOpts{
 	Help:      "The number of egress firewall policies",
 })
 
+// represents the count of multicast enabled namespaces
+var metricMulticastEnabledNamespaceCount = prometheus.NewGauge(prometheus.GaugeOpts{
+	Namespace: metricSDNNamespace,
+	Subsystem: metricSDNSubsystemController,
+	Name:      "num_multicast_enabled_namespaces",
+	Help:      "The number of multicast enabled namespaces",
+})
+
 var registry = prometheus.NewRegistry()
 
 func Register() {
 	registry.MustRegister(metricEgressIPCount)
 	registry.MustRegister(metricEgressFirewallRuleCount)
 	registry.MustRegister(metricEgressFirewallCount)
+	registry.MustRegister(metricMulticastEnabledNamespaceCount)
 }

pkg/network/master/vnids.go

@@ -16,13 +16,15 @@ import (
 	osdnclient "github.com/openshift/client-go/network/clientset/versioned"
 	osdnapihelpers "github.com/openshift/library-go/pkg/network/networkapihelpers"
 	"github.com/openshift/sdn/pkg/network/common"
+	metrics "github.com/openshift/sdn/pkg/network/master/metrics"
 	pnetid "github.com/openshift/sdn/pkg/network/master/netid"
 )
 
 type masterVNIDMap struct {
 	// Synchronizes assign, revoke and update VNID
 	lock         sync.Mutex
 	ids          map[string]uint32
+	mcEnabled    map[string]bool
 	netIDManager *pnetid.Allocator
 
 	allowRenumbering bool
@@ -37,6 +39,7 @@ func newMasterVNIDMap(allowRenumbering bool) *masterVNIDMap {
 	return &masterVNIDMap{
 		netIDManager:     pnetid.NewInMemory(netIDRange),
 		ids:              make(map[string]uint32),
+		mcEnabled:        make(map[string]bool),
 		allowRenumbering: allowRenumbering,
 	}
 }
@@ -215,6 +218,7 @@ func (vmap *masterVNIDMap) assignVNID(osdnClient osdnclient.Interface, nsName st
 func (vmap *masterVNIDMap) revokeVNID(osdnClient osdnclient.Interface, nsName string) error {
 	vmap.lock.Lock()
 	defer vmap.lock.Unlock()
+	delete(vmap.mcEnabled, nsName)
 
 	// Delete NetNamespace object
 	if err := osdnClient.NetworkV1().NetNamespaces().Delete(context.TODO(), nsName, metav1.DeleteOptions{}); err != nil {
@@ -236,6 +240,8 @@ func (vmap *masterVNIDMap) updateVNID(osdnClient osdnclient.Interface, origNetns
 	// Informer cache should not be mutated, so get a copy of the object
 	netns := origNetns.DeepCopy()
 
+	vmap.mcEnabled[netns.Name] = common.NetnsIsMulticastEnabled(netns)
+
 	action, args, err := osdnapihelpers.GetChangePodNetworkAnnotation(netns)
 	if err == osdnapihelpers.ErrorPodNetworkAnnotationNotFound {
 		// Nothing to update
@@ -311,6 +317,7 @@ func (master *OsdnMaster) handleDeleteNamespace(obj interface{}) {
 	if err := master.vnids.revokeVNID(master.osdnClient, ns.Name); err != nil {
 		klog.Errorf("Error revoking netid: %v", err)
 	}
+	master.recordMetrics()
 }
 
 func (master *OsdnMaster) watchNetNamespaces() {
@@ -325,4 +332,16 @@ func (master *OsdnMaster) handleAddOrUpdateNetNamespace(obj, _ interface{}, even
 	if err := master.vnids.updateVNID(master.osdnClient, netns); err != nil {
 		klog.Errorf("Error updating netid: %v", err)
 	}
+	master.recordMetrics()
+}
+
+// recordMetrics records prometheus metrics
+func (master *OsdnMaster) recordMetrics() {
+	mcEnabledNamespaceCount := 0.0
+	for _, enabled := range master.vnids.mcEnabled {
+		if enabled {
+			mcEnabledNamespaceCount += 1
+		}
+	}
+	metrics.RecordMulticastEnabledNamespaceCount(float64(mcEnabledNamespaceCount))
 }

pkg/network/node/vnids.go

@@ -178,19 +178,14 @@ func (vmap *nodeVNIDMap) unsetVNID(name string) (id uint32, err error) {
 	return id, nil
 }
 
-func netnsIsMulticastEnabled(netns *osdnv1.NetNamespace) bool {
-	enabled, ok := netns.Annotations[osdnv1.MulticastEnabledAnnotation]
-	return enabled == "true" && ok
-}
-
 func (vmap *nodeVNIDMap) populateVNIDs() error {
 	nets, err := common.ListAllNetNamespaces(context.TODO(), vmap.osdnClient)
 	if err != nil {
 		return err
 	}
 
 	for _, net := range nets {
-		vmap.setVNID(net.Name, net.NetID, netnsIsMulticastEnabled(net))
+		vmap.setVNID(net.Name, net.NetID, common.NetnsIsMulticastEnabled(net))
 	}
 	return nil
 }
@@ -227,7 +222,7 @@ func (vmap *nodeVNIDMap) handleAddOrUpdateNetNamespace(obj, _ interface{}, event
 	// Skip this event if nothing has changed
 	oldNetID, err := vmap.getVNID(netns.NetName)
 	oldMCEnabled := vmap.mcEnabled[netns.NetName]
-	mcEnabled := netnsIsMulticastEnabled(netns)
+	mcEnabled := common.NetnsIsMulticastEnabled(netns)
 	if err == nil && oldNetID == netns.NetID && oldMCEnabled == mcEnabled {
 		return
 	}