Skip to content
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.

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

Debug: Enable debug mode from setting menu #3342

Merged
merged 7 commits into from
Mar 8, 2024
Merged

Debug: Enable debug mode from setting menu #3342

merged 7 commits into from
Mar 8, 2024

Conversation

abeatrix
Copy link
Contributor

@abeatrix abeatrix commented Mar 7, 2024

Part of Better debugging facilities for enterprise issues

New commands to make debugging Cody easier:

  • cody.debug.outputChannel
    • open the Cody output channel
  • cody.debug.enable.all
    • enable both cody.debug.enable and cody.debug.verbose and open output channel with one click

New sidebar menu item to open output channel

image

New button in the Cody Setting menu to enable debug mode and open output channel on click

image

All debug commands are also grouped together and are available through the command palette

image

Test plan

debug.mov

Getting Started

In the Command Palette, type > Cody Debug to find a list of available commands for debugging Cody.

image

Debug Commands

  1. Cody Debug: Enable Debug Mode
  • This enables additional debug logging to help troubleshoot issues
  • It also opens the Output Channel for Cody
  1. Cody Debug: Export Log
  • export the logs in text file format to the selected location
  1. Cody Debug: Open Output Channel
  • Opens the Output Channel for Cody, where you can observe logs streaming each time an action is performed in Cody.

@abeatrix abeatrix requested review from slimsag and a team March 7, 2024 20:46
@slimsag
Copy link
Member

slimsag commented Mar 7, 2024

Thank you so much for working on this!

New sidebar menu item to open output channel

Very helpful!

New button in the Cody Setting menu to enable debug mode and open output channel on click

Also very helpful!

Could the button to enable debug mode also be available under the ... menu?

image

That way all the debugging tools are nested under there (having a one-stop shop for that stuff is super nice)

@abeatrix
Copy link
Contributor Author

abeatrix commented Mar 7, 2024

@slimsag Glad you find it helpful 🤗 Love that idea! I have updated it so that if cody.debug.verbose is not enabled, the Enable Debug Mode item will show up in the ... menu. This will make it easier for us to tell if the user has enabled debug mode or not in one place, wdyt?

When cody.debug.verbose is on:

image

When cody.debug.verbose is off:

image

@slimsag
Copy link
Member

slimsag commented Mar 7, 2024

Perfect!

Copy link
Contributor

@philipp-spiess philipp-spiess left a comment

Choose a reason for hiding this comment

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

Awesome but there's a more elegant way to open the output view, let's change this quickly 😅

vscode/src/services/utils/export-logs.ts Outdated Show resolved Hide resolved
vscode/src/services/utils/export-logs.ts Outdated Show resolved Hide resolved
@philipp-spiess
Copy link
Contributor

oh and don't forget about adding a change log entry 😎

abeatrix and others added 3 commits March 8, 2024 08:08
@abeatrix abeatrix merged commit 945be22 into main Mar 8, 2024
16 checks passed
@abeatrix abeatrix deleted the bee/debug-mode branch March 8, 2024 16:49
steveyegge pushed a commit that referenced this pull request Mar 13, 2024
Co-authored-by: Philipp Spiess <hello@philippspiess.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants