Improve error/debug message

This diff changes error message with fixed format for easy-to-read for users.
2025-09-20 09:01:15 +00:00 · 2019-10-02 18:02:26 +09:00
parent f4431cd010
commit 0a2f7b18d3
7 changed files with 113 additions and 109 deletions
--- a/multus/multus.go
+++ b/multus/multus.go
@@ -62,14 +62,14 @@ func printVersionString() string {
 func saveScratchNetConf(containerID, dataDir string, netconf []byte) error {
 	logging.Debugf("saveScratchNetConf: %s, %s, %s", containerID, dataDir, string(netconf))
 	if err := os.MkdirAll(dataDir, 0700); err != nil {
-		return logging.Errorf("failed to create the multus data directory(%q): %v", dataDir, err)
+		return logging.Errorf("saveScratchNetConf: failed to create the multus data directory(%q): %v", dataDir, err)
 	}

 	path := filepath.Join(dataDir, containerID)

 	err := ioutil.WriteFile(path, netconf, 0600)
 	if err != nil {
-		return logging.Errorf("failed to write container data in the path(%q): %v", path, err)
+		return logging.Errorf("saveScratchNetConf: failed to write container data in the path(%q): %v", path, err)
 	}

 	return err
@@ -102,11 +102,11 @@ func saveDelegates(containerID, dataDir string, delegates []*types.DelegateNetCo
 	logging.Debugf("saveDelegates: %s, %s, %v", containerID, dataDir, delegates)
 	delegatesBytes, err := json.Marshal(delegates)
 	if err != nil {
-		return logging.Errorf("error serializing delegate netconf: %v", err)
+		return logging.Errorf("saveDelegates: error serializing delegate netconf: %v", err)
 	}

 	if err = saveScratchNetConf(containerID, dataDir, delegatesBytes); err != nil {
-		return logging.Errorf("error in saving the delegates : %v", err)
+		return logging.Errorf("saveDelegates: error in saving the delegates : %v", err)
 	}

 	return err
@@ -117,7 +117,7 @@ func deleteDelegates(containerID, dataDir string) error {

 	path := filepath.Join(dataDir, containerID)
 	if err := os.Remove(path); err != nil {
-		return logging.Errorf("error in deleting the delegates : %v", err)
+		return logging.Errorf("deleteDelegates: error in deleting the delegates : %v", err)
 	}

 	return nil
@@ -127,7 +127,7 @@ func validateIfName(nsname string, ifname string) error {
 	logging.Debugf("validateIfName: %s, %s", nsname, ifname)
 	podNs, err := ns.GetNS(nsname)
 	if err != nil {
-		return logging.Errorf("no netns: %v", err)
+		return logging.Errorf("validateIfName: no net namespace %s found: %v", nsname, err)
 	}

 	err = podNs.Do(func(_ ns.NetNS) error {
@@ -138,7 +138,7 @@ func validateIfName(nsname string, ifname string) error {
 			}
 			return err
 		}
-		return logging.Errorf("ifname %s is already exist", ifname)
+		return logging.Errorf("validateIfName: interface name %s already exists", ifname)
 	})

 	return err
@@ -153,12 +153,12 @@ func conflistAdd(rt *libcni.RuntimeConf, rawnetconflist []byte, binDir string, e

 	confList, err := libcni.ConfListFromBytes(rawnetconflist)
 	if err != nil {
-		return nil, logging.Errorf("error in converting the raw bytes to conflist: %v", err)
+		return nil, logging.Errorf("conflistAdd: error converting the raw bytes into a conflist: %v", err)
 	}

 	result, err := cniNet.AddNetworkList(context.Background(), confList, rt)
 	if err != nil {
-		return nil, logging.Errorf("error in getting result from AddNetworkList: %v", err)
+		return nil, logging.Errorf("conflistAdd: error in getting result from AddNetworkList: %v", err)
 	}

 	return result, nil
@@ -173,12 +173,12 @@ func conflistDel(rt *libcni.RuntimeConf, rawnetconflist []byte, binDir string, e

 	confList, err := libcni.ConfListFromBytes(rawnetconflist)
 	if err != nil {
-		return logging.Errorf("error in converting the raw bytes to conflist: %v", err)
+		return logging.Errorf("conflistDel: error converting the raw bytes into a conflist: %v", err)
 	}

 	err = cniNet.DelNetworkList(context.Background(), confList, rt)
 	if err != nil {
-		return logging.Errorf("error in getting result from DelNetworkList: %v", err)
+		return logging.Errorf("conflistDel: error in getting result from DelNetworkList: %v", err)
 	}

 	return err
@@ -187,11 +187,11 @@ func conflistDel(rt *libcni.RuntimeConf, rawnetconflist []byte, binDir string, e
 func delegateAdd(exec invoke.Exec, ifName string, delegate *types.DelegateNetConf, rt *libcni.RuntimeConf, binDir string, cniArgs string) (cnitypes.Result, error) {
 	logging.Debugf("delegateAdd: %v, %s, %v, %v, %s", exec, ifName, delegate, rt, binDir)
 	if os.Setenv("CNI_IFNAME", ifName) != nil {
-		return nil, logging.Errorf("Multus: error in setting CNI_IFNAME")
+		return nil, logging.Errorf("delegateAdd: error setting envionment variable CNI_IFNAME")
 	}

 	if err := validateIfName(os.Getenv("CNI_NETNS"), ifName); err != nil {
-		return nil, logging.Errorf("cannot set %q ifname to %q: %v", delegate.Conf.Type, ifName, err)
+		return nil, logging.Errorf("delegateAdd: cannot set %q interface name to %q: %v", delegate.Conf.Type, ifName, err)
 	}

 	if delegate.MacRequest != "" || delegate.IPRequest != "" {
@@ -204,11 +204,11 @@ func delegateAdd(exec invoke.Exec, ifName string, delegate *types.DelegateNetCon
 			// validate Mac address
 			_, err := net.ParseMAC(delegate.MacRequest)
 			if err != nil {
-				return nil, logging.Errorf("failed to parse mac address %q", delegate.MacRequest)
+				return nil, logging.Errorf("delegateAdd: failed to parse mac address %q", delegate.MacRequest)
 			}

 			cniArgs = fmt.Sprintf("%s;MAC=%s", cniArgs, delegate.MacRequest)
-			logging.Debugf("Set MAC address %q to %q", delegate.MacRequest, ifName)
+			logging.Debugf("delegateAdd: set MAC address %q to %q", delegate.MacRequest, ifName)
 		}

 		if delegate.IPRequest != "" {
@@ -216,17 +216,17 @@ func delegateAdd(exec invoke.Exec, ifName string, delegate *types.DelegateNetCon
 			if strings.Contains(delegate.IPRequest, "/") {
 				_, _, err := net.ParseCIDR(delegate.IPRequest)
 				if err != nil {
-					return nil, logging.Errorf("failed to parse CIDR %q", delegate.MacRequest)
+					return nil, logging.Errorf("delegateAdd: failed to parse CIDR %q", delegate.MacRequest)
 				}
 			} else if net.ParseIP(delegate.IPRequest) == nil {
-				return nil, logging.Errorf("failed to parse IP address %q", delegate.IPRequest)
+				return nil, logging.Errorf("delegateAdd: failed to parse IP address %q", delegate.IPRequest)
 			}

 			cniArgs = fmt.Sprintf("%s;IP=%s", cniArgs, delegate.IPRequest)
-			logging.Debugf("Set IP address %q to %q", delegate.IPRequest, ifName)
+			logging.Debugf("delegateAdd: set IP address %q to %q", delegate.IPRequest, ifName)
 		}
 		if os.Setenv("CNI_ARGS", cniArgs) != nil {
-			return nil, logging.Errorf("cannot set %q mac to %q and ip to %q", delegate.Conf.Type, delegate.MacRequest, delegate.IPRequest)
+			return nil, logging.Errorf("delegateAdd: cannot set %q mac to %q and ip to %q", delegate.Conf.Type, delegate.MacRequest, delegate.IPRequest)
 		}
 	}

@@ -235,7 +235,7 @@ func delegateAdd(exec invoke.Exec, ifName string, delegate *types.DelegateNetCon
 	if delegate.ConfListPlugin {
 		result, err = conflistAdd(rt, delegate.Bytes, binDir, exec)
 		if err != nil {
-			return nil, logging.Errorf("Multus: error in invoke Conflist add - %q: %v", delegate.ConfList.Name, err)
+			return nil, logging.Errorf("delegateAdd: error invoking conflistAdd - %q: %v", delegate.ConfList.Name, err)
 		}
 	} else {
 		origpath := os.Getenv("CNI_PATH")
@@ -243,7 +243,7 @@ func delegateAdd(exec invoke.Exec, ifName string, delegate *types.DelegateNetCon
 		result, err = invoke.DelegateAdd(context.Background(), delegate.Conf.Type, delegate.Bytes, exec)
 		os.Setenv("CNI_PATH", origpath)
 		if err != nil {
-			return nil, logging.Errorf("Multus: error in invoke Delegate add - %q: %v", delegate.Conf.Type, err)
+			return nil, logging.Errorf("delegateAdd: error invoking DelegateAdd - %q: %v", delegate.Conf.Type, err)
 		}
 	}

@@ -265,7 +265,7 @@ func delegateAdd(exec invoke.Exec, ifName string, delegate *types.DelegateNetCon
 func delegateDel(exec invoke.Exec, ifName string, delegateConf *types.DelegateNetConf, rt *libcni.RuntimeConf, binDir string) error {
 	logging.Debugf("delegateDel: %v, %s, %v, %v, %s", exec, ifName, delegateConf, rt, binDir)
 	if os.Setenv("CNI_IFNAME", ifName) != nil {
-		return logging.Errorf("Multus: error in setting CNI_IFNAME")
+		return logging.Errorf("delegateDel: error setting envionment variable CNI_IFNAME")
 	}

 	if logging.GetLoggingLevel() >= logging.VerboseLevel {
@@ -282,14 +282,14 @@ func delegateDel(exec invoke.Exec, ifName string, delegateConf *types.DelegateNe
 	if delegateConf.ConfListPlugin {
 		err = conflistDel(rt, delegateConf.Bytes, binDir, exec)
 		if err != nil {
-			return logging.Errorf("Multus: error in invoke Conflist Del - %q: %v", delegateConf.ConfList.Name, err)
+			return logging.Errorf("delegateDel: error invoking ConflistDel - %q: %v", delegateConf.ConfList.Name, err)
 		}
 	} else {
 		origpath := os.Getenv("CNI_PATH")
 		os.Setenv("CNI_PATH", origpath+":"+binDir)
 		if err = invoke.DelegateDel(context.Background(), delegateConf.Conf.Type, delegateConf.Bytes, exec); err != nil {
 			os.Setenv("CNI_PATH", origpath)
-			return logging.Errorf("Multus: error in invoke Delegate del - %q: %v", delegateConf.Conf.Type, err)
+			return logging.Errorf("delegateDel: error invoking DelegateDel - %q: %v", delegateConf.Conf.Type, err)
 		}
 		os.Setenv("CNI_PATH", origpath)
 	}
@@ -300,7 +300,7 @@ func delegateDel(exec invoke.Exec, ifName string, delegateConf *types.DelegateNe
 func delPlugins(exec invoke.Exec, argIfname string, delegates []*types.DelegateNetConf, lastIdx int, rt *libcni.RuntimeConf, binDir string) error {
 	logging.Debugf("delPlugins: %v, %s, %v, %d, %v, %s", exec, argIfname, delegates, lastIdx, rt, binDir)
 	if os.Setenv("CNI_COMMAND", "DEL") != nil {
-		return logging.Errorf("Multus: error in setting CNI_COMMAND to DEL")
+		return logging.Errorf("delPlugins: error setting envionment variable CNI_COMMAND to a value of DEL")
 	}

 	var errorstrings []string
@@ -325,12 +325,12 @@ func cmdAdd(args *skel.CmdArgs, exec invoke.Exec, kubeClient k8s.KubeClient) (cn
 	n, err := types.LoadNetConf(args.StdinData)
 	logging.Debugf("cmdAdd: %v, %v, %v", args, exec, kubeClient)
 	if err != nil {
-		return nil, logging.Errorf("err in loading netconf: %v", err)
+		return nil, logging.Errorf("Multus: error loading netconf: %v", err)
 	}

 	k8sArgs, err := k8s.GetK8sArgs(args)
 	if err != nil {
-		return nil, logging.Errorf("Multus: Err in getting k8s args: %v", err)
+		return nil, logging.Errorf("Multus: error getting k8s args: %v", err)
 	}

 	wait.ExponentialBackoff(defaultReadinessBackoff, func() (bool, error) {
@@ -346,7 +346,7 @@ func cmdAdd(args *skel.CmdArgs, exec invoke.Exec, kubeClient k8s.KubeClient) (cn
 	if n.ClusterNetwork != "" {
 		err = k8s.GetDefaultNetworks(k8sArgs, n, kubeClient)
 		if err != nil {
-			return nil, logging.Errorf("Multus: Failed to get clusterNetwork/defaultNetworks: %v", err)
+			return nil, logging.Errorf("Multus: failed to get clusterNetwork/defaultNetworks: %v", err)
 		}
 		// First delegate is always the master plugin
 		n.Delegates[0].MasterPlugin = true
@@ -354,12 +354,12 @@ func cmdAdd(args *skel.CmdArgs, exec invoke.Exec, kubeClient k8s.KubeClient) (cn

 	_, kc, err := k8s.TryLoadPodDelegates(k8sArgs, n, kubeClient)
 	if err != nil {
-		return nil, logging.Errorf("Multus: Err in loading K8s Delegates k8s args: %v", err)
+		return nil, logging.Errorf("Multus: error loading k8s delegates k8s args: %v", err)
 	}

 	// cache the multus config
 	if err := saveDelegates(args.ContainerID, n.CNIDir, n.Delegates); err != nil {
-		return nil, logging.Errorf("Multus: Err in saving the delegates: %v", err)
+		return nil, logging.Errorf("Multus: error saving the delegates: %v", err)
 	}

 	var result, tmpResult cnitypes.Result
@@ -377,7 +377,7 @@ func cmdAdd(args *skel.CmdArgs, exec invoke.Exec, kubeClient k8s.KubeClient) (cn
 			}
 			// Ignore errors; DEL must be idempotent anyway
 			_ = delPlugins(exec, args.IfName, n.Delegates, idx, rt, n.BinDir)
-			return nil, logging.Errorf("Multus: Err adding pod to network %q: %v", netName, err)
+			return nil, logging.Errorf("Multus: error adding pod to network %q: %v", netName, err)
 		}

 		// Master plugin result is always used if present
@@ -390,7 +390,7 @@ func cmdAdd(args *skel.CmdArgs, exec invoke.Exec, kubeClient k8s.KubeClient) (cn
 			if !types.CheckSystemNamespaces(kc.Podnamespace, n.SystemNamespaces) {
 				delegateNetStatus, err := types.LoadNetworkStatus(tmpResult, delegate.Conf.Name, delegate.MasterPlugin)
 				if err != nil {
-					return nil, logging.Errorf("Multus: Err in setting network status: %v", err)
+					return nil, logging.Errorf("Multus: error setting network status: %v", err)
 				}

 				netStatus = append(netStatus, delegateNetStatus)
@@ -403,7 +403,7 @@ func cmdAdd(args *skel.CmdArgs, exec invoke.Exec, kubeClient k8s.KubeClient) (cn
 		if !types.CheckSystemNamespaces(kc.Podnamespace, n.SystemNamespaces) {
 			err = k8s.SetNetworkStatus(kubeClient, k8sArgs, netStatus, n)
 			if err != nil {
-				return nil, logging.Errorf("Multus: Err set the networks status: %v", err)
+				return nil, logging.Errorf("Multus: error setting the networks status: %v", err)
 			}
 		}
 	}
@@ -441,7 +441,7 @@ func cmdDel(args *skel.CmdArgs, exec invoke.Exec, kubeClient k8s.KubeClient) err
 			netnsfound = false
 			logging.Debugf("cmdDel: WARNING netns may not exist, netns: %s, err: %s", args.Netns, err)
 		} else {
-			return fmt.Errorf("failed to open netns %q: %v", netns, err)
+			return logging.Errorf("Multus: failed to open netns %q: %v", netns, err)
 		}
 	}

@@ -451,7 +451,7 @@ func cmdDel(args *skel.CmdArgs, exec invoke.Exec, kubeClient k8s.KubeClient) err

 	k8sArgs, err := k8s.GetK8sArgs(args)
 	if err != nil {
-		return logging.Errorf("Multus: Err in getting k8s args: %v", err)
+		return logging.Errorf("Multus: error getting k8s args: %v", err)
 	}

 	// Read the cache to get delegates json for the pod
@@ -462,7 +462,7 @@ func cmdDel(args *skel.CmdArgs, exec invoke.Exec, kubeClient k8s.KubeClient) err
 			if in.ClusterNetwork != "" {
 				err = k8s.GetDefaultNetworks(k8sArgs, in, kubeClient)
 				if err != nil {
-					return logging.Errorf("Multus: Failed to get clusterNetwork/defaultNetworks: %v", err)
+					return logging.Errorf("Multus: failed to get clusterNetwork/defaultNetworks: %v", err)
 				}
 				// First delegate is always the master plugin
 				in.Delegates[0].MasterPlugin = true
@@ -479,7 +479,7 @@ func cmdDel(args *skel.CmdArgs, exec invoke.Exec, kubeClient k8s.KubeClient) err
 				logging.Errorf("Multus: failed to get delegates: %v, but continue to delete clusterNetwork", err)
 			}
 		} else {
-			return logging.Errorf("Multus: Err in reading the delegates: %v", err)
+			return logging.Errorf("Multus: error reading the delegates: %v", err)
 		}
 	} else {
 		defer os.Remove(path)
@@ -511,7 +511,7 @@ func cmdDel(args *skel.CmdArgs, exec invoke.Exec, kubeClient k8s.KubeClient) err
 				err := k8s.SetNetworkStatus(kubeClient, k8sArgs, nil, in)
 				if err != nil {
 					// error happen but continue to delete
-					logging.Errorf("Multus: Err unset the networks status: %v", err)
+					logging.Errorf("Multus: error unsetting the networks status: %v", err)
 				}
 			}
 		} else {