GitHub Codespaces 日志

GitHub Codespaces 使用的日志概述。

本文内容

备注

  • 目前，在 JetBrains IDE 中使用 GitHub Codespaces 处于公开测试阶段，可能会发生变化。
  • 要在 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 或 Web 浏览器中使用 GitHub Codespaces，则可以使用其他日志。单击上面的选项卡以获取详细信息。

  • 创建日志

如果您在 VS Code 或 Web 浏览器中使用 GitHub Codespaces，则可以使用其他日志。单击上面的选项卡以获取详细信息。

Codespace 日志

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

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

Codespace 日志

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

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

Codespace 日志

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

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

创建日志

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

  1. 连接到要调试的 codespace。
  2. 打开 VS Code 命令面板（Shift+Command+P (Mac) / Ctrl+Shift+P (Windows/Linux)）并输入 creation log。从列表中选择 **Codespaces: 查看创建日志** 以打开 creation.log 文件。

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

打开 VS Code 命令面板（Shift+Command+P (Mac) / Ctrl+Shift+P (Windows/Linux)）并输入 creation log。从列表中选择 **Codespaces: 查看创建日志** 以打开 creation.log 文件。

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

要了解有关 GitHub CLI 的更多信息，请参阅 "关于 GitHub CLI."

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

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. 在您要调试的 codespace 的浏览器窗口中，打开开发者工具窗口。

  2. 点击 **控制台** 选项卡。

  3. 显示控制台侧边栏，如果它尚未显示。有关更多信息，请参阅 Chrome for Developers 文档中的 "控制台功能参考"。

  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 和本地客户端应用程序的日志。

进一步阅读