feat(catalog/olm): add tracking ids to logging

this will help correlate logs for each sync loop

Author: ecordell

pkg/controller/operators/catalog/operator.go

@@ -338,6 +338,7 @@ func (o *Operator) syncCatalogSources(obj interface{}) (syncError error) {
 
 	logger := o.Log.WithFields(logrus.Fields{
 		"source": catsrc.GetName(),
+		"id":     queueinformer.NewLoopID(),
 	})
 	logger.Debug("syncing catsrc")
 	out := catsrc.DeepCopy()
@@ -515,6 +516,7 @@ func (o *Operator) syncResolvingNamespace(obj interface{}) error {
 
 	logger := o.Log.WithFields(logrus.Fields{
 		"namespace": namespace,
+		"id":        queueinformer.NewLoopID(),
 	})
 
 	// get the set of sources that should be used for resolution and best-effort get their connections working
@@ -820,6 +822,7 @@ func (o *Operator) syncInstallPlans(obj interface{}) (syncError error) {
 	}
 
 	logger := o.Log.WithFields(logrus.Fields{
+		"id":        queueinformer.NewLoopID(),
 		"ip":        plan.GetName(),
 		"namespace": plan.GetNamespace(),
 		"phase":     plan.Status.Phase,

pkg/controller/operators/olm/operator.go

@@ -321,6 +321,7 @@ func (a *Operator) deleteClusterServiceVersion(obj interface{}) {
 	}
 
 	logger := a.Log.WithFields(logrus.Fields{
+		"id":        queueinformer.NewLoopID(),
 		"csv":       clusterServiceVersion.GetName(),
 		"namespace": clusterServiceVersion.GetNamespace(),
 		"phase":     clusterServiceVersion.Status.Phase,
@@ -351,6 +352,7 @@ func (a *Operator) deleteClusterServiceVersion(obj interface{}) {
 
 func (a *Operator) removeDanglingChildCSVs(csv *v1alpha1.ClusterServiceVersion) error {
 	logger := a.Log.WithFields(logrus.Fields{
+		"id":        queueinformer.NewLoopID(),
 		"csv":       csv.GetName(),
 		"namespace": csv.GetNamespace(),
 		"phase":     csv.Status.Phase,
@@ -381,6 +383,7 @@ func (a *Operator) syncClusterServiceVersion(obj interface{}) (syncError error)
 	}
 
 	logger := a.Log.WithFields(logrus.Fields{
+		"id":        queueinformer.NewLoopID(),
 		"csv":       clusterServiceVersion.GetName(),
 		"namespace": clusterServiceVersion.GetNamespace(),
 		"phase":     clusterServiceVersion.Status.Phase,
@@ -476,6 +479,7 @@ func (a *Operator) operatorGroupForActiveCSV(logger *logrus.Entry, csv *v1alpha1
 // transitionCSVState moves the CSV status state machine along based on the current value and the current cluster state.
 func (a *Operator) transitionCSVState(in v1alpha1.ClusterServiceVersion) (out *v1alpha1.ClusterServiceVersion, syncError error) {
 	logger := a.Log.WithFields(logrus.Fields{
+		"id":        queueinformer.NewLoopID(),
 		"csv":       in.GetName(),
 		"namespace": in.GetNamespace(),
 		"phase":     in.Status.Phase,

pkg/lib/queueinformer/loop_id.go

@@ -0,0 +1,14 @@
+package queueinformer
+
+import (
+	"encoding/base64"
+	"math/rand"
+)
+
+func NewLoopID() string {
+	len := 5
+	buff := make([]byte, len)
+	rand.Read(buff)
+	str := base64.StdEncoding.EncodeToString(buff)
+	return str[:len]
+}