kfaraz commented on code in PR #12697:
URL: https://github.com/apache/druid/pull/12697#discussion_r905311840


##########
dev/intellij-setup.md:
##########
@@ -69,6 +69,14 @@ Before running or debugging the apps, you should do a `mvn 
clean install -Pdist
 
 You may also add `-Ddruid.console.skip=true` to the command if you're focusing 
on backend servers instead of frontend project. This option saves great 
building time.
 
+## Debugging Running Druid from Intellij

Review Comment:
   Nit: The words "debugging" and "running" seem a little confusing in 
conjunction.
   
   ```suggestion
   ## Debug a running Druid cluster using Intellij
   ```
   or something to that effect.



##########
dev/intellij-setup.md:
##########
@@ -69,6 +69,14 @@ Before running or debugging the apps, you should do a `mvn 
clean install -Pdist
 
 You may also add `-Ddruid.console.skip=true` to the command if you're focusing 
on backend servers instead of frontend project. This option saves great 
building time.
 
+## Debugging Running Druid from Intellij
+Intellij IDEA debugger can attach to a local or remote Java process (Druid 
process). 
+First, you must enable debugging in the application.

Review Comment:
   Would it be better to write these steps in a list format?
   
   Something like:
   ```suggestion
   Follow these steps to debug a Druid process using the IntelliJ IDEA debugger.
   1. Enable debugging in the Druid process
      a. For Druid services (Overlord, Coordinator, etc.) ...
      b. For peons (...
   2. Find the port assigned to the Druid process.
      a. For Druid services, you can find it in ...
      b. For peons, you can find the assigned ephemeral port ... task log
   3. Create a remote configuration in the Run/Debug configurations dialog ...
   4. Start (debug) the above remote configuration
   ```
   



##########
integration-tests/README.md:
##########
@@ -212,6 +212,7 @@ For your convenience, Druid processes running inside Docker 
have been debugging
 | Historical | 5007 |
 | Middlemanager | 5008 |
 | Overlord | 5009 |
+| Peons (Workers on Middle Manager) |  Ephemeral port assigned by debugger 
(check task log for port assigned to each task)

Review Comment:
   Nit: to correspond to previous lines:
   
   ```suggestion
   | Peons (Workers on Middlemanager) |  Ephemeral port assigned by debugger 
(check task log for port assigned to each task) |
   ```



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: [email protected]

For queries about this service, please contact Infrastructure at:
[email protected]


---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]

Reply via email to