Xdebug文檔（六） 分析PHP腳本

分析PHP腳本Xdebug內置分析器能讓你找到腳本中的瓶頸並用額外的工具諸如KcacheGrind或WinCacheGrind工具可視化。

介紹

Xdebug分析器是分析PHP代碼和判斷瓶頸或肯定代碼哪裏運行過慢須要使用加速器的強大分析器。Xdebug2的分析器輸出信息以cachegrind兼容文件造成表現。這能讓你使用優秀的KcacheGrind工具（Linux,KDE）來分析數據。若是你用Linux你能夠在你安裝管理器安裝它。

Windows下也有預編譯的QcacheGrind二進制安裝包可用（QCacheGrind 是KcacheGrind不捆綁KDE的版本）

若是你用Mac系統，這裏有介紹如何安裝QcacheGrind。

Windows用戶也能夠選擇使用WinCacheGrind。但其功能與KcacheGrind不同因此本文不在此介紹該軟件。Xdebug2.3出版時，WinCacheGrind當前仍不支持cachegrind壓縮功能和文件。

若是你不使用KDE(或不想用)，kcachegrind包也攜帶perl腳本「ct_annotate」能分析跟蹤文件輸出ASCII。

開始分析

Php.ini內設置xdebug.profiler_enable設爲1開啓分析。該設置命令xdebug啓用分析並寫入到 xdebug.profiler_output_dir指定的目錄中。而產生的文件名通常以」cachegrind.out」開頭，而後結尾跟着以PHP（或apache）進程PID（進程ID）或包含初始調試腳本目錄的crc32哈希值。確保你的xdebug.profiler_output_dir設置目錄有足夠的空間保存分析對複雜腳本分析生成龐大的分析數據。好比有500MB以上的複雜應用程序 eZ Publish。

你也能夠經過 xdebug.profiler_enable_trigger 設爲1手動開啓分析器。當它設爲1後，你能讓分析器使用名爲XDEBUG_PROFILE的變量利用到GET/POST 或者 COOKIE 值。 FireFox 2 擴展能用於開啓debugger (參考 HTTP Debug Sessions) 也能用於使用該設置。爲了觸發器能合理地運行， xdebug.profiler_enable 須要設爲0。

分析輸出

當產生分析結果後，你就能利用 KCacheGrind打開它：

                       

一旦打開了文件，KCacheGrind會有不一樣的面板提供充足的信息讓你參考。左側你能看到"Flat Profile"面板列出全部腳本函數並以花費 時間爲序，還包括了它的子函數時間。第二列"Self"顯示該函數（不包括子函數）花費的時間，第三列"Called"指被調用的頻度，最後一列」functions」顯示函數名稱。Xdebug改變PHP內部函數名並在函數名加前綴「php::」，而引用文件也在用指定的方式處理。呼叫include命令都跟隨「::」和引用的文件名. 左側截圖你能看到"include::/home/httpd/ez_34/v..." 和內存函數示例"php::mysql_query"。頭兩列的數量能以百分數表示總運行時間的佔比（看示例）或絕對時間（1單元表明1/1.000.000之一秒）。你能夠用右邊的按鈕來切換這兩種模式。

右邊的面板包含上層和下層兩面板。上層面板顯示哪一個函數調用了當前選擇的函數（截圖中"eztemplatedesignresource->executecompiledtemplate). 下層面板顯示已選擇的函數調用的函數列表。

上層面板的Cost列顯示當前選擇的函數在列表內被調用時花費的時間。該數字在Cost列一般是100%。下方面板Cost列顯示在列表中調用的函數所花費的時間。在這列的數字當中，你毫不看到達100%執行時間的函數。

"All Callers" 和 "All Calls"顯示不單單是函數分別執行的直接調用並且還顯示函數更多的上下級關係。截圖中的上層面板顯示當前選擇的函數調用的全部函數列，直接和間接關係的其餘函數都在堆棧中間。（翻譯能力有限……原句是這樣的：The upper pane in the screenshot on the left shows all functions calling the current selected one, both directly and indirectly with other functions inbetween them on the stack.）「Distance」列表明有多少函數呼叫在列表當中，而當前選擇 的爲（-1）。若是兩函數間有不一樣的距離，此外會顯示一範圍值（例如：「5-24」）。圓括號中的數字表明平均值。下方面板也是相似顯示，但不一樣的是它顯示當前選擇的函數調用的全部函數信息，無論是直接仍是間接的。

相關設置

 

xdebug.profiler_append

類型: integer, 默認值: 0

設爲1時，分析文件工做在新的請求下映射到相同的文件時（取決於xdebug.profiler_output_name）不會下覆蓋分析結果，而是分析信息附加到尾部造成新的分析文件。

 

xdebug.profiler_enable

類型: integer, 默認值: 0

開啓Xdebug的分析器能在profile output directory目錄中建立分析文件。這些文件能被KcacheGrind讀取而可視化分析數據。該設置不能使用ini_set()在腳本中設置。若是你要選擇性開啓分析器，能夠使用 xdebug.profiler_enable_trigger設置設爲1代替使用。

 

xdebug.profiler_enable_trigger

類型: integer, 默認值: 0

設爲1時，你就能使用XDEBUG_PROFILE的GET/POST參數或設置XDEBUG_RPOFILE的cookie值觸發分析文件的產生。這些寫入分析數到預約義的目錄中，爲了避免上分析文件在每次請求中產生，你須要設置xdebug.profiler_enable 爲0值。訪問觸發器可能過xdebug.profiler_enable_trigger_value配置。

 

xdebug.profiler_enable_trigger_value

類型: string, 默認值: "", 始於 Xdebug > 2.3

如xdebug.profiler_enable_trigger所述，該設置用於限制誰能利用XDEBUG_PROFILE功能。當改變本來的空字符串默認值後，cookie,GET或POST參數值須要匹配共享祕密集合並隨設置開啓分析器。

 

xdebug.profiler_output_dir

類型: string, 默認值: /tmp

該目錄爲分析文件輸出的地方，請確保運行PHP的帳戶能對該目錄有寫入權限。該設置不能用ini_set()在腳本中設置。

 

xdebug.profiler_output_name

類型: string, 默認值: cachegrind.out.%p

該設置決定分析文件的名稱，可以使用格式標識符指定，相似於sprintf() 和strftime()。有幾種標識符可格式化文件名。詳見參考xdebug.trace_output_name說明。

 

相關函數

 

string xdebug_get_profiler_filename()

返回當前保存的分析信息的文件名稱。