feat(logging): replace all the loggers with zerolog EE-4186 (#7663)

api/http/handler/stacks/autoupdate.go

@@ -1,7 +1,6 @@
 package stacks
 
 import (
-	"log"
 	"time"
 
 	httperror "github.com/portainer/libhttp/error"
@@ -9,6 +8,8 @@ import (
 	"github.com/portainer/portainer/api/dataservices"
 	"github.com/portainer/portainer/api/scheduler"
 	"github.com/portainer/portainer/api/stacks"
+
+	"github.com/rs/zerolog/log"
 )
 
 func startAutoupdate(stackID portainer.StackID, interval string, scheduler *scheduler.Scheduler, stackDeployer stacks.StackDeployer, datastore dataservices.DataStore, gitService portainer.GitService) (jobID string, e *httperror.HandlerError) {
@@ -30,6 +31,6 @@ func stopAutoupdate(stackID portainer.StackID, jobID string, scheduler scheduler
 	}
 
 	if err := scheduler.StopJob(jobID); err != nil {
-		log.Printf("[WARN] could not stop the job for the stack %v", stackID)
+		log.Warn().Int("stack_id", int(stackID)).Msg("could not stop the job for the stack")
 	}
 }

api/http/handler/stacks/create_compose_stack.go

@@ -2,7 +2,6 @@ package stacks
 
 import (
 	"fmt"
-	"log"
 	"net/http"
 	"strconv"
 	"time"
@@ -16,6 +15,8 @@ import (
 	gittypes "github.com/portainer/portainer/api/git/types"
 	"github.com/portainer/portainer/api/http/security"
 	"github.com/portainer/portainer/api/internal/stackutils"
+
+	"github.com/rs/zerolog/log"
 )
 
 type composeStackFromFileContentPayload struct {
@@ -44,6 +45,7 @@ func (handler *Handler) checkAndCleanStackDupFromSwarm(w http.ResponseWriter, r
 	if err != nil {
 		return err
 	}
+
 	// stop scheduler updates of the stack before removal
 	if stack.AutoUpdate != nil {
 		stopAutoupdate(stack.ID, stack.AutoUpdate.JobID, *handler.Scheduler)
@@ -57,16 +59,21 @@ func (handler *Handler) checkAndCleanStackDupFromSwarm(w http.ResponseWriter, r
 	if resourceControl != nil {
 		err = handler.DataStore.ResourceControl().DeleteResourceControl(resourceControl.ID)
 		if err != nil {
-			log.Printf("[ERROR] [Stack] Unable to remove the associated resource control from the database for stack: [%+v].", stack)
+			log.Error().
+				Str("stack", fmt.Sprintf("%+v", stack)).
+				Msg("unable to remove the associated resource control from the database for stack")
 		}
 	}
 
 	if exists, _ := handler.FileService.FileExists(stack.ProjectPath); exists {
 		err = handler.FileService.RemoveDirectory(stack.ProjectPath)
 		if err != nil {
-			log.Printf("Unable to remove stack files from disk for stack: [%+v].", stack)
+			log.Warn().
+				Str("stack", fmt.Sprintf("%+v", stack)).
+				Msg("unable to remove stack files from disk for stack")
 		}
 	}
+
 	return nil
 }
 

api/http/handler/stacks/stack_create.go

@@ -1,12 +1,8 @@
 package stacks
 
 import (
-	"log"
 	"net/http"
 
-	"github.com/docker/cli/cli/compose/loader"
-	"github.com/docker/cli/cli/compose/types"
-	"github.com/pkg/errors"
 	httperror "github.com/portainer/libhttp/error"
 	"github.com/portainer/libhttp/request"
 	"github.com/portainer/libhttp/response"
@@ -14,6 +10,11 @@ import (
 	"github.com/portainer/portainer/api/http/security"
 	"github.com/portainer/portainer/api/internal/authorization"
 	"github.com/portainer/portainer/api/internal/stackutils"
+
+	"github.com/docker/cli/cli/compose/loader"
+	"github.com/docker/cli/cli/compose/types"
+	"github.com/pkg/errors"
+	"github.com/rs/zerolog/log"
 )
 
 func (handler *Handler) cleanUp(stack *portainer.Stack, doCleanUp *bool) error {
@@ -23,8 +24,9 @@ func (handler *Handler) cleanUp(stack *portainer.Stack, doCleanUp *bool) error {
 
 	err := handler.FileService.RemoveDirectory(stack.ProjectPath)
 	if err != nil {
-		log.Printf("http error: Unable to cleanup stack creation (err=%s)\n", err)
+		log.Error().Err(err).Msg("unable to cleanup stack creation")
 	}
+
 	return nil
 }
 

api/http/handler/stacks/stack_update.go

@@ -1,14 +1,10 @@
 package stacks
 
 import (
-	"log"
 	"net/http"
 	"strconv"
 	"time"
 
-	"github.com/pkg/errors"
-
-	"github.com/asaskevich/govalidator"
 	httperror "github.com/portainer/libhttp/error"
 	"github.com/portainer/libhttp/request"
 	"github.com/portainer/libhttp/response"
@@ -16,6 +12,10 @@ import (
 	httperrors "github.com/portainer/portainer/api/http/errors"
 	"github.com/portainer/portainer/api/http/security"
 	"github.com/portainer/portainer/api/internal/stackutils"
+
+	"github.com/asaskevich/govalidator"
+	"github.com/pkg/errors"
+	"github.com/rs/zerolog/log"
 )
 
 type updateComposeStackPayload struct {
@@ -197,7 +197,7 @@ func (handler *Handler) updateComposeStack(r *http.Request, stack *portainer.Sta
 	_, err = handler.FileService.UpdateStoreStackFileFromBytes(stackFolder, stack.EntryPoint, []byte(payload.StackFileContent))
 	if err != nil {
 		if rollbackErr := handler.FileService.RollbackStackFile(stackFolder, stack.EntryPoint); rollbackErr != nil {
-			log.Printf("[WARN] [stack,update] [message: rollback stack file error] [err: %s]", rollbackErr)
+			log.Warn().Err(rollbackErr).Msg("rollback stack file error")
 		}
 
 		return httperror.InternalServerError("Unable to persist updated Compose file on disk", err)
@@ -206,7 +206,7 @@ func (handler *Handler) updateComposeStack(r *http.Request, stack *portainer.Sta
 	config, configErr := handler.createComposeDeployConfig(r, stack, endpoint, payload.PullImage)
 	if configErr != nil {
 		if rollbackErr := handler.FileService.RollbackStackFile(stackFolder, stack.EntryPoint); rollbackErr != nil {
-			log.Printf("[WARN] [stack,update] [message: rollback stack file error] [err: %s]", rollbackErr)
+			log.Warn().Err(rollbackErr).Msg("rollback stack file error")
 		}
 
 		return configErr
@@ -215,7 +215,7 @@ func (handler *Handler) updateComposeStack(r *http.Request, stack *portainer.Sta
 	err = handler.deployComposeStack(config, false)
 	if err != nil {
 		if rollbackErr := handler.FileService.RollbackStackFile(stackFolder, stack.EntryPoint); rollbackErr != nil {
-			log.Printf("[WARN] [stack,update] [message: rollback stack file error] [err: %s]", rollbackErr)
+			log.Warn().Err(rollbackErr).Msg("rollback stack file error")
 		}
 
 		return httperror.InternalServerError(err.Error(), err)
@@ -248,7 +248,7 @@ func (handler *Handler) updateSwarmStack(r *http.Request, stack *portainer.Stack
 	_, err = handler.FileService.UpdateStoreStackFileFromBytes(stackFolder, stack.EntryPoint, []byte(payload.StackFileContent))
 	if err != nil {
 		if rollbackErr := handler.FileService.RollbackStackFile(stackFolder, stack.EntryPoint); rollbackErr != nil {
-			log.Printf("[WARN] [swarm,stack,update] [message: rollback stack file error] [err: %s]", rollbackErr)
+			log.Warn().Err(rollbackErr).Msg("rollback stack file error")
 		}
 
 		return httperror.InternalServerError("Unable to persist updated Compose file on disk", err)
@@ -257,7 +257,7 @@ func (handler *Handler) updateSwarmStack(r *http.Request, stack *portainer.Stack
 	config, configErr := handler.createSwarmDeployConfig(r, stack, endpoint, payload.Prune, payload.PullImage)
 	if configErr != nil {
 		if rollbackErr := handler.FileService.RollbackStackFile(stackFolder, stack.EntryPoint); rollbackErr != nil {
-			log.Printf("[WARN] [swarm,stack,update] [message: rollback stack file error] [err: %s]", rollbackErr)
+			log.Warn().Err(rollbackErr).Msg("rollback stack file error")
 		}
 
 		return configErr
@@ -266,7 +266,7 @@ func (handler *Handler) updateSwarmStack(r *http.Request, stack *portainer.Stack
 	err = handler.deploySwarmStack(config)
 	if err != nil {
 		if rollbackErr := handler.FileService.RollbackStackFile(stackFolder, stack.EntryPoint); rollbackErr != nil {
-			log.Printf("[WARN] [swarm,stack,update] [message: rollback stack file error] [err: %s]", rollbackErr)
+			log.Warn().Err(rollbackErr).Msg("rollback stack file error")
 		}
 
 		return httperror.InternalServerError(err.Error(), err)

api/http/handler/stacks/stack_update_git_redeploy.go

@@ -2,7 +2,6 @@ package stacks
 
 import (
 	"fmt"
-	"log"
 	"net/http"
 	"time"
 
@@ -16,6 +15,8 @@ import (
 	"github.com/portainer/portainer/api/http/security"
 	"github.com/portainer/portainer/api/internal/stackutils"
 	k "github.com/portainer/portainer/api/kubernetes"
+
+	"github.com/rs/zerolog/log"
 )
 
 type stackGitRedployPayload struct {
@@ -156,7 +157,7 @@ func (handler *Handler) stackGitRedeploy(w http.ResponseWriter, r *http.Request)
 	if err != nil {
 		restoreError := filesystem.MoveDirectory(backupProjectPath, stack.ProjectPath)
 		if restoreError != nil {
-			log.Printf("[WARN] [http,stacks,git] [error: %s] [message: failed restoring backup folder]", restoreError)
+			log.Warn().Err(restoreError).Msg("failed restoring backup folder")
 		}
 
 		return httperror.InternalServerError("Unable to clone git repository", err)
@@ -165,7 +166,7 @@ func (handler *Handler) stackGitRedeploy(w http.ResponseWriter, r *http.Request)
 	defer func() {
 		err = handler.FileService.RemoveDirectory(backupProjectPath)
 		if err != nil {
-			log.Printf("[WARN] [http,stacks,git] [error: %s] [message: unable to remove git repository directory]", err)
+			log.Warn().Err(err).Msg("unable to remove git repository directory")
 		}
 	}()
 

api/http/handler/stacks/update_kubernetes_stack.go

@@ -3,13 +3,10 @@ package stacks
 import (
 	"fmt"
 	"io/ioutil"
-	"log"
 	"net/http"
 	"os"
 	"strconv"
 
-	"github.com/asaskevich/govalidator"
-	"github.com/pkg/errors"
 	httperror "github.com/portainer/libhttp/error"
 	"github.com/portainer/libhttp/request"
 	portainer "github.com/portainer/portainer/api"
@@ -17,6 +14,10 @@ import (
 	gittypes "github.com/portainer/portainer/api/git/types"
 	"github.com/portainer/portainer/api/http/security"
 	k "github.com/portainer/portainer/api/kubernetes"
+
+	"github.com/asaskevich/govalidator"
+	"github.com/pkg/errors"
+	"github.com/rs/zerolog/log"
 )
 
 type kubernetesFileStackUpdatePayload struct {
@@ -128,7 +129,7 @@ func (handler *Handler) updateKubernetesStack(r *http.Request, stack *portainer.
 	projectPath, err := handler.FileService.UpdateStoreStackFileFromBytes(stackFolder, stack.EntryPoint, []byte(payload.StackFileContent))
 	if err != nil {
 		if rollbackErr := handler.FileService.RollbackStackFile(stackFolder, stack.EntryPoint); rollbackErr != nil {
-			log.Printf("[WARN] [kubernetes,stack,update] [message: rollback stack file error] [err: %s]", rollbackErr)
+			log.Warn().Err(rollbackErr).Msg("rollback stack file error")
 		}
 
 		fileType := "Manifest"

api/http/handler/stacks/webhook_invoke.go

@@ -3,15 +3,13 @@ package stacks
 import (
 	"net/http"
 
-	"github.com/gofrs/uuid"
-	"github.com/sirupsen/logrus"
-
-	"github.com/portainer/libhttp/response"
-
-	"github.com/portainer/portainer/api/stacks"
-
 	httperror "github.com/portainer/libhttp/error"
 	"github.com/portainer/libhttp/request"
+	"github.com/portainer/libhttp/response"
+	"github.com/portainer/portainer/api/stacks"
+
+	"github.com/gofrs/uuid"
+	"github.com/rs/zerolog/log"
 )
 
 // @id WebhookInvoke
@@ -36,6 +34,7 @@ func (handler *Handler) webhookInvoke(w http.ResponseWriter, r *http.Request) *h
 		if handler.DataStore.IsErrObjectNotFound(err) {
 			statusCode = http.StatusNotFound
 		}
+
 		return &httperror.HandlerError{StatusCode: statusCode, Message: "Unable to find the stack by webhook ID", Err: err}
 	}
 
@@ -43,7 +42,9 @@ func (handler *Handler) webhookInvoke(w http.ResponseWriter, r *http.Request) *h
 		if _, ok := err.(*stacks.StackAuthorMissingErr); ok {
 			return &httperror.HandlerError{StatusCode: http.StatusConflict, Message: "Autoupdate for the stack isn't available", Err: err}
 		}
-		logrus.WithError(err).Error("failed to update the stack")
+
+		log.Error().Err(err).Msg("failed to update the stack")
+
 		return httperror.InternalServerError("Failed to update the stack", err)
 	}
 
@@ -57,7 +58,6 @@ func retrieveUUIDRouteVariableValue(r *http.Request, name string) (uuid.UUID, er
 	}
 
 	uid, err := uuid.FromString(webhookID)
-
 	if err != nil {
 		return uuid.Nil, err
 	}