GitHub Codespaces 日志

GitHub Codespaces 使用的日志概述。

本文内容

注释

  • 目前，将 GitHub Codespaces 与 JetBrains IDE 结合使用处于公开测试阶段，并且可能会发生更改。
  • 要在 JetBrains IDE 中处理 codespace，你必须使用 JetBrains Gateway 的 2023.3.* 或 2024.1.* 版本。

有关 GitHub Codespaces 的信息会输出到各种日志

  • Codespace 日志
  • 创建日志
  • 浏览器控制台日志（适用于 VS Code 网络客户端）

如果你在 VS Code 中使用 GitHub Codespaces，则可以使用扩展日志。单击上方的“Visual Studio Code”选项卡以了解详情。

  • Codespace 日志
  • 创建日志
  • 扩展日志（适用于 VS Code 桌面应用程序）

如果你在浏览器中使用 GitHub Codespaces，则可以使用浏览器日志。单击上方的“Web 浏览器”选项卡以了解详情。

  • Codespace 日志
  • 创建日志

如果你在 VS Code 或网络浏览器中使用 GitHub Codespaces，则可以使用其他日志。单击上方的选项卡以了解详情。

  • 创建日志

如果你在 VS Code 或网络浏览器中使用 GitHub Codespaces，则可以使用其他日志。单击上方的选项卡以了解详情。

Codespace 日志

这些日志包含有关代码空间、容器、会话和 VS Code 环境的详细信息。它们对于诊断连接问题和其他意外行为很有用。例如，代码空间冻结，但“重新加载窗口”选项可以使其解冻几分钟，或者你随机断开与代码空间的连接，但能够立即重新连接。

  1. 如果你在浏览器中使用 GitHub Codespaces，请确保已连接到要调试的代码空间。
  2. 打开 VS Code 命令面板（Shift+Command+P（Mac）/ Ctrl+Shift+P（Windows/Linux）），然后键入 export logs。从列表中选择Codespaces: Export Logs下载日志。
  3. 定义日志的 zip 存档保存位置，然后单击保存（桌面）或单击确定（Web）。
  4. 如果你在浏览器中使用 GitHub Codespaces，请从资源管理器视图中右键单击日志的 zip 存档，然后选择下载…以将其下载到本地计算机。

Codespace 日志

这些日志包含有关代码空间、容器、会话和 VS Code 环境的详细信息。它们对于诊断连接问题和其他意外行为很有用。例如，代码空间冻结，但“重新加载窗口”选项可以使其解冻几分钟，或者你随机断开与代码空间的连接，但能够立即重新连接。

  1. 打开 VS Code 命令面板（Shift+Command+P（Mac）/ Ctrl+Shift+P（Windows/Linux）），然后键入 export log。从列表中选择Codespaces: Export Logs下载日志。
  2. 定义日志的 zip 存档保存位置，然后单击保存（桌面）或单击确定（Web）。

Codespace 日志

这些日志包含有关代码空间、容器、会话和 VS Code 环境的详细信息。它们对于诊断连接问题和其他意外行为很有用。例如，代码空间冻结，但“重新加载窗口”选项可以使其解冻几分钟，或者你随机断开与代码空间的连接，但能够立即重新连接。

目前你无法使用 GitHub CLI 访问这些日志。要访问它们，请在 VS Code 或浏览器中打开你的代码空间。

创建日志

这些日志包含有关容器、开发容器及其配置的信息。它们对于调试配置和设置问题很有用。

  1. 连接到要调试的代码空间。
  2. 打开 VS Code 命令面板（Shift+Command+P（Mac）/ Ctrl+Shift+P（Windows/Linux）），然后键入 creation log。从列表中选择Codespaces: View Creation Log打开 creation.log 文件。

如果你想与支持人员共享日志，可以将文本从创建日志复制到文本编辑器中，然后在本地保存文件。

打开 VS Code 命令面板（Shift+Command+P（Mac）/ Ctrl+Shift+P（Windows/Linux）），然后键入 creation log。从列表中选择Codespaces: View Creation Log打开 creation.log 文件。

如果你想与支持人员共享日志，可以将文本从创建日志复制到文本编辑器中，然后在本地保存文件。

要了解有关 GitHub CLI 的更多信息，请参阅“关于 GitHub CLI”。

要查看创建日志，请使用 gh codespace logs 子命令。输入命令后，从显示的代码空间列表中进行选择。

gh codespace logs

有关此命令的更多信息，请参阅GitHub CLI 手册。

如果你想与支持人员共享日志，可以将输出保存到文件中

gh codespace logs -c <CODESPACE-NAME> > /path/to/logs.txt

扩展日志

这些日志仅适用于 VS Code 桌面用户。如果 GitHub Codespaces 扩展或 VS Code 编辑器似乎存在阻止创建或连接的问题，它们很有用。

  1. 在 VS Code 中，打开命令面板。
  2. 键入 logs，然后选择开发者：打开扩展日志文件夹。
  3. 系统文件资源管理器显示了各种日志文件和文件夹。打开文件夹 output_logging_DATETIME。

在此视图中，你可以访问 VS Code 中使用的扩展（包括 GitHub Codespaces）生成的日志。

浏览器控制台日志

这些日志仅在你想要调试浏览器中使用 GitHub Codespaces 的问题时才有用。它们对于调试创建和连接到 GitHub Codespaces 的问题很有用。

以下说明适用于 Chrome。其他浏览器的步骤类似。

  1. 在要调试的代码空间的浏览器窗口中，打开开发者工具窗口。

  2. 单击控制台选项卡。

  3. 显示控制台侧边栏（如果尚未显示）。有关详细信息，请参阅 Chrome 开发者文档中的“控制台功能参考”。

  4. 在侧边栏中，单击NUMBER 错误以仅显示错误。

  5. 在右侧的日志区域中，右键单击并选择另存为，将错误副本保存到本地计算机。

    Screenshot of the developer tools panel in the Chrome browser. The right-click menu is displayed, showing the option "Save as."

  1. 在 JetBrains 客户端中，单击 GitHub Codespaces 插件以显示 GitHub Codespaces 工具窗口。

    Screenshot of the GitHub Codespaces tool window. The "GitHub Codespaces" tool window selector is highlighted with an orange outline.

  2. 在 GitHub Codespaces 工具窗口中，单击日志图标。

    Screenshot of the log button (a book symbol).

JetBrains 日志

你可以通过转到 JetBrains 客户端应用程序中的帮助菜单并单击收集主机和客户端日志来下载远程 JetBrains IDE 和本地客户端应用程序的日志。

延伸阅读