随着业务增长,你的系统可能会变得越来越复杂。对于复杂的系统来说,能够正确地追踪请求变得至关重要,而且颇有难度。

Embeded image

OpenResty Edge 可以通过以唯一的 ID 标识请求来降低追踪请求的难度。这就是我们今天的主题: Request ID。

Embeded image

全局配置 Request ID

让我们进入 OpenResty Edge 的 Admin Web 控制台。这是我们控制台的样本部署。每个用户都有自己的本地部署。

Screenshot

跳转到全局配置页面。在这里你可以配置是否在所有请求头添加一个 Request ID。

Screenshot

Screenshot

这个配置项默认是打开的,这意味着每个请求在代理头和响应体头中都会有一个 Req-ID 字段。

现在我们向 openresty.org 发送一个请求,看看这个 ID 是如何被使用的。

Screenshot

可以看到在请求头中有一个 “Req-ID” 字段。

Screenshot

Request ID 解码器

现在转到工具页面。

Screenshot

进入 Request ID 解码器页面。

Screenshot

输入我们刚才看到的 Request ID。

Screenshot

点击这个按钮进行解码。

Screenshot

可以看到下面显示了与该请求有关的一些详细信息。

像应用的域名、

Screenshot

网关分区、

Screenshot

网关集群、

Screenshot

以及网关服务器。

Screenshot

这里有两个按钮。你可以在 openresty.org 应用的错误日志和 WAF 日志页面中搜索这个 Request ID。

Screenshot

现在我来演示一下要怎么做。

点击 “Search in Error Logs” 按钮。

Screenshot

这会将我们带到错误日志页面。

Screenshot

看不到有任何日志显示,这是因为我们使用的 Request ID 是来自一个正常的请求。该请求并没有创建任何错误日志。

Screenshot

清除 Request ID 这个筛选项。

Screenshot

你可以看到所有错误日志的详细信息。

复制其中一个 Request ID。

Screenshot

把它粘贴到搜索框中。

Screenshot

可以看到错误日志列表经过了筛选,只有与所选 Request ID 相符的错误日志被显示出来。

Screenshot

这是错误日志页面。同样,在被 WAF 拦截的可疑请求页面,所有请求也都带有 Request ID 信息。

进入 WAF 的日志页面。

Screenshot

你可以看到所有被 WAF 拦截的请求以及相应的 Request ID。

这里你也可以使用 Request ID 来过滤请求。

Screenshot

而且你可以直接在列表中解码 Request ID。

点击一个 Request ID。

Screenshot

Screenshot

点击这个弹窗上的链接将把你带到相应的页面。例如,点击一下网关服务器的链接。我们被带到了网关服务器的页面上。

Screenshot

这时请求信息的弹窗依然是打开的,因为你可能想去其他页面。

如果你想关闭它,只需点击关闭按钮。

Screenshot

这是我今天要演示的内容。

如果你喜欢这个教程,请订阅这个博客网站和我们的 YouTube 频道B 站频道。谢谢!

关于本文和关联视频

本文和相关联的视频都是完全由我们的 OpenResty Showman 产品从一个简单的剧本文件自动生成的。

关于作者

章亦春是开源 OpenResty® 项目创始人兼 OpenResty Inc. 公司 CEO 和创始人。

章亦春(Github ID: agentzh),生于中国江苏,现定居美国湾区。他是中国早期开源技术和文化的倡导者和领军人物,曾供职于多家国际知名的高科技企业,如 Cloudflare、雅虎、阿里巴巴, 是 “边缘计算“、”动态追踪 “和 “机器编程 “的先驱,拥有超过 22 年的编程及 16 年的开源经验。作为拥有超过 4000 万全球域名用户的开源项目的领导者。他基于其 OpenResty® 开源项目打造的高科技企业 OpenResty Inc. 位于美国硅谷中心。其主打的两个产品 OpenResty XRay(利用动态追踪技术的非侵入式的故障剖析和排除工具)和 OpenResty Edge(最适合微服务和分布式流量的全能型网关软件),广受全球众多上市及大型企业青睐。在 OpenResty 以外,章亦春为多个开源项目贡献了累计超过百万行代码,其中包括,Linux 内核、Nginx、LuaJITGDBSystemTapLLVM、Perl 等,并编写过 60 多个开源软件库。

关注我们

如果您喜欢本文,欢迎关注我们 OpenResty Inc. 公司的博客网站 。也欢迎扫码关注我们的微信公众号:

我们的微信公众号

翻译

我们提供了英文版原文和中译版(本文)。我们也欢迎读者提供其他语言的翻译版本,只要是全文翻译不带省略,我们都将会考虑采用,非常感谢!