如何在Jitsi的Prosody插件Lua文件中添加日志及排查相关问题

前置基础疑问解答 #

• 这些Lua模块文件完全运行在Prosody服务端，属于Prosody的扩展插件，Prosody启动时会加载已启用的模块，所有逻辑都在Prosody进程内执行。
• 新增的Prosody模块和Jicofo的关联分两种情况：如果模块涉及修改MUC房间规则、用户入会逻辑、权限校验等核心会议流程，大概率会和Jicofo产生交互——Jicofo会通过XMPP信令和Prosody通信，触发对应模块的事件回调；如果是纯自定义的独立逻辑，也可以做到不依赖Jicofo运行。

如何在Prosody Lua模块中添加日志、查看日志 #

1. Prosody内置了日志能力，不需要额外引入依赖，直接在代码中调用对应级别的日志方法即可，可用的日志级别从低到高为：debug、info、warn、error。
2. 日志写法示例，以mod_muc_allowners.lua为例，直接在对应逻辑位置插入代码：

-- 输出info级别日志，变量用%s占位拼接
module:log("info", "当前处理用户JID: %s, 所属房间JID: %s", user_jid, room.jid)
-- 输出debug级别日志，用于查看复杂结构内容
module:log("debug", "事件触发详情: %s", require"util.serialization".serialize(event))

3. 日志查看位置：

• 默认配置下Prosody的日志存放在/var/log/prosody/目录下，通常包含两个文件：prosody.log（全级别日志）、prosody.err（仅错误和警告级别日志）
• 如果修改过默认日志配置，可以查看Prosody主配置文件/etc/prosody/prosody.cfg.lua里的log配置段确认日志路径
• 调试时也可以启动Prosody前台运行实时查看日志，命令为：prosodyctl start --foreground

验证occupant_affiliation_changed方法是否被调用的操作步骤 #

• 第一步：打开mod_av_moderation_component.lua文件，找到目标函数，在函数首行添加日志代码：

function occupant_affiliation_changed(event)
    module:log("info", "occupant_affiliation_changed 方法已触发，操作用户: %s", event.jid or "未知")
    -- 原有函数逻辑保持不变
    ...
end

• 第二步：重启Prosody服务加载修改后的模块：systemctl restart prosody
• 第三步：在Jitsi会议中触发用户权限变更操作，比如设置/取消主持人、踢除参会人等
• 第四步：查看Prosody日志文件，搜索上面添加的日志关键词，能匹配到对应内容就说明方法被正常调用。

内容的提问来源于stack exchange，提问作者MMSmmsbd