fix: print version info when starting (#1013)

Author: whynowy

Makefile

@@ -1,5 +1,6 @@
 SHELL:=/bin/bash
 
+PACKAGE=github.com/numaproj/numaflow
 CURRENT_DIR=$(shell pwd)
 DIST_DIR=${CURRENT_DIR}/dist
 BINARY_NAME:=numaflow

cmd/commands/daemon_server.go

@@ -25,6 +25,7 @@ import (
 	"github.com/spf13/cobra"
 	"sigs.k8s.io/controller-runtime/pkg/manager/signals"
 
+	"github.com/numaproj/numaflow"
 	"github.com/numaproj/numaflow/pkg/apis/numaflow/v1alpha1"
 	"github.com/numaproj/numaflow/pkg/daemon/server"
 	"github.com/numaproj/numaflow/pkg/shared/logging"
@@ -44,6 +45,7 @@ func NewDaemonServerCommand() *cobra.Command {
 				return fmt.Errorf("failed to decode the pipeline spec: %v", err)
 			}
 			logger := logging.NewLogger().Named("daemon-server").With("pipeline", pl.Name)
+			logger.Infow("Starting daemon server", "version", numaflow.GetVersion())
 			ctx := logging.WithLogger(signals.SetupSignalHandler(), logger)
 			server := server.NewDaemonServer(pl, v1alpha1.ISBSvcType(isbSvcType))
 			return server.Run(ctx)

cmd/commands/processor.go

@@ -26,6 +26,7 @@ import (
 	"github.com/spf13/cobra"
 	"sigs.k8s.io/controller-runtime/pkg/manager/signals"
 
+	"github.com/numaproj/numaflow"
 	dfv1 "github.com/numaproj/numaflow/pkg/apis/numaflow/v1alpha1"
 	"github.com/numaproj/numaflow/pkg/shared/logging"
 	"github.com/numaproj/numaflow/pkg/sinks"
@@ -44,6 +45,7 @@ func NewProcessorCommand() *cobra.Command {
 		Short: "Start a processor",
 		RunE: func(cmd *cobra.Command, args []string) error {
 			log := logging.NewLogger().Named(fmt.Sprintf("%s-processor", processorType))
+			log.Infow("Starting vertex data processor", "version", numaflow.GetVersion())
 			encodedVertex, defined := os.LookupEnv(dfv1.EnvVertexObject)
 			if !defined {
 				return fmt.Errorf("required environment variable '%s' not defined", dfv1.EnvVertexObject)

cmd/commands/side_inputs_manager.go

@@ -25,6 +25,7 @@ import (
 	"github.com/spf13/cobra"
 	"sigs.k8s.io/controller-runtime/pkg/manager/signals"
 
+	"github.com/numaproj/numaflow"
 	dfv1 "github.com/numaproj/numaflow/pkg/apis/numaflow/v1alpha1"
 	"github.com/numaproj/numaflow/pkg/shared/logging"
 	"github.com/numaproj/numaflow/pkg/sideinputs/manager"
@@ -58,6 +59,7 @@ func NewSideInputsManagerCommand() *cobra.Command {
 			}
 
 			logger := logging.NewLogger().Named("side-inputs-manager").With("pipeline", pipelineName)
+			logger.Infow("Starting side inputs manager", "version", numaflow.GetVersion())
 
 			ctx := logging.WithLogger(signals.SetupSignalHandler(), logger)
 			sideInputManager := manager.NewSideInputsManager(dfv1.ISBSvcType(isbSvcType), pipelineName, sideInputsStore, sideInput)

server/cmd/start.go

@@ -25,6 +25,7 @@ import (
 	"github.com/gin-contrib/static"
 	"github.com/gin-gonic/gin"
 
+	"github.com/numaproj/numaflow"
 	"github.com/numaproj/numaflow/pkg/shared/logging"
 	sharedtls "github.com/numaproj/numaflow/pkg/shared/tls"
 	"github.com/numaproj/numaflow/server/routes"
@@ -55,7 +56,7 @@ func Start(insecure bool, port int, namespaced bool, managedNamespace string, ba
 	}
 
 	if insecure {
-		logger.Infof("Starting server (TLS disabled) on %s", server.Addr)
+		logger.Infow("Starting server (TLS disabled) on "+server.Addr, "version", numaflow.GetVersion())
 		if err := server.ListenAndServe(); err != nil {
 			panic(err)
 		}
@@ -66,7 +67,7 @@ func Start(insecure bool, port int, namespaced bool, managedNamespace string, ba
 		}
 		server.TLSConfig = &tls.Config{Certificates: []tls.Certificate{*cert}, MinVersion: tls.VersionTLS12}
 
-		logger.Infof("Starting server on %s", server.Addr)
+		logger.Infow("Starting server on "+server.Addr, "version", numaflow.GetVersion())
 		if err := server.ListenAndServeTLS("", ""); err != nil {
 			panic(err)
 		}

version.go

@@ -45,7 +45,7 @@ type Version struct {
 
 // String outputs the version as a string
 func (v Version) String() string {
-	return v.Version
+	return fmt.Sprintf(`Version: %s, BuildDate: %s, GitCommit: %s, GitTag: %s, GitTreeState: %s, GoVersion: %s, Compiler: %s, Platform: %s`, v.Version, v.BuildDate, v.GitCommit, v.GitTag, v.GitTreeState, v.GoVersion, v.Compiler, v.Platform)
 }
 
 // GetVersion returns the version information

webhook/cmd/start.go

@@ -29,6 +29,7 @@ import (
 	"k8s.io/client-go/tools/clientcmd"
 	"sigs.k8s.io/controller-runtime/pkg/manager/signals"
 
+	"github.com/numaproj/numaflow"
 	dfv1 "github.com/numaproj/numaflow/pkg/apis/numaflow/v1alpha1"
 	"github.com/numaproj/numaflow/pkg/client/clientset/versioned"
 	"github.com/numaproj/numaflow/pkg/shared/logging"
@@ -76,7 +77,7 @@ func Start() {
 	portStr := sharedutil.LookupEnvStringOr(portEnvVar, "443")
 	port, err := strconv.Atoi(portStr)
 	if err != nil {
-		logger.Fatal("port should be a number, not valid")
+		logger.Fatal("Port should be a number, not valid")
 	}
 
 	options := webhook.Options{
@@ -99,9 +100,9 @@ func Start() {
 		},
 		Logger: logger,
 	}
+	logger.Infow("Starting admission controller", "version", numaflow.GetVersion())
 	ctx := logging.WithLogger(signals.SetupSignalHandler(), logger)
 	if err := controller.Run(ctx); err != nil {
 		logger.Fatalw("Failed to create admission controller", zap.Error(err))
 	}
-
 }