如何用 --log 日志、coder-logs 目录与浏览器控制台收集 code-server 问题信息?

原创2026-09-09 13:44:052,565 阅读
文章标签:开发工具IDE代码编辑器后端CLI

如何用 --log 日志、coder-logs 目录与浏览器控制台收集 code-server 问题信息?

code-server(VS Code in the browser)出现编辑器异常、连接失败或崩溃时,界面本身往往给不出原因。项目 FAQ 的 “How do I debug issues with code-server?” 给出了一条固定的收集路径:先把服务端日志级别调到 debug,复现问题,再从服务端日志目录、浏览器控制台、浏览器网络标签页三个位置收集信息。本文按这条路径说明每一步怎么执行。

复现前:开启 debug 级别日志

文档给出两种方式,效果相同:

  1. 启动时传 --log 标志:
code-server --log debug
  1. 或者设置 LOG_LEVEL 环境变量。

debug 级别用于大多数问题;trace 级别输出更详尽的消息,适合 debug 级别不够用时。文档明确说明 -vvv 和 --verbose 是 --log trace 的别名,不需要额外记忆。

如果 code-server 以 systemd 服务方式运行(例如通过安装脚本安装),修改启动参数后需要重启服务才能生效:

sudo systemctl restart code-server@$USER

其中 $USER 是运行该服务的当前系统用户,这条命令来自 FAQ 中管理 code-server 服务的示例。

复现问题

日志级别生效后,按实际触发问题的完整步骤操作一遍(打开某个工作区、执行某个操作、刷新页面等)。FAQ 要求先复现问题再收集日志,否则收集到的 coder-logs 文件无法对应到出错的时段。

从三个位置收集日志

按 FAQ 的编号顺序收集:

  1. 服务端:取 ~/.local/share/code-server/coder-logs 目录中最新的文件;
  2. 浏览器:打开浏览器控制台(console)记录其中的报错;
  3. 浏览器:打开网络标签页(network tab)记录出问题时段的请求。

浏览器控制台常常能直接显示根因。以 webview 加载失败为例,当访问上下文不安全(例如直接用 IP 地址访问)时,控制台会出现类似如下的报错(FAQ “Why do web views not work?” 给出的示例现象):

Error loading webview: Error: Could not register service workers: SecurityError: Failed to register a ServiceWorker for scope with script: An SSL certificate error occurred when fetching the script.

出现该现象时,文档给出的解决方向是改用 localhost/127.0.0.1 访问、使用带真实证书或受信任自签名证书的域名,或在浏览器允许时关闭该安全限制。

可选分支:崩溃场景收集 core dump

如果问题是 code-server 进程崩溃,FAQ 补充:收集 core dump 会有帮助,但可能需要先在系统上启用 core dump。文档未给出具体启用命令,需按操作系统常规方式处理后再复现。

辅助检查:进程是否还活着

如果现象是页面打不开,可以先请求 code-server 的 /healthz 端点判断服务端是否仍在运行。该端点不需要认证,响应包含状态和最后一次心跳时间戳(默认为 0)。文档给出的响应示例:

{
  "status": "alive",
  "lastHeartbeat": 1599166210566
}

以上为文档示例值,不是你必须得到的固定输出;status 会显示 alive 或 expired。

提交收集到的信息

FAQ “Questions?” 要求把所有问题与支持请求提交到项目的 Discussions。提交时把服务端日志文件、浏览器控制台输出和网络标签页信息放在一起,三者时间线可以互相对照。

边界与限制

  • FAQ 只说明取 coder-logs 中“最新的文件”,没有描述该目录文件的命名规则或保留策略。
  • 如果问题发生在 npm 安装阶段而不是运行阶段,那是另一条排查路径:docs/npm.md 建议用 npm install --loglevel verbose --global code-server 开启 verbose 安装日志,这与运行时的 --log 标志无关。
  • 文档没有给出“日志内容 → 根因”的判定表,收集到的信息主要用于维护者或本人对照时间线定位问题。
登录后查看全文
code-server