Go语言错误日志设计：包含堆栈跟踪信息

运维开发王义杰

发布于 2023-08-10 17:45:23

5660

发布于 2023-08-10 17:45:23

文章被收录于专栏：运维开发王义杰运维开发王义杰

在开发Go应用程序时，错误处理是一个重要的环节。当错误发生时，我们希望可以从日志中获取足够的信息，以便快速准确地定位问题。本文将介绍如何在Go的错误日志中输出堆栈跟踪信息。

为什么需要堆栈信息？

堆栈信息能够提供错误发生时程序的调用情况，这对于我们找出错误的来源非常有用。如果错误信息中不包含堆栈信息，我们可能会很难找出错误是在哪里产生的，特别是在大型项目中，这种情况更加突出。

使用github.com/pkg/errors包

github.com/pkg/errors是一个非常流行的Go错误处理库，它在标准的errors包基础上增加了一些有用的功能，包括堆栈跟踪。使用该库的Wrap或Wrapf函数，我们可以创建一个新的错误，同时包含原始错误的信息和堆栈跟踪信息。

err := errors.Wrap(err, "an error occurred")

创建错误后，我们可以使用fmt.Printf("%+v", err)打印出完整的错误信息和堆栈跟踪。

fmt.Printf("%+v", err)

以上代码会打印出类似以下的输出：

an error occurred: original error
main.someFunction
    /path/to/your/code.go:42
main.anotherFunction
    /path/to/your/code.go:36
main.main
    /path/to/your/code.go:29

使用logrus和github.com/pkg/errors结合

logrus是一个在Go社区广泛使用的日志库。它和pkg/errors一起使用，可以很方便地在日志中添加堆栈跟踪信息。

package main

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

func main() {
  err := errors.Wrap(errors.New("this is an error"), "error occurred")
  if err != nil {
    logrus.Errorf("something wrong: %+v", err)
  }
}

以上代码中，我们使用了logrus.WithField添加了一个名为error的字段，然后调用Error方法记录一条错误日志。运行这段代码，我们将看到类似以下的输出：

time="2023-07-10T12:44:24+08:00" level=error msg="something wrong: this is an error\nmain.main\n\td:/src/golang/demo/errdemo/main.go:9\nruntime.main\n\tC:/Program Files/Go/src/runtime/proc.go:255\nruntime.goexit\n\tC:/Program Files/Go/src/runtime/asm_amd64.s:1581\nerror occurred\nmain.main\n\td:/src/golang/demo/errdemo/main.go:9\nruntime.main\n\tC:/Program Files/Go/src/runtime/proc.go:255\nruntime.goexit\n\tC:/Program Files/Go/src/runtime/asm_amd64.s:1581"