From 67abba01f5c22a25aed75c6b31ad447aecd648ee Mon Sep 17 00:00:00 2001 From: Mehmet YILMAZ Date: Fri, 23 Aug 2024 12:16:18 +0300 Subject: [PATCH] Add Debugging Instructions to Devcontainer Setup in CONTRIBUTING.md (#7673) **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. --------- Co-authored-by: Mehmet YILMAZ --- .devcontainer/.psqlrc | 2 +- CONTRIBUTING.md | 22 ++++++++++++++++++++++ 2 files changed, 23 insertions(+), 1 deletion(-) diff --git a/.devcontainer/.psqlrc b/.devcontainer/.psqlrc index 7642a97149d..07ea06cddcc 100644 --- a/.devcontainer/.psqlrc +++ b/.devcontainer/.psqlrc @@ -3,5 +3,5 @@ \pset border 2 \setenv PAGER 'pspg --no-mouse -bX --no-commandbar --no-topbar' \set HISTSIZE 100000 -\set PROMPT1 '\n%[%033[1m%]%M %n@%/:%>-%p%R%[%033[0m%]%# ' +\set PROMPT1 '\n%[%033[1m%]%M %n@%/:%> (PID: %p)%R%[%033[0m%]%# ' \set PROMPT2 ' ' diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e1900642d3e..70cc486e74e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -35,6 +35,28 @@ To get citus installed from source we run `make install -s` in the first termina With the Citus cluster running you can connect to the coordinator in the first terminal via `psql -p9700`. Because the coordinator is the most common entrypoint the `PGPORT` environment is set accordingly, so a simple `psql` will connect directly to the coordinator. +### Debugging in the VS code + +1. Start Debugging: Press F5 in VS Code to start debugging. When prompted, you'll need to attach the debugger to the appropriate PostgreSQL process. + +2. Identify the Process: If you're running a psql command, take note of the PID that appears in your psql prompt. For example: +``` +[local] citus@citus:9700 (PID: 5436)=# +``` +This PID (5436 in this case) indicates the process that you should attach the debugger to. +If you are uncertain about which process to attach, you can list all running PostgreSQL processes using the following command: +``` +ps aux | grep postgres +``` + +Look for the process associated with the PID you noted. For example: +``` +citus 5436 0.0 0.0 0 0 ? S 14:00 0:00 postgres: citus citus +``` +4. Attach the Debugger: Once you've identified the correct PID, select that process when prompted in VS Code to attach the debugger. You should now be able to debug the PostgreSQL session tied to the psql command. + +5. Set Breakpoints and Debug: With the debugger attached, you can set breakpoints within the code. This allows you to step through the code execution, inspect variables, and fully debug the PostgreSQL instance running in your container. + ### Getting and building [PostgreSQL documentation](https://www.postgresql.org/support/versioning/) has a