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

Improve docs for debugging a charm #1520

Open
sed-i opened this issue Jan 6, 2025 · 0 comments
Open

Improve docs for debugging a charm #1520

sed-i opened this issue Jan 6, 2025 · 0 comments
Labels
docs Improvements or additions to documentation

Comments

@sed-i
Copy link
Contributor

sed-i commented Jan 6, 2025

Currently, we only have:

https://juju.is/docs/sdk/debug-a-charm

There should probably be dedicated tutorials/howtos for:

  • set_breakpointhook
  • how to set up vscode/pycharm for remote debugging

operator/ops/framework.py

Lines 658 to 659 in 6536f2a

def set_breakpointhook(self) -> Optional[Any]:
"""Hook into ``sys.breakpointhook`` so the builtin ``breakpoint()`` works as expected.

This issue is part of a cross-team effort (juju, jhack, ops, o11y) for improving debugging docs.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants