Menu Close

Go – SetLogger Function of redis package in Go

In this article, we will explore the SetLogger Function of redis package in Go in details, along with examples.


In modern applications, using a caching mechanism is essential for improving performance, and Redis is a popular choice for this purpose. The Go programming language offers a Redis client package, “,” for easy interaction with Redis. One of the useful features of this package is its logging capabilities. The SetLogger function allows you to set up custom logging for your Redis client. In this article, we’ll explore the SetLogger function in detail and provide examples of its usage.

What is SetLogger Function ?

The SetLogger function is a method of the *redis.Client and *redis.ClusterClient types, which allows you to set a custom logger for your Redis client. This custom logger will handle log messages produced by the Redis client, such as connection errors and retries. By default, the Redis client uses the standard Go logger (log package). The SetLogger function’s signature is as follows:


For *redis.Client:

func (c *Client) SetLogger(logger *log.Logger)

For *redis.ClusterClient:

func (c *ClusterClient) SetLogger(logger *log.Logger)

Here, ‘logger’ is an instance of the log.Logger type that you want to use as the custom logger for the Redis client.

Why use SetLogger ?

Using the SetLogger function can be helpful in various scenarios, such as:

  1. Customizing log messages: You can tailor the log messages produced by the Redis client to include more information or match the formatting of other log messages in your application.
  2. Redirecting logs: You can direct the Redis client’s log messages to a different output, such as a file or a remote log server.
  3. Filtering logs: You can filter the log messages produced by the Redis client, only showing messages of a specific severity or category.


Let’s look at an example to understand how to use the SetLogger function with the Redis client in Go.

package main

import (


func main() {

	// Create a custom logger
	logger := log.New(os.Stdout, "redis: ", log.LstdFlags|log.Lshortfile)

	// Create a Redis client
	client := redis.NewClient(&redis.Options{
		Addr:     "localhost:6379",
		Password: "", // no password set
		DB:       0,  // use default DB

	// Set the custom logger for the Redis client

	// Perform a basic operation with the Redis client
	err := client.Set("example_key", "example_value", 0).Err()

	if err != nil {
		logger.Printf("Failed to set key: %v", err)

	value, err := client.Get("example_key").Result()

	if err != nil {
		logger.Printf("Failed to get key: %v", err)

	fmt.Println("Value:", value)


In the example above, we create a custom logger using log.New, which writes log messages to stdout with a custom prefix (“redis: “) and includes the standard flags along with the short file name. We then create a Redis client and set our custom logger using the SetLogger function. The subsequent Redis operations will use our custom logger to log any messages, such as errors.


The SetLogger function in the Go Redis package is a powerful feature that enables you to customize logging for your Redis client. By setting a custom logger, you can control the formatting, filtering, and output destination of log messages produced by the Redis client.

To check more Go related articles. Pls click given below link:

Posted in golang, packages, redis

Leave a Reply

Your email address will not be published. Required fields are marked *