refactor metrics/driver and upload with off gocognit linter

Author: grishagavrin

CHANGELOG.md

@@ -1,3 +1,4 @@
+* Refactored `metrics/driver.go` and extract funcs
 * Refactored `metrics/sql.go` and extract funcs
 * Refactored `internal/table/retry_test.go` and extract func `retry_test.checkResultsRetryWithCustomErrors`
 * Refactored `internal/table/client.go` and extract func `client.onCloseSession`

metrics/driver.go

@@ -8,6 +8,12 @@ import (
 	"github.com/ydb-platform/ydb-go-sdk/v3/trace"
 )
 
+// endpointKey represents a key for mapping endpoints to their properties.
+type endpointKey struct {
+	localDC bool   // a boolean indicating if the endpoint is in the local data center
+	az      string // a string representing the availability zone of the endpoint
+}
+
 // driver makes driver with New publishing
 func driver(config Config) (t trace.Driver) {
 	config = config.WithSystem("driver")
@@ -19,21 +25,37 @@ func driver(config Config) (t trace.Driver) {
 	requests := config.WithSystem("conn").CounterVec("requests", "status", "method", "endpoint", "node_id")
 	tli := config.CounterVec("transaction_locks_invalidated")
 
-	type endpointKey struct {
-		localDC bool
-		az      string
-	}
 	knownEndpoints := make(map[endpointKey]struct{})
+	driverConnEvents := config.Details() & trace.DriverConnEvents
+	driverBalancerEvents := config.Details() & trace.DriverBalancerEvents
 
-	t.OnConnInvoke = func(info trace.DriverConnInvokeStartInfo) func(trace.DriverConnInvokeDoneInfo) {
+	t.OnConnInvoke = connInvoke(driverConnEvents, requests, tli)
+	t.OnConnNewStream = connNewStream(driverConnEvents, requests)
+	t.OnConnBan = connBan(driverConnEvents, banned)
+	t.OnBalancerClusterDiscoveryAttempt = balancerClusterDiscoveryAttempt(balancersDiscoveries)
+	t.OnBalancerUpdate = balancerUpdate(driverBalancerEvents, balancerUpdates, knownEndpoints, endpoints)
+	t.OnConnDial = connDial(driverConnEvents, conns)
+	t.OnConnClose = connClose(driverConnEvents, conns)
+
+	return t
+}
+
+// connInvoke is a function that returns a callback function to be called
+// when a driver connection invoke starts and when it is done.
+func connInvoke(
+	driverConnEvents trace.Details,
+	requests CounterVec,
+	tli CounterVec,
+) func(info trace.DriverConnInvokeStartInfo) func(trace.DriverConnInvokeDoneInfo) {
+	return func(info trace.DriverConnInvokeStartInfo) func(trace.DriverConnInvokeDoneInfo) {
 		var (
 			method   = info.Method
 			endpoint = info.Endpoint.Address()
 			nodeID   = info.Endpoint.NodeID()
 		)
 
 		return func(info trace.DriverConnInvokeDoneInfo) {
-			if config.Details()&trace.DriverConnEvents != 0 {
+			if driverConnEvents != 0 {
 				requests.With(map[string]string{
 					"status":   errorBrief(info.Error),
 					"method":   string(method),
@@ -46,7 +68,16 @@ func driver(config Config) (t trace.Driver) {
 			}
 		}
 	}
-	t.OnConnNewStream = func(info trace.DriverConnNewStreamStartInfo) func(
+}
+
+// connNewStream receives the `driverConnEvents` and `requests` parameters and returns a closure function.
+func connNewStream(
+	driverConnEvents trace.Details,
+	requests CounterVec,
+) func(
+	info trace.DriverConnNewStreamStartInfo,
+) func(trace.DriverConnNewStreamRecvInfo) func(trace.DriverConnNewStreamDoneInfo) {
+	return func(info trace.DriverConnNewStreamStartInfo) func(
 		trace.DriverConnNewStreamRecvInfo,
 	) func(
 		trace.DriverConnNewStreamDoneInfo,
@@ -59,7 +90,7 @@ func driver(config Config) (t trace.Driver) {
 
 		return func(info trace.DriverConnNewStreamRecvInfo) func(trace.DriverConnNewStreamDoneInfo) {
 			return func(info trace.DriverConnNewStreamDoneInfo) {
-				if config.Details()&trace.DriverConnEvents != 0 {
+				if driverConnEvents != 0 {
 					requests.With(map[string]string{
 						"status":   errorBrief(info.Error),
 						"method":   string(method),
@@ -70,8 +101,15 @@ func driver(config Config) (t trace.Driver) {
 			}
 		}
 	}
-	t.OnConnBan = func(info trace.DriverConnBanStartInfo) func(trace.DriverConnBanDoneInfo) {
-		if config.Details()&trace.DriverConnEvents != 0 {
+}
+
+// connBan is a function that returns a closure wrapping the logic for tracing a connection ban event.
+func connBan(
+	driverConnEvents trace.Details,
+	banned GaugeVec,
+) func(info trace.DriverConnBanStartInfo) func(trace.DriverConnBanDoneInfo) {
+	return func(info trace.DriverConnBanStartInfo) func(trace.DriverConnBanDoneInfo) {
+		if driverConnEvents != 0 {
 			banned.With(map[string]string{
 				"endpoint": info.Endpoint.Address(),
 				"node_id":  idToString(info.Endpoint.NodeID()),
@@ -81,7 +119,15 @@ func driver(config Config) (t trace.Driver) {
 
 		return nil
 	}
-	t.OnBalancerClusterDiscoveryAttempt = func(info trace.DriverBalancerClusterDiscoveryAttemptStartInfo) func(
+}
+
+// balancerClusterDiscoveryAttempt performs balancer cluster discovery attempt.
+func balancerClusterDiscoveryAttempt(
+	balancersDiscoveries CounterVec,
+) func(
+	info trace.DriverBalancerClusterDiscoveryAttemptStartInfo,
+) func(trace.DriverBalancerClusterDiscoveryAttemptDoneInfo) {
+	return func(info trace.DriverBalancerClusterDiscoveryAttemptStartInfo) func(
 		trace.DriverBalancerClusterDiscoveryAttemptDoneInfo,
 	) {
 		eventType := repeater.EventType(*info.Context)
@@ -93,11 +139,20 @@ func driver(config Config) (t trace.Driver) {
 			}).Inc()
 		}
 	}
-	t.OnBalancerUpdate = func(info trace.DriverBalancerUpdateStartInfo) func(trace.DriverBalancerUpdateDoneInfo) {
+}
+
+// balancerUpdate updates the balancer with new endpoint information.
+func balancerUpdate(
+	driverBalancerEvents trace.Details,
+	balancerUpdates CounterVec,
+	knownEndpoints map[endpointKey]struct{},
+	endpoints GaugeVec,
+) func(info trace.DriverBalancerUpdateStartInfo) func(trace.DriverBalancerUpdateDoneInfo) {
+	return func(info trace.DriverBalancerUpdateStartInfo) func(trace.DriverBalancerUpdateDoneInfo) {
 		eventType := repeater.EventType(*info.Context)
 
 		return func(info trace.DriverBalancerUpdateDoneInfo) {
-			if config.Details()&trace.DriverBalancerEvents != 0 {
+			if driverBalancerEvents != 0 {
 				balancerUpdates.With(map[string]string{
 					"cause": eventType,
 				}).Inc()
@@ -128,12 +183,20 @@ func driver(config Config) (t trace.Driver) {
 			}
 		}
 	}
-	t.OnConnDial = func(info trace.DriverConnDialStartInfo) func(trace.DriverConnDialDoneInfo) {
+}
+
+// connDial is a function that returns a closure function to handle the event when a driver connection dialing starts
+// and completes.
+func connDial(
+	driverConnEvents trace.Details,
+	conns GaugeVec,
+) func(info trace.DriverConnDialStartInfo) func(trace.DriverConnDialDoneInfo) {
+	return func(info trace.DriverConnDialStartInfo) func(trace.DriverConnDialDoneInfo) {
 		endpoint := info.Endpoint.Address()
 		nodeID := info.Endpoint.NodeID()
 
 		return func(info trace.DriverConnDialDoneInfo) {
-			if config.Details()&trace.DriverConnEvents != 0 {
+			if driverConnEvents != 0 {
 				if info.Error == nil {
 					conns.With(map[string]string{
 						"endpoint": endpoint,
@@ -143,8 +206,15 @@ func driver(config Config) (t trace.Driver) {
 			}
 		}
 	}
-	t.OnConnClose = func(info trace.DriverConnCloseStartInfo) func(trace.DriverConnCloseDoneInfo) {
-		if config.Details()&trace.DriverConnEvents != 0 {
+}
+
+// connClose is a function that returns a closure accepting a trace.DriverConnCloseStartInfo parameter
+func connClose(
+	driverConnEvents trace.Details,
+	conns GaugeVec,
+) func(info trace.DriverConnCloseStartInfo) func(trace.DriverConnCloseDoneInfo) {
+	return func(info trace.DriverConnCloseStartInfo) func(trace.DriverConnCloseDoneInfo) {
+		if driverConnEvents != 0 {
 			conns.With(map[string]string{
 				"endpoint": info.Endpoint.Address(),
 				"node_id":  idToString(info.Endpoint.NodeID()),
@@ -153,6 +223,4 @@ func driver(config Config) (t trace.Driver) {
 
 		return nil
 	}
-
-	return t
 }