Create COLLECT-LOGS.md for log collection guidance#1470
Conversation
Added detailed instructions on how to collect logs for troubleshooting, including exceptions, freeze events, and log files.
There was a problem hiding this comment.
Pull request overview
Adds a new troubleshooting document to help users gather diagnostics for GitHub Copilot Plugin for JetBrains IDEs issues, focusing on where to find exceptions, freeze reports, and IDE log files.
Changes:
- Introduces
COLLECT-LOGS.mdwith step-by-step log collection instructions. - Adds screenshot-based guidance for exception notifications and freeze events.
- Links to the existing wiki page for enabling debug logging.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
You can also share your feedback on Copilot code review. Take the survey.
|
|
||
| ## 2. Freeze Events | ||
| Freeze event shows up as a notification in the editor area as below, please click "Report problem". | ||
| <img width="905" height="288" alt="image" src="https://github.com/user-attachments/assets/da331f91-394e-4cc0-8b05-880641846b1b" /> |
There was a problem hiding this comment.
The image alt text is just "image", which isn’t accessible for screen readers and doesn’t convey what the screenshot shows. Please replace the alt text with a short, descriptive phrase (e.g., what dialog/notification the screenshot depicts).
| Please do the following: | ||
| 1. Open an issue with stack trace attached | ||
| 2. Click "Report to plugin owner" to send a copy of the stack trace directly to us | ||
| <img width="956" height="731" alt="image" src="https://github.com/user-attachments/assets/95bd44f6-0ff4-4ed4-86ff-c1008b94db1e" /> |
There was a problem hiding this comment.
The image alt text is just "image", which isn’t accessible for screen readers and doesn’t convey what the screenshot shows. Please replace the alt text with a short, descriptive phrase (e.g., what dialog/notification the screenshot depicts).
| To show where the logs persist, click "Help -> Show Log in Explorer (Finder)". Then you'll see series of log files named | ||
| idea.{#}.log | ||
| You can selectively share log snippets with us. Or feel free to attach all log files in the issue. |
There was a problem hiding this comment.
“Then you'll see series of log files named idea.{#}.log” is both grammatically incorrect (“a series…”) and inconsistent with the repo’s bug report template, which instructs users to attach idea.log (see .github/ISSUE_TEMPLATE/bug_report.yml). Please align the filename pattern and format it as inline code to avoid confusion.
| To show where the logs persist, click "Help -> Show Log in Explorer (Finder)". Then you'll see series of log files named | |
| idea.{#}.log | |
| You can selectively share log snippets with us. Or feel free to attach all log files in the issue. | |
| To show where the logs persist, click "Help -> Show Log in Explorer (Finder)". Then you'll see the main log file named `idea.log` (and possibly additional rotated log files). | |
| You can selectively share log snippets with us, or feel free to attach the `idea.log` file (and any related log files) in the issue. |
|
|
||
| To show where the logs persist, click "Help -> Show Log in Explorer (Finder)". Then you'll see series of log files named | ||
| idea.{#}.log | ||
| You can selectively share log snippets with us. Or feel free to attach all log files in the issue. |
There was a problem hiding this comment.
This guidance encourages users to attach logs/stack traces, but it doesn’t warn that logs can contain personal data, file paths, repository names, or tokens. Please add a short note asking users to review/redact sensitive information before posting publicly on GitHub issues.
| To show where the logs persist, click "Help -> Show Log in Explorer (Finder)". Then you'll see series of log files named | ||
| idea.{#}.log | ||
| You can selectively share log snippets with us. Or feel free to attach all log files in the issue. | ||
| <img width="205" height="102" alt="image" src="https://github.com/user-attachments/assets/152780a7-75a7-45fd-ab12-48bdeb074db9" /> |
There was a problem hiding this comment.
The image alt text is just "image", which isn’t accessible for screen readers and doesn’t convey what the screenshot shows. Please replace the alt text with a short, descriptive phrase (e.g., what dialog/notification the screenshot depicts).
| @@ -0,0 +1,26 @@ | |||
| # How to Collect Logs | |||
| Thank you so much for providing steps to help us reproduce the issue. There are cases when you are not sure what is actually happening. In this case, logs are also crucial for us to troubleshoot. So please watch out for logs and attach them in the issues. There are three places where you can find logs - exceptions, freezes and logs files. | |||
There was a problem hiding this comment.
Line 2 has several grammatical issues that make the instructions harder to follow (e.g., “attach them in the issues”, “logs files”, and the long run-on paragraph). Please rephrase for clarity (e.g., “attach them to the issue”, and “log files”) and consider splitting into shorter sentences.
|
|
||
| ## 1. Exceptions | ||
| Please pay attention to this kind of notifications at the bottom right corner. | ||
| <img width="394" height="102" alt="image" src="https://github.com/user-attachments/assets/a14753e8-bcdb-4b2f-b1f9-eb572b5c8e2e" /> |
There was a problem hiding this comment.
The image alt text is just "image", which isn’t accessible for screen readers and doesn’t convey what the screenshot shows. Please replace the alt text with a short, descriptive phrase (e.g., what dialog/notification the screenshot depicts).
| Please pay attention to this kind of notifications at the bottom right corner. | ||
| <img width="394" height="102" alt="image" src="https://github.com/user-attachments/assets/a14753e8-bcdb-4b2f-b1f9-eb572b5c8e2e" /> | ||
| Whenever you see them, please click to show this dialog. | ||
| <img width="956" height="731" alt="image" src="https://github.com/user-attachments/assets/3a8a64d4-4155-497c-87de-912a259bdd1d" /> |
There was a problem hiding this comment.
The image alt text is just "image", which isn’t accessible for screen readers and doesn’t convey what the screenshot shows. Please replace the alt text with a short, descriptive phrase (e.g., what dialog/notification the screenshot depicts).
Added detailed instructions on how to collect logs for troubleshooting, including exceptions, freeze events, and log files.