查看你环境中 GitHub Copilot 的日志

查看日志以排除 IDE 中与 GitHub Copilot 相关的错误。

谁可以使用此功能？

GitHub Copilot 个人版或 GitHub Copilot 企业版。

本文内容

收集日志文件

日志文件的位置取决于你使用的 JetBrains IDE。更多信息，请参阅“在你的环境中配置 GitHub Copilot”。

以下步骤描述了如何查看和收集以下 JetBrains IDE 的日志文件：

  • IntelliJ IDEA
  • Android Studio
  • GoLand
  • PhpStorm
  • PyCharm
  • RubyMine
  • WebStorm

GitHub Copilot 扩展将日志记录到 IntelliJ 插件的 IDEA 日志位置。

  1. 在你的 JetBrains IDE 中，打开**帮助**菜单。
  2. 转到**在 Finder 中显示日志**。
  3. 在你的首选编辑器中打开idea.log，并查找与 GitHub 或 GitHub Copilot 相关的任何错误。

更多信息，请参阅 IntelliJ 文档中的查找 IDE 日志文件。

从 Rider 收集日志文件

  1. 在 Rider 中，打开**帮助**菜单。
  2. 转到**诊断工具**。
  3. 转到**显示日志位置**。
  4. 在你的首选编辑器中打开idea.log，并查找与 GitHub 或 GitHub Copilot 相关的任何错误。

启用调试模式

如果你发现日志文件不包含足够的信息来解决问题，暂时启用调试日志记录可能会有所帮助。这对于调试网络相关问题尤其有用。

  1. 在菜单栏中，单击**帮助**，选择**诊断工具**，然后单击**调试日志设置...**。

    Screenshot of the menu bar in a JetBrains IDE. The "Help" menu and "Diagnostic Tools" submenu are expanded, and the "Debug Log Settings" option is highlighted in blue.

  2. 在“自定义调试日志配置”窗口中，添加一行包含以下内容，然后单击**确定**。

    文本
    #com.github.copilot:trace

  3. 继续使用你的 IDE 直到再次遇到问题，然后按照“收集日志文件”中的说明收集日志文件。

  4. 当你获得所需信息后，通过从“自定义调试日志配置”窗口中删除#com.github.copilot:trace来禁用调试模式。

查看网络连接诊断日志

如果由于网络限制、防火墙或你的代理设置而遇到连接到 GitHub Copilot 的问题，请使用以下故障排除步骤。

  1. 在菜单栏中，单击**工具**，选择**GitHub Copilot**，然后单击**日志诊断**。
  2. idea.log文件应在 JetBrains IDE 中打开，其中包含诊断输出。或者，你也可以在你的首选编辑器中打开idea.log文件。
  3. 检查**可达性**部分以确定 GitHub Copilot 是否可以访问必要的服务。

如果使用自定义证书，请确保证书已在操作系统中正确安装，请参阅“GitHub Copilot 的网络错误故障排除”。然后使用以下故障排除步骤。

  1. 在菜单栏中，单击**工具**，选择**GitHub Copilot**，然后单击**日志 CA 证书**。
  2. idea.log文件应在 JetBrains IDE 中打开，其中包含以 PEM 格式记录的可信 CA 证书。你可能需要刷新idea.log文件才能查看所有输出。或者，你也可以在你的首选编辑器中打开idea.log文件。
  3. 检查证书列表输出中是否包含预期的自定义证书。

在 Visual Studio 中查看日志

GitHub Copilot 扩展的日志文件存储在 Visual Studio 扩展的标准日志位置。

  1. 在 Visual Studio 中打开**视图**菜单。
  2. 单击**输出**。
  3. 在输出视图窗格的右侧，从下拉菜单中选择**GitHub Copilot**。

进一步阅读

查看和收集日志文件

GitHub Copilot 扩展的日志文件存储在 Visual Studio Code 扩展的标准日志位置。日志文件可用于诊断连接问题。

  1. 在 Visual Studio Code 中打开**视图**菜单。
  2. 单击**输出**。
  3. 在输出视图窗格的右侧，从下拉菜单中选择**GitHub Copilot**。

或者，你可以在系统的文件浏览器中打开 Visual Studio Code 扩展的日志文件夹。如果你需要将日志文件转发给支持团队，这将非常有用。

  1. 打开 VS Code 命令面板
    • 对于 Mac
      • 使用：Shift+Command+P
    • 对于 Windows 或 Linux
      • 使用：Ctrl+Shift+P
  2. 输入“日志”，然后从列表中选择**开发人员：打开扩展日志文件夹**。

查看网络连接诊断日志

如果由于网络限制、防火墙或你的代理设置而遇到连接到 GitHub Copilot 的问题，请使用以下故障排除步骤。

  1. 打开 VS Code 命令面板
    • 对于 Mac
      • 使用：Shift+Command+P
    • 对于 Windows 或 Linux
      • 使用：Ctrl+Shift+P
  2. 输入“诊断”，然后从列表中选择**GitHub Copilot：收集诊断信息**。这将打开一个新的编辑器，其中包含你可以自己检查或与支持团队共享的相关信息。
  3. 检查**可达性**部分以确定 GitHub Copilot 是否可以实际访问必要的服务。

查看 Electron 日志

在极少数情况下，错误可能不会传播到相应的错误处理程序，并且不会记录在常规位置。如果遇到错误并且日志中没有任何内容，你可以尝试查看运行 VS Code 和扩展的进程的日志。

  1. 打开 VS Code 命令面板

    • 对于 Mac
      • 使用：Shift+Command+P
    • 对于 Windows 或 Linux
      • 使用Ctrl+Shift+P

  2. 输入“切换”，然后从列表中选择**开发人员：切换开发者工具**。

  3. 在开发者工具窗口中，选择**控制台**选项卡以查看任何错误或警告。

    Screenshot of the Developer Tools window in Visual Studio Code. The console tab is outlined in dark orange.

进一步阅读

检查 GitHub Copilot 是否正常运行

要检查 GitHub Copilot 是否正常运行，请在 Vim/Neovim 中运行以下命令：

:Copilot status

收集日志文件

Xcode 的 GitHub Copilot 扩展的日志文件存储在~/Library/Logs/GitHubCopilot/中。最新的文件名为github-copilot-for-xcode.log。

  1. 打开 GitHub Copilot 扩展应用程序。
  2. 在应用程序窗口顶部，单击**高级**。
  3. 在“日志记录”部分，单击**打开 Copilot 日志文件夹**。

启用详细日志

你可以启用详细日志记录以帮助排除 Xcode 的 GitHub Copilot 扩展的问题。

  1. 打开 GitHub Copilot 扩展应用程序。
  2. 在应用程序窗口顶部，单击**高级**。
  3. 在“日志记录”部分，“详细日志记录”旁边，将开关切换到右侧。