Go / 系统课时

给请求建立关联标识

给请求建立关联标识

并发服务里的多条日志会交错出现,只看时间很难判断它们是否属于同一次请求。本节给连接生成 conn_id、给每个请求生成独立 request_id,再把带标识的日志器放进 context.Context,让入口、处理和错误日志能够被同一组字段串起来。

学习目标

  • 区分连接标识与请求标识的生命周期
  • 在请求入口生成标识,并通过 context.Context 向下传递
  • 让业务日志自动携带统一字段,避免每层手工拼接

两种标识解决不同问题

conn_id 适合描述一条 TCP 连接从建立到关闭的生命周期;同一连接上如果承载多个消息或请求,它们会共享这个标识。request_id 则应在每次请求开始时重新生成,用来定位一次完整处理链路。

连接与请求关联标识的数据流

这样查询日志时,可以先用 request_id 找到单次请求的所有记录;如果怀疑问题与长连接状态有关,再用 conn_id 回看同一连接上的前后请求。

在入口创建带字段的日志器

下面的程序使用 crypto/rand 生成 8 字节随机标识,并用 slog.Logger.With 绑定关联字段。业务函数只从 context.Context 取日志器,不需要重复接收两个字符串参数。

go
package main

import (
	"context"
	"crypto/rand"
	"encoding/hex"
	"errors"
	"fmt"
	"log/slog"
	"os"
)

type contextKey string

const loggerKey contextKey = "request-logger"

func newID() (string, error) {
	var b [8]byte
	if _, err := rand.Read(b[:]); err != nil {
		return "", fmt.Errorf("generate id: %w", err)
	}
	return hex.EncodeToString(b[:]), nil
}

func withLogger(ctx context.Context, logger *slog.Logger) context.Context {
	return context.WithValue(ctx, loggerKey, logger)
}

func loggerFrom(ctx context.Context) *slog.Logger {
	if logger, ok := ctx.Value(loggerKey).(*slog.Logger); ok {
		return logger
	}
	return slog.Default()
}

func handleRequest(ctx context.Context) error {
	loggerFrom(ctx).Info("handler started")
	return errors.New("simulated downstream failure")
}

func main() {
	base := slog.New(slog.NewTextHandler(os.Stdout, &slog.HandlerOptions{}))

	connID, err := newID()
	if err != nil {
		panic(err)
	}
	requestID, err := newID()
	if err != nil {
		panic(err)
	}

	requestLogger := base.With(
		"conn_id", connID,
		"request_id", requestID,
	)
	ctx := withLogger(context.Background(), requestLogger)

	requestLogger.Info("request started")
	if err := handleRequest(ctx); err != nil {
		requestLogger.Error("request failed", "error", err)
	}
}

运行:

bash
go mod init example/correlation
go run .

预期输出

text
time=<TIME> level=INFO msg="request started" conn_id=<ID> request_id=<ID>
time=<TIME> level=INFO msg="handler started" conn_id=<ID> request_id=<ID>
time=<TIME> level=ERROR msg="request failed" conn_id=<ID> request_id=<ID> error="simulated downstream failure"

<TIME> 和 <ID> 都是运行时动态值;三行中的 conn_id 与 request_id 应分别保持一致,这就是验证关联是否成功的关键。

把标识放在正确的边界

连接建立时创建一次 conn_id,连接关闭后立即失效。每成功解析出一条独立请求,就创建新的 request_id;不要把一个请求标识复用给整个长连接,否则并发或流水线处理时仍会混在一起。

context.Context 只负责随调用链传递请求范围数据。不要把它保存到全局变量,也不要为了取日志器而传入 nil。如果服务已有请求上下文,应基于原上下文派生,而不是重新用 context.Background() 截断取消信号和截止时间。

让关联字段成为日志契约

一旦决定使用 conn_id 和 request_id,就应让入口、业务处理、外部调用和错误日志采用同名字段。字段名频繁变化会让检索规则和告警规则失效。

在真实网络服务中,客户端若已经提供可信的请求标识,可以在完成格式与长度校验后沿用;否则由服务端生成。无论来源如何,核心要求都是一次请求内稳定、不同请求间可区分,并且所有关键日志都自动携带同一字段。

按自己的节奏,确认真正理解。

目录与阅读设置

阅读设置

17

记录一个想法

给请求建立关联标识

0 / 10000 · 笔记保存到账号。未提交的修改会在关闭、离开或刷新后丢失。

登录哪都通