Troubleshooting
Knowing where to begin looking for information is the first step to reaching out for help. Many answers to commonly found problems can be found on the SonarLint channel of the Sonar Community Forum. See below for the basic steps to access the SonarLint logs when the analysis results are not what you expected.
Before posting to the Community, make sure that you have your logs ready by following the instructions below.
How to get SonarLint logs
- Open the Eclipse Console view.
- Open the SonarLint Console.
- Behind the double-gear dropdown menu in the Console view, enable Verbose output and Analysis logs.
- Reproduce the issue; for example, reopen the offending file.
IDE-specific traces are useful when troubleshooting only when Eclipse-specific activity is related to SonarLint errors.
How to get the Eclipse logs
Sometimes errors are not in the SonarLint console but could be directly in Eclipse error logs.
- Open Eclipse Error Log view: go to Eclipse > Window > Show view > Other... > General and select Error Log from the list
- Look for an error event related to SonarLint
- Open event details to get the stacktrace
How to get SonarLint thread dumps
In some cases, it can be useful to extract thread dumps from the running instance of your IDE for debugging; thread dumps can help us investigate UI freeze issues or threading problems.
If SonarLint does not start or stops working and the IDE is still running, thread dumps are necessary to properly troubleshoot the problem before the IDE is restarted. If you restart the IDE, some information about what was happening when it failed will be lost. Fortunately, thread dumps are easy to obtain for both SonarLint and your IDE.
Once obtained, please report your error to the Community forum. Your thread dump may contain sensitive details and if it’s required for further troubleshooting, it will be possible to share your thread dump privately.
Getting an IDE thread dump
You must first get the process ID for your IDE, then export the thread dump. The jps and jstack commands below are utilities that come bundled with the Java JDK.
- Run the following command and note the process ID number returned for your IDE:
jps- Second, run the following command using your process ID to return the thread dump. Be sure to specify your process ID and change the name of the output file if you’d like:
jstack -F -l {process id} > eclipse_thread_dump.txtGetting a SonarLint thread dump
Getting the process ID for SonarLint is the same as for the IDE; simply note the ID for SonarLintServerCli or run the command again, then export the thread dump. The jps and jstack commands below are utilities that come bundled with the Java JDK.
- Run the following command and note the process ID number returned for
SonarLintServerCli:
jps- Second, run the following command using your process ID to return the thread dump. Be sure to specify your process ID and change the name of the output file if you’d like:
jstack -F -l {process id} > sonarlint_thread_dump.txtTroubleshooting Connected Mode setup
No matching project found
No matching project is found because:
- It's best if you already have the project open in your IDE, otherwise SonarLint might not be able to find a matching file.
- SonarLint can get confused if you have multiple projects open in the workspace. Please open or choose the correct project and try again.
If these solutions don't help, follow these instructions to manually configure the project binding.
No matching issue found
SonarLint can't find your issue because:
- You might not be on the same branch.
- The issue was fixed, or the source code may be different from the analyzed version.
Troubleshooting unexpected analysis results
Sometimes, issues found on the server differ from those found locally by SonarLint. Usually, the server-side rule configuration (your quality profile) is to blame; however, it could be something more than that. Maybe your local build configuration and system dependencies don’t align with your DevOps pipeline, or it could simply be that the issue, due to its complexity, is only detectable by SonarQube or SonarCloud.
The collapsible below lists some of the most commonly encountered reasons, along with some details that will help you troubleshoot discrepancies.
Why your local analysis might be different than found on the server
Some issues might be detected by third-party analyzers
SonarLint will only run rules from SonarSource analyzers including custom rules extending SonarSource analyzers. Third-party analyzers usually have their own IDE integration, and there is no plan to run them inside of SonarLint.
Your test files might be mistaken as source files
Test files can be defined in SonarQube, on SonarCloud, or in the IDE. SonarLint for IntelliJ relies on the IDE to detect if a file is a test file, which is the case if:
- The file is under a test sources root. Those roots can be manually created by users or automatically populated by the IDE by relying on the build system such as Maven or Gradle, for example.
- The file is flagged as a test file by any plugin that you have installed. The IDE bundles some internal plugins like the “JavaScript and TypeScript” plugin; these internal plugins can infer if a file should be considered as a test file. Third-party plugins can also infer test files, and SonarLint will recognize these as such.
Some rules are too complex to run locally
Some rules can report issues at the project level or require extensive resources to analyze, such as injection vulnerabilities and some advanced bug detection rules; such issues are not displayed in SonarLint, only in SonarQube and SonarCloud. Please check the SonarLint roadmap for a list of features and enhancements on the horizon.
File or language types are not supported
Check your IDE’s Rules and languages page for a list of supported languages and file types.
The analyzer version may be different
Improvements are constantly being made to the Sonar analyzers during the CI/CD development cycle. Depending on the product version you are running, you may have a different analyzer therefore, the results might be different.
- SonarCloud is always running the latest analyzers.
- SonarQube runs the latest available analyzer at the time of its release.
- SonarLint runs the latest available analyzer at the time of its release.
- Sometimes SonarLint downloads and uses the same SonarQube or SonarCloud analyzer when running in Connected Mode.
Your project configuration may be different
Discrepancies in C and C++ analysis may result from different project builds and system dependencies. For example, you might have one set up in your local build configuration and another set up for your CI build configuration (or the configuration created by Autoscan).
FAQ
Are my SonarScanner properties applied to SonarLint?
No. Scanner properties you may have defined in the sonar-project.properties or pom.xml files (for example sonar.sources or sonar.projectBasedir) only make sense when modifying the SonarScanner in the command line. SonarLint tries to use IDE metadata to avoid other configurations.
If you want to share some configuration between SonarScanners and SonarLint, like File exclusions, or some specific analyzer properties, the best way is to use Connected Mode and set the configuration in the SonarQube or SonarCloud UI.
Was this page helpful?
© 2008-2024 SonarSource SA. All rights reserved. SONAR, SONARSOURCE, SONARQUBE, and CLEAN AS YOU CODE are trademarks of SonarSource SA.
