contrib/go-redis/redis.v8: add Option to Exclude Raw Command

contrib/go-redis/redis.v8/option.go

@@ -12,8 +12,9 @@ import (
 )
 
 type clientConfig struct {
-	serviceName   string
-	analyticsRate float64
+	serviceName       string
+	analyticsRate     float64
+	excludeRawCommand bool
 }
 
 // ClientOption represents an option that can be used to create or wrap a client.
@@ -58,3 +59,11 @@ func WithAnalyticsRate(rate float64) ClientOption {
 		}
 	}
 }
+
+// WithExcludeRawCommand sets the option to exclude the raw command
+// for when the command/cache might contain sensitive data
+func WithExcludeRawCommand(exclude bool) ClientOption {
+	return func(cfg *clientConfig) {
+		cfg.excludeRawCommand = exclude
+	}
+}

contrib/go-redis/redis.v8/redis.go

@@ -102,14 +102,18 @@ func (ddh *datadogHook) BeforeProcess(ctx context.Context, cmd redis.Cmder) (con
 	raw := cmd.String()
 	length := strings.Count(raw, " ")
 	p := ddh.params
-	opts := make([]ddtrace.StartSpanOption, 0, 5+len(ddh.additionalTags)+1) // 5 options below + for additionalTags + for analyticsRate
+	var opts []ddtrace.StartSpanOption
 	opts = append(opts,
 		tracer.SpanType(ext.SpanTypeRedis),
 		tracer.ServiceName(p.config.serviceName),
 		tracer.ResourceName(raw[:strings.IndexByte(raw, ' ')]),
-		tracer.Tag("redis.raw_command", raw),
 		tracer.Tag("redis.args_length", strconv.Itoa(length)),
 	)
+
+	if !p.config.excludeRawCommand {
+		opts = append(opts, tracer.Tag("redis.raw_command", raw))
+	}
+
 	opts = append(opts, ddh.additionalTags...)
 	if !math.IsNaN(p.config.analyticsRate) {
 		opts = append(opts, tracer.Tag(ext.EventSampleRate, p.config.analyticsRate))
@@ -134,16 +138,21 @@ func (ddh *datadogHook) BeforeProcessPipeline(ctx context.Context, cmds []redis.
 	raw := commandsToString(cmds)
 	length := strings.Count(raw, " ")
 	p := ddh.params
-	opts := make([]ddtrace.StartSpanOption, 0, 7+len(ddh.additionalTags)+1) // 7 options below + for additionalTags + for analyticsRate
+	var opts []ddtrace.StartSpanOption
 	opts = append(opts,
 		tracer.SpanType(ext.SpanTypeRedis),
 		tracer.ServiceName(p.config.serviceName),
 		tracer.ResourceName(raw[:strings.IndexByte(raw, ' ')]),
-		tracer.Tag("redis.raw_command", raw),
 		tracer.Tag("redis.args_length", strconv.Itoa(length)),
-		tracer.Tag(ext.ResourceName, raw),
 		tracer.Tag("redis.pipeline_length", strconv.Itoa(len(cmds))),
 	)
+
+	if !p.config.excludeRawCommand {
+		opts = append(opts,
+			tracer.Tag("redis.raw_command", raw),
+			tracer.Tag(ext.ResourceName, raw))
+	}
+
 	opts = append(opts, ddh.additionalTags...)
 	if !math.IsNaN(p.config.analyticsRate) {
 		opts = append(opts, tracer.Tag(ext.EventSampleRate, p.config.analyticsRate))

contrib/go-redis/redis.v8/redis_test.go

@@ -464,3 +464,53 @@ func TestWithContext(t *testing.T) {
 	assert.Equal(span1.SpanID(), setSpan.ParentID())
 	assert.Equal(span2.SpanID(), getSpan.ParentID())
 }
+
+func TestWithExcludeRawCommand(t *testing.T) {
+	execCommand := func(t *testing.T, mt mocktracer.Tracer, opts ...ClientOption) {
+		ctx := context.Background()
+		client := NewClient(&redis.Options{Addr: "127.0.0.1:6379"}, opts...)
+		client.Set(ctx, "test_key", "test_value", 0)
+		pipeline := client.Pipeline()
+		pipeline.Expire(ctx, "pipeline_counter", time.Hour)
+		pipeline.Exec(ctx)
+	}
+
+	t.Run("defaults", func(t *testing.T) {
+		mt := mocktracer.Start()
+		defer mt.Stop()
+
+		execCommand(t, mt)
+
+		spans := mt.FinishedSpans()
+		assert.Len(t, spans, 2)
+		for _, s := range spans {
+			assert.Equal(t, "SET test_key test_value", s.Tag("redis.raw_command"))
+		}
+	})
+
+	t.Run("with exclude true", func(t *testing.T) {
+		mt := mocktracer.Start()
+		defer mt.Stop()
+
+		execCommand(t, mt, WithExcludeRawCommand(true))
+
+		spans := mt.FinishedSpans()
+		assert.Len(t, spans, 2)
+		for _, s := range spans {
+			assert.Equal(t, nil, s.Tag("redis.raw_command"))
+		}
+	})
+
+	t.Run("with exclude false", func(t *testing.T) {
+		mt := mocktracer.Start()
+		defer mt.Stop()
+
+		execCommand(t, mt, WithExcludeRawCommand(false))
+
+		spans := mt.FinishedSpans()
+		assert.Len(t, spans, 2)
+		for _, s := range spans {
+			assert.Equal(t, "SET test_key test_value", s.Tag("redis.raw_command"))
+		}
+	})
+}