How can I debug my Quarkus application that is running in dev mode?

Question

I have launched my application using the Quarkus dev mode (mvn quarkus:dev) and I would like to be able to debug it.

How can do that?

score 58 · Accepted Answer · edited Aug 25 '23 at 12:57

58

When launching a Quarkus app simply using mvn quarkus:dev, the running application is configured to open port 5005 for remote debugging. That means that all you have to do is point your remote debugger to that port and you will be able to debug it in your favorite IDE/lightweight editor.

If however you would like to be able to suspend the application until a debugger is connected then simply execute:

Maven:

mvn quarkus:dev -Dsuspend

Gradle:

./gradlew quarkusDev -Dsuspend=true

The same port is used (5005) but this time the application doesn't start until a remote debugger is connected. You can use -Ddebug to change the debugging port.

UPDATE

As of version 2020.3, IntelliJ Ultimate should recognize a quarkus application and automatically create a launch configuration that uses quarkus:dev under the hood.

edited Aug 25 '23 at 12:57

Jmini

9,189
2
55
77

answered Mar 15 '19 at 20:13

geoand

60,071
24
172
190

This doesn't work for me - it just hangs at Listening for transport dt_socket at address: 5005 - attach to process works but I'm looking for a one step solution like Spring or similar – Charlie Apr 19 '21 at 17:25
The one step solution is provided by IntelliJ Ultimate as I mention above. – geoand Apr 20 '21 at 07:53
@geoand This question has a lot of SEO ranking and is a FAQ. Is it still accurate? – Geoffrey De Smet Apr 19 '22 at 09:40
It seems like you fixed it, thanks! – geoand Apr 19 '22 at 16:40
@geoand I use gradle and `gradlew quarkusDev -Dsuspend` does not work for me, the application starts up and does not wait for debugger to attach. Quarkus version : 2.9.2.Final – Kiran K Apr 04 '23 at 14:42
output when i use `gradlew quarkusDev -Dsuspend -Ddebug` is : Ignoring invalid value "" for "suspend" param and defaulting to "n" FAILURE: Build failed with an exception. – Kiran K Apr 04 '23 at 15:04
Have you tried `gradlew quarkusDev -Dsuspend=true`? – geoand Apr 05 '23 at 07:26

score 31 · Answer 2 · answered Feb 03 '20 at 12:24

31

In case you are using IntellJ IDEA run your application normally (without debugging) and then go to

RUN --> Attach to Process.

This will attach the debugger separately and has worked for me.

answered Feb 03 '20 at 12:24

Marian Klühspies

15,824
16
93
136

5

How to do it in one step though? – Jon Nov 24 '20 at 07:27
@Jon, my answer may be helpful. Here is the link to it: https://stackoverflow.com/a/76177085/1278463 – Borislav Gizdov May 04 '23 at 20:30

Borislav Gizdov · Answer 3 · 2023-05-04T20:28:12.723

To start a Quarkus application directly with debug configuration in IntelliJ IDEA, you have the option of using "mvn quarkus:dev" and then attaching, but it's easier to use a plugin. To debug a Quarkus app in IntelliJ IDEA, follow these steps:

Install the Quarkus Run Configs plugin: https://plugins.jetbrains.com/plugin/14242-quarkus-run-configs
Open the Run menu, select "Edit Configurations," and then add a new configuration for Quarkus (Maven/Gradle).
Set the name, working directory, and JRE, and click "OK."

enter image description here

Click the debug button or use "cmd + D".

enter image description here

How can I debug my Quarkus application that is running in dev mode?

3 Answers3

Linked