Merge pull request #195 from ydb-platform/version

Add version to all warn and error calls

Author: asmyasnikov

CHANGELOG.md

@@ -1,3 +1,5 @@
+* Added version into all error and warm log messages
+
 ## v3.18.5
 * Fixed duplicating `WithPanicCallback` proxying to table config options
 * Fixed comments for `xerrros.Is` and `xerrros.As` 

NEXT_MAJOR_RELEASE.md

@@ -1,2 +1,2 @@
 # Breaking changes for the next major release
-- [ ] Switch driver traces to middleware concept
+- [ ] Added required param DSN to ydb.New call (instead optional params ydb.WithConnectionString, ydb.WithEndpoint, ydb.WithDatabase, ydb.WithInsecure)

internal/meta/meta.go

@@ -99,7 +99,7 @@ func (m *meta) meta(ctx context.Context) (_ metadata.MD, err error) {
 	}
 
 	if len(md.Get(HeaderVersion)) == 0 {
-		md.Set(HeaderVersion, "ydb-go-sdk/"+VersionMajor+"."+VersionMinor+"."+VersionPatch)
+		md.Set(HeaderVersion, "ydb-go-sdk/"+Version)
 	}
 
 	if m.requestsType != "" {

internal/meta/version.go

@@ -5,3 +5,5 @@ const (
 	VersionMinor = "18"
 	VersionPatch = "5"
 )
+
+const Version = VersionMajor + "." + VersionMinor + "." + VersionPatch

internal/xerrors/ydb.go

@@ -1,6 +1,8 @@
 package xerrors
 
-import "errors"
+import (
+	"errors"
+)
 
 type isYdbError interface {
 	isYdbError()

log/coordination.go

@@ -4,10 +4,11 @@ import (
 	"github.com/ydb-platform/ydb-go-sdk/v3/trace"
 )
 
+// Coordination makes trace.Coordination with logging events from details
 func Coordination(l Logger, details trace.Details) (t trace.Coordination) {
-	if details&trace.CoordinationEvents != 0 {
-		// nolint:staticcheck
-		l = l.WithName(`coordination`)
+	if details&trace.CoordinationEvents == 0 {
+		return
 	}
+	_ = l.WithName(`coordination`)
 	return t
 }

log/discovery.go

@@ -3,52 +3,57 @@ package log
 import (
 	"time"
 
+	"github.com/ydb-platform/ydb-go-sdk/v3/internal/meta"
 	"github.com/ydb-platform/ydb-go-sdk/v3/trace"
 )
 
-func Discovery(log Logger, details trace.Details) (t trace.Discovery) {
-	if details&trace.DiscoveryEvents != 0 {
-		log = log.WithName(`discovery`)
-		t.OnDiscover = func(info trace.DiscoveryDiscoverStartInfo) func(trace.DiscoveryDiscoverDoneInfo) {
-			log.Infof(`discover start {address:"%s",database:"%s"}`,
-				info.Address,
-				info.Database,
-			)
-			start := time.Now()
-			return func(info trace.DiscoveryDiscoverDoneInfo) {
-				if info.Error == nil {
-					endpoints := make([]string, 0, len(info.Endpoints))
-					for _, e := range info.Endpoints {
-						endpoints = append(endpoints, e.String())
-					}
-					log.Debugf(`discover done {latency:"%v",endpoints:%v}`,
-						time.Since(start),
-						endpoints,
-					)
-				} else {
-					log.Errorf(`discover failed {latency:"%v",error:"%s"}`,
-						time.Since(start),
-						info.Error,
-					)
+// Discovery makes trace.Discovery with logging events from details
+func Discovery(l Logger, details trace.Details) (t trace.Discovery) {
+	if details&trace.DiscoveryEvents == 0 {
+		return
+	}
+	l = l.WithName(`discovery`)
+	t.OnDiscover = func(info trace.DiscoveryDiscoverStartInfo) func(trace.DiscoveryDiscoverDoneInfo) {
+		l.Infof(`discover start {address:"%s",database:"%s"}`,
+			info.Address,
+			info.Database,
+		)
+		start := time.Now()
+		return func(info trace.DiscoveryDiscoverDoneInfo) {
+			if info.Error == nil {
+				endpoints := make([]string, 0, len(info.Endpoints))
+				for _, e := range info.Endpoints {
+					endpoints = append(endpoints, e.String())
 				}
+				l.Debugf(`discover done {latency:"%v",endpoints:%v}`,
+					time.Since(start),
+					endpoints,
+				)
+			} else {
+				l.Errorf(`discover failed {latency:"%v",error:"%s",version:"%s"}`,
+					time.Since(start),
+					info.Error,
+					meta.Version,
+				)
 			}
 		}
-		t.OnWhoAmI = func(info trace.DiscoveryWhoAmIStartInfo) func(doneInfo trace.DiscoveryWhoAmIDoneInfo) {
-			log.Debugf(`whoAmI start`)
-			start := time.Now()
-			return func(info trace.DiscoveryWhoAmIDoneInfo) {
-				if info.Error == nil {
-					log.Debugf(`whoAmI done {latency:"%v",user:%v,groups:%v}`,
-						time.Since(start),
-						info.User,
-						info.Groups,
-					)
-				} else {
-					log.Errorf(`whoAmI failed {latency:"%v",error:"%s"}`,
-						time.Since(start),
-						info.Error,
-					)
-				}
+	}
+	t.OnWhoAmI = func(info trace.DiscoveryWhoAmIStartInfo) func(doneInfo trace.DiscoveryWhoAmIDoneInfo) {
+		l.Debugf(`whoAmI start`)
+		start := time.Now()
+		return func(info trace.DiscoveryWhoAmIDoneInfo) {
+			if info.Error == nil {
+				l.Debugf(`whoAmI done {latency:"%v",user:%v,groups:%v}`,
+					time.Since(start),
+					info.User,
+					info.Groups,
+				)
+			} else {
+				l.Errorf(`whoAmI failed {latency:"%v",error:"%s",version:"%s"}`,
+					time.Since(start),
+					info.Error,
+					meta.Version,
+				)
 			}
 		}
 	}