server: print more info about build and runtime (#354)

Makefile

@@ -14,13 +14,19 @@
 # limitations under the License.
 
 GOBIN := $(shell pwd)/bin
-VERSION ?= $(shell git rev-parse --abbrev-ref HEAD)
+VERSION ?= $(shell git describe --tags --dirty --always)
+BRANCH ?= $(shell git rev-parse --abbrev-ref HEAD)
 COMMIT ?= $(shell git describe --match=NeVeRmAtCh --always --abbrev=40 --dirty)
 DEBUG ?=
 DOCKERPREFIX ?=
 BUILD_TAGS ?=
 LDFLAGS ?=
-BUILDFLAGS ?= -gcflags '$(GCFLAGS)' -ldflags '$(LDFLAGS) -X github.com/pingcap/tiproxy/pkg/util/versioninfo.TiProxyVersion=$(VERSION) -X github.com/pingcap/TiProxy/pkg/util/versioninfo.TiProxyGitHash=$(COMMIT)' -tags '$(BUILD_TAGS)'
+LDFLAGS += -X "github.com/pingcap/tiproxy/pkg/util/versioninfo.TiProxyVersion=$(VERSION)"
+LDFLAGS += -X "github.com/pingcap/tiproxy/pkg/util/versioninfo.TiProxyGitBranch=$(BRANCH)"
+LDFLAGS += -X "github.com/pingcap/tiproxy/pkg/util/versioninfo.TiProxyGitHash=$(COMMIT)"
+LDFLAGS += -X "github.com/pingcap/tiproxy/pkg/util/versioninfo.TiProxyBuildTS=$(shell date -u '+%Y-%m-%d %H:%M:%S')"
+
+BUILDFLAGS ?= -gcflags '$(GCFLAGS)' -ldflags '$(LDFLAGS)' -tags '$(BUILD_TAGS)'
 ifneq ("$(DEBUG)", "")
 	BUILDFLAGS += -race
 endif

pkg/server/server.go

@@ -6,6 +6,7 @@ package server
 import (
 	"context"
 	"net/http"
+	"runtime"
 
 	"github.com/pingcap/tiproxy/lib/config"
 	"github.com/pingcap/tiproxy/lib/util/errors"
@@ -20,6 +21,7 @@ import (
 	"github.com/pingcap/tiproxy/pkg/proxy/backend"
 	"github.com/pingcap/tiproxy/pkg/sctx"
 	"github.com/pingcap/tiproxy/pkg/server/api"
+	"github.com/pingcap/tiproxy/pkg/util/versioninfo"
 	"go.uber.org/atomic"
 	"go.uber.org/zap"
 )
@@ -59,6 +61,7 @@ func NewServer(ctx context.Context, sctx *sctx.Context) (srv *Server, err error)
 		return
 	}
 	srv.LoggerManager.Init(srv.ConfigManager.WatchConfig())
+	printInfo(lg)
 
 	// setup config manager
 	if err = srv.ConfigManager.Init(ctx, lg.Named("config"), sctx.ConfigFile, &sctx.Overlay); err != nil {
@@ -149,6 +152,19 @@ func NewServer(ctx context.Context, sctx *sctx.Context) (srv *Server, err error)
 	return
 }
 
+func printInfo(lg *zap.Logger) {
+	fields := []zap.Field{
+		zap.String("Release Version", versioninfo.TiProxyVersion),
+		zap.String("Git Commit Hash", versioninfo.TiProxyGitHash),
+		zap.String("Git Branch", versioninfo.TiProxyGitBranch),
+		zap.String("UTC Build Time", versioninfo.TiProxyBuildTS),
+		zap.String("GoVersion", runtime.Version()),
+		zap.String("OS", runtime.GOOS),
+		zap.String("Arch", runtime.GOARCH),
+	}
+	lg.Info("Welcome to TiProxy.", fields...)
+}
+
 func (s *Server) Close() error {
 	metrics.ServerEventCounter.WithLabelValues(metrics.EventClose).Inc()
 

pkg/util/versioninfo/versioninfo.go

@@ -5,6 +5,8 @@ package versioninfo
 
 // These variables will be overwritten by Makefile.
 var (
-	TiProxyGitHash = "None"
-	TiProxyVersion = "None"
+	TiProxyVersion   = "None"
+	TiProxyGitBranch = "None"
+	TiProxyGitHash   = "None"
+	TiProxyBuildTS   = "None"
 )