Documentation
¶
Overview ¶
Package trace 提供链路追踪 ID 的生成与提取能力。
什么是 TraceID ¶
在微服务架构中,一次用户请求会经过多个服务(gateway → user service → note service ...)。 TraceID 是贯穿整条链路的唯一标识符,每个服务在处理请求时都将其写入日志, 排查问题时只需搜索同一个 TraceID,即可还原完整的请求调用链。
传播规则 ¶
- 客户端(或上游服务)在请求头 X-Trace-ID 中携带 TraceID
- 若请求头不存在,gateway 自动生成一个新的 UUID 作为 TraceID
- gateway 将 TraceID 写回响应头 X-Trace-ID,客户端可凭此关联问题
- gateway 在调用下游 gRPC 服务时,应将 TraceID 通过 metadata 透传
中间件调用方式 ¶
traceID := trace.FromHeader(c.GetHeader("X-Trace-ID"))
Index ¶
Constants ¶
View Source
const GinContextKey = "trace_id"
GinContextKey 写入 gin.Context 时使用的 key,与中间件、日志组件约定一致
View Source
const HeaderKey = "X-Trace-ID"
HeaderKey 链路追踪 ID 的 HTTP 请求/响应头字段名
Variables ¶
This section is empty.
Functions ¶
func FromHeader ¶
FromHeader 从请求头值中提取 TraceID。 若上游已传入合法的 traceID,原样复用,保证跨服务链路一致; 若为空(请求来自客户端或未传播),生成新的 UUID。
Types ¶
This section is empty.
Click to show internal directories.
Click to hide internal directories.