Add an source to all log statements

This includes a `logger` as a data members for all objects, which sets a default "source" field on every log statement so that it's easy to track where log messages are coming from. This is particularly useful as the controller for Agones gets more complicated.
googleforgames · Feb 23, 2018 · d99b932 · d99b932
1 parent 4409235
commit d99b932
Show file tree

Hide file tree

Showing 9 changed files with 146 additions and 125 deletions.
diff --git a/cmd/controller/main.go b/cmd/controller/main.go
@@ -16,10 +16,10 @@
 package main
 
 import (
-	"strings"
-	"time"
 	"os"
 	"path/filepath"
+	"strings"
+	"time"
 
 	"agones.dev/agones/pkg"
 	"agones.dev/agones/pkg/client/clientset/versioned"
@@ -28,7 +28,6 @@ import (
 	"agones.dev/agones/pkg/util/runtime"
 	"agones.dev/agones/pkg/util/signals"
 	"agones.dev/agones/pkg/util/webhooks"
-	"github.com/sirupsen/logrus"
 	"github.com/spf13/pflag"
 	"github.com/spf13/viper"
 	extclientset "k8s.io/apiextensions-apiserver/pkg/client/clientset/clientset"
@@ -46,15 +45,15 @@ const (
 	keyFileFlag     = "key-file"
 )
 
-func init() {
-	logrus.SetFormatter(&logrus.JSONFormatter{})
-}
+var (
+	logger = runtime.NewLoggerWithSource("main")
+)
 
 // main starts the operator for the gameserver CRD
 func main() {
 	exec, err := os.Executable()
 	if err != nil {
-		logrus.WithError(err).Fatal("Could not get executable path")
+		logger.WithError(err).Fatal("Could not get executable path")
 	}
 
 	base := filepath.Dir(exec)
@@ -87,7 +86,7 @@ func main() {
 	keyFile := viper.GetString(keyFileFlag)
 	certFile := viper.GetString(certFileFlag)
 
-	logrus.WithField(sidecarFlag, sidecarImage).
+	logger.WithField(sidecarFlag, sidecarImage).
 		WithField("minPort", minPort).
 		WithField("maxPort", maxPort).
 		WithField(keyFileFlag, keyFile).
@@ -96,29 +95,29 @@ func main() {
 		WithField("Version", pkg.Version).Info("starting gameServer operator...")
 
 	if minPort <= 0 || maxPort <= 0 {
-		logrus.Fatal("Min Port and Max Port values are required.")
+		logger.Fatal("Min Port and Max Port values are required.")
 	} else if maxPort < minPort {
-		logrus.Fatal("Max Port cannot be set less that the Min Port")
+		logger.Fatal("Max Port cannot be set less that the Min Port")
 	}
 
 	config, err := rest.InClusterConfig()
 	if err != nil {
-		logrus.WithError(err).Fatal("Could not create in cluster config")
+		logger.WithError(err).Fatal("Could not create in cluster config")
 	}
 
 	kubeClient, err := kubernetes.NewForConfig(config)
 	if err != nil {
-		logrus.WithError(err).Fatal("Could not create the kubernetes clientset")
+		logger.WithError(err).Fatal("Could not create the kubernetes clientset")
 	}
 
 	extClient, err := extclientset.NewForConfig(config)
 	if err != nil {
-		logrus.WithError(err).Fatal("Could not create the api extension clientset")
+		logger.WithError(err).Fatal("Could not create the api extension clientset")
 	}
 
 	agonesClient, err := versioned.NewForConfig(config)
 	if err != nil {
-		logrus.WithError(err).Fatal("Could not create the agones api clientset")
+		logger.WithError(err).Fatal("Could not create the agones api clientset")
 	}
 
 	agonesInformerFactory := externalversions.NewSharedInformerFactory(agonesClient, 30*time.Second)
@@ -134,14 +133,14 @@ func main() {
 
 	go func() {
 		if err := wh.Run(stop); err != nil { // nolint: vetshadow
-			logrus.WithError(err).Fatal("could not run webhook server")
+			logger.WithError(err).Fatal("could not run webhook server")
 		}
 	}()
 
 	err = c.Run(2, stop)
 	if err != nil {
-		logrus.WithError(err).Fatal("Could not run gameserver controller")
+		logger.WithError(err).Fatal("Could not run gameserver controller")
 	}
 
-	logrus.Info("Shut down gameserver controller")
+	logger.Info("Shut down gameserver controller")
 }
diff --git a/cmd/sdk-server/main.go b/cmd/sdk-server/main.go
@@ -26,7 +26,6 @@ import (
 	"agones.dev/agones/pkg/gameservers"
 	"agones.dev/agones/pkg/sdk"
 	"agones.dev/agones/pkg/util/runtime"
-	"github.com/sirupsen/logrus"
 	"github.com/spf13/pflag"
 	"github.com/spf13/viper"
 	"golang.org/x/net/context"
@@ -51,9 +50,9 @@ const (
 	healthFailureThresholdFlag = "health-failure-threshold"
 )
 
-func init() {
-	logrus.SetFormatter(&logrus.JSONFormatter{})
-}
+var (
+	logger = runtime.NewLoggerWithSource("main")
+)
 
 func main() {
 	viper.SetDefault(localFlag, false)
@@ -92,15 +91,15 @@ func main() {
 	healthInitialDelay := time.Duration(viper.GetInt64(healthInitialDelayFlag)) * time.Second
 	healthFailureThreshold := viper.GetInt64(healthFailureThresholdFlag)
 
-	logrus.WithField(localFlag, isLocal).WithField("version", pkg.Version).
+	logger.WithField(localFlag, isLocal).WithField("version", pkg.Version).
 		WithField("port", port).WithField(addressFlag, address).
 		WithField(healthDisabledFlag, healthDisabled).WithField(healthTimeoutFlag, healthTimeout).
 		WithField(healthFailureThresholdFlag, healthFailureThreshold).
 		WithField(healthInitialDelayFlag, healthInitialDelay).Info("Starting sdk sidecar")
 
 	lis, err := net.Listen("tcp", fmt.Sprintf("%s:%d", address, port))
 	if err != nil {
-		logrus.WithField("port", port).WithField("address", address).Fatalf("Could not listen on port")
+		logger.WithField("port", port).WithField("address", address).Fatalf("Could not listen on port")
 	}
 	grpcServer := grpc.NewServer()
 
@@ -109,24 +108,24 @@ func main() {
 	} else {
 		config, err := rest.InClusterConfig()
 		if err != nil {
-			logrus.WithError(err).Fatal("Could not create in cluster config")
+			logger.WithError(err).Fatal("Could not create in cluster config")
 		}
 
 		kubeClient, err := kubernetes.NewForConfig(config)
 		if err != nil {
-			logrus.WithError(err).Fatal("Could not create the kubernetes clientset")
+			logger.WithError(err).Fatal("Could not create the kubernetes clientset")
 		}
 
 		agonesClient, err := versioned.NewForConfig(config)
 		if err != nil {
-			logrus.WithError(err).Fatalf("Could not create the agones api clientset")
+			logger.WithError(err).Fatalf("Could not create the agones api clientset")
 		}
 
 		var s *gameservers.SDKServer
 		s, err = gameservers.NewSDKServer(viper.GetString(gameServerNameEnv), viper.GetString(podNamespaceEnv),
 			healthDisabled, healthTimeout, healthFailureThreshold, healthInitialDelay, kubeClient, agonesClient)
 		if err != nil {
-			logrus.WithError(err).Fatalf("Could not start sidecar")
+			logger.WithError(err).Fatalf("Could not start sidecar")
 		}
 		ctx, cancel := context.WithCancel(context.Background())
 		defer cancel()
@@ -137,6 +136,6 @@ func main() {
 
 	err = grpcServer.Serve(lis)
 	if err != nil {
-		logrus.WithError(err).Error("Could not serve grpc server")
+		logger.WithError(err).Error("Could not serve grpc server")
 	}
 }
diff --git a/pkg/apis/stable/v1alpha1/types_test.go b/pkg/apis/stable/v1alpha1/types_test.go
@@ -18,7 +18,6 @@ import (
 	"testing"
 
 	"agones.dev/agones/pkg/apis/stable"
-	"github.com/sirupsen/logrus"
 	"github.com/stretchr/testify/assert"
 	corev1 "k8s.io/api/core/v1"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
@@ -218,7 +217,6 @@ func TestGameServerPod(t *testing.T) {
 	assert.Equal(t, fixture.Spec.HostPort, pod.Spec.Containers[0].Ports[0].HostPort)
 	assert.Equal(t, fixture.Spec.ContainerPort, pod.Spec.Containers[0].Ports[0].ContainerPort)
 	assert.Equal(t, corev1.Protocol("UDP"), pod.Spec.Containers[0].Ports[0].Protocol)
-	logrus.SetFormatter(&logrus.JSONFormatter{})
 	assert.True(t, metav1.IsControlledBy(pod, fixture))
 
 	sidecar := corev1.Container{Name: "sidecar", Image: "container/sidecar"}