Start the process of migrating from zap to a cleaner CLI output for logs

server/environment_docker.go

@@ -6,6 +6,7 @@ import (
 	"context"
 	"encoding/json"
 	"fmt"
+	"github.com/apex/log"
 	"github.com/docker/docker/api/types"
 	"github.com/docker/docker/api/types/container"
 	"github.com/docker/docker/api/types/mount"
@@ -15,7 +16,6 @@ import (
 	"github.com/pkg/errors"
 	"github.com/pterodactyl/wings/api"
 	"github.com/pterodactyl/wings/config"
-	"go.uber.org/zap"
 	"io"
 	"os"
 	"strconv"
@@ -141,7 +141,7 @@ func (d *DockerEnvironment) InSituUpdate() error {
 // state. This ensures that unexpected container deletion while Wings is running does
 // not result in the server becoming unbootable.
 func (d *DockerEnvironment) OnBeforeStart() error {
-	zap.S().Infow("syncing server configuration with Panel", zap.String("server", d.Server.Uuid))
+	d.Server.Log().Info("syncing server configuration with panel")
 	if err := d.Server.Sync(); err != nil {
 		return err
 	}
@@ -422,7 +422,7 @@ func (d *DockerEnvironment) Attach() error {
 	d.attached = true
 	go func() {
 		if err := d.EnableResourcePolling(); err != nil {
-			zap.S().Warnw("failed to enabled resource polling on server", zap.String("server", d.Server.Uuid), zap.Error(errors.WithStack(err)))
+			d.Server.Log().WithField("error", errors.WithStack(err)).Warn("failed to enable resource polling on server")
 		}
 	}()
 
@@ -470,7 +470,7 @@ func (d *DockerEnvironment) FollowConsoleOutput() error {
 		}
 
 		if err := s.Err(); err != nil {
-			zap.S().Warnw("error processing scanner line in console output", zap.String("server", d.Server.Uuid), zap.Error(err))
+			d.Server.Log().WithField("error", err).Warn("error processing scanner line in console output")
 		}
 	}(reader)
 
@@ -500,7 +500,7 @@ func (d *DockerEnvironment) EnableResourcePolling() error {
 
 			if err := dec.Decode(&v); err != nil {
 				if err != io.EOF {
-					zap.S().Warnw("encountered error processing server stats; stopping collection", zap.Error(err))
+					d.Server.Log().WithField("error", err).Warn("encountered error processing server stats, stopping collection")
 				}
 
 				d.DisableResourcePolling()
@@ -576,12 +576,10 @@ func (d *DockerEnvironment) ensureImageExists(c *client.Client) error {
 		for _, img := range images {
 			for _, t := range img.RepoTags {
 				if t == d.Server.Container.Image {
-					zap.S().Warnw(
-						"unable to pull requested image from remote source, however the image exists locally",
-						zap.String("server", d.Server.Uuid),
-						zap.String("image", d.Server.Container.Image),
-						zap.Error(err),
-					)
+					d.Server.Log().WithFields(log.Fields{
+						"image": d.Server.Container.Image,
+						"error": errors.New(err.Error()),
+					}).Warn("unable to pull requested image from remote source, however the image exists locally")
 
 					// Okay, we found a matching container image, in that case just go ahead and return
 					// from this function, since there is nothing else we need to do here.
@@ -594,7 +592,7 @@ func (d *DockerEnvironment) ensureImageExists(c *client.Client) error {
 	}
 	defer out.Close()
 
-	zap.S().Debugw("pulling docker image... this could take a bit of time", zap.String("image", d.Server.Container.Image))
+	log.WithField("image", d.Server.Container.Image).Debug("pulling docker image... this could take a bit of time")
 
 	// I'm not sure what the best approach here is, but this will block execution until the image
 	// is done being pulled, which is what we need.

server/server.go

@@ -2,13 +2,13 @@ package server
 
 import (
 	"fmt"
+	"github.com/apex/log"
 	"github.com/creasty/defaults"
 	"github.com/patrickmn/go-cache"
 	"github.com/pkg/errors"
 	"github.com/pterodactyl/wings/api"
 	"github.com/pterodactyl/wings/config"
 	"github.com/remeh/sizedwaitgroup"
-	"go.uber.org/zap"
 	"math"
 	"os"
 	"strings"
@@ -194,13 +194,13 @@ func LoadDirectory() error {
 
 			s, err := FromConfiguration(data)
 			if err != nil {
-				zap.S().Errorw("failed to load server, skipping...", zap.String("server", uuid), zap.Error(err))
+				log.WithField("server", uuid).WithField("error", err).Error("failed to load server, skipping...")
 				return
 			}
 
 			if state, exists := states[s.Uuid]; exists {
 				s.SetState(state)
-				zap.S().Debugw("loaded server state from cache", zap.String("server", s.Uuid), zap.String("state", s.GetState()))
+				s.Log().WithField("state", s.GetState()).Debug("loaded server state from cache file")
 			}
 
 			servers.Add(s)
@@ -282,6 +282,10 @@ eloop:
 	return out
 }
 
+func (s *Server) Log() *log.Entry {
+	return log.WithField("server", s.Uuid)
+}
+
 // Syncs the state of the server on the Panel with Wings. This ensures that we're always
 // using the state of the server from the Panel and allows us to not require successful
 // API calls to Wings to do things.

server/state.go

@@ -82,7 +82,7 @@ func (s *Server) SetState(state string) error {
 	s.State = state
 
 	// Emit the event to any listeners that are currently registered.
-	zap.S().Debugw("saw server status change event", zap.String("server", s.Uuid), zap.String("status", s.State))
+	s.Log().WithField("status", s.State).Debug("saw server status change event")
 	s.Events().Publish(StatusEvent, s.State)
 
 	// Release the lock as it is no longer needed for the following actions.