diff --git a/DEVELOPER_GUIDE.rst b/DEVELOPER_GUIDE.rst index f7798c9e92..d0d869e1d0 100644 --- a/DEVELOPER_GUIDE.rst +++ b/DEVELOPER_GUIDE.rst @@ -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 `_. + License Header --------------