转:XDebug 配置与使用,WinCacheGrind 查看
XDebug是一个开放源代码的PHP程序调试器(即一个Debug工具),可以用来跟踪,调试和分析PHP程序的运行状况。是一个C语言扩展包(Windows下扩展名为.dll)。
XDebug 下载地址:
http://xdebug.org/download.php
WinCacheGrind 下载地址:
http://sourceforge.net/projects/wincachegrind/
1. 下载
以Windows环境下php5.2为例。去官方下载合适的XDebug版本,看下图,应该在前两个链接选择一个下载,这要取决于你的PHP5.2是否为非线程安全还是线程安全版,我这里是后者,因此选择红框标定的链接下载
下载后是一个dll文件,建议修改为更友好的文件名:php_xdebug.dll.
2. 配置
复制php_xdebug.dll到$php_installed_dir/ext目录下,修改php.ini,可以先设置如下选项:
- [Xdebug]
- extension=php_xdebug.dll
- xdebug.profiler_enable=on
- xdebug.trace_output_dir="d:\temp\xdebug"
- xdebug.profiler_output_dir="d:\temp\xdebug"
注:output_dir需要手工事先建好,否则不会生成profiler数据到该目录。
3. 测试安装成功
重新启动apache, 运行<?php phpinfo()?>,看到如下选项表明安装成功
4. 开始调试
1). Test Case1
- <?php
- require_once(\'empty.php\');
- ?>
运行结果
xdebug的输出文件格式(cachegrind.out)
xdebug的输出文件格式(cachegrind.out)
xdebug的性能测试输出文件名是可以配置的。
默认是 xdebug.profiler_output_name = cachegrind.out.%p
那个%p是服务器的pid,会输出“cachegrind.out.1408”之类的文件。
可能这样不太方便测试很多文件的网站。另外对于单一入口的文件名都是一样的.
网上看到的中文文章里面都没有关于这个参数的说明。
| %c | 当前工作目录的crc32校验值 | trace.%c | trace.1258863198.xt |
| %p | 当前服务器进程的pid | trace.%p | trace.5174.xt |
| %r | 随机数 | trace.%r | trace.072db0.xt |
| %s | 脚本文件名(注) | cachegrind.out.%s | cachegrind.out._home_httpd_html_test_xdebug_test_php |
| %t | Unix时间戳(秒) | trace.%t | trace.1179434742.xt |
| %u | Unix时间戳(微秒) | trace.%u | trace.1179434749_642382.xt |
| %H | $_SERVER[\'HTTP_HOST\'] | trace.%H | trace.kossu.xt |
| %R | $_SERVER[\'REQUEST_URI\'] | trace.%R | trace._test_xdebug_test_php_var=1_var2=2.xt |
| %S | session_id (来自$_COOKIE 如果设置了的话) | trace.%S | trace.c70c1ec2375af58f74b390bbdd2a679d.xt |
| %% | %字符 | trace.%% | trace.%.xt |
| 注 此项不适用于trace file的文件名 | |||
从上表可以找到一些适合你的参数。
比如,我想针对每个文件生成一个输出文件。
那么我可以用:
xdebug.profiler_output_name = cachegrind.out.%s
多个域名的话,也可以组合使用
xdebug.profiler_output_name = cachegrind.out.%H.%u.%s
=============================================================
使用Xdebug调试和优化PHP程序系列教程之Xdebug配置,根据Xdebug的官方文档来详细解释Xdebug的参数配置。
第一部分:安装
预编译模块
安装预编译模块是很容易的。只需要将它们放到一个目录中,并将下面的内容添加到php.ini中:(不要忘记更改路径和文件名为你自己的值,并确信你使用的是完整路)
zend_extension_ts = “c:/php/modules/php_xdebug.dll”
第二部分:基本特征:
相关参数设置
xdebug.default_enable
类型:布尔型 默认值:On
如果这项设置为On,堆栈跟踪将被默认的显示在错误事件中。你可以通过在代码中使用xdebug_disable()来禁止堆叠跟踪的显示。因为这是xdebug基本功能之一,将这项参数设置为On是比较明智的。
xdebug.max_nesting_level
类型:整型 默认值:100
The value of this setting is the maximum level of nested functions that are allowed before the script will be aborted.
限制无限递归的访问深度。这项参数设置的值是脚本失败前所允许的嵌套程序的最大访问深度。
第三部分:堆栈跟踪:
相关参数设置
xdebug.dump_globals
类型:布尔型 默认值:1
限制是否显示被xdebug.dump.*设置定义的超全局变量的值
例 如,xdebug.dump.SERVER = REQUEST_METHOD,REQUEST_URI,HTTP_USER_AGENT 将打印 PHP 超全局变量 $_SERVER[\'REQUEST_METHOD\']、$_SERVER[\'REQUEST_URI\'] 和 $_SERVER[\'HTTP_USER_AGENT\']。
xdebug.dump_once
类型:布尔型 默认值:1
限制是否超全局变量的值应该转储在所有出错环境(设置为Off时)或仅仅在开始的地方(设置为On时)
xdebug.dump_undefined
类型:布尔型 默认值:0
如果你想从超全局变量中转储未定义的值,你应该把这个参数设置成On,否则就设置成Off
xdebug.show_exception_trace
类型:整型 默认值:0
当这个参数被设置为1时,即使捕捉到异常,xdebug仍将强制执行异常跟踪当一个异常出现时。
xdebug.show_local_vars
类型:整型 默认值:0
当这个参数被设置为不等于0时,xdebug在错环境中所产生的堆栈转储还将显示所有局部变量,包括尚未初始化的变量在最上面。要注意的是这将产生大量的信息,也因此默认情况下是关闭的。
第四部分:分析PHP脚本
相关参数设置
xdebug.profiler_append
类型:整型 默认值:0
当这个参数被设置为1时,文件将不会被追加当一个新的需求到一个相同的文件时(依靠xdebug.profiler_output_name的设置)。相反的设置的话,文件将被附加成一个新文件。
xdebug.profiler_enable
类型:整型 默认值:0
开放xdebug文件的权限,就是在文件输出目录中创建文件。那些文件可以通过KCacheGrind来阅读来展现你的数据。这个设置不能通过在你的脚本中调用ini_set()来设置。
xdebug.profiler_output_dir
类型:字符串 默认值:/tmp
这个文件是profiler文件输出写入的,确信PHP用户对这个目录有写入的权限。这个设置不能通过在你的脚本中调用ini_set()来设置。
xdebug.profiler_output_name
类型:字符串 默认值:cachegrind.out%p
这个设置决定了转储跟踪写入的文件的名称。
第五部分:远程Debug
相关参数设置
xdebug.remote_autostart
类型:布尔型 默认值:0
一般来说,你需要使用明确的HTTP GET/POST变量来开启远程debug。而当这个参数设置为On,xdebug将经常试图去开启一个远程debug session并试图去连接客户端,即使GET/POST/COOKIE变量不是当前的。
xdebug.remote_enable
类型:布尔型 默认值:0
这个开关控制xdebug是否应该试着去连接一个按照xdebug.remote_host和xdebug.remote_port来设置监听主机和端口的debug客户端。
xdebug.remote_host
类型:字符串 默认值:localhost
选择debug客户端正在运行的主机,你不仅可以使用主机名还可以使用IP地址
xdebug.remote_port
类型:整型 默认值:9000
这个端口是xdebug试着去连接远程主机的。9000是一般客户端和被绑定的debug客户端默认的端口。许多客户端都使用这个端口数字,最好不要去修改这个设置。
注意:所有以上参数修改后,要重启Apache才能生效!
=======================================================
转自:Xdebug安装与使用
为什么需要Debugger?
很多PHP程序员调试使用echo、print_r()、var_dump()、printf()等,其实对 于有较丰富开发经验的程序员来说这些也已经足够了,他们往往可以在程序执行的过程中,通过输出特定变量的值可以判断程序执行是否正确,甚至效率高低也可以 看出来(当然可能还需要使用一些时间函数)。那么我们为什么还需要一个专门的调试程序来监控我们的程序运行呢? 这个问题的答案不妨留到后面来揭晓。
什么是Xdebug?
Xdebug是一个开放源代码的PHP程序调试器(即一个Debug工具),可以用来跟踪,调试和分析PHP程序的运行状况。
如何安装Xdebug?:
1. 打开http://www.xdebug.org/download.php下载相应的版本
Win: Windows binaries版本
Linux: source
得到一个dll文件(win)或运行安装文件(linux)
2. 安装
Win:将下载的dll文件放到相应的目录中。比如我的就放D:\xampp\php\ext下面;
Linux:执行安装文件
tar -xvzf xdebug-2.1.2.tgz
cd xdebug-2.1.2
phpize (如果phpize没有这个command,需要安装一次phpize。phpize可以让php支持扩展模块)安装phpize:sudo apt-get install php5-dev
如果安装了继续进行下面命令
./configure
make
make install
会有这个界面
cp modules/xdebug.so /usr/lib/php5/20090626+lfs 将xdebug.so文件移到php5下面
3. 编辑php.ini,加入下面几行:
[Xdebug]
zend_extension=D:\xampp\php\ext\php_xdebug.dll (Win)
zend_extension= /usr/lib/php5/20090626+lfs/xdebug.so (Linux)
xdebug.profiler_enable=on
xdebug.trace_output_dir="../Projects/xdebug"
xdebug.profiler_output_dir="../Projects/xdebug"
后面的目录“../Projects/xdebug”为你想要放置Xdebug输出的数据文件的目录,可自由设置。
4. 重启Apache;
5. 写一个test.php,内容为<?php phpinfo(); ?>,如果输出的内容中有看到xdebug,说明安装配置成功。如下图:
现在我们来从最简单的程序调试开始一步步介绍Xdebug。
调试:
我们先写一个可以导致执行出错的程序,例如尝试包含一个不存在的文件。
testXdebug.php
require_once(‘abc.php’);
?>
然后通过浏览器访问,我们惊奇地发现,出错信息变成了彩色的了:
不过除了样式改变,和我们平时打印的出错信息内容没什么不同,意义不大。好,我们继续改写程序:
testXdebug2.php
testXdebug();
function testXdebug() {
require_once(\'abc.php\');
}
?>
输出信息:
发现了什么? Xdebug跟踪代码的执行,找到了出错的函数testXdebug()。
我们把代码再写得复杂一些:
testXdebug3.php
testXdebug();
function testXdebug() {
requireFile();
}
function requireFile() {
require_once(\'abc.php\');
}
?>
输出信息:
也就是说Xdebug具有类似于Java的Exception的“跟踪回溯”的功能,可以根据程序的执行一步步跟踪到出错的具体位置,哪怕程序中的调用很复杂,我们也可以通过这个功能来理清代码关系,迅速定位,快速排错。
其实PHP函数debug_backtrace()也有类似的功能,但是要注意debug_backtrace()函数只在PHP4.3.0之后版本及PHP5中才生效。这个函数是PHP开发团队在PHP5中新增的函数,然后又反向移植到PHP4.3中。
如何利用Xdebug测试脚本执行时间
测试某段脚本的执行时间,通常我们都需要用到microtime()函数来确定当前时间。例如PHP手册上的例子:
/**
* Simple function to replicate PHP 5 behaviour
*/
function microtime_float()
{
list($usec, $sec) = explode(" ", microtime());
return ((float)$usec + (float)$sec);
}
$time_start = microtime_float();
// Sleep for a while
usleep(100);
$time_end = microtime_float();
$time = $time_end - $time_start;
echo "Did nothing in $time seconds\n";
?>
但是microtime()返回的值是微秒数及绝对时间戳(例如“0.03520000 1153122275”),没有可读性。所以如上程序,我们需要另外写一个函数microtime_float(),来将两者相加。
Xdebug自带了一个函数xdebug_time_index()来显示时间。
如何测定脚本占用的内存?
有时候我们想知道程序执行到某个特定阶段时到底占用了多大内存,为此PHP提供了函数memory_get_usage()。这个函数只有当PHP编译时使用了-enable-memory-limit参数时才有效。
Xdebug同样提供了一个函数xdebug_memory_usage()来实现这样的功能,另外xdebug还提供了一个xdebug_peak_memory_usage()函数来查看内存占用的峰值。
如何检测代码中的不足?
有时候代码没有明显的编写错误,没有显示任何错误信息(如error、warning、notice等),但是这不表明代码就是正确无误的。有时候可能某段代码执行时间过长,占用内存过多以致于影响整个系统的效率,我们没有办法直接看出来是哪部份代码出了问题。这时候我们希望把代码的每个阶段的运行情况都监控起来,写到日志文件中去,运行一段时间后再进行分析,找到问题所在。
回忆一下,之前我们编辑php.ini文件
加入
[Xdebug]
xdebug.profiler_enable=on
xdebug.trace_output_dir="I:\Projects\xdebug"
xdebug.profiler_output_dir="I:\Projects\xdebug"
这几行,目的就在于把执行情况的分析文件写入到”../Projects/xdebug”目录中去(你可以替换成任何你想设定的目录)。如果你执行某段程序后,再打开相应的目录,可以发现生成了一堆文件,例如cachegrind.out.1169585776这种格式命名的文件。这些就是Xdebug生成的分析文件。用编辑器打开你可以看到很多程序运行的相关细节信息,
最后:
Xdebug提供了各种自带的函数,并对已有的某些PHP函数进行覆写,可以方便地用于调试排错;Xdebug还可以跟踪程序的运行,通过对日志文件的分析,我们可以迅速找到程序运行的瓶颈所在,提高程序效率,从而提高整个系统的性能。
php调优过程
1、安装phpize
yum install php-devel
2、安装xdebug
cd /xdebug-2.2.4
phpize
./config --enable-xdebug
make && make install
3、修改/etc/php.ini文件,增加如下内容,以生成profile文件。(程序或软件保存的档案资料)
#[Xdebug]
#zend_extension="/usr/lib/php/modules/xdebug.so"
#xdebug.profiler_enable=on
#xdebug.trace_output_dir="/tmp/xdebug"
#xdebug.profiler_output_dir="/tmp/xdebug"
#xdebug.remote_enable=on
#xdebug.remote_handler=dbgp
注:xdebug 不用的时候一定要关掉,否则会很占磁盘空间,在etc/php.ini 中,xdebug 下第一行用分号注释掉
4、建立log 输出目录
5、重启apache
6、操作 被测的功能,在步骤4 指定的目录下生成profile 文件
7、使用winCacheGrind 工具对profile 文件进行分析,先找到耗时最长的php,然后再对耗时最长的php 进行分析,找到耗时最多的方法。
参考资料:
2、