Skip to content

Change Debug Elasticsearch and debug-jvm order in TESTING.asciidoc #127801

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

Merged
merged 3 commits into from
May 14, 2025
Merged

Change Debug Elasticsearch and debug-jvm order in TESTING.asciidoc #127801

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b2a1686
Change `Debug Elasticsearch` and `debug-jvm` order.
vsop-479 May 7, 2025
5da27e6
Move configuration of IntelliJ together.
vsop-479 May 14, 2025
9a84c1b
Merge branch 'main' into fix_debug_jvm_doc2
PeteGillinElastic May 14, 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
16 changes: 8 additions & 8 deletions TESTING.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,20 +46,20 @@ run it using Gradle:
==== Launching and debugging from an IDE

If you want to run and debug Elasticsearch from your IDE, the `./gradlew run` task
supports a remote debugging option. Run the following from your terminal:

---------------------------------------------------------------------------
./gradlew run --debug-jvm
---------------------------------------------------------------------------

Next start the "Debug Elasticsearch" run configuration in IntelliJ. This will enable the IDE to connect to the process and allow debug functionality.

supports a remote debugging option. Start the "Debug Elasticsearch" run configuration in IntelliJ. This will enable the
IDE to connect to the process and allow debug functionality.

As such the IDE needs to be instructed to listen for connections on the debug port.
Since we might run multiple JVMs as part of configuring and starting the cluster it's
recommended to configure the IDE to initiate multiple listening attempts. In case of IntelliJ, this option
is called "Auto restart" and needs to be checked.

Next run the following from your terminal:

---------------------------------------------------------------------------
./gradlew run --debug-jvm
---------------------------------------------------------------------------
Copy link
Member

@PeteGillinElastic PeteGillinElastic May 13, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think that this should probably be moved below the following NOTE: paragraph. That note is about configuring IntelliJ, and it seems better to keep those bits together.

Copy link
Contributor Author

@vsop-479 vsop-479 May 14, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for your review @PeteGillinElastic , I think I addressed your suggestion.

Copy link
Member

@PeteGillinElastic PeteGillinElastic May 14, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It does address it, yes. Thanks.


NOTE: If you have imported the project into IntelliJ according to the instructions in
link:/CONTRIBUTING.md#importing-the-project-into-intellij-idea[CONTRIBUTING.md] then a debug run configuration
named "Debug Elasticsearch" will be created for you and configured appropriately.
Expand Down