From 8d0edf45c195afb9e7f2e1c10928589ac8b9577b Mon Sep 17 00:00:00 2001 From: "opensearch-trigger-bot[bot]" <98922864+opensearch-trigger-bot[bot]@users.noreply.github.com> Date: Tue, 26 Nov 2024 10:31:02 -0800 Subject: [PATCH] Add simple IntelliJ debugger config (#2287) (#2288) Signed-off-by: Jay Deng (cherry picked from commit 0bbeac37327d744e899241326a75b04653cbbb5c) Co-authored-by: Jay Deng --- .idea/runConfigurations/Debug_OpenSearch.xml | 15 +++++++++++++++ DEVELOPER_GUIDE.md | 2 +- 2 files changed, 16 insertions(+), 1 deletion(-) create mode 100644 .idea/runConfigurations/Debug_OpenSearch.xml diff --git a/.idea/runConfigurations/Debug_OpenSearch.xml b/.idea/runConfigurations/Debug_OpenSearch.xml new file mode 100644 index 000000000..c18046f87 --- /dev/null +++ b/.idea/runConfigurations/Debug_OpenSearch.xml @@ -0,0 +1,15 @@ + + + + \ No newline at end of file diff --git a/DEVELOPER_GUIDE.md b/DEVELOPER_GUIDE.md index c39a6f1b6..ad696fda1 100644 --- a/DEVELOPER_GUIDE.md +++ b/DEVELOPER_GUIDE.md @@ -412,7 +412,7 @@ OR ./gradlew run --debug-jvm # to just start a cluster that can be debugged ``` -The OpenSearch server JVM will connect to a debugger attached to `localhost:5005` before starting. If there are multiple nodes, the servers will connect to debuggers listening on ports `5005, 5006, ...` +The OpenSearch server JVM will connect to a debugger attached to `localhost:5005` before starting. If there are multiple nodes, the servers will connect to debuggers listening on ports `5005, 5006, ...`. A simple debugger configuration for IntelliJ is included in this project and can be found [here](https://github.com/opensearch-project/k-NN/tree/main/.idea/runConfigurations/Debug_OpenSearch.xml). To debug code running in an integration test (which exercises the server from a separate JVM), first, setup a remote debugger listening on port `8000`, and then run: