* Added trace.Driver.OnRouter{Init,Close,SelectCandidate,Discovery} events

* Marked cluster events as deprecated

Author: asmyasnikov

CHANGELOG.md

@@ -1,5 +1,6 @@
 * Implemented detection of local data-center with measuring tcp dial RTT
-* Added `trace.Driver.OnRouterDiscovery` event
+* Added `trace.Driver.OnBalancer{Init,Close,ChooseEndpoint,Update}` events
+* Marked the driver cluster events as deprecated  
 * Simplified the balancing logic
 
 ## v3.25.3

connection.go

@@ -390,6 +390,17 @@ func open(ctx context.Context, opts ...Option) (_ Connection, err error) {
 		return nil, xerrors.WithStackTrace(errors.New("configuration: empty database"))
 	}
 
+	onDone := trace.DriverOnInit(
+		c.config.Trace(),
+		&ctx,
+		c.config.Endpoint(),
+		c.config.Database(),
+		c.config.Secure(),
+	)
+	defer func() {
+		onDone(err)
+	}()
+
 	if c.pool == nil {
 		c.pool = conn.NewPool(
 			ctx,

internal/router/router.go

@@ -35,7 +35,7 @@ type router struct {
 
 func (r *router) clusterDiscovery(ctx context.Context) (err error) {
 	var (
-		onDone = trace.DriverOnRouterDiscovery(
+		onDone = trace.DriverOnBalancerUpdate(
 			r.driverConfig.Trace(),
 			&ctx,
 			r.routerConfig.DetectlocalDC,
@@ -93,6 +93,14 @@ func (r *router) Discovery() discovery.Client {
 }
 
 func (r *router) Close(ctx context.Context) (err error) {
+	onDone := trace.DriverOnBalancerClose(
+		r.driverConfig.Trace(),
+		&ctx,
+	)
+	defer func() {
+		onDone(err)
+	}()
+
 	issues := make([]error, 0, 2)
 
 	if r.discoveryRepeater != nil {
@@ -116,12 +124,9 @@ func New(
 	pool *conn.Pool,
 	opts ...discoveryConfig.Option,
 ) (_ Connection, err error) {
-	onDone := trace.DriverOnInit(
+	onDone := trace.DriverOnBalancerInit(
 		c.Trace(),
 		&ctx,
-		c.Endpoint(),
-		c.Database(),
-		c.Secure(),
 	)
 	defer func() {
 		onDone(err)
@@ -258,13 +263,31 @@ func (r *router) connections() *connectionsState {
 	return r.connectionsState
 }
 
-func (r *router) getConn(ctx context.Context) (conn.Conn, error) {
-	state := r.connections()
-	c, failedCount := state.GetConnection(ctx)
-	if failedCount*2 > state.PreferredCount() {
-		r.discoveryRepeater.Force()
-	}
+func (r *router) getConn(ctx context.Context) (c conn.Conn, err error) {
+	onDone := trace.DriverOnBalancerChooseEndpoint(
+		r.driverConfig.Trace(),
+		&ctx,
+	)
+	defer func() {
+		if err == nil {
+			onDone(c.Endpoint(), nil)
+		} else {
+			onDone(nil, err)
+		}
+	}()
+
+	var (
+		state       = r.connections()
+		failedCount int
+	)
+
+	defer func() {
+		if failedCount*2 > state.PreferredCount() {
+			r.discoveryRepeater.Force()
+		}
+	}()
 
+	c, failedCount = state.GetConnection(ctx)
 	if c == nil {
 		return nil, xerrors.WithStackTrace(ErrClusterEmpty)
 	}

log/driver.go

@@ -418,47 +418,24 @@ func Driver(l Logger, details trace.Details) (t trace.Driver) {
 				}
 			}
 		}
-
-		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,
-					)
-				}
-			}
-		}
 	}
-	if details&trace.DriverClusterEvents != 0 {
+	// nolint:nestif
+	if details&trace.DriverBalancerEvents != 0 {
 		// nolint:govet
 		l := l.WithName(`cluster`)
-		t.OnClusterInit = func(info trace.DriverClusterInitStartInfo) func(trace.DriverClusterInitDoneInfo) {
+		t.OnBalancerInit = func(info trace.DriverBalancerInitStartInfo) func(trace.DriverBalancerInitDoneInfo) {
 			l.Tracef(`init start`)
 			start := time.Now()
-			return func(info trace.DriverClusterInitDoneInfo) {
+			return func(info trace.DriverBalancerInitDoneInfo) {
 				l.Debugf(`init done {latency:"%v"}`,
 					time.Since(start),
 				)
 			}
 		}
-		t.OnClusterClose = func(info trace.DriverClusterCloseStartInfo) func(trace.DriverClusterCloseDoneInfo) {
+		t.OnBalancerClose = func(info trace.DriverBalancerCloseStartInfo) func(trace.DriverBalancerCloseDoneInfo) {
 			l.Tracef(`close start`)
 			start := time.Now()
-			return func(info trace.DriverClusterCloseDoneInfo) {
+			return func(info trace.DriverBalancerCloseDoneInfo) {
 				if info.Error == nil {
 					l.Tracef(`close done {latency:"%v"}`,
 						time.Since(start),
@@ -472,24 +449,55 @@ func Driver(l Logger, details trace.Details) (t trace.Driver) {
 				}
 			}
 		}
-		t.OnClusterGet = func(info trace.DriverClusterGetStartInfo) func(trace.DriverClusterGetDoneInfo) {
-			l.Tracef(`get start`)
+		t.OnBalancerChooseEndpoint = func(
+			info trace.DriverBalancerChooseEndpointStartInfo,
+		) func(
+			trace.DriverBalancerChooseEndpointDoneInfo,
+		) {
+			l.Tracef(`select endpoint start`)
 			start := time.Now()
-			return func(info trace.DriverClusterGetDoneInfo) {
+			return func(info trace.DriverBalancerChooseEndpointDoneInfo) {
 				if info.Error == nil {
-					l.Tracef(`get done {latency:"%v",endpoint:%v}`,
+					l.Tracef(`select endpoint done {latency:"%v",endpoint:%v}`,
 						time.Since(start),
 						info.Endpoint.String(),
 					)
 				} else {
-					l.Warnf(`get failed {latency:"%v",error:"%s",version:"%s"}`,
+					l.Warnf(`select endpoint failed {latency:"%v",error:"%s",version:"%s"}`,
 						time.Since(start),
 						info.Error,
 						meta.Version,
 					)
 				}
 			}
 		}
+		t.OnBalancerUpdate = func(
+			info trace.DriverBalancerUpdateStartInfo,
+		) func(
+			trace.DriverBalancerUpdateDoneInfo,
+		) {
+			l.Tracef(
+				`router discovery start {needLocalDC: "%v"}`,
+				info.NeedLocalDC,
+			)
+			start := time.Now()
+			return func(info trace.DriverBalancerUpdateDoneInfo) {
+				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,
+					)
+				}
+			}
+		}
 	}
 	if details&trace.DriverCredentialsEvents != 0 {
 		// nolint:govet

trace/details.go

@@ -9,7 +9,7 @@ type Details uint64
 const (
 	DriverNetEvents         Details = 1 << iota // 1
 	DriverConnEvents                            // 2
-	DriverClusterEvents                         // 4
+	DriverBalancerEvents                        // 4
 	DriverResolverEvents                        // 8
 	DriverRepeaterEvents                        // 16
 	DriverCredentialsEvents                     // 32
@@ -34,9 +34,12 @@ const (
 
 	CoordinationEvents // 262144
 
+	// Deprecated: has no effect now
+	DriverClusterEvents
+
 	DriverEvents = DriverNetEvents |
 		DriverConnEvents |
-		DriverClusterEvents |
+		DriverBalancerEvents |
 		DriverResolverEvents |
 		DriverRepeaterEvents |
 		DriverCredentialsEvents // 63
@@ -65,9 +68,9 @@ const (
 var (
 	details = map[Details]string{
 		DriverEvents:            "ydb.driver",
-		DriverClusterEvents:     "ydb.driver.cluster",
-		DriverNetEvents:         "ydb.driver.xnet",
-		DriverResolverEvents:    "ydb.driver.xresolver",
+		DriverBalancerEvents:    "ydb.driver.balancer",
+		DriverNetEvents:         "ydb.driver.net",
+		DriverResolverEvents:    "ydb.driver.resolver",
 		DriverRepeaterEvents:    "ydb.driver.repeater",
 		DriverConnEvents:        "ydb.driver.conn",
 		DriverCredentialsEvents: "ydb.driver.credentials",

trace/details_test.go

@@ -18,15 +18,15 @@ func TestDetailsMatch(t *testing.T) {
 			details: DriverEvents,
 		},
 		{
-			pattern: `^ydb\.driver\.xresolver$`,
+			pattern: `^ydb\.driver\.resolver$`,
 			details: DriverResolverEvents,
 		},
 		{
-			pattern: `^ydb\.driver\.(xresolver|xnet)$`,
+			pattern: `^ydb\.driver\.(resolver|net)$`,
 			details: DriverResolverEvents | DriverNetEvents,
 		},
 		{
-			pattern: `^ydb\.driver\.(conn|credentials|xresolver|xnet)$`,
+			pattern: `^ydb\.driver\.(conn|credentials|resolver|net)$`,
 			details: DriverConnEvents | DriverCredentialsEvents | DriverResolverEvents | DriverNetEvents,
 		},
 		{