Merge pull request #21 from portainer/fix/EE-2825/logging-improvements

fix(logging): improve the log output EE-2825

Author: hookenz

compose/compose.go

@@ -18,7 +18,7 @@ func NewComposeDeployer(binaryPath, configPath string) (libstack.Deployer, error
 	}
 
 	if err == errors.ErrBinaryNotFound {
-		log.Printf("[INFO] [main,compose] [message: binary is missing, falling-back to compose plugin] [error: %s]", err)
+		log.Printf("[INFO] [compose] [message: binary is missing, falling-back to compose plugin] [error: %s]", err)
 		return composeplugin.NewPluginWrapper(binaryPath, configPath)
 	}
 

compose/internal/composebinary/composebinary.go

@@ -35,7 +35,12 @@ func NewComposeWrapper(binaryPath, configPath string) (libstack.Deployer, error)
 func (wrapper *ComposeWrapper) Deploy(ctx context.Context, workingDir, host, projectName string, filePaths []string, envFilePath string, forceRereate bool) error {
 	output, err := wrapper.Command(newUpCommand(filePaths, forceRereate), workingDir, host, projectName, envFilePath)
 	if len(output) != 0 {
-		log.Printf("[libstack,composebinary] [message: finish deploying] [output: %s] [err: %s]", output, err)
+		if err != nil {
+			return err
+		}
+
+		log.Printf("[INFO] [compose,internal,composebinary] [message: Stack deployment successful]")
+		log.Printf("[DEBUG] [compose,internal,composebinary] [output: %s]", output)
 	}
 
 	return err
@@ -45,7 +50,12 @@ func (wrapper *ComposeWrapper) Deploy(ctx context.Context, workingDir, host, pro
 func (wrapper *ComposeWrapper) Remove(ctx context.Context, workingDir, host, projectName string, filePaths []string) error {
 	output, err := wrapper.Command(newDownCommand(filePaths), workingDir, host, projectName, "")
 	if len(output) != 0 {
-		log.Printf("[libstack,composebinary] [message: finish deploying] [output: %s] [err: %s]", output, err)
+		if err != nil {
+			return err
+		}
+
+		log.Printf("[INFO] [compose,internal,composebinary] [message: Stack removal successful]")
+		log.Printf("[DEBUG] [compose,internal,composebinary] [output: %s]", output)
 	}
 
 	return err
@@ -56,7 +66,12 @@ func (wrapper *ComposeWrapper) Remove(ctx context.Context, workingDir, host, pro
 func (wrapper *ComposeWrapper) Pull(ctx context.Context, workingDir, host, projectName string, filePaths []string) error {
 	output, err := wrapper.Command(newPullCommand(filePaths), workingDir, host, projectName, "")
 	if len(output) != 0 {
-		log.Printf("[libstack,composebinary] [message: finish deploying] [output: %s] [err: %s]", output, err)
+		if err != nil {
+			return err
+		}
+
+		log.Printf("[INFO] [compose,internal,composebinary] [message: Stack pull successful]")
+		log.Printf("[DEBUG] [compose,internal,composebinary] [output: %s]", output)
 	}
 
 	return err

compose/internal/composeplugin/composeplugin.go

@@ -65,7 +65,12 @@ func NewPluginWrapper(binaryPath, configPath string) (libstack.Deployer, error)
 func (wrapper *PluginWrapper) Deploy(ctx context.Context, workingDir, host, projectName string, filePaths []string, envFilePath string, forceRereate bool) error {
 	output, err := wrapper.command(newUpCommand(filePaths, forceRereate), workingDir, host, projectName, envFilePath)
 	if len(output) != 0 {
-		log.Printf("[libstack,composebinary] [message: finish deploying] [output: %s] [err: %s]", output, err)
+		if err != nil {
+			return err
+		}
+
+		log.Printf("[INFO] [compose,internal,composeplugin] [message: Stack deployment successful]")
+		log.Printf("[DEBUG] [compose,internal,composeplugin] [output: %s]", output)
 	}
 
 	return err
@@ -75,7 +80,12 @@ func (wrapper *PluginWrapper) Deploy(ctx context.Context, workingDir, host, proj
 func (wrapper *PluginWrapper) Remove(ctx context.Context, workingDir, host, projectName string, filePaths []string) error {
 	output, err := wrapper.command(newDownCommand(filePaths), workingDir, host, projectName, "")
 	if len(output) != 0 {
-		log.Printf("[libstack,composebinary] [message: finish deploying] [output: %s] [err: %s]", output, err)
+		if err != nil {
+			return err
+		}
+
+		log.Printf("[INFO] [compose,internal,composeplugin] [message: Stack removal successful]")
+		log.Printf("[DEBUG] [compose,internal,composeplugin] [output: %s]", output)
 	}
 
 	return err
@@ -85,7 +95,12 @@ func (wrapper *PluginWrapper) Remove(ctx context.Context, workingDir, host, proj
 func (wrapper *PluginWrapper) Pull(ctx context.Context, workingDir, host, projectName string, filePaths []string) error {
 	output, err := wrapper.command(newPullCommand(filePaths), workingDir, host, projectName, "")
 	if len(output) != 0 {
-		log.Printf("[libstack,composebinary] [message: finish pulling] [output: %s] [err: %s]", output, err)
+		if err != nil {
+			return err
+		}
+
+		log.Printf("[INFO] [compose,internal,composeplugin] [message: Stack pull successful]")
+		log.Printf("[DEBUG] [compose,internal,composeplugin] [output: %s]", output)
 	}
 
 	return err