XDebug介绍

 
问题：
0. 如何调试代码？
1. 如何分析脚本性能瓶颈？
 
====================================================
 
一、XDebug 基本功能：
 
官方文档： https://xdebug.org/docs/
 
XDebug 是一个开放源代码的 PHP Debug 工具，可以用来跟踪，调试和分析 PHP 程序的运行状况。
 
基本功能：
  1. Variable Display Features
         Xdebug 能替代 PHP 的 var_dump() 函数来显示变量值。
         xdebug 的版本包含对不同数据类型作数组元素/对象属性、最大深度和字符串长度以不同颜色标识。
       
             
        
  1. Stack Traces
         当 xdebug 激活时，PHP 一旦要显示通知、警告或错误时，xdebug 显示堆栈跟踪信息。
 
  1. Function Traces
         Xdebug 能让你把所有函数调用，包括参数和返回值以不同的格式记录到文件中。
 
  1. Code Coverage Analysis
         代码覆盖分析能在请求时让你知道脚本哪一行（或哪一段）在执行。
 
  1. Remote Debugging
        Xdebug 的远程调试器允许你检查数据结构，交互式地调试代码。
 
  1. Profiling PHP Scripts
         使用 Xdebug 的内置分析分析 PHP 脚本中的瓶颈，并使用外部工具 KcacheGrind 或 WinCacheGrind 、webgrind 进行可视化。
 
 
 
二、XDebug 安装：
https://xdebug.org/docs/install
略...
 
 
 
三、远程调试 Remote Debugging：
 
1、支持的客户端：
 
2、主要配置：
https://xdebug.org/docs/remote
 
xdebug.remote_enable
是否开启远程调试
xdebug.remote_host
指定远程调试主机名
xdebug.remote_port
指定远程调试端口号
xdebug.remote_autostart
是否自动开启调试。
手动：
POST/GET ： XDEBUG_SESSION_START=客户端标识
COOKIE: XDEBUG_SESSION=客户端标识
xdebug.idekey
指定与 XDebug 通过 DBGp 通讯的 IDE key
xdebug.remote_connect_back
忽略 xdebug.remote_host，连接 $_SERVER['REMOTE_ADDR']
 
xdebug.remote_enable = 1
xdebug.remote_host = 192.168.9.136
xdebug.remote_port = 13000
xdebug.remote_autostart = 1
xdebug.idekey = MAPI
 
3、PhpStorm 配置：
http://www.jetbrains.com/help/phpstorm/configuring-xdebug.html
 
 
4、远程调试工作方式：
 
(1) 单人调试
 
 
(2) 多人调试
 
 
 
5、 灰度环境 xdebug 配置：
 
 
 
四、PHP 脚本分析：
 
1、主要配置：
https://xdebug.org/docs/profiler
 
xdebug.profile_enable
自动开启 xdebug 分析
xdebug.profiler_enable_trigger
手动触发开启 xdebug 分析
触发变量：XDEBUG_PROFILE （GET/POST/COOKIE）
xdebug.profiler_enable_trigger_value
手动触发开启 xedebug 分析的变量值，默认值为 ""
xdebug.profiler_output_dir
分析文件的输出目录
xdebug.profiler_output_name
分析文件的文件名
 
xdebug.profiler_enable = 0
xdebug.profiler_enable_trigger = 1
xdebug.profiler_output_dir = /mnt/hgfs/www/xdebug_log/
 
 
2、可视化工具：
 
(1) KCacheGrind
平台： Linux
https://kcachegrind.github.io/html/Home.html
 
(2) QCacheGrind
平台：windows、Mac OSX
https://sourceforge.net/projects/qcachegrindwin/
 
(3) WinCacheGrind
平台：windows
http://ceefour.github.io/wincachegrind/
 
(4) webGrind
平台：全平台
https://github.com/jokkedk/webgrind
 
 
测试链接：
http://webgrind.mama.cn
 
 
 
 
 
 
 
 
 
 
配置参数选项参数值类型与默认值参数选项描述
xdebug.auto_trace boolean类型，默认值=0 是否在脚本运行之前自动调用相关追踪函数。
xdebug.cli_color integer类型，默认值=0 该参数自2.2版本开始引入。如果值=1，当处于CLI模式或连接虚拟控制台时，Xdebug将高亮显示var_dumps()和堆栈输出，；在Windows中，这需要安装ANSICON工具。如果值=2，不管是否处于CLI模式或连接虚拟控制台，Xdebug都会高亮显示var_dumps()或堆栈输出；这种情况下，你可能会看到转义后的代码。
xdebug.collect_assignments boolean类型，默认值=0 该参数自2.1版本开始引入。用于控制是否为函数跟踪添加变量赋值功能。
xdebug.collect_includes boolean类型，默认值=1 控制是否在跟踪文件中写入include()、include_once()、require()、require_once()等函数中用到的文件名。
xdebug.collect_params integer类型，默认值=0

控制在调用函数时，是否收集传递给函数的参数信息。如果参数值过大，这可能会占用大量的内存；不过，在Xdebug 2中不会出现该问题，因为Xdebug 2将相关数据写入磁盘中，而不是占用内存。

如果值=0，则不显示任何信息。
如果值=1，只显示类型和大小信息，例如：string(6)、array(8)。
如果值=2，将显示类型和大小，以及全部信息的工具提示。
如果值=3，将显示变量的全部内容。
如果值=4，将显示变量的全部内容和变量名。
xdebug.collect_return boolean类型，默认值=0 控制是否在追踪文件中写入函数调用的返回值。
xdebug.collect_vars boolean类型，默认值=0 控制是否收集指定作用域中的变量信息。由于需要反向工程PHP的操作码数组，因此Xdebug的分析速度可能比较慢。
xdebug.coverage_enable boolean类型，默认值=1 该参数自2.2版本开始引入。控制是否允许通过设置内部结构来启用代码覆盖率功能。
xdebug.default_enable boolean类型，默认值=1 当发生异常或错误时，是否默认显示堆栈信息。
xdebug.dump.* string类型，默认值=Empty 这里的*可以是COOKIE, FILES, GET, POST, REQUEST, SERVER, SESSION中的任意一个。用于指定发生错误时是否显示超全局变量数组中的索引变量信息。比如，你想要显示请求的IP地址和请求方式，可以设置为
xdebug.dump.SERVER=REMOTE_ADD,REQUEST_METHOD
多个索引变量用英文逗号隔开，如果要输出其中的所有变量，可以直接用*，例如：
xdebug.dump.GET=*
xdebug.dump_globals boolean类型，默认值=1 控制是否显示通过xdebug.dump.*定义的所有超全局变量的信息。
xdebug.dump_once boolean类型，默认值=1 如果出现多个错误，控制超全局变量信息是在所有错误中显示，还是只在第一个错误中显示。
xdebug.dump_undefined boolean类型，默认值=1 控制是否显示超全局变量中未定义的值。
xdebug.extended_info integer类型，默认值=1 是否强制进入PHP解析器的"extended_info"模式，这将允许Xdebug以远程调试器对文件或行添加断点。开启此模式将拖慢脚本的允许速度，该参数只能在php.ini中设置。
xdebug.file_link_format string类型，默认值=, 自2.2版本开始引入。用于指定堆栈信息中用到的文件名称的链接样式，这允许IDE通过设置链接协议，直接点击堆栈信息中的文件名称，即可快速打开指定的文件。例如：ZendStudio://%f@%l(%f表示文件路径，%f表示行号)。
xdebug.force_display_errors integer类型，默认值=0 自2.3版本开始引入。是否强制显示错误信息。
xdebug.force_error_reporting integer类型，默认值=0 自2.3版本开始引入。是否强制显示所有错误级别的信息。
xdebug.halt_level integer类型，默认值=0 自2.3版本开始引入。指定出现那些错误级别的错误时，中止程序运行。例如：xdebug.halt_level=E_WARNING|E_NOTICE|E_USER_WARNING|E_USER_NOTICE(也仅支持上述4种错误级别)。
xdebug.idekey string类型，默认值=*complex* 指定传递给DBGp调试器处理程序的IDE Key。
xdebug.manual_url string类型，默认值=http://www.php.net 仅2.2.1以下版本可用，用于指定从函数堆栈和错误信息链接到的帮助手册的基本URL。
xdebug.max_nesting_level integer类型，默认值=100 指定递归的嵌套层级数。
xdebug.overload_var_dump boolean类型，默认值=1 自2.2版本开始引入，当php.ini中的html_error设为1时，Xdebug是否默认使用自身的改进版本来重载var_dump()。
xdebug.profiler_append integer类型，默认值=0 当多个请求映射到相同文件时，指定是覆盖之前的调试信息文件还是追加内容到该文件中。
xdebug.profiler_enable integer类型，默认值=0 指定是否启用Xdebug的性能分析，并创建性能信息文件。
xdebug.profiler_output_dir string类型，默认值=/tmp 指定性能分析信息文件的输出目录
xdebug.profiler_output_name string类型，默认值=cachegrind.out.%p 指定性能分析信息文件的名称
xdebug.remote_enable boolean类型，默认值=0 是否开启远程调试
xdebug.remote_handler string类型，默认值=dbgp 指定远程调试的处理协议
xdebug.remote_host string类型，默认值=localhost 指定远程调试的主机名
xdebug.remote_log string类型，默认值= 指定远程调试的日志文件名
xdebug.remote_mode string类型，默认值=req 可以设为req或jit，req表示脚本一开始运行就连接远程客户端，jit表示脚本出错时才连接远程客户端。
xdebug.remote_port integer类型，默认值=9000 指定远程调试的端口号
xdebug.trace_options integer类型，默认值=0 指定对于之后的请求，追踪文件是追加内容还是覆盖之前内容。
xdebug.trace_output_dir string类型，默认值=/tmp 指定追踪文件的存放目录
xdebug.trace_output_name
 string类型，默认值=trace.%c 指定追踪文件的名称
 
 
 
 
 
 

posted on 2017-06-09 17:32  科比08  阅读(500)  评论(0)  编辑  收藏  举报

导航