Collecting log files

The location of the log files depends on the JetBrains IDE you are using. For more information, seeConfiguring GitHub Copilot in your environment.

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 GitHub Copilot extension logs to the IDEA log location for IntelliJ plugins.

1. In your JetBrains IDE, open theHelp menu.
2. Go toShow Log in Finder.
3. Open theidea.log in your preferred editor and look for any errors related to GitHub or GitHub Copilot.

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

Collect log files from Rider

1. In Rider, open theHelp menu.
2. Go toDiagnostic Tools.
3. Go toShow Log in.
4. Open theidea.log in your preferred editor and look for any errors related to GitHub or GitHub Copilot.

Enabling debug mode

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

1. In the menu bar, clickHelp, selectDiagnostic Tools, and clickDebug Log Settings....

   

2. In the "Custom Debug Log Configuration" window, add a new line with the following content, then clickOK.

   Text

   #com.github.copilot:trace

3. Keep using your IDE until you encounter the issue again, then collect the log file as described inCollecting 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.

Viewing network connectivity diagnostics logs

If you encounter problems connecting to GitHub Copilot due to network restrictions, firewalls, or your proxy setup, use the following troubleshooting steps.

1. In the menu bar, clickTools, selectGitHub Copilot, and clickLog Diagnostics.
2. Theidea.log file should open in the JetBrains IDE with the diagnostics output. Alternatively, you can open theidea.log file in your preferred editor.
3. Check the section onReachability to determine if GitHub Copilot can access the necessary services.

Troubleshooting certificate-related errors

If you're using a custom certificate, ensure the certificate is installed correctly in the operating system, seeTroubleshooting network errors for GitHub Copilot. Then use the following troubleshooting steps.

1. In the menu bar, clickTools, selectGitHub Copilot, and clickLog CA Certificates.
2. Theidea.log file should open in the JetBrains IDE with the trusted CA certificates logged in PEM format. You may need to refresh theidea.log file to view all of the output. Alternatively, you can open theidea.log file in your preferred editor.
3. Check to see if the expected custom certificate is included in the certificate list output.

Viewing logs in Visual Studio

The log files for the GitHub Copilot extension are stored in the standard log location for Visual Studio extensions.

1. Open theView menu in Visual Studio.
2. ClickOutput.
3. On the right of the Output view pane, selectGitHub Copilot from the dropdown menu.

Further reading

• Log all activity to the log file for troubleshooting in the Visual Studio documentation

Viewing and collecting log files

The log files for the GitHub Copilot extension are stored in the standard log location for Visual Studio Code extensions. The log files are useful for diagnosing connection issues.

1. Open theView menu in Visual Studio Code.
2. ClickOutput.
3. On the right of the Output view pane, selectGitHub Copilot from the dropdown menu.

Alternatively, you can open the log folder for Visual Studio Code 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 VS Code Command Palette
   • For Mac:
     • Use:Shift+Command+P
   • For Windows or Linux:
     • Use:Ctrl+Shift+P
2. Type "Logs", and then selectDeveloper: Open Extension Logs Folder from the list.

Enabling debug mode

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

1. Open the VS Code Command Palette
   • For Mac:
     • Use:Shift+Command+P
   • For Windows or Linux:
     • Use:Ctrl+Shift+P
2. Type "Developer", then selectDeveloper: Set Log Level.
3. Type "GitHub", then select the GitHub extension you're troubleshooting:
   • GitHub Copilot Chat for the Copilot Chat extension.
   • GitHub for the GitHub Copilot Extension.
4. SelectTrace from the dropdown list.
5. When you have the information you need, disable debug mode by repeating steps 1 through 4 and returning the logging level toInfo.

Viewing network connectivity diagnostics logs

If you encounter problems connecting to GitHub Copilot due to network restrictions, firewalls, or your proxy setup, use the following troubleshooting steps.

1. Open the VS Code Command Palette
   • For Mac:
     • Use:Shift+Command+P
   • For Windows or Linux:
     • Use:Ctrl+Shift+P
2. Type "Diagnostics", and then selectGitHub 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 onReachability to determine if GitHub Copilot can actually access the necessary services.

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 VS Code Command Palette

   • For Mac:
     • Use:Shift+Command+P
   • For Windows or Linux:
     • UseCtrl+Shift+P

2. Type "Toggle", and then selectDeveloper: Toggle Developer Tools from the list.

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

   

Further reading

• Troubleshooting network errors for GitHub Copilot
• Network Connections in Visual Studio Code in the Visual Studio Code documentation

Checking if GitHub Copilot is operational

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

:Copilot status

Collecting log files

The log files for the GitHub Copilot extension for Xcode are stored in~/Library/Logs/GitHubCopilot/. The most recent file is namedgithub-copilot-for-xcode.log.

1. Open the GitHub Copilot for Xcode application.
2. At the top of the application window, clickAdvanced.
3. In the "Logging" section, clickOpen Copilot Log Folder.

Enabling verbose logs

You can enable verbose logging to help troubleshoot issues with the GitHub Copilot extension for Xcode.

1. Open the GitHub Copilot for Xcode application.
2. At the top of the application window, clickAdvanced.
3. In the "Logging" section, next to "Verbose Logging", toggle the switch to the right.