原文 2016-01-07 01:14:27 发表于 CSDN,这里对以前写的文章做下收录。
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 服务启动内置的单步调试器。 |
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 服务。
local skynet = require "skynet" require "skynet.manager" -- import skynet.register local db = {} local command = {} function command.GET(key) return db[key] end function command.SET(key, value) local last = db[key] db[key] = value return last end -- 新增的代码 -- start skynet.info_func(function() return "hello cwqqq!" end) -- 新增的代码 -- end skynet.start(function() skynet.dispatch("lua", function(session, address, cmd, ...) local f = command[string.upper(cmd)] if f then skynet.ret(skynet.pack(f(...))) else error(string.format("Unknown command %s", tostring(cmd))) end end) skynet.register "SIMPLEDB" end)
启动example例子, 连接控制台,
$ nc 127.0.0.1 8000 Welcome to skynet console list :00000004 snlua cmaster :00000005 snlua cslave :00000007 snlua datacenterd :00000008 snlua service_mgr :0000000a snlua protoloader :0000000b snlua console :0000000c snlua debug_console 8000 :0000000d snlua simpledb :0000000e snlua watchdog :0000000f snlua gate OK info :0000000d hello cwqqq!
代码热更新 - inject address script
前面提到,这个命令将 script 对应的脚本插入到指定服务中运行
下面写个简单的 inject 例子,保存为 example/inject_simpledb.lua
if not _P then print "inject error!!" return end local command = _P.lua.command command.TEST = function() return "TEST" end print "inject ok!"
启动 example 例子, 连接控制台,
$ nc 127.0.0.1 8000 Welcome to skynet console list :00000004 snlua cmaster :00000005 snlua cslave :00000007 snlua datacenterd :00000008 snlua service_mgr :0000000a snlua protoloader :0000000b snlua console :0000000c snlua debug_console 8000 :0000000d snlua simpledb :0000000e snlua watchdog :0000000f snlua gate OK inject :0000000d example/inject_simpledb.lua inject ok!
使用 rlwrap 强化控制台
前面提到了skynet 控制台不能使用上下键回溯历史命令,退格键也不能使用等,为了弥补这个不足,可以使用 rlwrap
这里以 centos 做说明, rlwrap 依赖 readline,系统必须装有 readline , 在现有很多linux系统,readline 都可自动化安装:
yum -y install readline-devel
rlwrap 则需要手动安装,安装很简单,如下:
wget https://github.com/hanslub42/rlwrap/releases/download/0.46.1/rlwrap-0.46.1.tar.gz tar -zxf rlwrap-0.46.1.tar.gz cd rlwrap-0.46.1 ./configure make && make install
以后,skynet 控制台的连接方式改成这样,就可以回溯命令了。
$ rlwrap nc 127.0.0.1 8000 Welcome to skynet console list :01000004 snlua cmaster :01000005 snlua cslave :01000007 snlua datacenterd :01000008 snlua service_mgr :0100000a snlua protoloader :0100000b snlua console :0100000c snlua debug_console 8000 :0100000d snlua simpledb :0100000e snlua watchdog :0100000f snlua gate OK
最后,这里列举 rlwrap 常用的快捷键:
Ctrl+L 清屏,实际是将当前行置顶
Ctrl+P 上一条命令
Ctrl+N 下一条命令
Ctrl+U 从光标处删除到行首
Ctrl+W 向前删除一个单词
Ctrl+B 光标向前移动一个位置
Ctrl+T 光标处字符与前一个字符交换位置
Ctrl+Z 后台运行,使用fg调出
Ctrl+H 相当于删除键
Ctrl+J 相当于回车键
Ctrl+O 相当于回车键
Ctrl+M 相当于回车键
参考:
https://github.com/cloudwu/skynet/wiki/DebugConsole