1
0
mirror of synced 2025-12-23 11:54:18 -05:00
Files
docs/content/copilot/troubleshooting-github-copilot/viewing-logs-for-github-copilot-in-your-environment.md
Isaac Brown 54489bb2c4 Improve documentation around HTTP proxy support in Copilot (#40157)
Co-authored-by: github-actions <github-actions@github.com>
Co-authored-by: hubwriter <hubwriter@github.com>
2023-08-10 09:37:45 +00:00

8.5 KiB

title, intro, product, redirect_from, topics, versions, shortTitle
title intro product redirect_from topics versions shortTitle
Viewing logs for GitHub Copilot in your environment View logs to troubleshoot {% data variables.product.prodname_copilot %}-related errors in your IDE. {% data reusables.gated-features.copilot %}
/copilot/troubleshooting-github-copilot/troubleshooting-github-copilot-in-visual-studio
/copilot/troubleshooting-github-copilot/troubleshooting-github-copilot-in-visual-studio-code
/copilot/troubleshooting-github-copilot/troubleshooting-github-copilot-in-a-jetbrains-ide
/copilot/troubleshooting-github-copilot/troubleshooting-github-copilot-in-neovim
/copilot/troubleshooting-github-copilot/troubleshooting-github-copilot-in-your-environment
Copilot
Logging
Troubleshooting
feature
copilot
View logs

{% jetbrains %}

Collecting log files

The location of the log files depends on the JetBrains IDE you are using. For more information, see "AUTOTITLE."

These steps describe how to view and collect the log files for the following JetBrains IDEs:

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

The {% data variables.product.prodname_copilot%} extension logs to the IDEA log location for IntelliJ plugins.

  1. In your JetBrains IDE, open the Help menu.
  2. Go to Show Log in Finder.
  3. Open the idea.log in your preferred editor and look for any errors related to {% data variables.product.prodname_dotcom%} or {% data variables.product.prodname_copilot%}.

For more information, see the Locating IDE log files in the IntelliJ documentation.

Collect log files from Rider

  1. In Rider, open the Help menu.
  2. Go to Diagnostic Tools.
  3. Go to Show Log in.
  4. Open the idea.log in your preferred editor and look for any errors related to {% data variables.product.prodname_dotcom%} or {% data variables.product.prodname_copilot%}.

Enabling debug mode

If you find the log file doesn't contain enough information to resolve an issue, it may help to temporarily enable debug logging. This can be especially helpful for debugging network-related issues.

  1. In the menu bar, click Help, select Diagnostic Tools, and click Debug Log Settings....

    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. In the "Custom Debug Log Configuration" window, add a new line with the following content, then click OK.

    #com.github.copilot:trace
    
  3. Keep using your IDE until you encounter the issue again, then collect the log file as described in "Collecting log files."

  4. When you have the information you need, disable debug mode by removing #com.github.copilot:trace from the "Custom Debug Log Configuration" window.

{% endjetbrains %}

{% visualstudio %}

Viewing logs in {% data variables.product.prodname_vs %}

The log files for the {% data variables.product.prodname_copilot%} extension are stored in the standard log location for {% data variables.product.prodname_vs %} extensions.

  1. Open the the View menu in {% data variables.product.prodname_vs %}.
  2. Click Output.
  3. On the right of the Output view pane, select {% data variables.product.prodname_copilot%} from the dropdown menu.

Further reading

{% endvisualstudio %}

{% vscode %}

Viewing and collecting log files

The log files for the {% data variables.product.prodname_copilot%} extension are stored in the standard log location for {% data variables.product.prodname_vscode %} extensions. The log files are useful for diagnosing connection issues.

  1. Open the View menu in {% data variables.product.prodname_vscode %}.
  2. Click Output.
  3. On the right of the Output view pane, select {% data variables.product.prodname_copilot%} from the dropdown menu.

Alternatively, you can open the log folder for {% data variables.product.prodname_vscode %} extensions in your system's file explorer. This is useful if you need to forward the log files to the support team.

  1. Open the {% data variables.product.prodname_vscode_command_palette_shortname %}
    • For Mac:
      • Use: Shift+Command+P
    • For Windows or Linux:
      • Use: Ctrl+Shift+P
  2. Type "Logs", and then select Developer: Open Extension Logs Folder from the list.

Viewing network connectivity diagnostics logs

If you encounter problems connecting to {% data variables.product.prodname_copilot%} due to network restrictions, firewalls, or your proxy setup, use the following troubleshooting steps.

  1. Open the {% data variables.product.prodname_vscode_command_palette_shortname %}
    • For Mac:
      • Use: Shift+Command+P
    • For Windows or Linux:
      • Use: Ctrl+Shift+P
  2. Type "Diagnostics", and then select {% data variables.product.prodname_copilot%}: Collect Diagnostics from the list. This opens a new editor with the relevant information that you can inspect yourself or share with the support team.
  3. Check the section on Reachability to determine if {% data variables.product.prodname_copilot%} can actually access the necessary services.

{% note %}

Note: If your error is related to certificates, it helps to check these logs for the Custom Certificates: line. If this line says disabled, you are not using {% data variables.product.prodname_copilot_for_business %}, so custom certificates are not supported. For more information, see "AUTOTITLE."

{% endnote %}

Enabling debug mode

If you find the log file doesn't contain enough information to resolve an issue, it may help to temporarily enable debug logging. This can be especially helpful for debugging network-related issues.

  1. Open the {% data variables.product.prodname_vscode_command_palette_shortname %} by pressing Shift+Command+P (Mac) / Ctrl+Shift+P (Windows/Linux).

  2. Type settings, then click Preferences: Open User Settings (JSON).

  3. In the JSON object, insert the following content as a top-level property, then save the file.

    "github.copilot.advanced": {
       "debug.overrideLogLevels": {
          "*": "DEBUG"
       }
    },
    
  4. Keep using your IDE until you encounter the issue again, then collect the log file as described in "Viewing and collecting log files."

  5. When you have the information you need, disable debug mode by removing the content you added to your settings.

Viewing Electron logs

In rare cases, errors might not be propagated to the corresponding error handlers and are not logged in the regular locations. If you encounter errors and there is nothing in the logs, you may try to see the logs from the process running VS Code and the extension.

  1. Open the {% data variables.product.prodname_vscode_command_palette_shortname %}

    • For Mac:
      • Use: Shift+Command+P
    • For Windows or Linux:
      • Use Ctrl+Shift+P
  2. Type "Toggle", and then select Developer: Toggle Developer Tools from the list.

  3. In the Developer Tools window, select the Console tab to see any errors or warnings.

    Screenshot of the Developer Tools window in {% data variables.product.prodname_vscode %}. The console tab is outlined in dark orange.

Further reading

{% endvscode %}

{% vimneovim %}

Checking if {% data variables.product.prodname_copilot%} is operational

To check if GitHub Copilot is operational, run the following command in Vim/Neovim:

:Copilot status

{% endvimneovim %}