如何通过 $request_id 变量在日志中实现前后端请求的一键关联链路追踪

浅婷小哥_1631

浅婷小哥_1631

2026-05-07

457人浏览

原创

核心在于全链路透传、统一生成、日志标准化输出:nginx入口统一生成request_id并透传,后端从x-request-id读取并注入mdc日志上下文,前端获取后携带至后续请求,最终在elk/sls中凭该id一键串联全链路日志。

如何通过 $request_id 变量在日志中实现前后端请求的一键关联链路追踪

在分布式系统中,通过 $request_id 实现前后端请求的一键关联,核心在于:**全链路透传、统一生成、日志标准化输出**。只要每个中间节点(Nginx、后端服务、前端埋点)都携带并记录同一个 request_id,就能在 ELK、SLS 或其他日志平台中用一个 ID 快速串联起一次完整请求的全部日志。

1. 在 Nginx 层统一生成并透传 $request_id

Nginx 作为入口网关,是最适合统一生成和注入 request_id 的位置。它能避免后端重复生成,也确保即使请求未到达应用层,也有 ID 可查。

  • 使用 ngx_http_secure_link_module 或更常用的是 map + random 模块(需编译支持)生成 UUID;但更推荐用 lua-resty-random 或 OpenResty 的 resty.uuid 模块生成标准 UUIDv4
  • 若用 OpenResty,在 http 块中定义:
    lua_package_path "/path/to/lua-resty-uuid/lib/?.lua;;";
    init_by_lua_block {
        require "resty.uuid"
    }
    map $time_iso8601 $request_id {
        default "";
    }
    server {
        listen 80;
        location / {
            set $req_id "";
            access_by_lua_block {
                local uuid = require "resty.uuid"
                local ok, id = uuid:generate()
                if ok then
                    ngx.var.req_id = id
                else
                    ngx.var.req_id = ngx.md5(ngx.now() .. ngx.var.remote_addr .. math.random(10000, 99999))
                end
            }
            proxy_set_header X-Request-ID $req_id;
            proxy_pass http://backend;
        }
    }
  • 务必把 X-Request-ID 透传给后端(proxy_set_header),同时自身 access log 中记录该字段:log_format main '$remote_addr - $remote_user [$time_local] "$request" $status $body_bytes_sent "$http_referer" "$http_user_agent" "$http_x_request_id"';

2. 后端服务主动读取并注入日志上下文

后端不自行生成 request_id,而是优先从 X-Request-ID Header 中读取。若缺失,再按需生成(仅作兜底,避免空 ID)。

Consensus
Consensus

一款AI工具,主要用于一个新型搜索引擎,利用AI在科学研究中为你找到答案,适合需要提升相关任务效率的用户。

下载
  • Spring Boot 示例:用 OncePerRequestFilter 提前提取并存入 MDC(Mapped Diagnostic Context)
  • 代码片段:
    @Component
    public class RequestIdFilter extends OncePerRequestFilter {
        @Override
        protected void doFilterInternal(HttpServletRequest request, HttpServletResponse response,
                                      FilterChain filterChain) throws ServletException, IOException {
            String reqId = Optional.ofNullable(request.getHeader("X-Request-ID"))
                    .filter(id -> !id.trim().isEmpty())
                    .orElse(UUID.randomUUID().toString());
            MDC.put("request_id", reqId);
            try {
                filterChain.doFilter(request, response);
            } finally {
                MDC.remove("request_id");
            }
        }
    }
  • Logback 配置中启用 %X{request_id},例如:%d{yyyy-MM-dd HH:mm:ss.SSS} [%X{request_id}] [%thread] %-5level %logger{36} - %msg%n
  • Node.js(Express)可用 cls-hooked 或简单中间件挂载到 res.locals + winston 的 format 添加字段

3. 前端主动采集并带上 request_id 发起后续请求

