Can't debug custom rules plugin

SonarQube Server / Community Build Plugin Development
1

Hi. I’m trying to develop a plugin with an extended set of rules for my project. I have created a plugin based on the sample plugin example. I built it with maven and added it to extensions/plugins folder.

After that I added the following to sonar.properties :
sonar.web.javaAdditionalOpts=-agentlib:jdwp=transport=dt_socket,server=y,suspend=y,address=5005

Running sonarqube ( native instance, no docker image )

./sonar.sh console

Screenshot_20250217_205159
Screenshot_20250217_2051591920×525 165 KB

Debugger settings:

Screenshot_20250217_205251
Screenshot_20250217_2052511731×1181 127 KB

After attaching a debugger to the process, and the debugger even stops in my plugin’s entrypoint

Screenshot_20250217_205426
Screenshot_20250217_2054262233×1180 191 KB

After which the sonar starts up correctly
And I’m running a sonar scanner.

sonar-scanner -Dsonar.token="<token>" -Dsonar.projectKey=magento2 -Dsonar.sources=. -Dsonar.scanner.debug=true

The analysis went correctly. I can see that my rule worked ( the error appeared after the analysis). But the debugger did not stop at the classes of custom checks.
I also tried to do it with
export SONAR_SCANNER_OPTS="-agentlib:jdwp=transport=dt_socket,server=y,suspend=y,address=8001”
Before starting the scanner, but neither the process on port 5005 nor on port 8001 stops.
Please help(

2

Hi,

The rules are executed by the scanner, so you don’t need to start the SonarQube Server in the debugger.

The SonarScanner distribution comes with a handy “sonar-scanner-debug” script which sets the correct environment variables.

2 Likes
3

Thanks, that saved me a lot of time. Oh, my God.
Btw, why is there no any information about “sonar-scanner-debug” in the docs?

1 Like
4

@Scott :exploding_head: I did not know about this.

It probably deserves a mention in Developing a plugin. I’ll ping our Docs folks and get that in the backlog.