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

Add Debugging Instructions to Devcontainer Setup in CONTRIBUTING.md #7673

Merged
merged 3 commits into from
Aug 23, 2024

Conversation

m3hm3t
Copy link
Contributor

@m3hm3t m3hm3t commented Aug 21, 2024

Description:
This PR adds a section to CONTRIBUTING.md that explains how to set up debugging in the devcontainer using VS Code.

Changes:

  • New Debugging Section: Clear instructions on starting the debugger, selecting the appropriate PostgreSQL process, and setting breakpoints for easier troubleshooting.

Purpose:

  • Improved Contributor Workflow: Enables contributors to debug the Citus extension within the devcontainer, enhancing productivity and making it easier to resolve issues.

@m3hm3t m3hm3t requested a review from thanodnl August 21, 2024 13:15
@m3hm3t m3hm3t self-assigned this Aug 21, 2024
Copy link

codecov bot commented Aug 21, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 89.69%. Comparing base (9e1852e) to head (b096b85).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #7673      +/-   ##
==========================================
- Coverage   89.69%   89.69%   -0.01%     
==========================================
  Files         283      283              
  Lines       60510    60509       -1     
  Branches     7541     7541              
==========================================
- Hits        54277    54276       -1     
  Misses       4077     4077              
  Partials     2156     2156              

@m3hm3t m3hm3t marked this pull request as draft August 21, 2024 19:53
@m3hm3t m3hm3t force-pushed the users/m3hm3t/devcontainer_debug branch from 120a686 to 150c515 Compare August 21, 2024 19:58
@m3hm3t m3hm3t marked this pull request as ready for review August 21, 2024 19:59
CONTRIBUTING.md Outdated
Comment on lines 41 to 43
```
postgres: citus citus [local] idle
```
Copy link
Member

Choose a reason for hiding this comment

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

Although this works great when having a single psql session open, it fails when multiple sessions open, or when you are connecting over the tcp stack instead of the named pipe.

Not saying to remove this, as it could cover a good portion of the simple workflows.

However, it would be great to add a section on the pid of the backend you are connected to. When running in the devcontainer a .psqlrc is installed in the devcontainer which changes the prompt of psql to show the pid of the running process.

citus@07de2e6180a9:/data$ psql
Timing is on.
Line style is unicode.
Border style is 2.
psql (16.2)
Type "help" for help.


[local] citus@citus:9700-3783=# 

The last number in the prompt, 3783 is the pid of the backend that psql session is connected to.

If you have the process selector open for the debugger you can simply type these numbers, which is generally easier than typing the name of the process - although a tactical [local] will filter it down to the sessions connected via the named pipe.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks for the feedback! @thanodnl

You're right, this method works well for simple workflows with a single psql session but can be tricky when dealing with multiple sessions or TCP connections. I added a section to clarify how to locate the pid of the backend you're connected to in the container setup. The .psqlrc prompt tweak showing the pid is a great tip—I included it.

@m3hm3t m3hm3t merged commit 68d28ec into main Aug 23, 2024
123 checks passed
@m3hm3t m3hm3t deleted the users/m3hm3t/devcontainer_debug branch August 23, 2024 09:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants