OpenResty可通过Lua在请求入口生成唯一TraceID并注入请求/响应头及透传下游,核心是保证全局可见、不重复、可传递;推荐用ngx.ctx存储,支持复用上游ID、日志记录与OpenTracing集成。

OpenResty 可以通过 Lua 脚本在请求入口处生成唯一 TraceID,并将其注入到请求头(如 X-Trace-ID)和响应头中,同时透传给下游服务,从而实现轻量级链路追踪。关键在于保证 TraceID 在单次请求生命周期内全局可见、不重复、可传递。
生成并注入 TraceID 到请求上下文
使用 ngx.var 或 ngx.ctx 存储 TraceID,推荐用 ngx.ctx(请求级局部变量,线程安全且生命周期与请求一致)。生成方式常用 os.time()..ngx.worker.pid()..math.random(1e6) 或更可靠的 resty.random 模块(需提前安装):
- 在
init_by_lua_block中加载随机模块(如require "resty.random") - 在
access_by_lua_block中生成 TraceID:local trace_id = string.format("trace-%x-%d-%06d", os.time(), ngx.worker.pid(), math.random(1000000)) - 存入
ngx.ctx.trace_id = trace_id,后续阶段可直接读取
透传 TraceID 给下游服务
若使用 balancer_by_lua_block 或 proxy_pass 转发请求,需手动添加请求头:
- 在
access_by_lua_block中设置:ngx.req.set_header("X-Trace-ID", ngx.ctx.trace_id) - 若用
lua-resty-http发起子请求,构造 headers 表时显式加入:headers["X-Trace-ID"] = ngx.ctx.trace_id - 注意:OpenResty 默认不会自动继承上游
X-Trace-ID,需先检查并复用(避免多层生成):local upstream_tid = ngx.req.get_headers()["X-Trace-ID"]<br>ngx.ctx.trace_id = upstream_tid or generated_tid
记录日志并返回给客户端
让 TraceID 出现在 access log 和响应头中,便于排查和前端调试:
- 自定义 log format(nginx.conf):
log_format main '$remote_addr - $remote_user [$time_local] "$request" $status $body_bytes_sent "$http_referer" "$http_user_agent" "$http_x_trace_id"'; - 在
log_by_lua_block中写入日志字段(可选):ngx.log(ngx.INFO, "trace_id=", ngx.ctx.trace_id) - 响应头返回(可选,方便前端关联):
ngx.header["X-Trace-ID"] = ngx.ctx.trace_id
与 OpenTracing / Jaeger 集成(进阶)
若需对接标准追踪系统,可用 lua-resty-opentracing 模块:
- 初始化 tracer(如 Jaeger):
local ot = require "opentracing"<br>local tracer = ot.tracer({ service_name = "my-api" }) - 在
access_by_lua_block中启动 span:local span = tracer:start_span(ngx.var.uri, { child_of = ot.extract("http_headers", ngx.req.get_headers()) })<br>ngx.ctx.span = span<br>span:set_tag("http.method", ngx.var.request_method) - 在
log_by_lua_block中 finish span:if ngx.ctx.span then ngx.ctx.span:finish() end


















