Merge pull request #743 from ydb-platform/gtrace

Gtrace refactoring

Author: asmyasnikov

.gitignore

@@ -15,3 +15,4 @@
 *.out
 vendor
 changes.txt
+./internal/cmd/gtrace/gtrace

CHANGELOG.md

@@ -1,3 +1,6 @@
+* Refactored `internal/cmd/gtrace` tool (prefer pointers instead trace struct copies) for bust performance
+* Fixed usage of generated traces in code
+
 ## v3.47.1
 * Removed test artifacts from repository
 

config/config.go

@@ -19,7 +19,7 @@ import (
 type Config struct {
 	config.Common
 
-	trace          trace.Driver
+	trace          *trace.Driver
 	dialTimeout    time.Duration
 	connectionTTL  time.Duration
 	balancerConfig *balancerConfig.Config
@@ -93,7 +93,7 @@ func (c Config) Database() string {
 }
 
 // Trace contains driver tracing options.
-func (c Config) Trace() trace.Driver {
+func (c Config) Trace() *trace.Driver {
 	return c.trace
 }
 
@@ -151,7 +151,7 @@ func WithTLSConfig(tlsConfig *tls.Config) Option {
 
 func WithTrace(t trace.Driver, opts ...trace.DriverComposeOption) Option {
 	return func(c *Config) {
-		c.trace = c.trace.Compose(t, opts...)
+		c.trace = c.trace.Compose(&t, opts...)
 	}
 }
 

config/defaults.go

@@ -29,7 +29,7 @@ var (
 	}
 )
 
-func defaultGrpcOptions(t trace.Driver, secure bool, tlsConfig *tls.Config) (opts []grpc.DialOption) {
+func defaultGrpcOptions(t *trace.Driver, secure bool, tlsConfig *tls.Config) (opts []grpc.DialOption) {
 	opts = append(opts,
 		// keep-aliving all connections
 		grpc.WithKeepaliveParams(
@@ -89,5 +89,6 @@ func defaultConfig() (c Config) {
 		balancerConfig: balancers.Default(),
 		tlsConfig:      defaultTLSConfig(),
 		dialTimeout:    DefaultDialTimeout,
+		trace:          &trace.Driver{},
 	}
 }

internal/cmd/gtrace/gtrace

@@ -317,9 +317,10 @@ func (w *Writer) compose(trace *Trace) {
 		w.line(`// Compose returns a new `, trace.Name, ` which has functional fields composed both from `,
 			t, ` and `, x, `.`,
 		)
-		w.code(`func (`, t, ` `, trace.Name, `) Compose(`, x, ` `, trace.Name, `, opts ...`+trace.Name+`ComposeOption) `)
-		w.line(`(`, ret, ` `, trace.Name, `) {`)
+		w.code(`func (`, t, ` *`, trace.Name, `) Compose(`, x, ` *`, trace.Name, `, opts ...`+trace.Name+`ComposeOption) `)
+		w.line(`*`, trace.Name, ` {`)
 		w.block(func() {
+			w.line(`var `, ret, ` `, trace.Name, ``)
 			if len(trace.Hooks) > 0 {
 				w.line(`options := `, unexported(trace.Name), `ComposeOptions{}`)
 				w.line(`for _, opt := range opts {`)
@@ -335,7 +336,7 @@ func (w *Writer) compose(trace *Trace) {
 			for _, hook := range trace.Hooks {
 				w.composeHook(hook, t, x, ret+"."+hook.Name)
 			}
-			w.line(`return `, ret)
+			w.line(`return &`, ret)
 		})
 		w.line(`}`)
 	})
@@ -455,7 +456,7 @@ func (w *Writer) hook(trace *Trace, hook Hook) {
 		t := w.declare("t")
 		fn := w.declare("fn")
 
-		w.code(`func (`, t, ` `, trace.Name, `) `, unexported(hook.Name))
+		w.code(`func (`, t, ` *`, trace.Name, `) `, unexported(hook.Name))
 
 		w.code(`(`)
 		var args []string
@@ -626,7 +627,7 @@ func (w *Writer) hookShortcut(trace *Trace, hook Hook) {
 		w.code(`func `, name)
 		w.code(`(`)
 		var ctx string
-		w.code(t, ` `, trace.Name)
+		w.code(t, ` *`, trace.Name)
 
 		var (
 			params = flattenParams(hook.Func.Params)

internal/cmd/gtrace/writer.go

@@ -10,7 +10,7 @@ import (
 
 type Config interface {
 	DialTimeout() time.Duration
-	Trace() trace.Driver
+	Trace() *trace.Driver
 	ConnectionTTL() time.Duration
 	GrpcDialOptions() []grpc.DialOption
 }

internal/conn/config.go

@@ -11,11 +11,11 @@ import (
 type Config struct {
 	config.Common
 
-	trace trace.Coordination
+	trace *trace.Coordination
 }
 
 // Trace returns trace over coordination client calls
-func (c Config) Trace() trace.Coordination {
+func (c Config) Trace() *trace.Coordination {
 	return c.trace
 }
 
@@ -24,7 +24,7 @@ type Option func(c *Config)
 // WithTrace appends coordination trace to early defined traces
 func WithTrace(trace trace.Coordination, opts ...trace.CoordinationComposeOption) Option {
 	return func(c *Config) {
-		c.trace = c.trace.Compose(trace, opts...)
+		c.trace = c.trace.Compose(&trace, opts...)
 	}
 }
 
@@ -36,7 +36,9 @@ func With(config config.Common) Option {
 }
 
 func New(opts ...Option) Config {
-	c := Config{}
+	c := Config{
+		trace: &trace.Coordination{},
+	}
 	for _, o := range opts {
 		if o != nil {
 			o(&c)

internal/coordination/config/config.go

@@ -21,12 +21,13 @@ type Config struct {
 	meta     meta.Meta
 
 	interval time.Duration
-	trace    trace.Discovery
+	trace    *trace.Discovery
 }
 
 func New(opts ...Option) Config {
 	c := Config{
 		interval: DefaultInterval,
+		trace:    &trace.Discovery{},
 	}
 	for _, o := range opts {
 		if o != nil {
@@ -56,7 +57,7 @@ func (c Config) Secure() bool {
 	return c.secure
 }
 
-func (c Config) Trace() trace.Discovery {
+func (c Config) Trace() *trace.Discovery {
 	return c.trace
 }
 
@@ -102,7 +103,7 @@ func WithMeta(meta meta.Meta) Option {
 // WithTrace configures discovery client calls tracing
 func WithTrace(trace trace.Discovery, opts ...trace.DiscoveryComposeOption) Option {
 	return func(c *Config) {
-		c.trace = c.trace.Compose(trace, opts...)
+		c.trace = c.trace.Compose(&trace, opts...)
 	}
 }
 

internal/discovery/config/config.go

@@ -14,7 +14,7 @@ import (
 func New(
 	database string,
 	credentials credentials.Credentials,
-	trace trace.Driver,
+	trace *trace.Driver,
 	opts ...Option,
 ) Meta {
 	m := Meta{
@@ -64,7 +64,7 @@ func ForbidOption(feature string) Option {
 }
 
 type Meta struct {
-	trace        trace.Driver
+	trace        *trace.Driver
 	credentials  credentials.Credentials
 	database     string
 	requestsType string