openstack调试
对于开源的openstack而言,调试显然非常重要,在调试的过程中,我们可以跟踪代码的执行过程,对于我们理解openstack的结构和框架有十分重要的意义。在之前的教程中提到的使用devstack工具在虚拟机中安装部署openstack,通常虚拟机运行会有点卡,为了不让虚拟机那么卡,我们抛弃了较大的python IDE(pycharm和eclipse等)。使用的是最为常见的python代码调试手段-PDB。
使用PDB调试openstack代码只需在我们希望设置断点的地方加上下面的两行代码:
import pdb
pdb.set_trace ()
然后在screen窗口中重启相应的服务即可,代码就会停止在这两行代码所在的地方,然后我们可以使用pdb提供的命令进行调试,常用的pdb命令如下所示:
s(tep) 单步调试,执行当前的行,遇到函数则进入
n(ext) 单步调试,执行到下一行。step和next的区别的step遇到函数会进入函数内部,而next直接运行到当前代码的下一行,执行完step进入的整个函数
c(ontinue) 继续执行,直到遇到下一个断点,若后面没有断点,直接执行完整个代码
r(eturn) 继续执行,直到当前函数返回
pp 表达式 打印变量的值
l(ist) 查看当前行的代码段
a(rgs) 查看当前函数的参数列表,很有用
b(reak) 设置断点,在python程序执行过程中可以随时设置断点
更多的可以参考pdb的官方文档:https://docs.python.org/2/library/pdb.html
下面我们将演示如何调试openstack/nova子项目中的keypairs.py,具体路径在/opt/stack/nova/nova/api/openstack/compute/keypairs.py
打开keypairs.py,在2.10对应的版本(由于我的nova-compute的版本是2.10)中加入前面的两行代码,如下所示:
我们在196和197行上加了两行代码,完了之后保存一下。把/opt/stack/nova/nova/api/openstack/compute/keypairs.pyc文件备份一下,改个名称就好了,这里我们把它改成keypairs_backup.pyc,以便以后需要时可以找回。
然后使用python的py_compile的compile方法把keypairs.py编译一下,编译成keypairs.pyc,因为openstack中直接使用的是pyc文件而不是py文件,这样可以加快速度。
如下所示:
我们会发现在当前目录下多了一个keypairs.pyc文件。
由于我们使用的是devstack安装部署的openstack,因此可以在devstack目录下执行 screen -x stack 打开screen窗口,不懂得可以查看我之前的教程http://www.cnblogs.com/uestcjoel/p/5987020.html
切换到n-api*窗口之后,使用ctrl+c关闭,使用向上键找到nova api开启的命令(/usr/local/bin/nova-api & echo $! >/opt/stack/status/stack "/opt/stack/status/stack/n-api.failure"
),按回车等待执行就好。重启nova api服务后,可以看到如图所示的画面:
为了观看方便,我们先使用nova keypair-add keypair-d20a3d59-9433-4b79-8726-20b431d89c78创建一个名为keypair-d20a3d59-9433-4b79-8726-20b431d89c78的keypair,之后使用
nova keypair-show keypair-d20a3d59-9433-4b79-8726-20b431d89c78命令查看这个keypair。
由于我们在keypairs.py中的show中设置了断点,因此程序会停留在被设置的断点处,我们可以在screen窗口中看到,如下所示:
之后我们便可以像调试一般的pyhton程序一样调试keypairs.py中的代码,例如可以使用l查看当前代码段:
至此,我们学习了如何在pdb中调试openstack nova代码,具体的执行细节可以使用pdb命令s跟下去。