chore(log): add note related to logging and simple void logger

Author: ndyakov

internal/log.go

@@ -7,6 +7,9 @@ import (
 	"os"
 )
 
+// TODO (ned): Revisit logging
+// Add more standardized approach with log levels and configurability
+
 type Logging interface {
 	Printf(ctx context.Context, format string, v ...interface{})
 }
@@ -24,3 +27,13 @@ func (l *logger) Printf(ctx context.Context, format string, v ...interface{}) {
 var Logger Logging = &logger{
 	log: log.New(os.Stderr, "redis: ", log.LstdFlags|log.Lshortfile),
 }
+
+// VoidLogger is a logger that does nothing.
+// Used to disable logging and thus speed up the library.
+type VoidLogger struct{}
+
+func (v *VoidLogger) Printf(_ context.Context, _ string, _ ...interface{}) {
+	// do nothing
+}
+
+var _ Logging = (*VoidLogger)(nil)

redis.go

@@ -24,6 +24,7 @@ type Scanner = hscan.Scanner
 const Nil = proto.Nil
 
 // SetLogger set custom log
+// Use with VoidLogger to disable logging.
 func SetLogger(logger internal.Logging) {
 	internal.Logger = logger
 }