在本教程中,我们将介绍如何使用 OpenResty XRay 线上分析 PHP 应用中的程序异常。OpenResty XRay 能够检测和分析 PHP 在线进程中的代码异常,包括那些不会导致进程崩溃的被捕获的异常。值得注意的是,即使是应用程序自身已经捕获并处理的异常,OpenResty XRay 也能够检测到,这大大增强了问题诊断的能力。这些代码路径是 OpenResty XRay 自动分析和解读 PHP 语言级别的异常火焰图得来的。它将最大限度地减少对性能的影响。因此,OpenResty XRay 非常适合对性能开销和延迟敏感的生产环境。

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

首先,运行 ps 命令来查看 PHP 应用进程中的完整命令行。

Screenshot

可以看到这个 PHP 二进制可执行文件是 Linux 发行版自带的。

Screenshot

让我们使用 OpenResty XRay 来检查这个未经修改的进程。您可以对它实时分析其内部抛出的 PHP 异常。

跳转到 OpenResty XRay 的 Web 控制台。

Screenshot

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

Screenshot

进入 “Guided Analysis“ 页面。

Screenshot

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

Screenshot

选择 “Errors & exceptions”。

Screenshot

点击 “Next”。

Screenshot

选择之前的 PHP 应用。

Screenshot

选择 “Whole application“。

Screenshot

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

Screenshot

OpenResty XRay 可以同时分析多种不同的语言层面。这里保持 PHP 和 C/C++ 都选中的状态。

Screenshot

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

Screenshot

开始分析。

Screenshot

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

Screenshot

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

Screenshot

停止分析。

Screenshot

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

Screenshot

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

Screenshot

这里指的是 PHP 代码路径。我们可以看到它展示了抛出最多异常的代码路径。

Screenshot

首先,我们可以看到一个访问数组越界的错误。

Screenshot

这个错误发生在业务代码中的 getOrder 函数内。

Screenshot

Laravel 的路由组件会自动调用控制器方法 callAction 来执行相应的业务逻辑代码。

Screenshot

点击 “More“ 查看更多细节。

Screenshot

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

Screenshot

下面是对问题更详细的解释和建议。

Screenshot

这里提到了上面的异常。

Screenshot

这里指出了发生 PHP 错误代码的位置。

Screenshot

我们可以通过这里提出的建议来避免该错误。OpenResty XRay 还提供了一个代码示例来修复这个错误。

Screenshot

让我们回到原来的热代码路径。

Screenshot

将鼠标悬停在 getOrder 函数的绿框上。

Screenshot

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

Screenshot

这行 PHP 源码的行号是 54。

Screenshot

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

Screenshot

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

Screenshot

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

Screenshot

可以看到对 PHP 数组元素的访问。orderId 变量的值有时显然超出了数组边界。用户在这行源代码之前需要检查但还没有检查这个数组索引的值。

Screenshot

这个异常虽然被应用本身捕获住,但 OpenResty XRay 仍然可以检测到。

Screenshot

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

Screenshot

这是 PHP 业务代码通过 throw 语句主动抛出来的异常。

Screenshot

可以看到这个异常也是由 getOrder 函数触发的。

Screenshot

全自动分析报告

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

Screenshot

切换到 “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. 公司的博客网站 。也欢迎扫码关注我们的微信公众号:

我们的微信公众号

翻译

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