diff --git a/assets/images/help/copilot/vs-output.png b/assets/images/help/copilot/vs-output.png new file mode 100644 index 0000000000..58bf49fc7e Binary files /dev/null and b/assets/images/help/copilot/vs-output.png differ diff --git a/assets/images/help/copilot/vsc-electron-logs.png b/assets/images/help/copilot/vsc-electron-logs.png new file mode 100644 index 0000000000..5202d62699 Binary files /dev/null and b/assets/images/help/copilot/vsc-electron-logs.png differ diff --git a/assets/images/help/copilot/vsc-output-pane.png b/assets/images/help/copilot/vsc-output-pane.png new file mode 100644 index 0000000000..8c8c0b1144 Binary files /dev/null and b/assets/images/help/copilot/vsc-output-pane.png differ diff --git a/content/copilot/index.md b/content/copilot/index.md index a3dab73097..0904dea2a5 100644 --- a/content/copilot/index.md +++ b/content/copilot/index.md @@ -28,6 +28,7 @@ children: - /overview-of-github-copilot - /getting-started-with-github-copilot - /configuring-github-copilot + - /troubleshooting-github-copilot topics: - Copilot --- diff --git a/content/copilot/troubleshooting-github-copilot/index.md b/content/copilot/troubleshooting-github-copilot/index.md new file mode 100644 index 0000000000..09c362b71b --- /dev/null +++ b/content/copilot/troubleshooting-github-copilot/index.md @@ -0,0 +1,14 @@ +--- +title: Troubleshooting GitHub Copilot +shortTitle: Troubleshooting +intro: 'These guides provide information for troubleshooting {% data variables.product.prodname_copilot %}.' +versions: + fpt: '*' + ghec: '*' +children: + - /troubleshooting-github-copilot-in-visual-studio-code + - /troubleshooting-github-copilot-in-visual-studio + - /troubleshooting-github-copilot-in-a-jetbrains-ide + - /troubleshooting-github-copilot-in-neovim + - /troubleshooting-certificate-errors-for-github-copilot +--- diff --git a/content/copilot/troubleshooting-github-copilot/troubleshooting-certificate-errors-for-github-copilot.md b/content/copilot/troubleshooting-github-copilot/troubleshooting-certificate-errors-for-github-copilot.md new file mode 100644 index 0000000000..7d551608ac --- /dev/null +++ b/content/copilot/troubleshooting-github-copilot/troubleshooting-certificate-errors-for-github-copilot.md @@ -0,0 +1,31 @@ +--- +title: Troubleshooting certificate errors for GitHub Copilot +intro: 'Troubleshooting help for certificate-related errors.' +product: '{% data reusables.gated-features.copilot %}' +topics: + - Copilot + - Logging + - Troubleshooting +versions: + feature: copilot +shortTitle: Self-signed certificates +--- + +## Handling certificate-related errors + +Depending on your proxy setup, you may encounter errors like “certificate signature failure”, “self-signed certificate”, or “unable to verify the first certificate”. These errors are usually caused by a corporate proxy setup that intercepts secure connections, terminates the secure connection to {% data variables.product.prodname_dotcom %}, and instead uses a self-signed certificate to act like a TLS middleman. Support for this type of proxy is not available for all {% data variables.product.prodname_copilot%} licenses. +Possible ways to resolve this issue are: +* If you are using a corporate proxy, please contact your IT department to see if they can configure the proxy to not intercept secure connections. +* Properly install the proxy certificates on your machine in the OS trust chain. + {% note %} + + **Note:** This requires a {% data variables.product.prodname_copilot_for_business%} subscription. For more information about {% data variables.product.prodname_copilot_for_business%}, see "[About {% data variables.product.prodname_copilot_for_business%}](/enterprise-cloud@latest/copilot/overview-of-github-copilot/about-github-copilot-for-business)" in the {% data variables.product.prodname_ghe_cloud %} documentation. + + {% endnote %} +* Configure a different proxy that does not intercept secure connections. +* Configure {% data variables.product.prodname_copilot%} to ignore certificate errors. + {% warning %} + + **Warning:** Ignoring certificate errors is not recommended, since it might cause security issues. + + {% endwarning %} \ No newline at end of file diff --git a/content/copilot/troubleshooting-github-copilot/troubleshooting-github-copilot-in-a-jetbrains-ide.md b/content/copilot/troubleshooting-github-copilot/troubleshooting-github-copilot-in-a-jetbrains-ide.md new file mode 100644 index 0000000000..d57fca1419 --- /dev/null +++ b/content/copilot/troubleshooting-github-copilot/troubleshooting-github-copilot-in-a-jetbrains-ide.md @@ -0,0 +1,40 @@ +--- +title: Troubleshooting GitHub Copilot in a JetBrains IDE +intro: 'This article provides troubleshooting advice for errors related to {% data variables.product.prodname_copilot%} in a JetBrains IDE.' +product: '{% data reusables.gated-features.copilot %}' +topics: + - Copilot + - Logging + - Troubleshooting +versions: + feature: copilot +shortTitle: JetBrains +--- + +To troubleshoot issues with {% data variables.product.prodname_copilot%} or your Jetbrains IDE, you can view the log files. The location of the log files depends on the Jetbrains IDE you are using. For more information, see "[Configuring GitHub Copilot in a JetBrains IDE](/copilot/configuring-github-copilot/configuring-github-copilot-in-a-jetbrains-ide)." + +## Collecting log files + +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. +1. Go to **Show Log in**. +1. 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](https://intellij-support.jetbrains.com/hc/en-us/articles/207241085-Locating-IDE-log-files) in the Intellij documentation. + +### Collect log files from Rider + +1. In Rider, open the **Help** menu. +1. Go to **Diagnostic Tools**. +1. Go to **Show Log in**. +1. 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%}. diff --git a/content/copilot/troubleshooting-github-copilot/troubleshooting-github-copilot-in-neovim.md b/content/copilot/troubleshooting-github-copilot/troubleshooting-github-copilot-in-neovim.md new file mode 100644 index 0000000000..dfcb5d5aa9 --- /dev/null +++ b/content/copilot/troubleshooting-github-copilot/troubleshooting-github-copilot-in-neovim.md @@ -0,0 +1,19 @@ +--- +title: Troubleshooting GitHub Copilot in Neovim +intro: 'This article provides troubleshooting advice for errors related to {% data variables.product.prodname_copilot%} in Neovim.' +product: '{% data reusables.gated-features.copilot %}' +topics: + - Copilot + - Logging + - Troubleshooting +versions: + feature: copilot +shortTitle: Neovim +--- + +## Checking if {% data variables.product.prodname_copilot%} is operational + +To check if GitHub Copilot is operational, run the following command in Neovim: + + + :Copilot status diff --git a/content/copilot/troubleshooting-github-copilot/troubleshooting-github-copilot-in-visual-studio-code.md b/content/copilot/troubleshooting-github-copilot/troubleshooting-github-copilot-in-visual-studio-code.md new file mode 100644 index 0000000000..1c90ccc42e --- /dev/null +++ b/content/copilot/troubleshooting-github-copilot/troubleshooting-github-copilot-in-visual-studio-code.md @@ -0,0 +1,61 @@ +--- +title: Troubleshooting GitHub Copilot in Visual Studio Code +intro: 'This article provides troubleshooting advice for errors related to {% data variables.product.prodname_copilot%} in {% data variables.product.prodname_vscode %}.' +product: '{% data reusables.gated-features.copilot %}' +topics: + - Copilot + - Logging + - Troubleshooting +versions: + feature: copilot +shortTitle: Visual Studio Code +--- + +## 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 %}. +1. Click **Output**. +1. On the right of the Output view pane, select **{% data variables.product.prodname_copilot%}** from the dropdown menu. + +![Screenshot of {% data variables.product.prodname_copilot%} Output pane](/assets/images/help/copilot/vsc-output-pane.png) + +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 +1. 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 +1. 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. +1. Check the section on **Reachability** to determine if {% data variables.product.prodname_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 {% data variables.product.prodname_vscode_command_palette_shortname %} + - For Mac: + - Use: Shift+Command+P + - For Windows or Linux: + - Use Ctrl+Shift+P +1. Type "Toggle", and then select **Developer: Toggle Developer Tools** from the list. +1. In the Developer Tools window, select the **Console** tab to see any errors or warnings. + +![Screenshot of {% data variables.product.prodname_vscode %} Developer Console](/assets/images/help/copilot/vsc-electron-logs.png) + +## Further reading + +- "[Configuring {% data variables.product.prodname_copilot%} proxy support](/copilot/configuring-github-copilot/configuring-github-copilot-in-visual-studio-code#configuring-proxy-settings-for-github-copilot)" +- "[Network Connections in {% data variables.product.prodname_vscode %}](https://code.visualstudio.com/docs/setup/network)" in the {% data variables.product.prodname_vscode %} documentation diff --git a/content/copilot/troubleshooting-github-copilot/troubleshooting-github-copilot-in-visual-studio.md b/content/copilot/troubleshooting-github-copilot/troubleshooting-github-copilot-in-visual-studio.md new file mode 100644 index 0000000000..e4333cedb1 --- /dev/null +++ b/content/copilot/troubleshooting-github-copilot/troubleshooting-github-copilot-in-visual-studio.md @@ -0,0 +1,25 @@ +--- +title: Troubleshooting GitHub Copilot in Visual Studio +intro: 'This article provides troubleshooting advice for errors related to {% data variables.product.prodname_copilot%} in {% data variables.product.prodname_vs %}.' +product: '{% data reusables.gated-features.copilot %}' +topics: + - Copilot + - Logging + - Troubleshooting +versions: + feature: copilot +shortTitle: Visual Studio +--- + +## 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 %}. +1. Click **Output**. +1. On the right of the Output view pane, select **{% data variables.product.prodname_copilot%}** from the dropdown menu. + +![Screenshot of {% data variables.product.prodname_copilot%} Output pane](/assets/images/help/copilot/vs-output.png) + +## Further reading + +- "[Log all activity to the log file for troubleshooting](https://learn.microsoft.com/en-us/visualstudio/ide/reference/log-devenv-exe?view=vs-2022)" in the {% data variables.product.prodname_vs %} documentation