开发者社区> thinkyoung> 正文
阿里云
为了无法计算的价值
打开APP
阿里云APP内打开

通过SocketLog快速分析OneThink程序

简介: 通过SocketLog快速分析OneThink程序 http://www.thinkphp.cn/topic/10846.html   浏览:2332 发布日期:2014/02/08 分类:技术分享 正在运行的API有bug,不能var_dump进行调试,因为会影响client的调用。
+关注继续查看

通过SocketLog快速分析OneThink程序

http://www.thinkphp.cn/topic/10846.html

 
浏览:2332 发布日期:2014/02/08 分类:技术分享
正在运行的API有bug,不能var_dump进行调试,因为会影响client的调用。这时候用SocketLog最好,SocketLog通过websocket将调试日志打印到浏览器的console中。你还可以用它来分析开源程序,分析SQL性能,结合taint分析程序漏洞。 

我将演示如何用SocketLog分析OneThink程序, SocketLog的项目地址:https://github.com/luofei614/SocketLog 

#说明
* SocketLog方便API,AJAX的调试,能将日志通过WebSocket输出到Chrome浏览器的console中
* 它能代替ChromePHP、FirePHP等工具,ChromePHP等是通过header通信,适合AJAX调试,但不适合API调试,而且它们是通过Header通信,Chrome浏览器对传递Header大小有限制,日志如果多了,Chrome浏览器就无法支持。
* 目录结构:
* chrome 目录是 chrome插件的源代码
* chrome.crx 文件是chrome插件的安装包, 目前插件还没有上架到Chrome App Store, 大家需要手动安装, 浏览器地址栏输入并打开: chrome://extensions/ ,然后将chrome.crx拖入即可安装。
* php 目录是php相关脚本。 SocketLog.server.php 是一个 Websocket服务器, SocketLog.class.php是发送日志的类库,我们在发送日志的时候,需要载入这个类库然后调用函数slog即可。
* 效果展示: 我们在浏览网站的时候在浏览器console中就知道程序做了什么,这对于二次开发产品十分有用。 下面效果图在console中打印出浏览discuz程序时,执行了哪些sql语句, 以及执行sql语句的调用栈。程序的warning,notice等错误信息也可以打到console中。



#使用方法
* 首先,请在chrome浏览器上安装好插件。
* 然后,启用Websocket服务, 在命令行中运行 `php php/SocketLog.server.php` , 将会在本地起一个websocket服务 ,监听端口是1229 。 如果想服务后台运行: `nohup php php/SocketLog.server.php > /dev/null &`
* 在自己的程序中发送日志:
  1.        <?php
  2.         include './php/SocketLog.class.php';
  3.         slog('hello world');
  4.         ?>
复制代码
* 用slog函数发送日志, 支持多种日志类型:
  1.         slog('msg','log');  //一般日志
  2.         slog('msg','error'); //错误日志
  3.         slog('msg','info'); //信息日志
  4.         slog('msg','warn'); //警告日志
  5.         slog('msg','trace');// 输入日志同时会打出调用栈
  6.         slog('msg','alert');//将日志以alert方式弹出
  7.         slog('msg','log','color:red;font-size:20px;');//自定义日志的样式,第三个参数为css样式
复制代码
* 通过上面例子可以看出, slog函数支持三个参数:
* 第一个参数是日志内容,日志内容不光能支持字符串哟,大家如果传递数组,对象等一样可以打印到console中。
* 第二个参数是日志类型,可选,如果没有指定日志类型默认类型为log, 第三个参数是自定样式,在这里写上你自定义css样式即可。

##配置
* 在载入SocketLog.class.php文件后,还可以对SocketLog进行一些配置。
* 例如:我们如果想将程序的报错信息页输出到console,可以配置
  1.         <?php
  2.         include './php/SocketLog.class.php';
  3.         slog(array(
  4.         'error_handler'=>true
  5.         ),'set_config');
  6.         echo notice;//制造一个notice报错
  7.         slog('这里是输出的一般日志');
  8.         ?>
复制代码
* 配置SocketLog也是用slog函数, 第一个参数传递配置项的数组,第二个参数设置为set_config
* 还支持其他配置项
  1.         <?php
  2.         include './php/SocketLog.class.php';
  3.         slog(array(
  4.         'host'=>'localhost',//websocket服务器地址,默认localhost
  5.         'port'=>'1229',//websocket服务器端口,默认端口是1229
  6.         'optimize'=>false,//是否显示利于优化的参数,如果运行时间,消耗内存等,默认为false
  7.         'show_included_files'=>false,//是否显示本次程序运行加载了哪些文件,默认为false
  8.         'error_handler'=>false,//是否接管程序错误,将程序错误显示在console中,默认为false
  9.         'force_client_id'=>'',//日志强制记录到配置的client_id,默认为空
  10.         'allow_client_ids'=>array()////限制允许读取日志的client_id,默认为空,表示所有人都可以获得日志。
  11.         )
  12.         ,'set_config');
  13.         ?>
复制代码
* optimize 参数如果设置为true, 可以在日志中看见利于优化参数,如:`[运行时间:0.081346035003662s][吞吐率:12.29req/s][内存消耗:346,910.45kb]` 
* show_included_files 设置为true,能显示出程序运行时加载了哪些文件,比如我们在分析开源程序时,如果不知道模板文件在那里, 往往看一下加载文件列表就知道模板文件在哪里了。
* error_handler 设置为true,能接管报错,将错误信息显示到浏览器console, 在开发程序时notice报错能让我们快速发现bug,但是有些notice报错是不可避免的,如果让他们显示在页面中会影响网页的正常布局,那么就设置error_handler,让它显示在浏览器console中吧。 另外此功能结合php taint也是极佳的。 taint能自动检测出xss,sql注入, 如果只用php taint, 它warning报错只告诉了变量输出的地方,并不知道变量在那里赋值、怎么传递。通过SocketLog, 能看到调用栈,轻松对有问题变量进行跟踪。 更多taint的信息:http://www.laruence.com/2012/02/14/2544.html 
* 设置client_id: 在chrome浏览器中,可以设置插件的Client_ID ,Client_ID是你任意指定的字符串。

* 设置client_id后能实现以下功能:

* 1,配置allow_client_ids 配置项,让指定的浏览器才能获得日志,这样就可以把调试代码带上线。 普通用户访问不会触发调试,不会发送日志。 开发人员访问就能看的调试日志, 这样利于找线上bug。 Client_ID 建议设置为姓名拼命加上随机字符串,这样如果有员工离职可以将其对应的client_id从配置项allow_client_ids中移除。 client_id除了姓名拼音,加上随机字符串的目的,以防别人根据你公司员工姓名猜测出client_id,获取线上的调试日志。
* 设置allow_client_ids示例代码:
  1.         slog(array(
  2.         'allow_client_ids'=>array('luofei_zfH5NbLn','easy_DJq0z80H')
  3.         ),'set_config')
