Troubleshooting Overview - kevin-hinz/sonarlint-docs-migration-render GitHub Wiki

Page Item: Troubleshooting SLUG: troubleshooting

HEADING 1

CONTENT CAN BE FED BY INPUT FROM THE COMMUNITY FORUM AND/OR REFERENCE TO THE COMMUNITY

tabbed

Eclipse

PLACE ECLIPSE CONTENT HERE TO ENTERED INTO THE KONTENT.AI-SPECIFIC ASSET

How to get SonarLint for Eclipse logs

  1. Open the Eclipse Console view

  2. Open the SonarLint Console

    Logs

  3. Enable Verbose output and Analysis logs

    Verbose Logs

  4. Reproduce the issue (for example, reopen the offending file)

Sometimes errors are not in the SonarLint console but could be directly in Eclipse error logs. To find these errors:

  1. Open your Eclipse Error Log view.

  2. Look for an error event related to SonarLint.

  3. Open event details to get the stacktrace.

    Error Logs

I have configured some SonarScanner properties. Are they 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 exclusions, or some analyzer properties, the best way is to use Connected Mode and set the configuration in the SonarQube or SonarCloud UI

tabbed

IntelliJ

PLACE INTELLIJ CONTENT HERE TO ENTERED INTO THE KONTENT.AI-SPECIFIC ASSET

How to get SonarLint for IntelliJ logs

  1. Open the SonarLint tool window: View > Tool Windows > SonarLint.

  2. Enable the Verbose output and Analysis logs options in the tool window settings.

    Logs

  3. Find the logs in the Log tab of the tool window.

How to access thread dumps

In some cases, it can be useful to extract thread dumps from the running instance of IntelliJ for debugging; thread dumps often help us investigate UI freeze issues or threading problems. This article from JetBrains will help you find or generate those dumps.

If the UI is still reactive, you have another alternative: select Help > Collect Logs and Diagnostic Data to create a .zip file containing one or several threadDumps-XXX folders. In these folders, you should find one .txt file with the current date and time that will contain the logs.

I have configured some SonarScanner properties. Are they 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 exclusions, or some analyzer properties, the best way is to use Connected Mode and set the configuration in the SonarQube or SonarCloud UI

tabbed

Visual Studio

PLACE VISUAL STUDIO CONTENT HERE TO ENTERED INTO THE KONTENT.AI-SPECIFIC ASSET

C or C±± Analysis

Starting with version 4.21, it is possible to create a "reproducer" file for C/C++ analysis. A reproducer file contains diagnostic information to help the developers at SonarSource investigate problems that occur during C/C++ analysis.

Note: Starting with version 4.27, a second "reproducer" file is created with additional debug information.

If you encounter a problem with C/C++ analysis, please contact us in the community forum and include the reproducer file(s).

Creating a reproducer file for the Active Document

To create a reproducer:

  • open the C/C++ file that is not being analysed correctly
  • open Visual Studio's Command Window, found under View -> Other Windows -> Command Window.
  • type in the command window "Analyze.SonarLint.CFamily.CreateReproducer":

Create reproducer command

You can then view the location of the created reproducer file(s) in the SonarLint Output pane:

Reproducer file in SonarLint 4.21-4.26 Reproducer information in the SonarLint output pane versions 4.21-4.26.

Reproducer files in SonarLint 4.27 Reproducer information in the SonarLint output pane version 4.27.

Notes:

  • the reproducer file(s) are regenerated each time the command is invoked. Invoking the command will overwrite the previous reproducer file(s).
  • running the reproducer will only produce the reproducer file(s). It will not report any issues for the active C/C++ file.

tabbed

Visual Studio Code

PLACE VISUAL STUDIO CONTENT HERE TO ENTERED INTO THE KONTENT.AI-SPECIFIC ASSET

How to get SonarLint for VSCode logs?

  1. Open the SonarLint extension settings: Manage > Settings > Extensions > SonarLint

  2. Enable the Show Verbose Logs and select the Show Analyzer Logs options in the extension settings.

    Settings

  3. Switch the output in the VSCode console: Output > SonarLint

    Output