Skip to main content

查看环境中GitHub Copilot 的日志

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

收集日志文件

日志文件的位置取决于所用的 JetBrains IDE。 有关详细信息,请参阅 在环境中配置 GitHub Copilot

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

  • IntelliJ 理念
  • Android Studio
  • GoLand
  • PhpStorm
  • PyCharm
  • RubyMine
  • WebStorm

GitHub Copilot 扩展将日志写入 IntelliJ 插件的 IDEA 日志目录。

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

有关详细信息,请参阅 IntelliJ 文档中的查找 IDE 日志文件

从 Rider 收集日志文件

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

启用调试模式

如果发现日志文件没有包含足以解决问题的问题,暂时启用调试日志记录可能会有所帮助。 这对于调试与网络相关的问题尤其有帮助。

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

    JetBrains IDE 中菜单栏的屏幕截图。 “帮助”菜单和“诊断工具”子菜单已展开,“调试日志设置”已突出显示。

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

    Text
    #com.github.copilot:trace
    
  3. 继续使用 IDE 直到再次遇到该问题,然后按照“收集日志文件”中的说明收集日志文件。

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

使用代理调试面板

注意

此功能目前处于公开预览,可能会发生更改。

代理调试面板显示会话期间 Copilot 命令行界面(CLI) 代理交互的时间顺序事件日志。 使用面板调试 自定义代理 和子代理工作流。

  1. 在 JetBrains IDE 中打开 副驾驶聊天 。
  2. 在代理选取器中,选择 Copilot 命令行界面(CLI)。
  3. 在聊天面板的右上角,单击设置图标,然后单击 “代理调试面板”。
  4. 若要全面支持当前会话和历史会话,请启用调试文件日志记录。
    1. 打开设置
    2. 在边栏中,单击“工具”,然后单击Copilot****“聊天”。
    3. 选择“ 启用代理调试文件日志记录”。

如果使用 Copilot业务 或 Copilot Enterprise,请在使用此功能之前要求管理员启用编辑器预览功能策略。

查看网络连接诊断日志

如果因网络限制、防火墙或代理设置而连接 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 Command Palette
    • 对于 Mac:
      • 使用:Shift+Command+P
    • 对于 Windows 或 Linux:
      • 使用:Ctrl+Shift+P
  2. 输入“日志”,然后从列表中选择“开发人员:打开扩展日志文件夹”****。

启用调试模式

如果发现日志文件没有包含足以解决问题的问题,暂时启用调试日志记录可能会有所帮助。 这对于调试与网络相关的问题尤其有帮助。

  1. 打开 VS Code Command Palette
    • 对于 Mac:
      • 使用:Shift+Command+P
    • 对于 Windows 或 Linux:
      • 使用:Ctrl+Shift+P
  2. 键入“Developer”,然后选择 “开发人员:设置日志级别”。
  3. 键入“”GitHub,然后选择要进行故障排除的 GitHub 扩展:

GitHub Copilot 聊天功能 ** 副驾驶聊天用于扩展。 * ** GitHub ** 用于 GitHub Copilot 扩展。

  1. 从下拉列表中选择 “跟踪 ”。
  2. 获得所需信息后,请通过重复执行步骤 1 到 4 并将日志记录级别恢复为 Info 来禁用调试模式。

查看网络连接诊断日志

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

  1. 打开 VS Code Command Palette
    • 对于 Mac:
      • 使用:Shift+Command+P
    • 对于 Windows 或 Linux:
      • 使用:Ctrl+Shift+P
  2. 键入“诊断”,然后从列表中选择 “开发人员:聊天诊断 ”。 这将打开一个新的编辑器,其中包含可以自行检查或与支持团队共享的相关信息。
  3. 检查“ 可访问性 ”部分,以确定是否可以 GitHub Copilot 实际访问必要的服务。

查看 Electron 日志

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

  1. 打开 VS Code Command Palette

    • 对于 Mac:
      • 使用:Shift+Command+P
    • 对于 Windows 或 Linux:
      • 使用 Ctrl+Shift+P
  2. 键入“Toggle”,然后从列表中选择 开发人员:切换开发人员工具

  3. 在Developer Tools窗口中,选择 Console 选项卡以查看任何错误或警告。

    Visual Studio Code中开发者工具窗口的屏幕截图。 “控制台”选项卡用深橙色框出。

其他阅读材料

检查是否 GitHub Copilot 正常运行

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

:Copilot status

收集日志文件

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

  1. 打开 GitHub Copilot Xcode 应用程序。
  2. 在应用程序窗口顶部,单击“Advanced”****。
  3. 在“日志记录”部分,单击“打开 Copilot 日志文件夹”****。

启用详细日志

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

  1. 打开 GitHub Copilot Xcode 应用程序。
  2. 在应用程序窗口顶部,单击“Advanced”****。
  3. 在“日志记录”部分,单击“详细日志记录”右侧的开关,将其切换到开启状态。