在本教程中,我们将介绍如何使用 OpenResty XRay 线上检测分析 Go (golang) 应用中的程序异常(或 panics)。OpenResty XRay 能够检测和分析 Go 在线进程中的代码异常,包括那些不会导致进程崩溃的被捕获的异常。这些代码路径是 OpenResty XRay 自动分析和解读 Go 源码级别的异常火焰图得来的。它将最大限度地减少对性能的影响。因此,OpenResty XRay 非常适合对性能开销和延迟敏感的生产环境。

使用引导式分析功能分析 Go 应用中的程序异常

本文将演示如何线上分析任意正在运行的 Go 应用中的程序异常,或者说 panic。我们使用的是 Linux 发行版自带的未经修改的 Go 编译器。

Screenshot

目标 Go 程序是使用普通的 go build 命令编译的。不需要做任何更改,无需添加任何特殊选项。

Screenshot

在浏览器中打开 OpenResty XRay 的 Web 控制台。

Screenshot

确保当前分析的机器是正确的。

Screenshot

如果不对,我们可以在下面的列表重新选择。

Screenshot

进入 “Guided Analysis” 页面。

Screenshot

这里可以看到系统能分析的不同类型的问题。

Screenshot

选择 “Errors & exceptions”。

Screenshot

点击 “Next”。

Screenshot

选择之前的 Go 应用。

Screenshot

选择之前的目标进程。

Screenshot

确保应用的类型是正确的。通常默认值就是对的。

Screenshot

这里的语言级别就只有 “Go” 了。

Screenshot

我们还可以设置最长的分析时间。这里保持默认的 300 秒不变。

Screenshot

开始分析。

Screenshot

系统将持续执行多轮分析。目前它正在运行第一轮分析。

Screenshot

第一轮分析已经完成,现在进入第二轮。对这个例子来说,运行一轮分析就够了。

Screenshot

停止分析。

Screenshot

可以看到自动生成了一份分析报告。

Screenshot

这是我们要分析的问题类型,“Errors & exceptions”。

Screenshot

看一下第一条抛出异常的 Go 代码路径。

Screenshot

Go 最终会通过其运行时的 gopanic 函数抛出异常。

Screenshot

在这条代码路径中,gopanic 函数由运行时的 panicdivide 函数调用。意味着这是一个除零错误。

Screenshot

根据调用上下文,是函数 calculate 抛出了程序异常。这个函数属于业务层面的代码。

Screenshot

handleHTTPRequest 函数属于 golang 的 Gin 这个 Web 框架。该函数负责处理传入的 HTTP 请求。

Screenshot

点击 “More”。

Screenshot

这条热代码路径是从这个 Go 级别的异常火焰图自动推导出来的。

Screenshot

下面是对问题更详细的解释和建议。它提到了上面的程序异常,是由除零错误引起的。

Screenshot

这是一个能修复这个错误的代码示例。

Screenshot

回到原始的热代码路径。将鼠标悬停在 calculate 函数的绿框上。

Screenshot

在提示框中可以看到这个函数的源文件名和完整路径。

Screenshot

这行源码的行号是 25。

Screenshot

点击这个图标,复制这个函数的源文件路径。

Screenshot

用 vim 编辑器打开源文件。粘贴我们刚才复制的文件路径。您可以使用任何您喜欢的编辑器。

Screenshot

正如 OpenResty XRay 建议的那样跳转到第 25 行。

Screenshot

如我们刚刚在代码路径看到的,这行代码正是在 calculate 函数内部。我们应该先检查除数 b 是否为零。

Screenshot

接下来,查看第二条抛出程序异常的代码路径。

Screenshot

这是和上面类似的 gopanic 函数。

Screenshot

goPanicIndex 函数也属于 Go 的标准运行时。在这条代码路径中,这个程序异常是由运行时的 goPanicIndex 函数触发的。

Screenshot

可能是这个 weekday.Handler 函数中的数组或切片索引发生了越界访问。这个 Go 函数是业务代码级别的。

Screenshot

将鼠标悬停于这个函数上方,在提示框中可以看到它的源文件路径。

Screenshot

这行源码的行号是 17。

Screenshot

复制它的源文件路径。

Screenshot

在终端上打开源文件。粘贴刚才复制的文件路径。

Screenshot

跳转到第 17 行。可以看到,确实是在通过索引访问数组元素。

Screenshot

这个数组变量名为 weekDays

Screenshot

该函数没有确认索引变量 i 的值范围。

Screenshot

而这个 i 变量可以从客户端请求中获取任意整数值。

Screenshot

全自动分析报告

OpenResty XRay 也可以自动监控在线进程,并生成分析报告。

切换到 “Insights” 页面。

Screenshot

您可以在 “Insights” 页面中找到以日和周为周期的自动报告。其实您不是非得用 “Guided Analysis” 功能。

Screenshot

当然,“Guided Analysis” 对于应用的开发和演示是很有用的。

Screenshot

关于 OpenResty XRay

OpenResty XRay 是一个动态追踪产品,它可以自动分析运行中的应用,以解决性能问题、行为问题和安全漏洞,并提供可行的建议。在底层实现上,OpenResty XRay 由我们的 Y 语言 驱动,可以在不同环境下支持多种不同的运行时,如 Stap+、eBPF+、GDB 和 ODB。

关于作者

章亦春是开源 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. 公司的博客网站 。也欢迎扫码关注我们的微信公众号:

我们的微信公众号

翻译

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