用户首次访问时,Nginx 已在响应头中写入 X-Request-ID。前端可在页面初始化时读取,并用于后续所有 API 请求。

  • 在 HTML 模板或首屏 JS 中获取响应头(需服务端允许 CORS 暴露):Access-Control-Expose-Headers: X-Request-ID
  • 示例(fetch 封装):
    let globalRequestId = '';
    // 首次加载时从 document.responseHeader 获取(实际需用 fetch + Response.headers)
    // 更可靠方式:服务端渲染模板时注入 window.__INITIAL_REQUEST_ID__ = 'xxx'
    fetch('/api/init').then(r => {
        globalRequestId = r.headers.get('X-Request-ID') || '';
    });
    // 后续请求自动携带
    function api(url) {
        return fetch(url, {
            headers: { 'X-Request-ID': globalRequestId }
        });
    }
  • Vue/React 可结合 axios 拦截器或自定义 Hook 统一注入
  • 注意:WebSocket、图片资源等非 XHR 请求无法自动带 header,可改用 URL query(如 ?_rid=xxx)并在后端解析补全

4. 日志平台中一键检索与链路还原

当日志中每条记录都含 request_id 字段(Nginx access log、后端业务日志、前端上报日志),即可在日志系统中直接搜索该 ID 查看完整链路。

  • ELK 中:Kibana 使用 request_id: "a1b2c3..." 查询,按 @timestamp 排序,天然呈现时间线
  • SLS(阿里云日志服务):用 * | select * where request_id = 'xxx',支持关联分析(如统计该请求下各服务耗时、错误码分布)
  • 进阶技巧:在日志中额外打点关键阶段,例如 "stage": "nginx-enter"、"stage": "service-db-query",便于快速定位瓶颈环节
  • 前端日志建议上报时也带上 request_id 和 page_url、user_id 等上下文,实现“用户行为 → 请求链路 → 后端异常”闭环排查

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
python是前端还是后端
python是前端还是后端

Python属于前端也属于后端,其灵活性和丰富的生态系统使得开发人员能够在不同的领域中灵活运用。本专题为大家提供python相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.11

2283

5

前端和后端的区别
前端和后端的区别

前端关注的是用户界面的设计和交互,而后端则注重数据处理和逻辑控制。想了解更多前端后端的相关内容,可以阅读本专题下面的文章。

2024.03.19

5990

13

后端的主要工作内容介绍
后端的主要工作内容介绍

后端是应用程序的服务端部分,负责核心任务,如数据库交互、业务逻辑处理和响应客户端请求。想了解更多后端的相关内容,可以阅读本专题下面的文章。

2024.03.19

5346

10

nginx 重启
nginx 重启

nginx重启对于网站的运维来说是非常重要的,根据不同的需求,可以选择简单重启、平滑重启或定时重启等方式。本专题为大家提供nginx重启的相关的文章、下载、课程内容,供大家免费下载体验。

2023.07.27

383

5

nginx 配置详解
nginx 配置详解

Nginx的配置是指设置和调整Nginx服务器的行为和功能的过程。通过配置文件,可以定义虚拟主机、HTTP请求处理、反向代理、缓存和负载均衡等功能。Nginx的配置语法简洁而强大,允许管理员根据自己的需要进行灵活的调整。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.04

3267

6

nginx配置详解
nginx配置详解

NGINX与其他服务类似,因为它具有以特定格式编写的基于文本的配置文件。本专题为大家提供nginx配置相关的文章,大家可以免费学习。

2023.08.04

5925

6

tomcat和nginx有哪些区别
tomcat和nginx有哪些区别

tomcat和nginx的区别:1、应用领域;2、性能;3、功能;4、配置;5、安全性;6、扩展性;7、部署复杂性;8、社区支持;9、成本;10、日志管理。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

2024.02.23

561

5

nginx报404怎么解决
nginx报404怎么解决

当访问 nginx 网页服务器时遇到 404 错误,表明服务器无法找到请求资源,可以通过以下步骤解决:1. 检查文件是否存在且路径正确;2. 检查文件权限并更改为 644 或 755;3. 检查 nginx 配置,确保根目录设置正确、没有冲突配置等等。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

2024.07.09

1476

5

Nginx报404错误解决方法
Nginx报404错误解决方法

解决方法:只需要加上这段配置:try_files $uri $uri/ /index.html;即可。想了解更多Nginx的相关内容,可以阅读本专题下面的文章。

2024.08.07

3938

3

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程