Try to make log more common and more easily grepable

Signed-off-by: Benoit Tigeot <benoit.tigeot@lifen.fr>

Author: benoittgt

pkg/kube/client.go

@@ -137,7 +137,7 @@ func (c *Client) IsReachable() error {
 
 // Create creates Kubernetes resources specified in the resource list.
 func (c *Client) Create(resources ResourceList) (*Result, error) {
-	c.Log.Debug("creating resource(s)", "resources", resources)
+	c.Log.Debug("creating resource(s)", "resources", len(resources))
 	if err := perform(resources, createResource); err != nil {
 		return nil, err
 	}
@@ -207,7 +207,7 @@ func (c *Client) getSelectRelationPod(info *resource.Info, objs map[string][]run
 	if info == nil {
 		return objs, nil
 	}
-	c.Log.Debug("get relation pod of object", "namespace", info.Namespace, "kind", info.Mapping.GroupVersionKind.Kind, "name", info.Name)
+	c.Log.Debug("get relation pod of object", "namespace", info.Namespace, "name", info.Name, "kind", info.Mapping.GroupVersionKind.Kind)
 	selector, ok, _ := getSelectorFromObject(info.Object)
 	if !ok {
 		return objs, nil
@@ -388,7 +388,7 @@ func (c *Client) Update(original, target ResourceList, force bool) (*Result, err
 	updateErrors := []string{}
 	res := &Result{}
 
-	c.Log.Debug("checking resources for changes", "original", original, "target", target)
+	c.Log.Debug("checking resources for changes", "resources", len(target))
 	err := target.Visit(func(info *resource.Info, err error) error {
 		if err != nil {
 			return err
@@ -409,7 +409,7 @@ func (c *Client) Update(original, target ResourceList, force bool) (*Result, err
 			}
 
 			kind := info.Mapping.GroupVersionKind.Kind
-			c.Log.Debug("created a new resource", "kind", kind, "name", info.Name, "namespace", info.Namespace)
+			c.Log.Debug("created a new resource", "namespace", info.Namespace, "name", info.Name, "kind", kind)
 			return nil
 		}
 
@@ -420,7 +420,7 @@ func (c *Client) Update(original, target ResourceList, force bool) (*Result, err
 		}
 
 		if err := updateResource(c, info, originalInfo.Object, force); err != nil {
-			c.Log.Debug("error updating the resource", "kind", info.Mapping.GroupVersionKind.Kind, "name", info.Name, "error", err)
+			c.Log.Debug("error updating the resource", "namespace", info.Namespace, "name", info.Name, "kind", info.Mapping.GroupVersionKind.Kind, "error", err)
 			updateErrors = append(updateErrors, err.Error())
 		}
 		// Because we check for errors later, append the info regardless
@@ -437,22 +437,22 @@ func (c *Client) Update(original, target ResourceList, force bool) (*Result, err
 	}
 
 	for _, info := range original.Difference(target) {
-		c.Log.Debug("deleting resource", "kind", info.Mapping.GroupVersionKind.Kind, "name", info.Name, "namespace", info.Namespace)
+		c.Log.Debug("deleting resource", "namespace", info.Namespace, "name", info.Name, "kind", info.Mapping.GroupVersionKind.Kind)
 
 		if err := info.Get(); err != nil {
-			c.Log.Debug("unable to get object", "name", info.Name, "error", err)
+			c.Log.Debug("unable to get object", "namespace", info.Namespace, "name", info.Name, "kind", info.Mapping.GroupVersionKind.Kind, "error", err)
 			continue
 		}
 		annotations, err := metadataAccessor.Annotations(info.Object)
 		if err != nil {
-			c.Log.Debug("unable to get annotations", "name", info.Name, "error", err)
+			c.Log.Debug("unable to get annotations", "namespace", info.Namespace, "name", info.Name, "kind", info.Mapping.GroupVersionKind.Kind, "error", err)
 		}
 		if annotations != nil && annotations[ResourcePolicyAnno] == KeepPolicy {
-			c.Log.Debug("skipping delete due to annotation", "name", info.Name, "annotation", ResourcePolicyAnno, "value", KeepPolicy)
+			c.Log.Debug("skipping delete due to annotation", "namespace", info.Namespace, "name", info.Name, "kind", info.Mapping.GroupVersionKind.Kind, "annotation", ResourcePolicyAnno, "value", KeepPolicy)
 			continue
 		}
 		if err := deleteResource(info, metav1.DeletePropagationBackground); err != nil {
-			c.Log.Debug("failed to delete resource", "name", info.Name, "error", err)
+			c.Log.Debug("failed to delete resource", "namespace", info.Namespace, "name", info.Name, "kind", info.Mapping.GroupVersionKind.Kind, "error", err)
 			continue
 		}
 		res.Deleted = append(res.Deleted, info)
@@ -481,11 +481,11 @@ func rdelete(c *Client, resources ResourceList, propagation metav1.DeletionPropa
 	res := &Result{}
 	mtx := sync.Mutex{}
 	err := perform(resources, func(info *resource.Info) error {
-		c.Log.Debug("starting delete resource", "kind", info.Mapping.GroupVersionKind.Kind, "name", info.Name, "namespace", info.Namespace)
+		c.Log.Debug("starting delete resource", "namespace", info.Namespace, "name", info.Name, "kind", info.Mapping.GroupVersionKind.Kind)
 		err := deleteResource(info, propagation)
 		if err == nil || apierrors.IsNotFound(err) {
 			if err != nil {
-				c.Log.Debug("ignoring delete failure", "name", info.Name, "kind", info.Mapping.GroupVersionKind.Kind, "error", err)
+				c.Log.Debug("ignoring delete failure", "namespace", info.Namespace, "name", info.Name, "kind", info.Mapping.GroupVersionKind.Kind, "error", err)
 			}
 			mtx.Lock()
 			defer mtx.Unlock()
@@ -715,7 +715,7 @@ func (c *Client) watchUntilReady(timeout time.Duration, info *resource.Info) err
 		return nil
 	}
 
-	c.Log.Debug("watching for changes", "kind", kind, "name", info.Name, "timeout", timeout)
+	c.Log.Debug("watching for changes", "namespace", info.Namespace, "name", info.Name, "timeout", timeout)
 
 	// Use a selector on the name of the resource. This should be unique for the
 	// given version and kind
@@ -743,7 +743,7 @@ func (c *Client) watchUntilReady(timeout time.Duration, info *resource.Info) err
 			// we get. We care mostly about jobs, where what we want to see is
 			// the status go into a good state. For other types, like ReplicaSet
 			// we don't really do anything to support these as hooks.
-			c.Log.Debug("add/modify event received", "name", info.Name, "type", e.Type)
+			c.Log.Debug("add/modify event received", "namespace", info.Namespace, "name", info.Name, "type", e.Type)
 			switch kind {
 			case "Job":
 				return c.waitForJob(obj, info.Name)
@@ -752,12 +752,12 @@ func (c *Client) watchUntilReady(timeout time.Duration, info *resource.Info) err
 			}
 			return true, nil
 		case watch.Deleted:
-			c.Log.Debug("deleted event received", "name", info.Name)
+			c.Log.Debug("deleted event received", "namespace", info.Namespace, "name", info.Name)
 			return true, nil
 		case watch.Error:
 			// Handle error and return with an error.
 			// c.Log("Error event for %s", info.Name)
-			c.Log.Debug("error event received", "name", info.Name)
+			c.Log.Debug("error event received", "namespace", info.Namespace, "name", info.Name)
 			return true, errors.Errorf("failed to deploy %s", info.Name)
 		default:
 			return false, nil
@@ -784,7 +784,7 @@ func (c *Client) waitForJob(obj runtime.Object, name string) (bool, error) {
 	}
 
 	// c.Log("%s: Jobs active: %d, jobs failed: %d, jobs succeeded: %d", name, o.Status.Active, o.Status.Failed, o.Status.Succeeded)
-	c.Log.Debug("job status", "name", name, "active", o.Status.Active, "failed", o.Status.Failed, "succeeded", o.Status.Succeeded)
+	c.Log.Debug("job status", "namespace", o.Namespace, "name", name, "active", o.Status.Active, "failed", o.Status.Failed, "succeeded", o.Status.Succeeded)
 	return false, nil
 }
 
@@ -799,14 +799,14 @@ func (c *Client) waitForPodSuccess(obj runtime.Object, name string) (bool, error
 
 	switch o.Status.Phase {
 	case v1.PodSucceeded:
-		c.Log.Debug("Pod succeeded", "name", o.Name)
+		c.Log.Debug("Pod succeeded", "namespace", o.Namespace, "name", o.Name)
 		return true, nil
 	case v1.PodFailed:
 		return true, errors.Errorf("pod %s failed", o.Name)
 	case v1.PodPending:
-		c.Log.Debug("Pod pending", "name", o.Name)
+		c.Log.Debug("Pod pending", "namespace", o.Namespace, "name", o.Name)
 	case v1.PodRunning:
-		c.Log.Debug("Pod running", "name", o.Name)
+		c.Log.Debug("Pod running", "namespace", o.Namespace, "name", o.Name)
 	}
 
 	return false, nil

pkg/kube/wait.go

@@ -85,7 +85,7 @@ func (w *waiter) isRetryableError(err error, resource *resource.Info) bool {
 	if err == nil {
 		return false
 	}
-	w.log.Debug("error received when checking status of resource", "error", err, "resourceName", resource.Name, "resourceDetails", resource)
+	w.log.Debug("error received when checking status of resource", "error", err, "resourceNamespace", resource.Namespace, "resourceName", resource.Name, "resourceDetails", resource)
 	if ev, ok := err.(*apierrors.StatusError); ok {
 		statusCode := ev.Status().Code
 		retryable := w.isRetryableHTTPStatusCode(statusCode)