复制代码
* 2, 设置force_client_id配置项,让后台脚本也能输出日志到chrome。 网站有可能用了队列,一些业务逻辑通过后台脚本处理, 如果后台脚本需要调试,你也可以将日志打印到浏览器的console中, 当然后台脚本不和浏览器接触,不知道当前触发程序的是哪个浏览器,所以我们需要强制将日志打印到指定client_id的浏览器上面。 我们在后台脚本中使用SocketLog时设置force_client_id 配置项指定要强制输出浏览器的client_id 即可。
* 示例代码:
  1.         <?php
  2.         include './php/SocketLog.class.php';
  3.         slog(array(
  4.         'force_client_id'=>'luofei_zfH5NbLn'
  5.         ),'set_config');
  6.         slog('test'); `
复制代码
##对数据库进行调试
* SocketLog还能对sql语句进行调试,自动对sql语句进行explain分析,显示出有性能问题的sql语句。 如下图所示。 

* 图中显示出了三条sql语句 , 第一条sql语句字体较大,是因为它又性能问题, 在sql语句的后台已经标注Using filesort。 我们还可以点击某个sql语句看到sql执行的调用栈,清楚的知道sql语句是如何被执行的,方便我们分析程序、方便做开源程序的二次开发。图中第三条sql语句为被点开的状态。
* 用slog函数打印sql语句是,第二个参数传递为mysql或mysqli的对象即可。 示例代码:
  1.         $link=mysql_connect( 'localhost:3306' , 'root' , '123456' , true ) ;
  2.         mysql_select_db('kuaijianli',$link);
  3.         $sql="SELECT * FROM `user`";
  4.         slog($sql,$link);
复制代码
后面会以OneThink为实例再对数据库调试进行演示。

* 注意,有时候在数据比较少的情况下,mysql查询不会使用索引,explain也会提示Using filesort等性能问题, 其实这时候并不是真正有性能问题, 你需要自行进行判断,或者增加更多的数据再测试。

##对API进行调试
网站调用了API ,如何将API程序的调试信息也打印到浏览器的console中? 前面我们讲了一个配置 force_client_id, 能将日志强制记录到指定的浏览器。 用这种方式也可以将API的调试信息打印到console中,但是force_client_id 只能指定一个client_id, 如果我们的开发环境是多人共用,这种方式就不方便了。
其实只要将浏览器传递给网站的User-Agent 再传递给API, API程序中不用配置force_client_id, 也能识别当前访问程序的浏览器, 将日志打印到当前访问程序的浏览器, 我们需要将SDK代码稍微做一下修改。 调用API的SDK,一般是用curl写的,增加下面代码可以将浏览器的User-Agent传递到API 。 
  1.         $headers=array(
  2.                 'User-Agent: '.$_SERVER['HTTP_USER_AGENT']
  3.             );
  4.         curl_setopt($ch,CURLOPT_HTTPHEADER,$headers); 
复制代码
##分析开源程序

有了SocketLog,我们能很方便的分析开源程序,下面以OneThink为例, 大家可以在 http://www.onethink.cn/ 下载最新的OneThink程序。 安装好OneThink后,按下面步骤增加SocketLog程序。 

* 将SocketLog.class.php复制到OneThink的程序目录中,你如果没有想好将文件放到哪个子文件夹,暂且放到根目录吧。 
* 编辑入口文件index.php, 再代码的最前面加载SocketLog.class.php ,并设置SocketLog

  1.         <?php
  2.             include './SocketLog.class.php';
  3.             slog(array(
  4.              'error_handler'=>true,
  5.              'optimize'=>true,
  6.              'show_included_files'=>true
  7.             ),'set_config');
复制代码
- 编辑ThinkPHP/Library/Think/Db/Driver/Mysqli.class.php 文件, 如果你用的数据库驱动类型不是mysqli,而是mysql,那么请打开Mysql.class.php, 找到执行sql语句的地方, 这个类中得execute 方法为一个执行sql语句的方法,大约在119行处,增加代码:
  1.         slog($this->queryStr,$this->_linkID);
复制代码
- 类中的query方法也是一个执行sql语句的地方, 同样需要增加上面的代码, 大约在92行增加slog($this->queryStr,$this->_linkID);

- 然后浏览网站看看效果: 


通过console的日志,访问每一页我们都知道程序干了什么,是一件很爽的事情。

- 提示:另一种更简单的方法,因为OneThink每次执行完sql语句都会调用$this->debug, 所以我们可以把slog($this->queryStr,$this->_linkID); 直接写在 Db.class.php文件的debug方法中。 这样不管是mysqli还是mysql驱动都有效。

##About Me
Author: @luofei614 新浪微博:http://weibo.com/luofei614
快简历CTO,ThinkPHP核心开发者之一,待过新浪云计算
如果你觉得SocketLog对你有帮助, 以后找工作就用快简历吧:http://rd.kuaijianli.com

附件 socketlog.zip ( 71.83 KB 下载:34 次 )

版权声明:本文内容由阿里云实名注册用户自发贡献,版权归原作者所有,阿里云开发者社区不拥有其著作权,亦不承担相应法律责任。具体规则请查看《阿里云开发者社区用户服务协议》和《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容,填写侵权投诉表单进行举报,一经查实,本社区将立刻删除涉嫌侵权内容。

相关文章
通过 XShell 远程连接 Ubuntu
通过 XShell 远程连接 Ubuntu
37 0
RocketMQ高手之路系列之七:RocketMQ之消息发送(四)
本文主要阐述了消息发送的基本流程。其中包括了获取Broker地址、设置全局ID、构建请求包以及发送消息了。在下篇文章中我们继续来看消息发送的底层流程。
89 0
RocketMQ 学习之路 | 第一章 :RocketMQ 的安装与配置
一:RocketMQ 简介 RocketMQ 是一款分布式、队列模型的消息中间件,具有以下特点: 能够保证严格的消息顺序。 提供丰富的消息拉取模式。 高效的订阅者水平扩展能力。 实时的消息订阅机制。
3718 0
AspNetCore-MVC实战系列(二)之通过绑定邮箱找回密码
AspNetCore - MVC实战系列目录 . 爱留图网站诞生 . git源码:https://github.com/shenniubuxing3/LovePicture.Web . AspNetCore - MVC实战系列(一)之Sqlserver表映射实体模型 .
1317 0
OTG驱动分析(二)
<div style="word-wrap: break-word; color: rgb(102, 102, 102); font-family: 宋体, Arial; font-size: 16px; line-height: 26px;">上回介绍了OTG功能的 OTG部分驱动,本片分析OTG功能的从设备部分驱动。从设备的注册过程和OTG的一样,首先注册设备。</div> <div st
1469 0
Clank – 快速构建移动 APP 原型的 HTML/CSS 框架
  Clank 是一个自由和开放源码的 HTML/CSS 框架,可以帮助你轻松创建本地手机或平板电脑应用程序的原型。它着重于提供一致的用户界面,不会刻意去模仿一个特定的 OS 。该框架是基于组件的,这样我们就可以选择和使用所需的部分,组件包括按钮,表格,滑块,切换等等。
684 0
Easy UI 遮罩(MASK)
Easy UI 的各类控件有些带了遮罩功能,如 DataGrid,可以这样使用: //显示遮罩 $("#dg").datagrid("loading", "数据加载中……"); //隐藏遮罩 $("#dg").datagrid("loaded"); 在有些情况下,我们不能直接使用控件本身的遮罩效果,比如: 1:有些控件则没有这样的属性,比如 Tabs; 2:页面初始加载时; 3:通过 Ajax 异步获取数据并刷新当前页面; 这个时候,就要采用另外的办法来进行遮罩。
748 0
+关注
文章
问答
文章排行榜
最热
最新
相关电子书
更多
小程序 大世界
立即下载
15分钟打造你自己的小程序
立即下载
《15分钟打造你自己的小程序》
立即下载