feat!: rename WithDBStatement to EnableDBQueryText (#42)

Author: wzy9607

Diff for: config.go

@@ -20,7 +20,7 @@ type config struct {
 	tp     trace.TracerProvider
 	tracer trace.Tracer
 
-	dbStmtEnabled bool
+	dbQueryTextEnabled bool
 
 	// Metrics options.
 
@@ -50,7 +50,7 @@ func newConfig(opts ...Option) *config {
 		tp:     otel.GetTracerProvider(),
 		tracer: nil,
 
-		dbStmtEnabled: false,
+		dbQueryTextEnabled: false,
 
 		metricsEnabled: true,
 
@@ -106,10 +106,10 @@ func WithTracerProvider(provider trace.TracerProvider) Option {
 	})
 }
 
-// WithDBStatement tells the tracing hook not to log raw redis commands.
-func WithDBStatement(on bool) Option {
+// EnableDBQueryText tells the tracing hook to log raw redis commands.
+func EnableDBQueryText() Option {
 	return option(func(conf *config) {
-		conf.dbStmtEnabled = on
+		conf.dbQueryTextEnabled = true
 	})
 }
 

Diff for: hook.go

@@ -161,7 +161,7 @@ func (ch *clientHook) ProcessHook(hook redis.ProcessHook) redis.ProcessHook {
 			semconv.DBOperationName(oprName),
 		)
 
-		if ch.conf.dbStmtEnabled {
+		if ch.conf.dbQueryTextEnabled {
 			cmdString := rediscmd.CmdString(cmd)
 			attrs = append(attrs, semconv.DBQueryText(cmdString))
 		}
@@ -204,7 +204,7 @@ func (ch *clientHook) ProcessPipelineHook(hook redis.ProcessPipelineHook) redis.
 			semconv.DBOperationBatchSize(len(cmds)),
 		)
 
-		if ch.conf.dbStmtEnabled {
+		if ch.conf.dbQueryTextEnabled {
 			attrs = append(attrs, semconv.DBQueryText(cmdsString))
 		}
 

Diff for: hook_test.go

@@ -399,10 +399,10 @@ func Test_clientHook_ProcessHook(t *testing.T) { //nolint:maintidx //table drive
 				})
 			},
 		}, {
-			name: "enable WithDBStatement option",
+			name: "enable DBQueryText option",
 			fields: fields{
 				rdsOpt: &redis.Options{Addr: "10.1.1.1:6379", DB: 3},
-				opts:   []Option{WithDBStatement(true)},
+				opts:   []Option{EnableDBQueryText()},
 			},
 			args: args{
 				hook: func(ctx context.Context, cmd redis.Cmder) error { return nil },
@@ -537,6 +537,61 @@ func Test_clientHook_ProcessPipelineHook(t *testing.T) {
 					semconv.ServerPort(6379),
 				})
 
+				assertUseTime(t, sm.Metrics[1], []attribute.KeyValue{
+					semconv.DBSystemNameRedis,
+					semconv.DBClientConnectionPoolName("10.1.1.1:6379/3"),
+					attribute.String("status", "ok"),
+				})
+			},
+		}, {
+			name: "enable DBQueryText option",
+			fields: fields{
+				rdsOpt: &redis.Options{Addr: "10.1.1.1:6379", DB: 3},
+				opts:   []Option{EnableDBQueryText()},
+			},
+			args: args{
+				hook: func(ctx context.Context, cmds []redis.Cmder) error { return nil },
+				cmds: []redis.Cmder{
+					redis.NewCmd(context.Background(), "set", "key", "value"),
+					redis.NewCmd(context.Background(), "get", "key1"),
+					redis.NewCmd(context.Background(), "get", "key2"),
+				},
+			},
+			checkSpan: func(t *testing.T, span sdktrace.ReadOnlySpan) {
+				t.Helper()
+				assert.Equal(t, "pipeline set get", span.Name())
+				assert.Equal(t, sdktrace.Status{Code: codes.Unset}, span.Status())
+				t.Logf("attrs: %v", span.Attributes())
+
+				wantAttrs := []attribute.KeyValue{
+					semconv.DBSystemNameRedis,
+					semconv.DBNamespace("3"),
+					semconv.DBOperationName("pipeline set get"),
+					semconv.ServerAddress("10.1.1.1"),
+					semconv.ServerPort(6379),
+					semconv.DBQueryText("set key value\nget key1\nget key2"),
+				}
+				assert.Subset(t, span.Attributes(), wantAttrs)
+
+				wantNotExistAttrs := []attribute.Key{semconv.DBResponseStatusCodeKey}
+				attrs := attrMap(span.Attributes())
+				for _, key := range wantNotExistAttrs {
+					assert.NotContains(t, attrs, key)
+				}
+			},
+			checkMetrics: func(t *testing.T, sm metricdata.ScopeMetrics) {
+				t.Helper()
+				require.Len(t, sm.Metrics, 2)
+
+				assertOprDuration(t, sm.Metrics[0], []attribute.KeyValue{
+					semconv.DBSystemNameRedis,
+					semconv.DBNamespace("3"),
+					semconv.DBOperationName("pipeline set get"),
+					semconv.DBOperationBatchSize(3),
+					semconv.ServerAddress("10.1.1.1"),
+					semconv.ServerPort(6379),
+				})
+
 				assertUseTime(t, sm.Metrics[1], []attribute.KeyValue{
 					semconv.DBSystemNameRedis,
 					semconv.DBClientConnectionPoolName("10.1.1.1:6379/3"),