Skip to content

Revamp debugging section #3224

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 26, 2021
Merged

Revamp debugging section #3224

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 29 additions & 4 deletions .github/ISSUE_TEMPLATE/bug-report.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,14 @@ assignees: ""

Hi there! 👋

Thanks for reporting a bug. Please see https://github.com/cdr/code-server/blob/main/docs/FAQ.md#how-do-i-debug-issues-with-code-server and include any logging information relevant to the issue.

Please search for existing issues before filing, as they may contain additional information about the problem and descriptions of workarounds. Provide as much information as you can, so that we can reproduce the issue. Otherwise, we may not be able to help diagnose the problem, and may close the issue as unreproducible or incomplete. For visual defects, please include screenshots to help us understand the issue.
Thanks for reporting a bug.

Please search for existing issues before filing, as they may contain additional
information about the problem and descriptions of workarounds. Provide as much
information as you can, so that we can reproduce the issue. Otherwise, we may
not be able to help diagnose the problem, and may close the issue as
unreproducible or incomplete. For visual defects, please include screenshots to
help us understand the issue.
-->

## OS/Web Information
Expand All @@ -37,9 +42,29 @@ Please search for existing issues before filing, as they may contain additional

<!-- What actually happens? -->

## Logs

<!--
First run code-server with at least debug logging (or trace to be really
thorough) by setting the --log flag or the LOG_LEVEL environment variable. -vvv
and --verbose are aliases for --log trace. For example:

code-server --log debug

Once this is done, replicate the issue you're having then collect logging
information from the following places:

1. The most recent files from ~/.local/share/code-server/coder-logs.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Line added here, but removed from the debugging FAQ;

2. The browser console.
3. The browser network tab.

Additionally, collecting core dumps (you may need to enable them first) if
code-server crashes can be helpful.
-->

## Screenshot

<!-- Ideally provide a screenshot, gif, video or screenrecording -->
<!-- Ideally provide a screenshot, gif, video or screen recording. -->

## Notes

Expand Down
4 changes: 2 additions & 2 deletions docs/FAQ.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -330,8 +330,8 @@ Once this is done, replicate the issue you're having then collect logging
information from the following places:

1. The most recent files from `~/.local/share/code-server/coder-logs`.
2. The most recently created directory in the `~/.local/share/code-server/logs` directory.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Line removed here, but still present in the issue template;

3. The browser console and network tabs.
2. The browser console.
3. The browser network tab.

Additionally, collecting core dumps (you may need to enable them first) if
code-server crashes can be helpful.
Expand Down