我不会起名字322 · 后端 / 算法 / 数据库
文章目录
- [仅 Web 主动 ping:30 秒读超时与各平台保活](#仅 Web 主动 ping:30 秒读超时与各平台保活)
-
- [30 秒读超时是从哪几行开始的](#30 秒读超时是从哪几行开始的)
- [只有 Web 会进 doPing,其余 11 个平台全靠自己](#只有 Web 会进 doPing,其余 11 个平台全靠自己)
- [一条 ping 要经过四个环节才会被发出去](#一条 ping 要经过四个环节才会被发出去)
- [NAT 静默丢弃时,TCP 几十分钟都不报错](#NAT 静默丢弃时,TCP 几十分钟都不报错)
- [压测工具当前配置走 Web 分支](#压测工具当前配置走 Web 分支)
- 修法三档:从改一行到改协议
- 怎么在现场确认连接是被读超时踢掉的
- 小结
仅 Web 主动 ping:30 秒读超时与各平台保活
服务端只在 platformID == 5(Web)时启动主动 ping,其余平台需要客户端发心跳或其他可使读取续期的流量;读超时对所有平台都设为 30 秒。连接静默时读取会在截止时间到期,实际关闭、注销时间及 NAT 断链后的客户端表现还要结合环境和实验判断。
这条链路上没有一个变量叫 heartbeat。grep -rn heartbeat internal/msggateway/ 返回空。真正决定连接生死的,是 pongWait 这个 30 秒常量、pingInterval 这个几乎全程为 0 的变量,以及 gorilla 每轮读取前重设的那一个 deadline。
30 秒读超时是从哪几行开始的
internal/msggateway/constant.go:61-68 定义了全部连接级时间参数,其中三个数字直接决定保活:
go
// internal/msggateway/constant.go:61-68
const (
writeWait = 10 * time.Second
pongWait = 30 * time.Second
pingPeriod = (pongWait * 9) / 10
maxMessageSize = 51200
)
pongWait 是 30 秒,pingPeriod 等于 (pongWait * 9) / 10,也就是 27 秒。这个 9/10 沿用了 gorilla 官方示例的惯例:主动方要留出余量,避免"我刚发出 ping,对方的 pong 还在路上,我这边先超时了"。
下一件事是把这两个值塞进连接。internal/msggateway/ws_server.go:642 调用 NewWebSocketClientConn(conn, maxMessageSize, pongWait, pingInterval),第 3 个参数是读超时,第 4 个是主动 ping 间隔。client_conn.go:42 的签名里这两者并列:
go
// internal/msggateway/client_conn.go:42
func NewWebSocketClientConn(conn *websocket.Conn, readLimit int64, readTimeout time.Duration, pingInterval time.Duration) ClientConn
关键在于:读超时永远是 pongWait,而主动 ping 间隔可能是 0。 两者不对称,这就是全部问题的起点。
只有 Web 会进 doPing,其余 11 个平台全靠自己
ws_server.go:635-639 是这个设计唯一的落点,连注释都写得很直白:
go
// internal/msggateway/ws_server.go:635-642
// 只有 Web 平台由服务端主动发 ping;其他平台依赖客户端心跳 + 读超时。
var pingInterval time.Duration
if connContext.GetPlatformID() == constant.WebPlatformID {
pingInterval = pingPeriod
}
client := new(Client)
client.ResetClient(connContext, NewWebSocketClientConn(conn, maxMessageSize, pongWait, pingInterval), ws)
constant.WebPlatformID 的值是 5。而 github.com/openimsdk/protocol@v0.0.73-alpha.19/constant/platform_id_to_name.go:7-18 里一共登记了 12 个平台:
| platformID | 名称 | 服务端主动 ping | 依赖什么保活 |
|---|---|---|---|
| 1 | IOS | 否 | 客户端控制帧 ping 或文本 ping |
| 2 | Android | 否 | 同上 |
| 3 | Windows | 否 | 同上 |
| 4 | OSX | 否 | 同上 |
| 5 | Web | 是(27 秒一次) | 服务端 ping + 客户端 pong |
| 6 | MiniWeb | 否 | 客户端文本心跳或其他可续期流量;底层控制帧能力待验证 |
| 7 | Linux | 否 | 客户端心跳 |
| 8 | APad | 否 | 客户端心跳 |
| 9 | IPad | 否 | 客户端心跳 |
| 10 | Admin | 否 | 客户端心跳 |
| 11 | HarmonyOS | 否 | 客户端心跳 |
| 12 | Bot | 否 | 客户端心跳 |
注意第 6 行 MiniWeb。它在 PlatformID2Name 里是独立平台,ID 为 6,不等于 5,所以同样拿不到服务端主动 ping。client_conn.go:206-210 的注释说明浏览器 WebSocket API 不暴露主动发送控制帧的接口,服务端同时支持 ping / pong 文本心跳;这不能证明 MiniWeb 的具体 API 能力、SDK 实际会发送文本心跳,或底层是否自动响应控制帧。MiniWeb 连接需要客户端产生可续期流量,具体行为应通过对应 SDK 和真机验证。
转移之后,服务端手里就只剩一个 30 秒的读超时。client_conn.go:163-166 每轮读取前把它推到 now + readTimeout:
go
// internal/msggateway/client_conn.go:163-179
func (c *websocketClientConn) setReadDeadline() error {
deadline := time.Now().Add(c.readTimeout)
return c.conn.SetReadDeadline(deadline)
}
func (c *websocketClientConn) readMessage() ([]byte, error) {
for {
if err := c.setReadDeadline(); err != nil {
return nil, err
}
messageType, buf, err := c.conn.ReadMessage()
if err != nil {
return nil, err
}
设置 deadline 的地方有三处:每轮 readMessage 入口(client_conn.go:173)、pingHandler(:237)、pongHandler(:251)。首次读取之前就会设置截止时间;完整业务消息使读取进入下一轮,ping/pong 控制帧的处理器也会刷新截止时间,并非任意到达的分片都保证续期。静默时读取将在截止时间到期,后续关闭和注销还受其他协程影响。
一条 ping 要经过四个环节才会被发出去
Web 平台那条 27 秒的 ticker 在 client_conn.go:259-273,全文只有 15 行:
go
// internal/msggateway/client_conn.go:259-273
func (c *websocketClientConn) doPing(d time.Duration) {
ticker := time.NewTicker(d)
defer ticker.Stop()
for {
select {
case <-c.done:
return
case <-ticker.C:
if err := c.writeMessage(websocket.PingMessage, nil); err != nil {
_ = c.closeBy(fmt.Errorf("send ping %w", err))
return
}
}
}
}
它并不是"直接写 socket",而是走了和业务消息同一条路。我把这条路过了一遍,一共四关:
doPing把websocket.PingMessage交给writeMessage(client_conn.go:267)。writeMessage(client_conn.go:103-113)把它塞进容量 256 的writerchannel;塞不进去就走closeBy(ErrWriteFull)直接把连接关掉。loopSend(client_conn.go:120-158)串行取出,控制帧走c.conn.WriteControl(msg.MessageType, msg.Data, time.Time{})(:151)。- gorilla 真正写到 socket,对端回 pong,
pongHandler(client_conn.go:249-255)刷新读超时。
第 3 步有个容易忽略的细节:控制帧传入零值 deadline。gorilla v1.5.1 将 1000 小时作为等待写锁的时间,底层写入仍接收零 deadline;这不是统一的 1000 小时写超时。写循环卡住时,读超时仍可能发生,但不能保证连接关闭与注销恰好在 30 秒完成。ping 入队与真正写到线上也不是同一件事。
对照 pingHandler(client_conn.go:235-246),回 pong 反而更小心,给了明确的 1 秒:
go
// internal/msggateway/client_conn.go:240
err := c.conn.WriteControl(websocket.PongMessage, []byte(appData), time.Now().Add(time.Second*1))
主动 ping 的控制帧使用零 deadline,被动 pong 使用 1 秒 deadline,两条写路径存在差异。源码本身不能证明作者意图、队列不会积压或高负载下的实际表现;这些需要结合压测和连接指标判断。
NAT 静默丢弃时,TCP 几十分钟都不报错
移动网络切换(Wi-Fi → 4G)可能使 NAT 映射失效,TCP 连接不一定立刻感知。具体表现取决于网络设备、RST、TCP keepalive、重传参数以及是否有流量;不能一概断言不会收到 RST 或需要等待固定时间。
例如某些 Linux 配置的 tcp_retries2 = 15 常被用来讨论长时间重传,但实际持续时间受内核与环境影响,不能把该值当成此项目连接存活时间。这里还必须考虑应用层:静默读取有 30 秒截止时间,因此不能声称静默连接在服务端内存表里必然存活十几分钟,也不能据此断言推送成功。
pongWait = 30s 给读取设置了期限;非 Web 平台需要客户端定期产生可续期流量。真正的切网发现时间、推送结果及注销耗时需要结合真机和日志验证。
把时间轴摊开看更清楚:
| 时刻 | Web(platformID=5) | 非 Web(1/2/3/6/...) |
|---|---|---|
| 0 s | 握手成功,读截止 = 30 s | 握手成功,读截止 = 30 s |
| 27 s | doPing 把 PingMessage 入队 |
什么都没发生 |
| 27 s+ε | 客户端回 pong → 读截止推到 57 s | 若客户端没发帧,截止仍是 30 s |
| 30 s | 已续期,继续存活 | ReadMessage 返回 i/o timeout |
| 30 s+ε | 若 pong 已成功处理则继续读取 | 进入关闭处理;注销完成时间取决于运行状态 |
| 54 s | 下一次 ping 预计入队 | ------ |
这条时间轴以首次设置读截止时间和启动 ticker 的时间近似为 0,假设 Web ping 及时写出并收到 pong,非 Web 始终静默;实际调度及首次读取存在时间差,任一端的其他有效流量也可能改变截止时间。
压测工具当前配置走 Web 分支
这一点我必须诚实交代,因为它决定了上面所有结论的证据等级。
im-server/loadtest/ws.go:74-84 的 dialWS 把 platformID 写死成 5:
go
// im-server/loadtest/ws.go:79-84
query := "sendID=" + userID +
"&token=" + token +
"&platformID=5" +
"&operationID=loadtest-" + userID + "-" + fmt.Sprint(time.Now().UnixNano()) +
"&isBackground=false" +
"&sdkType=js"
(api.go:169 取 token 时也是 "platformID": 5。)
原文提到 .backups/loadtest/cap1/capacity.json 中五档、每档 60 秒、最多 200 条/秒的数据;目前没有原始报告和执行记录,无法核验这些数字、当时版本或是否发生读超时。当前源码中的压测连接使用 Web 分支,具备服务端 27 秒主动 ping 配置,但不能保证每次 ping 都成功写出。
因此只用 platformID=5 冒烟无法覆盖非 Web 的保活分支,也不能据此推断移动端稳定性;应补充各平台和 SDK 的对照测试。
修法三档:从改一行到改协议
第一档(1 行,代价最小):对所有平台都启动主动 ping。
go
// 现状
var pingInterval time.Duration
if connContext.GetPlatformID() == constant.WebPlatformID {
pingInterval = pingPeriod
}
// 改法
pingInterval := pingPeriod
改完 NewWebSocketClientConn 的 if pingInterval > 0 { go c.doPing(...) }(client_conn.go:56-58)对每条连接都成立。部署前必须逐端验证底层是否自动响应控制帧 ping,以及代理和 SDK 的实际行为。应用 API 不暴露控制帧发送能力,并不能证明底层不会自动 pong;MiniWeb 是否需要排除应由对应 SDK 和真机测试决定。
第二档(几行,代价小但更正确):让读超时跟着客户端心跳走。
如果某个端的 SDK 仅每 45 秒发一次可续期心跳且没有其他流量,30 秒读超时会先到期。一种方案是按心跳间隔留出余量,例如 45 秒心跳配 90 秒读超时;具体值需要依据网络抖动、检测时效与实测调整。可以在握手时协商 heartbeatInterval 并校验范围,或按平台查表配置,也要考虑旧客户端兼容性。
第三档(推荐,代价中等):把"我用 ping 保活"和"我等你心跳"变成互斥但必须二选一,并在握手时校验。
具体可以在握手时协商平台及心跳模式,校验客户端申报间隔与上下限;未申报时仅对已经验证支持 pong 的客户端采用服务端 ping,其他情况拒绝或明确回退策略。协商只能约束约定,无法保证网络上实际收到心跳,仍需读超时和运行监控兜底。
如果某端底层确实不响应控制帧 ping,且也没有其他续期流量,启用服务端 ping 仍不能维持该连接。是否属于这种情况需要逐端验证;要调整 ping 范围,也应核对 SDK 的 pong 和文本心跳能力。
怎么在现场确认连接是被读超时踢掉的
这段是我认为最该带走的部分,因为它不依赖复现,只依赖日志。
第一步,数一下超时。client.go:128-131 在读失败时会打一条 ZWarn,日志正文是 readMessage,错误对象是 i/o timeout:
bash
cd /path/to/im-server
grep -c 'i/o timeout' logs/*.log
grep 'readMessage' logs/*.log | grep -i timeout | tail -5
日志数量和投诉数量即使同量级也不能建立因果关系;应在相同时间窗口按用户、平台、连接和错误上下文关联,确认日志格式与实际路径。
第二步,结合源码确认哪些平台会启动 doPing。如果部署明确给网关进程配置并暴露了 pprof,可在受控环境查询该进程的实际 pprof 地址,再与连接指标及堆栈关联;仓库 API 的 10002 端口不能直接当成网关 pprof 地址。goroutine 数也只能辅助判断,无法单独证明某条连接的 ping 已成功发送。
第三步,做对照实验。同一份服务端代码,分别给 Web 和 iOS 用户签发匹配用户及平台的 token,关闭 Python 客户端主动 ping,观察 40 秒。先确认所用 websockets 版本支持 ping_interval=None 且自动响应服务端控制 ping;还需避免其他客户端使用相同身份造成互踢:
python
# read_timeout_probe.py ------ 需要 pip install websockets
import asyncio, time, websockets
from urllib.parse import urlencode
BASE = "ws://127.0.0.1:10001/?"
async def probe(pid, uid, tok):
"""用匹配身份的 token 观察连接,区分握手失败与握手后关闭。"""
t0 = time.monotonic()
query = urlencode(dict(sendID=uid, token=tok, platformID=pid,
operationID=f"probe-{pid}", isBackground="false", sdkType="js"))
connected = False
try:
async with websockets.connect(BASE + query, ping_interval=None) as ws:
connected = True
deadline = time.monotonic() + 40
while True:
remaining = deadline - time.monotonic()
if remaining <= 0:
print(f"platformID={pid}: 观察期结束,连接仍打开")
break
try:
message = await asyncio.wait_for(ws.recv(), remaining)
print(f"platformID={pid}: 收到业务下行 {message!r}")
except asyncio.TimeoutError:
print(f"platformID={pid}: 观察期结束,连接仍打开")
break
except Exception as e:
stage = "握手后关闭或出错" if connected else "握手失败"
print(f"platformID={pid}: {time.monotonic()-t0:.1f}s {stage} -> {type(e).__name__}: {e}")
async def main():
web_token = open("token-web.txt", encoding="utf-8").read().strip()
ios_token = open("token-ios.txt", encoding="utf-8").read().strip()
await asyncio.gather(probe(5, "probe-web", web_token), probe(1, "probe-ios", ios_token))
asyncio.run(main())
在握手成功、无其他续期流量且 Web 的 ping/pong 按预期工作的条件下,预计 Web 在 40 秒时仍打开,iOS 静默连接约在读截止时被关闭。结果不一致时,应检查客户端版本与主动 ping 设置、业务流量、鉴权、代理、实际服务端版本和日志,不能单凭现象断定某一个原因。上述实验尚未执行。
先准备有效的管理员 token,并确认 probe-ios、probe-web 是可用于测试的用户;下面的命令和脚本在同一工作目录运行。通过管理接口分别签发 token(仓库配置 config/im-api.yml:5 的端口为 10002,实际部署地址可能不同),命令成功后才运行脚本;若接口返回错误,检查响应和鉴权,不要把空文件当作有效 token:
bash
curl -s -X POST 'http://127.0.0.1:10002/auth/get_user_token' \
-H 'Content-Type: application/json' -H 'operationID: token-ios-probe' -H "token: $ADMIN_TOKEN" \
-d '{"platformID":1,"userID":"probe-ios"}' \
| python -c 'import sys,json;print(json.load(sys.stdin)["data"]["token"])' > token-ios.txt
curl -s -X POST 'http://127.0.0.1:10002/auth/get_user_token' \
-H 'Content-Type: application/json' -H 'operationID: token-web-probe' -H "token: $ADMIN_TOKEN" \
-d '{"platformID":5,"userID":"probe-web"}' \
| python -c 'import sys,json;print(json.load(sys.stdin)["data"]["token"])' > token-web.txt
一个限制要说清楚:这个脚本只能证明"服务端会不会主动关",证明不了"真机上 NAT 映射丢了之后多久才发现"。后者必须真机 + 切网,我没做过,不敢下结论。
小结
三句话:
- 网关仅对 Web 主动 ping,所有平台使用 30 秒读超时。 非 Web 端需要客户端产生能使读取续期的流量。
- MiniWeb(platformID=6)同样没有服务端主动 ping。 应用 API 对控制帧的限制不等于底层不响应 ping,实际能力需要 SDK 和真机验证。
- 压测工具写死
platformID=5,无法覆盖非 Web 分支。 历史报告及实际断线情况尚未核验。
排查应关联同一时间窗口内的连接、平台、超时日志和客户端行为;累计超时次数与瞬时 goroutine 数不具备可比口径。