Skip to content

Add debugger details to dev guide #3732

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.

Sign up for GitHub

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

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Add debugger details to dev guide #3732

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c61afc0
Add details to dev guide
Swiddis Jun 4, 2025
0294532
RST, not MD
Swiddis Jun 4, 2025
000bb25
Update DEVELOPER_GUIDE.rst
Swiddis Jun 12, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions DEVELOPER_GUIDE.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,16 @@ Firstly you need to add the following configuration to the JVM used by your IDE.

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

This is automatically applied if you pass the ``debugJVM`` flag when
running.

::

./gradlew opensearch-sql:run -DdebugJVM

To connect to the cluster with the debugger in an IDE, you’ll need to
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>`_.

License Header
--------------

Expand Down
Loading