Skip to content

Commit 35518dc

Browse files
authored
Add debugger details to dev guide (#3732)
1 parent e32c945 commit 35518dc

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

DEVELOPER_GUIDE.rst

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -87,6 +87,16 @@ Firstly you need to add the following configuration to the JVM used by your IDE.
8787

8888
-agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=5005
8989

90+
This is automatically applied if you pass the ``debugJVM`` flag when
91+
running.
92+
93+
::
94+
95+
./gradlew opensearch-sql:run -DdebugJVM
96+
97+
To connect to the cluster with the debugger in an IDE, you’ll need to
98+
connect to that port. For IntelliJ, see `attaching to a remote process <https://www.jetbrains.com/help/idea/attach-to-process.html#attach-to-remote>`_.
99+
90100
License Header
91101
--------------
92102

0 commit comments

Comments
 (0)