skynet 自带了一个控制台服务,可以很方便获取和调试 skynet 运行数据,而且可以热更新代码,所以,弄明白skynet控制台管理可以让你更好地使用skynet,甚至改进这个控制台服务,以满足不同业务需求。
这个服务默认不会启动,需要你手动启动它,如下:
skynet.newservice("debug_console", 8000)
设计原因,调试控制台只监听本地地址 127.0.0.1 ,如果需要远程使用,需要先登录到本机,然后再连接。
使用时,通过 telnet 或 nc 登录调试控制台,启动后显示:
$ nc 127.0.0.1 8000
Welcome to skynet console
表示连接成功。
注:skynet控制台不能使用上下键回溯历史命令,退格键也不能使用(改用删除键)等等,这是由于 skynet 使用了自己的 IO 库,很难接入libreadline (不能在 readline 的 hook 中 yield)。如果希望在控制台中使用 readline 的 history 等特性,可以自己使用 rlwrap 。
这时,你可以输入调试指令,输入 help 可以列出目前支持的所有指令。(不同版本结果不同)
$ nc 127.0.0.1 8000
Welcome to skynet console
help
clearcache clear lua code cache
cmem Show C memory info
debug debug address : debug a lua service
exit exit address : kill a lua service
gc gc : force every lua service do garbage collect
help This help message
info Info address : get service infomation
inject inject address luascript.lua
kill kill address : kill service
list List all the service
logoff logoff address
logon logon address
mem mem : show memory status
service List unique service
signal signal address sig
snax lanuch a new snax service
start lanuch a new lua service
stat Dump all stats
task task address : show service task detail
命令的一般格式是 命令 地址 ,有些命令不带地址,会针对所有的服务。当输入地址时,可以使用 :01000001 这样的格式指代一个服务地址:由冒号开头的 8 位 16 进制数字,也可以省略前面两个数字的 harbor id 以及接下来的连续 0 ,比如 :01000001 可以简写为 1 。所有活动的服务可以输入 list 列出。
常用的通用指令:
list 列出所有服务,以及服务的启动参数。
gc 对所有 lua 服务执行gc,并列出gc后所有服务的内存情况。
mem 列出所有 lua 服务的内存占用情况。(注:只获取 lua 服务的 lua vm 内存占用情况,如果需要 C 模块中内存使用情况,使用cmem。)
stat 列出所有 lua 服务的消息队列长度,以及被挂起的请求(协程)数量。
service 列出所有的唯一 lua 服务。
注意,由于这些指令是逐个向每个服务发送消息并等待回应,所以当某个 lua 服务过载时,可能需要等待很长时间才有返回。
针对单个 lua 服务的指令:
exit address 退出指定 lua 服务
kill address 强制中止指定 lua 服务。
info address 让指定 lua 服务输出自己的内部信息(数据通过回调服务内 skynet.info_func 生成)
signal address sig 向服务发送一个信号,sig 默认为 0 。当一个服务陷入死循环时,默认信号会打断正在执行的 lua 字节码,并抛出 error 显示调用栈。这是针对 endless loop 的 log 的有效调试方法。(注:这里的信号并非系统信号。)
task address 显示一个服务中所有被挂起的请求的调用栈。
debug address 针对一个 lua 服务启动内置的单步调试器。http://blog.codingnow.com/2015/02/skynet_debugger.html
logon/logoff address 记录一个服务所有的输入消息(source, type, session, data, size)到文件。(生成文件的路径地址取配置 logpath) 。
inject address script 将 script 对应的脚本插入到指定服务中运行(通常可用于热更新补丁)。
这里重点说下info address 和inject address script,这两个命令很重要。
获取服务内部数据 - info address
前面提到,这个命令让指定 lua 服务输出自己的内部信息,数据通过回调服务内 skynet.info_func 生成。
下面以 example/simpledb.lua做说明,这是个典型的skynet服务。
启动example例子,连接控制台:
代码热更新 - inject address script
前面提到,这个命令将 script 对应的脚本插入到指定服务中运行
下面写个简单的inject例子,保存为 example/inject_simpledb.lua
启动example例子,连接控制台: