Get the actual error source in Go using Uber/Zap logging in gRPC middleware

In this article, php editor Zimo will introduce how to use Uber/Zap logging to obtain the actual error source in the Go language when using gRPC middleware. By using this middleware, we can better understand and track errors in the code, thereby locating and solving problems faster. This article details how to configure and use Uber/Zap logging, and how to capture and log error information in gRPC requests and responses. By mastering these techniques, we can improve our debugging and error handling capabilities in gRPC applications.

Question content

I am using the uber/zap package for logging. In my design, I log all errors in the grpc package's middleware. I want to log which file and line number the error comes from. However, currently I can only get the filename and line number of the current middleware. Is there any way to get the actual source of the error?

func RegisterLogger(c config.Config) *zap.SugaredLogger {

    var logger *zap.Logger
    var err error
    if c.IsDebug {
        logger, err = zap.NewDevelopment()
    } else {
        logger, err = zap.NewProduction()
    }

    if err != nil {
        panic(err)
    }
    defer logger.Sync()

    return logger.Sugar()
}



func (s *ProviderServer) Pay(ctx context.Context, in *payment.PayRequest) (string, error) {
    resp, err := ctx.Value(in.Provider).(provider.IPayment).Exec(ctx, in)

    if err != nil {
            pc, file, line, ok := runtime.Caller(2)
            if ok {
                file = filepath.Base(file)
                nowTime := time.Now().Format("2006/01/02 15:04:05")
                funcName := runtime.FuncForPC(pc).Name()
                funcName = filepath.Ext(funcName)
                funcName = strings.TrimPrefix(funcName, ".")
                s.log.Info("Times:", i, " nowTime:", nowTime, " file:", file, " line:", line, " funcName:", funcName, " err:", err)
            }
        
//Log the error information, including which file the error comes from.

        return resp.Result, err
    } else {
        s.log.Info("resp:", resp)
    }

}

Workaround

In the current implementation, you try to log the file and line number where the error occurred. However, the information you get is for the current middleware and not the actual source of the error.

To get the file and line information of the actual source of the error, you can use the pkg/errors package. This package provides a way to wrap errors and preserve file and line information. Here is an example of how to modify the code to achieve this:

import (
    "github.com/pkg/errors"
)

// ...

func (s *ProviderServer) Pay(ctx context.Context, in *payment.PayRequest) (string, error) {
    resp, err := ctx.Value(in.Provider).(provider.IPayment).Exec(ctx, in)

    if err != nil {
        // Wrap the error with file and line information
        err = errors.Wrap(err, "pay error")

        // Log the wrapped error
        s.log.Errorw("Error occurred", "error", err)

        return resp.Result, err
    } else {
        s.log.Infow("Request processed successfully", "response", resp)
        return resp.Result, nil
    }
}

You can add file and line information to the error by wrapping the error using the errors.wrap function. Then, when an error is logged using s.log.errorw, the log message will contain the full stack trace, including the file and line information where the error originated.

This way you can use the information provided by the errors package to track the actual source of the error.

The above is the detailed content of Get the actual error source in Go using Uber/Zap logging in gRPC middleware. For more information, please follow other related articles on the PHP Chinese website!