logging

package
v9.15.0-beta.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 10, 2025 License: BSD-2-Clause Imports: 4 Imported by: 2

Documentation

Overview

Package logging provides logging level constants and utilities for the go-redis library. This package centralizes logging configuration to ensure consistency across all components.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func Disable

func Disable()

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 Enable

func Enable()

Enable enables logging by setting the internal logger to the default logger. This is the default behavior. You can use redis.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 NewBlacklistLogger

func NewBlacklistLogger(substr []string) internal.Logging

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 NewWhitelistLogger

func NewWhitelistLogger(substr []string) internal.Logging

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.

Types

type LogLevel

type LogLevel int

LogLevel represents the logging level

const (
	LogLevelError LogLevel = iota // 0 - errors only
	LogLevelWarn                  // 1 - warnings and errors
	LogLevelInfo                  // 2 - info, warnings, and errors
	LogLevelDebug                 // 3 - debug, info, warnings, and errors
)

Log level constants for the entire go-redis library

func (LogLevel) DebugOrAbove

func (l LogLevel) DebugOrAbove() bool

func (LogLevel) InfoOrAbove

func (l LogLevel) InfoOrAbove() bool

func (LogLevel) IsValid

func (l LogLevel) IsValid() bool

IsValid returns true if the log level is valid

func (LogLevel) String

func (l LogLevel) String() string

String returns the string representation of the log level

func (LogLevel) WarnOrAbove

func (l LogLevel) WarnOrAbove() bool

type VoidLogger

type VoidLogger struct{}

VoidLogger is a logger that does nothing. Used to disable logging and thus speed up the library.

func (*VoidLogger) Printf

func (v *VoidLogger) Printf(_ context.Context, _ string, _ ...interface{})

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL