在 nginx 中配置 websocket 代理日志记录,核心做法是将 `proxy_pass` 指向的 upstream 块中的服务器地址与 `access_log` 指令绑定。通过定义一个包含 websocket 升级逻辑的 `upstream` 组,并在 `server` 块中针对该上游调用 `access_log`,即可实现针对 websocket 连接的独立日志记录。

如何为特定 WebSocket 路径配置独立的访问日志
要为特定的 WebSocket 路径(如 `/ws`)配置独立的访问日志,需要在 Nginx 配置文件中定义一个 `map` 变量或直接在 `location` 块中使用条件判断来触发日志写入。最直接且常用的方法是利用 `if` 指令结合 `access_log` 的路径参数,或者更优雅地通过 `map` 模块动态指定日志文件路径。

http {
# 定义日志格式
log_format websocket '$remote_addr - $remote_user [$time_local] '
'"$request" $status $body_bytes_sent '
'"$http_upgrade" "$connection_upgrade"';
server {
listen 80;
server_name example.com;
location /ws {
proxy_pass http://websocket_backend;
proxy_http_version 1.1;
proxy_set_header Upgrade $http_upgrade;
proxy_set_header Connection "upgrade";
# 关键配置:为该 location 指定专用日志文件
access_log /var/log/nginx/ws_access.log websocket;
}
location /api {
proxy_pass http://backend_api;
access_log /var/log/nginx/api_access.log combined;
}
}
}
上述代码中,`log_format` 定义了名为 `websocket` 的日志格式,特别包含了 `$http_upgrade` 和 `$connection_upgrade` 字段,这对于排查 WebSocket 握手问题至关重要。在 `location /ws` 块中,`access_log` 指令被赋予了一个具体的文件路径 `/var/log/nginx/ws_access.log` 以及之前定义的格式名 `websocket`。这样,所有经过 `/ws` 路径的请求都会记录到该文件中,而不会混入默认的 `access.log`。对于非 WebSocket 的路径,如 `/api`,则继续使用标准的 `combined` 格式和默认日志文件。这种配置方式确保了日志的分类存储,便于后续分析和监控 WebSocket 连接的健康状况。
如何通过日志识别 WebSocket 连接状态与异常
通过分析 WebSocket 代理日志,可以识别连接建立、维持和断开的状态,以及常见的异常情况。关键在于检查日志中的 `$status` 字段和自定义的 `$http_upgrade` 字段。正常的 WebSocket 握手通常返回 HTTP 101 Switching Protocols 状态码,而在长连接期间,由于没有新的 HTTP 请求发起,日志可能不会频繁更新,除非启用了 keepalive 超时或发生了错误。
可水平扩展的 WebSocket 中心模式,支持懒加载 Redis 订阅、连接注册表和优雅关闭。适用于构建可跨多实例扩展的实时 WebSocket 服务器。

# 假设 ws_access.log 中的一行典型记录 192.168.1.100 - - [10/Oct/2023:13:55:36 +0000] "GET /ws HTTP/1.1" 101 0 "-" "websocket" "upgrade" # 异常断开示例:客户端意外关闭或网络中断 192.168.1.101 - - [10/Oct/2023:14:00:12 +0000] "GET /ws HTTP/1.1" 400 197 "-" "websocket" "upgrade" # 后端服务不可用 192.168.1.102 - - [10/Oct/2023:14:05:45 +0000] "GET /ws HTTP/1.1" 502 166 "-" "websocket" "upgrade"
在日志分析中,重点关注状态码为 101 的记录,这表示 WebSocket 握手成功。如果看到状态码为 400、403 或 502,则表明连接建立失败。例如,400 错误可能源于客户端发送了无效的 Upgrade 头,而 502 错误则通常意味着 Nginx 无法连接到后端的 WebSocket 服务器。此外,`$http_upgrade` 字段的值应为 `websocket`,`$connection_upgrade` 应为 `upgrade`。如果这些值为空或不匹配,说明请求未正确升级为 WebSocket 协议,可能被当作普通 HTTP 请求处理,导致连接立即关闭。通过定期轮询这些日志条目,运维人员可以快速定位 WebSocket 服务的故障点,区分是客户端问题、Nginx 配置问题还是后端服务问题。
当后端 WebSocket 服务器返回非 101 状态码时日志会记录什么
当后端 WebSocket 服务器返回非 101 状态码(如 400、403、500 等)时,Nginx 会将该状态码原样传递给客户端,并在访问日志中记录这个实际的状态码。这意味着日志中不会显示“WebSocket 连接成功”,而是显示具体的 HTTP 错误状态码。这对于调试非常有用,因为它直接反映了后端服务器的响应情况。
# 后端返回 403 Forbidden 192.168.1.103 - - [10/Oct/2023:14:10:22 +0000] "GET /ws HTTP/1.1" 403 197 "-" "websocket" "upgrade" # 后端返回 500 Internal Server Error 192.168.1.104 - - [10/Oct/2023:14:15:33 +0000] "GET /ws HTTP/1.1" 500 166 "-" "websocket" "upgrade"
在这种情况下,日志记录的 `$status` 字段将是 403 或 500,而不是 101。同时,`$body_bytes_sent` 将包含后端返回的错误页面大小。如果后端服务器完全无响应或超时,Nginx 可能会记录 502 Bad Gateway 或 504 Gateway Timeout。因此,通过检查日志中的状态码,可以明确知道 WebSocket 握手失败的具体原因,并据此调整后端逻辑或 Nginx 的重试策略。需要注意的是,即使握手失败,Nginx 仍然会记录这条日志,因为这是一个完整的 HTTP 请求-响应周期。对于长连接期间的数据帧传输,Nginx 默认不会记录日志,因为这些数据不属于 HTTP 请求的一部分,除非启用了特殊的模块或自定义日志机制。

















