From 0bbeac37327d744e899241326a75b04653cbbb5c Mon Sep 17 00:00:00 2001
From: Jay Deng <jayd0104@gmail.com>
Date: Mon, 25 Nov 2024 23:19:54 -0800
Subject: [PATCH] Add simple IntelliJ debugger config (#2287)

Signed-off-by: Jay Deng <jayd0104@gmail.com>
---
 .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 @@
+<component name="ProjectRunConfigurationManager">
+  <configuration default="false" name="Debug OpenSearch" type="Remote">
+    <option name="USE_SOCKET_TRANSPORT" value="true" />
+    <option name="SERVER_MODE" value="true" />
+    <option name="SHMEM_ADDRESS" />
+    <option name="HOST" value="localhost" />
+    <option name="PORT" value="5005" />
+    <option name="AUTO_RESTART" value="true" />
+    <RunnerSettings RunnerId="Debug">
+      <option name="DEBUG_PORT" value="5005" />
+      <option name="LOCAL" value="false" />
+    </RunnerSettings>
+    <method v="2" />
+  </configuration>
+</component>
\ No newline at end of file
diff --git a/DEVELOPER_GUIDE.md b/DEVELOPER_GUIDE.md
index 5f79d222b..9a6a375c1 100644
--- a/DEVELOPER_GUIDE.md
+++ b/DEVELOPER_GUIDE.md
@@ -413,7 +413,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: