changed on router discovery trace

Author: asmyasnikov

CHANGELOG.md

@@ -1,4 +1,5 @@
 * Implemented detection of local data-center with measuring tcp dial RTT
+* Added `trace.Driver.OnRouterDiscovery` event
 * Simplified the balancing logic
 
 ## v3.25.3

internal/router/router.go

@@ -4,19 +4,17 @@ import (
 	"context"
 	"fmt"
 	"sync"
-	"time"
 
 	"google.golang.org/grpc"
 
-	routerconfig "github.com/ydb-platform/ydb-go-sdk/v3/internal/router/config"
-
 	"github.com/ydb-platform/ydb-go-sdk/v3/config"
 	"github.com/ydb-platform/ydb-go-sdk/v3/discovery"
 	"github.com/ydb-platform/ydb-go-sdk/v3/internal/conn"
 	discoveryBuilder "github.com/ydb-platform/ydb-go-sdk/v3/internal/discovery"
 	discoveryConfig "github.com/ydb-platform/ydb-go-sdk/v3/internal/discovery/config"
 	"github.com/ydb-platform/ydb-go-sdk/v3/internal/endpoint"
 	"github.com/ydb-platform/ydb-go-sdk/v3/internal/repeater"
+	routerconfig "github.com/ydb-platform/ydb-go-sdk/v3/internal/router/config"
 	"github.com/ydb-platform/ydb-go-sdk/v3/internal/xerrors"
 	"github.com/ydb-platform/ydb-go-sdk/v3/trace"
 )
@@ -36,41 +34,42 @@ type router struct {
 }
 
 func (r *router) clusterDiscovery(ctx context.Context) (err error) {
-	var discoveryTrace trace.DriverRouterDiscoveryInfo
-	start := time.Now()
-	defer func() {
-		discoveryTrace.Error = err
-		discoveryTrace.Latency = time.Since(start)
-
-		trace.DriverOnRouterDiscovery(
+	var (
+		onDone = trace.DriverOnRouterDiscovery(
 			r.driverConfig.Trace(),
-			discoveryTrace.Latency,
-			discoveryTrace.Endpoints,
+			&ctx,
 			r.routerConfig.DetectlocalDC,
-			discoveryTrace.LocalDC,
+		)
+		endpoints []endpoint.Endpoint
+		localDC   string
+	)
+
+	defer func() {
+		nodes := make([]trace.EndpointInfo, 0, len(endpoints))
+		for _, e := range endpoints {
+			nodes = append(nodes, e.Copy())
+		}
+		onDone(
+			nodes,
+			localDC,
 			err,
 		)
 	}()
 
-	endpoints, err := r.discovery.Discover(ctx)
+	endpoints, err = r.discovery.Discover(ctx)
 	if err != nil {
 		return xerrors.WithStackTrace(err)
 	}
-	discoveryTrace.Endpoints = make([]trace.EndpointInfo, 0, len(endpoints))
-	for _, e := range endpoints {
-		discoveryTrace.Endpoints = append(discoveryTrace.Endpoints, e)
-	}
 
-	var localDC string
 	if r.routerConfig.DetectlocalDC {
 		localDC, err = r.localDCDetector(ctx, endpoints)
 		if err != nil {
-			return err
+			return xerrors.WithStackTrace(err)
 		}
-		discoveryTrace.LocalDC = localDC
 	}
 
 	r.applyDiscoveredEndpoints(ctx, endpoints, localDC)
+
 	return nil
 }
 

log/driver.go

@@ -419,24 +419,27 @@ func Driver(l Logger, details trace.Details) (t trace.Driver) {
 			}
 		}
 
-		t.OnRouterDiscovery = func(info trace.DriverRouterDiscoveryInfo) {
-			if info.Error == nil {
-				l.Tracef(
-					`discovery new endpoints done {latency:"%v", endpoints: "%v", needLocalDC: "%v", detectedLocalDC: "%v"}`,
-					info.Latency,
-					info.Endpoints,
-					info.NeedLocalDC,
-					info.LocalDC,
-				)
-			} else {
-				l.Errorf(
-					`discovery new endpoints fail {latency:"%v", endpoints: "%v", needLocalDC: "%v", localDC: "%v", error: "%v"}`,
-					info.Latency,
-					info.Endpoints,
-					info.NeedLocalDC,
-					info.LocalDC,
-					info.Error,
-				)
+		t.OnRouterDiscovery = func(info trace.DriverRouterDiscoveryStartInfo) func(trace.DriverRouterDiscoveryDoneInfo) {
+			l.Tracef(
+				`router discovery start {needLocalDC: "%v"}`,
+				info.NeedLocalDC,
+			)
+			start := time.Now()
+			return func(info trace.DriverRouterDiscoveryDoneInfo) {
+				if info.Error == nil {
+					l.Infof(
+						`router discovery done {latency:"%v", endpoints: "%v", detectedLocalDC: "%v"}`,
+						time.Since(start),
+						info.Endpoints,
+						info.LocalDC,
+					)
+				} else {
+					l.Errorf(
+						`router discovery failed {latency:"%v", error: "%v"}`,
+						time.Since(start),
+						info.Error,
+					)
+				}
 			}
 		}
 	}

trace/driver.go

@@ -71,8 +71,10 @@ type (
 		OnUnpessimizeNode func(DriverUnpessimizeNodeStartInfo) func(DriverUnpessimizeNodeDoneInfo)
 
 		// Repeater events
-		OnRepeaterWakeUp  func(DriverRepeaterWakeUpStartInfo) func(DriverRepeaterWakeUpDoneInfo)
-		OnRouterDiscovery func(DriverRouterDiscoveryInfo)
+		OnRepeaterWakeUp func(DriverRepeaterWakeUpStartInfo) func(DriverRepeaterWakeUpDoneInfo)
+
+		// Router events
+		OnRouterDiscovery func(DriverRouterDiscoveryStartInfo) func(DriverRouterDiscoveryDoneInfo)
 
 		// Credentials events
 		OnGetCredentials func(DriverGetCredentialsStartInfo) func(DriverGetCredentialsDoneInfo)
@@ -171,12 +173,18 @@ type (
 	DriverResolveDoneInfo struct {
 		Error error
 	}
-	DriverRouterDiscoveryInfo struct {
-		Latency     time.Duration
-		Endpoints   []EndpointInfo
+	DriverRouterDiscoveryStartInfo struct {
+		// Context make available context in trace callback function.
+		// Pointer to context provide replacement of context in trace callback function.
+		// Warning: concurrent access to pointer on client side must be excluded.
+		// Safe replacement of context are provided only inside callback function
+		Context     *context.Context
 		NeedLocalDC bool
-		LocalDC     string
-		Error       error
+	}
+	DriverRouterDiscoveryDoneInfo struct {
+		Endpoints []EndpointInfo
+		LocalDC   string
+		Error     error
 	}
 	DriverNetReadStartInfo struct {
 		Address string