利用请求 ID 在所有日志文件中进行标记

在使用 Go 开发 Web 应用程序时，通常需要在所有日志记录中包含请求 ID 以方便调试和追踪。本文将介绍一种方法，通过利用请求 ID 的上下文信息，在所有日志文件中进行标记，从而简化日志记录流程，无需在每个日志打印中手动添加请求 ID。

我有一些使用 go http 的 web 应用程序服务器，我希望每个请求都有 uuid 的上下文，为此我可以使用 http 请求上下文 https://golang.org/pkg/net/http/#request .上下文

我们正在使用 logrus，并在一个文件中启动它，并在其他文件中使用记录器实例。

我需要的是在所有日志中打印请求id，但不是在每个日志打印中添加新的参数，我想在每个http请求中执行一次（传递req-id）并且所有日志打印都会有无需对其进行任何操作

例如如果 id=123 那么 log.info("foo") 将打印 // id=123 foo

我尝试过以下方法，但不确定是否正确，请指教。

package main

import (
    "context"
    "errors"

    log "github.com/sirupsen/logrus"
)

type someContextKey string

var (
    keyA = someContextKey("a")
    keyB = someContextKey("b")
)

func main() {
    ctx := context.Background()
    ctx = context.WithValue(ctx, keyA, "foo")
    ctx = context.WithValue(ctx, keyB, "bar")

    logger(ctx, nil).Info("did nothing")
    err := errors.New("an error")
    logger(ctx, err).Fatal("unrecoverable error")
}

func logger(ctx context.Context, err error) *log.Entry {
    entry := log.WithField("component", "main")

    entry = entry.WithField("ReqID", "myRequestID")

    return entry
}

https://play.golang.org/p/ocw09uhtjz5

解决方案

每次调用 logger 函数时，您都会创建一个新的 *log.entry 并再次将请求 id 写入其中。从你的问题来看，你似乎不希望这样。

func main() {
    ctx := context.Background()
    ctx = context.WithValue(ctx, keyA, "foo")
    ctx = context.WithValue(ctx, keyB, "bar")

    lg := logger(ctx)
    lg.Info("did nothing")
    err := errors.New("an error")
    lg.WithError(err).Fatal("unrecoverable error")
}

func logger(ctx context.Context) *log.Entry {
    entry := log.WithField("component", "main")
    entry = entry.WithField("ReqID", "myRequestID")

    return entry
}

这样做的缺点是，您必须将 lg 变量传递给此请求调用的每个函数，并且该函数还应该记录请求 id。

我们在公司所做的是在 logrus 周围创建一个薄层，它有一个附加方法 withrequestctx，这样我们就可以传入请求上下文，它会提取请求 id 本身（我们已在中间件中写入上下文） 。如果不存在请求 id，则不会向日志条目添加任何内容。然而，这确实再次将请求 id 添加到每个日志条目，就像您的示例代码一样。

注意：我们围绕 logrus 的薄层有更多的功能和默认设置，以证明额外的努力是合理的。从长远来看，这对于有一个地方能够调整我们所有服务的日志记录非常有帮助。

注2：同时我们正在用zerolog替换logrus以使其更加轻量级。

以上就是本文的全部内容了，是否有顺利帮助你解决问题？若是能给你带来学习上的帮助，请大家多多支持golang学习网！更多关于Golang的相关知识，也可关注golang学习网公众号。