mirror of
https://github.com/hanzokv/go.git
synced 2026-09-24 00:31:51 +00:00
zeekay
6994cf05aa
We do not use Redis. The client was a go-redis fork and still said so
everywhere: `package redis`, `redis.NewClient`, `redis://`, `extra/redisotel`.
Consumers wrote `redis.Client` against a Valkey-backed store called KV.
package redis -> package kv (93 decls)
redis.X -> kv.X (2,794 call sites)
"redis: …" errors -> "kv: …" (206)
extra/redis{otel,cmd,prometheus,census} -> extra/kv{otel,cmd,prometheus,census}
redis:// , rediss:// -> kv:// , kvs:// (ParseURL)
Redis*/*Redis* idents -> KV*/*KV*
REDIS_VERSION, REDIS_ENDPOINTS_CONFIG_PATH -> KV_*
I previously argued this rename was unsafe because much of it was "wire
contract". That was wrong, and the categorisation shows why: RESP command names
are GET/SET/HSET — they never contain the word. Of 5,771 occurrences only two
kinds were server-visible at all: the ParseURL scheme (we choose what we pass;
our configs already use kv://) and the CLIENT SETINFO lib-name label, which the
server merely records. Nothing here changes a byte of protocol.
Two things deliberately keep the old spelling:
RediSearch — names a specific external module the FT.* commands map to.
StoreDist — contains the letters by accident (sto-reDis-t), not the word.
Breaking for consumers by design: every import site must move redis.X -> kv.X.
Minor bump, never a major — this module stays v9 forever.
92 lines
2.6 KiB
Go
92 lines
2.6 KiB
Go
// Package logging provides logging level constants and utilities for the go-kv library.
|
|
// This package centralizes logging configuration to ensure consistency across all components.
|
|
package logging
|
|
|
|
import (
|
|
"context"
|
|
"fmt"
|
|
"strings"
|
|
|
|
"github.com/hanzokv/go/v9/internal"
|
|
)
|
|
|
|
type LogLevelT = internal.LogLevelT
|
|
|
|
const (
|
|
LogLevelError = internal.LogLevelError
|
|
LogLevelWarn = internal.LogLevelWarn
|
|
LogLevelInfo = internal.LogLevelInfo
|
|
LogLevelDebug = internal.LogLevelDebug
|
|
)
|
|
|
|
// 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
|
|
}
|
|
|
|
// Disable disables logging by setting the internal logger to a void logger.
|
|
// This can be used to speed up the library if logging is not needed.
|
|
// It will override any custom logger that was set before and set the VoidLogger.
|
|
func Disable() {
|
|
internal.Logger = &VoidLogger{}
|
|
}
|
|
|
|
// Enable enables logging by setting the internal logger to the default logger.
|
|
// This is the default behavior.
|
|
// You can use kv.SetLogger to set a custom logger.
|
|
//
|
|
// NOTE: This function is not thread-safe.
|
|
// It will override any custom logger that was set before and set the DefaultLogger.
|
|
func Enable() {
|
|
internal.Logger = internal.NewDefaultLogger()
|
|
}
|
|
|
|
// SetLogLevel sets the log level for the library.
|
|
func SetLogLevel(logLevel LogLevelT) {
|
|
internal.LogLevel = logLevel
|
|
}
|
|
|
|
// NewBlacklistLogger returns a new logger that filters out messages containing any of the substrings.
|
|
// This can be used to filter out messages containing sensitive information.
|
|
func NewBlacklistLogger(substr []string) internal.Logging {
|
|
l := internal.NewDefaultLogger()
|
|
return &filterLogger{logger: l, substr: substr, blacklist: true}
|
|
}
|
|
|
|
// NewWhitelistLogger returns a new logger that only logs messages containing any of the substrings.
|
|
// This can be used to only log messages related to specific commands or patterns.
|
|
func NewWhitelistLogger(substr []string) internal.Logging {
|
|
l := internal.NewDefaultLogger()
|
|
return &filterLogger{logger: l, substr: substr, blacklist: false}
|
|
}
|
|
|
|
type filterLogger struct {
|
|
logger internal.Logging
|
|
blacklist bool
|
|
substr []string
|
|
}
|
|
|
|
func (l *filterLogger) Printf(ctx context.Context, format string, v ...interface{}) {
|
|
msg := fmt.Sprintf(format, v...)
|
|
found := false
|
|
for _, substr := range l.substr {
|
|
if strings.Contains(msg, substr) {
|
|
found = true
|
|
if l.blacklist {
|
|
return
|
|
}
|
|
}
|
|
}
|
|
// whitelist, only log if one of the substrings is present
|
|
if !l.blacklist && !found {
|
|
return
|
|
}
|
|
if l.logger != nil {
|
|
l.logger.Printf(ctx, format, v...)
|
|
return
|
|
}
|
|
}
|