refactor: standardize log & error messages

Standardize a lot of the logging and error message strings. Include some
additional state when logging at trace and debug levels.

Signed-off-by: Link Dupont <[email protected]>

cmd/yggd/client.go

@@ -142,7 +142,7 @@ func (c *Client) DataReceiveHandlerFunc(data []byte, dest string) {
 func (c *Client) ReceiveData() {
 	for msg := range c.d.recvQ {
 		if err := c.SendDataMessage(&msg); err != nil {
-			log.Errorf("failed to send data message: %v", err)
+			log.Errorf("cannot send data message: %v", err)
 		}
 	}
 }

cmd/yggd/exec.go

@@ -12,24 +12,24 @@ import (
 // process has been started.
 func startProcess(file string, args []string, env []string, started func(pid int, stdout io.ReadCloser, stderr io.ReadCloser)) error {
 	if _, err := os.Stat(file); os.IsNotExist(err) {
-		return fmt.Errorf("cannot find file: %v", err)
+		return fmt.Errorf("cannot find file: %w", err)
 	}
 
 	cmd := exec.Command(file, args...)
 	cmd.Env = env
 
 	stdout, err := cmd.StdoutPipe()
 	if err != nil {
-		return fmt.Errorf("cannot connect to stdout: %v", err)
+		return fmt.Errorf("cannot connect to stdout: %w", err)
 	}
 
 	stderr, err := cmd.StderrPipe()
 	if err != nil {
-		return fmt.Errorf("cannot connect to stderr: %v", err)
+		return fmt.Errorf("cannot connect to stderr: %w", err)
 	}
 
 	if err := cmd.Start(); err != nil {
-		return fmt.Errorf("cannot start process: %v: %v", file, err)
+		return fmt.Errorf("cannot start process: %v: %w", file, err)
 	}
 
 	if started != nil {
@@ -44,12 +44,12 @@ func startProcess(file string, args []string, env []string, started func(pid int
 func waitProcess(pid int, died func(pid int, state *os.ProcessState)) error {
 	process, err := os.FindProcess(pid)
 	if err != nil {
-		return fmt.Errorf("cannot find process with pid: %v", err)
+		return fmt.Errorf("cannot find process with pid %v: %w", pid, err)
 	}
 
 	state, err := process.Wait()
 	if err != nil {
-		return fmt.Errorf("process %v exited with error: %v", process.Pid, err)
+		return fmt.Errorf("process %v exited with error: %w", process.Pid, err)
 	}
 
 	if died != nil {
@@ -63,11 +63,11 @@ func waitProcess(pid int, died func(pid int, state *os.ProcessState)) error {
 func stopProcess(pid int) error {
 	process, err := os.FindProcess(pid)
 	if err != nil {
-		return fmt.Errorf("cannot find process with pid: %v", err)
+		return fmt.Errorf("cannot find process with pid %v: %w", pid, err)
 	}
 
 	if err := process.Kill(); err != nil {
-		return fmt.Errorf("cannot stop process: %v", err)
+		return fmt.Errorf("cannot stop process: %w", err)
 	}
 
 	return nil

cmd/yggd/grpc.go

@@ -137,7 +137,7 @@ func (d *dispatcher) disconnectWorker(w *worker) error {
 
 	_, err = workerClient.NotifyEvent(ctx, &pb.EventNotification{Name: pb.Event_RECEIVED_DISCONNECT})
 	if err != nil {
-		log.Errorf("cannot disconnect worker %v", err)
+		log.Errorf("cannot disconnect worker %v: %v", w, err)
 		return err
 	}
 	return nil
@@ -150,7 +150,7 @@ func (d *dispatcher) sendData() {
 			w := d.reg.get(data.Directive)
 
 			if w == nil {
-				log.Warnf("cannot route message to directive: %v", data.Directive)
+				log.Warnf("cannot route message  %v to directive: %v", data.MessageID, data.Directive)
 				return
 			}
 

cmd/yggd/main.go

@@ -341,6 +341,7 @@ func main() {
 				continue
 			}
 			if ExcludeWorkers[config.directive] {
+				log.Tracef("skipping excluded worker %v", config.directive)
 				continue
 			}
 			log.Debugf("starting worker: %v", config.directive)

cmd/yggd/worker.go

@@ -231,22 +231,23 @@ func watchWorkerDir(dir string, died chan int) {
 				log.Errorf("cannot load worker config: %v", err)
 			}
 			if ExcludeWorkers[config.directive] {
+				log.Tracef("skipping excluded worker %v", config.directive)
 				continue
 			}
 			log.Debugf("starting worker: %v", config.directive)
 			go func() {
 				if err := startWorker(*config, nil, func(pid int) {
 					died <- pid
 				}); err != nil {
-					log.Errorf("cannot start worker: %v", err)
+					log.Errorf("cannot start worker %v: %v", config.directive, err)
 					return
 				}
 			}()
 		case notify.InDelete, notify.InMovedFrom:
 			name := strings.TrimSuffix(filepath.Base(e.Path()), filepath.Ext(e.Path()))
 
 			if err := stopWorker(name); err != nil {
-				log.Errorf("cannot kill worker: %v", err)
+				log.Errorf("cannot kill worker %v: %v", name, err)
 				continue
 			}
 		}