多人游戏与网络同步 / 系统课时
一次房间异常该记录哪些日志
一次房间异常该记录哪些日志
当多人游戏大厅出现房间创建失败、成员状态异常或进入房间卡住时,日志需要帮助开发者还原一次完整事件。本篇将建立可检索的诊断字段体系,让线上问题可以从用户操作追踪到具体服务响应。
学习目标
- 理解房间异常日志中请求、状态和业务字段的职责。
- 掌握客户端记录关键时间点和错误上下文的方法。
- 学会设计便于线上检索的日志结构。
为什么房间日志不能只记录错误信息
单独记录“加入房间失败”无法回答真正的问题。排查时通常需要知道哪个用户、哪个房间、哪次请求、经过哪些状态变化,以及失败发生在客户端还是服务端。
一个可用的房间诊断日志至少应包含以下信息:
| 字段 | 作用 |
|---|---|
| requestId | 串联一次请求链路,定位重复或乱序响应 |
| roomId | 确认异常影响的房间 |
| userId | 判断用户权限和成员关系 |
| action | 描述 create、join、leave 等操作 |
| stateBefore/stateAfter | 还原客户端状态迁移 |
| errorCode | 区分网络、权限、业务失败 |
| timestamp | 对齐客户端与服务端时间线 |
设计客户端房间事件日志
推荐使用结构化日志,而不是拼接长字符串。结构化字段可以被日志平台直接过滤,例如查询某个房间所有加入失败记录。
下面是一个简单的 TypeScript 日志封装示例:
ts
interface RoomLog {
requestId: string;
roomId: string;
action: string;
stateBefore: string;
stateAfter: string;
errorCode?: string;
}
function writeRoomLog(event: RoomLog) {
console.log(JSON.stringify({
scope: "room",
time: new Date().toISOString(),
...event
}));
}
writeRoomLog({
requestId: "req-1001",
roomId: "room-88",
action: "join",
stateBefore: "idle",
stateAfter: "failed",
errorCode: "ROOM_FULL"
});预期输出
text
{"scope":"room","time":"<TIME>","requestId":"req-1001","roomId":"room-88","action":"join","stateBefore":"idle","stateAfter":"failed","errorCode":"ROOM_FULL"}记录状态变化比记录最终结果更重要
大厅客户端通常存在 idle、joining、inRoom、leaving 等状态。异常发生时,如果只有最终状态,无法判断是请求未发送、响应延迟,还是状态提交被旧响应覆盖。
建议在状态迁移点记录:
- 触发动作,例如点击加入按钮。
- 请求发送时间和请求编号。
- 响应返回时间。
- 状态提交前后的值。
- 被拒绝时的业务原因。
线上排查时如何使用这些字段
拿到一个异常后,先通过 requestId 查完整链路,再通过 roomId 查看同一房间内其他玩家是否受到影响。如果大量请求集中出现相同 errorCode,通常优先检查服务端规则;如果只有单个客户端异常,则重点检查本地状态管理和网络重试逻辑。
日志的目标不是记录所有运行细节,而是在问题发生后快速回答“谁在什么时间,对哪个房间执行了什么操作,为什么没有进入下一状态”。
按自己的节奏,确认真正理解。