生產環境如何追蹤 PHP 異常(無需重啟應用)
OpenResty XRay 基於非侵入式動態追蹤技術,無需重啟或修改程序即可追蹤生產環境中 PHP 應用的程式異常,包括導致程序崩潰的異常和被應用自身捕獲、不會崩潰的異常。它會自動解讀 PHP 語言級別的異常火焰圖,精確定位丟擲異常的具體程式碼路徑,並將效能開銷降到最低,適合對延遲敏感的生產環境。
本教程將演示如何使用 XRay 的引導式分析(Guided Analysis)功能,在一個真實的 PHP 應用中追蹤程式異常——從啟動分析到檢視自動生成的報告。
用 XRay 引導式分析追蹤 PHP 異常
排查程序並開啟 XRay 控制檯
首先,執行 ps 命令來檢視 PHP 應用程序中的完整命令列。
可以看到這個 PHP 二進位制可執行檔案是 Linux 發行版自帶的。
讓我們使用 OpenResty XRay 來檢查這個未經修改的程序。您可以對它實時分析其內部丟擲的 PHP 異常。
跳轉到 OpenResty XRay 的 Web 控制檯。
確保當前分析的機器是正確的。
執行引導式分析掃描 PHP 異常
進入 “Guided Analysis“ 頁面。
這裡可以看到系統能分析的不同型別的問題。
選擇 “Errors & exceptions”。
點選 “Next”。
選擇之前的 PHP 應用。
選擇 “Whole application“。
確保應用的型別是正確的。通常預設值就是對的。
OpenResty XRay 可以同時分析多種不同的語言層面。這裡保持 PHP 和 C/C++ 都選中的狀態。
我們還可以設定最長的分析時間。這裡保持預設的 300 秒不變。
開始分析。
系統將持續執行多輪分析。目前它正在執行第一輪分析。
第一輪分析已經完成,現在進入第二輪。對這個例子來說,執行一輪分析就夠了。
停止分析。
檢視異常分析報告與熱程式碼路徑
可以看到自動生成了一份分析報告。
這是我們要分析的問題型別。是 “Errors & exceptions”。
這裡指的是 PHP 程式碼路徑。我們可以看到它展示了丟擲最多異常的程式碼路徑。
首先,我們可以看到一個訪問陣列越界的錯誤。
這個錯誤發生在業務程式碼中的 getOrder 函式內。
Laravel 的路由元件會自動呼叫控制器方法 callAction 來執行相應的業務邏輯程式碼。
點選 “More“ 檢視更多細節。
這條熱程式碼路徑是從這個 PHP 級別的異常火焰圖自動推匯出來的。
下面是對問題更詳細的解釋和建議。
這裡提到了上面的異常。
這裡指出了發生 PHP 錯誤程式碼的位置。
我們可以透過這裡提出的建議來避免該錯誤。OpenResty XRay 還提供了一個程式碼示例來修復這個錯誤。
定位到具體的 PHP 原始碼行
讓我們回到原來的熱程式碼路徑。
將滑鼠懸停在 getOrder 函式的綠框上。
在提示框中可以看到 PHP 函式的原始檔名和完整路徑。
這行 PHP 原始碼的行號是 54。
點選這個圖示,複製這個函式的原始檔路徑。
在終端中用 vim 編輯器開啟原始檔。貼上我們剛才複製的檔案路徑。您可以使用任何您喜歡的編輯器。
正如 OpenResty XRay 建議的那樣跳轉到第 54 行。
可以看到對 PHP 陣列元素的訪問。orderId 變數的值有時顯然超出了陣列邊界。使用者在這行原始碼之前需要檢查但還沒有檢查這個陣列索引的值。
這個異常雖然被應用本身捕獲住,但 OpenResty XRay 仍然可以檢測到。
第二種 PHP 異常:業務程式碼主動 throw
接下來,檢視第二條在 PHP 程式碼路徑中丟擲程式異常的程式碼路徑。
這是 PHP 業務程式碼透過 throw 語句主動丟擲來的異常。
可以看到這個異常也是由 getOrder 函式觸發的。
無需引導式分析:PHP 異常自動報告
OpenResty XRay 也可以自動監控線上程序,並生成分析報告。
切換到 “Insights” 頁面。
您可以在 “Insights” 頁面中找到以日和周為週期的自動報告。所以您不是非得用 “Guided Analysis” 功能。
當然,“Guided Analysis” 對於應用的開發和演示是很有用的。
常見問題
Q: OpenResty XRay 是如何在不重啟應用的情況下檢測 PHP 異常的? A: XRay 基於非侵入式動態追蹤技術——底層由 Y 語言驅動,支援 Stap+、eBPF+、GDB 等多種執行時——從程序外部觀測正在執行的 PHP 程序,因此無需觸碰程序本身的程式碼或生命週期即可捕獲異常。
Q: 已經被應用自身捕獲、不會導致崩潰的 PHP 異常,XRay 還能檢測到嗎? A: 可以。即使異常已經被應用自身捕獲、不會導致崩潰,XRay 仍能檢測到,暴露出大多數基於日誌的方案會漏掉的程式碼路徑。
Q: 本文示例中的陣列越界異常是怎麼產生的?
A: 業務程式碼中的 getOrder 函式用 orderId 變數訪問 PHP 陣列,而這個變數的值有時會超出陣列邊界,程式碼在此之前又沒有做索引校驗——這是一個典型的陣列越界訪問 bug。
Q: 不執行引導式分析,要怎麼檢視 PHP 異常報告? A: XRay 控制檯的 “Insights” 頁面會自動生成日報和週報,不需要每次都手動跑一次引導式分析。
關於 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、LuaJIT、GDB、SystemTap、LLVM、Perl 等,並編寫過 60 多個開源軟體庫。
關注我們
如果您喜歡本文,歡迎關注我們 OpenResty Inc. 公司的部落格網站 。也歡迎掃碼關注我們的微信公眾號:
翻譯
我們提供了英文版原文和中譯版(本文)。我們也歡迎讀者提供其他語言的翻譯版本,只要是全文翻譯不帶省略,我們都將會考慮採用,非常感謝
































































