10.3 | Analyzing source code | Analysis parameters

On this page

Analysis parameters

Project analysis settings can be configured in multiple places. Each plugin and language analyzer adds its own properties which can be defined in the SonarQube UI; these properties can also be defined as analysis parameters, however, the descriptions of those properties and the best place to set them is in the UI when possible. Only parameters set through the UI are reusable for subsequent analysis and there is a structure to the way parameters are read by the scanner.

Here is the hierarchy in order of precedence:

Diagram showing settings hierarchy.
  1. Global properties: Apply to all projects. Defined in the UI in Administration > Configuration > General Settings
  2. Project properties: Apply to one project only. At project level, defined in the UI in Project Settings > General Settings
  3. Project analysis parameters: Defined in a project analysis configuration file or scanner configuration file
  4. Analysis / Command line parameters: Defined when launching an analysis with -D on the command line

Note that only parameters set through the UI are stored in the database. For example, if you override the sonar.exclusions parameter via the command line for a specific project, it will not be stored in the database. Subsequent analyses, or analyses in SonarLint with connected mode, would still be executed with the exclusions defined in the UI and therefore stored in the DB.

Most of the property keys shown in the interface at both global and project levels can also be set as analysis parameters, but the parameters listed below can only be set at analysis time.

For language-specific parameters related to test coverage and execution, see Test coverage. For language-specific parameters related to external issue reports, see External issues. And to learn more about controlling the scope of your analysis, see the page on Analysis scope.  

Mandatory parameters

This section lists analysis parameters (sonar properties) that, during a project analysis, cannot be set in the UI and are mandatory. It means that they must be set on the CI/CD host. The following default values are indicated for a parameter when applicable:

  • Default from build: It indicates from which build system(s) the scanner can read a default value for the sonar property. The build property used as the default value is not indicated: see the corresponding scanner section for more information.
  • Default: This value applies if the property was neither defined on the CI/CD host nor in the UI. 

Authentication to the server

  • sonar.token
    • Token used by the scanner to authenticate to the SonarQube Server. A token can be specific to a project (allows you to run analyses on the specific project) or global (allows you to run analyses on any project). The corresponding SonarQube user must have the Execute Analysis permission on the project or the Global Execute Analysis permission, respectively.  
    • Notes
      • Replaces sonar.login and sonar.password properties that are deprecated.
      • This property can be defined through the SONAR_TOKEN environment variable.
    • Recommendation: It is recommended not to write passwords or authentication tokens in files and not to pass them as parameters in the command line.

Server connection

Project identification

  • sonar.projectKey
    • The project's unique key. Can include up to 400 characters. All letters, digits, dash, underscore, periods, and colons are accepted. 
    • Default from build: Maven, Gradle.
  • sonar.organization
    • The key of the organization to which the project belongs.

Optional Parameters

This section lists analysis parameters (sonar properties) that, during a project analysis, cannot be set in the UI (or, like the sonar.projectName, cannot be changed in the UI) and are optional. It means that they can only be set on the CI/CD host. The following default values are indicated for a parameter when applicable:

  • Default from build: It indicates from which build system(s) the scanner can read a default value for the sonar property. The build property used as the default value is not indicated: see the corresponding scanner section for more information.
  • Default: This value applies if the property was neither defined on the CI/CD host nor in the UI. 

Project information

  • sonar.projectName
    • Name of the project that will be displayed on the SonarQube UI.
    • Possible values: white space allowed.
    • Default from build: Maven 
    • Notes
      • Is set in the UI if the project is manually created in SonarQube (cannot be changed in the UI).
      • If passed in the command line, will only be read by the scanner if the command applies to the main branch. 
  • sonar.projectVersion
    • The project version. Is mandatory in case you use the new code definition based on the previous version.
    • Default from build: Maven, Gradle
    • Note: Do not use your build number as the project version because:
      • This would overload the SonarQube database (Houskeeping would not apply to the analysis snapshots because they would be marked by the project version change event).
      • This would prevent a correct application of the new code definition based on the previous project version since the build version usually changes much more often than the project release version.

Analysis scope

  • sonar.sources
    • Analysis baseline for main source code (non-test code) in the project. 
    • Possible values: Comma-separated paths to directories are included. An individual file in the list means that the file is included. A directory in the list means that all analyzable files and directories recursively below it are included. The path can be relative (to the sonar.projectBaseDir property) or absolute. Wildcards (*, ** and ?) are not allowed.
    • Default from build: Maven, Gradle, .NET
    • Default: The value of the sonar.projectBaseDir property.
  • sonar.tests
    • Analysis baseline for test code in the project. 
    • Possible values: See sonar.sources above.
    • Default from build: Maven, Gradle, .NET
    • Note: If this property is not defined, no code will be analyzed as test code as there is no default value.
  • sonar.projectBaseDir
    • Project’s base directory. Use this property when you need the analysis to take place in a directory other than the one from which it was started. For example, the analysis starts from jenkins/jobs/myjob/workspace but the files to be analyzed are in ftpdrop/cobol/project1
    • Possible values: The path may be relative (to the directory from which the analysis was started) or absolute. Specify not the source directory, but some ancestor of the source directory. The value specified here becomes the new "analysis directory", and other paths are then specified as though the analysis were starting from that specified value. 
    • Default from build: Maven, Gradle, .NET.
    • Default: The directory from which the analysis was started.
    • Note: The analysis process will need Write permissions in this directory; it is where the sonar.working.directory will be created by default.
  • sonar.scm.exclusions.disabled
    • For supported SCMs, defines whether files ignored by the SCM, e.g., files listed in .gitignore, will be excluded from the analysis or not. 
    • Possible values: 
      • true: exclusion disabled
      • false: exclusion enabled
    • Default: false
  • sonar.filesize.limit 
    • Sets the limit in MB for files to be discarded from the analysis scope if the size is greater than specified. 
    • Default: 20
    • Note: The sonar.javascript.maxFileSize property (default: 1000 KB) discards JavaScript and TypeScript files from the analysis scope if the file size is greater than specified (This parameter can be set in the UI).

Duplication check

  • sonar.cpd.<language>.minimumtokens
    • Is used for non-Java projects to define the duplication check rule: a piece of code is considered duplicated if sonar.cpd.<language>.minimumtokens identical tokens are found across at least sonar.cpd.<language>.minimumLines lines of code.
    • Note: For Java projects, a piece of code is considered duplicated when there is a series of at least 10 statements in a row, regardless of the number of tokens and lines. This threshold cannot be overridden.
    • Default: 100
  • sonar.cpd.<language>.minimumLines
    • Is used for non-Java projects to define the duplication check rule: see above.
    • Default: 10

Analysis logging

  • sonar.log.level
    • Control the quantity/level of logs produced during an analysis. 
    • Possible values: From least to most verbose: 
      • INFO
      • DEBUG 
      • TRACE: like DEBUG with possible additional information output by plugins or libraries used by the scanner.
    • DefaultINFO
  • sonar.verbose
    • Possible values:
      • true: adds more details to the analysis logs by activating the DEBUG mode for the scanner.
      • false
    • Defaultfalse
    • Note: There is the potential for this setting to expose sensitive information such as passwords if they are stored as server-side environment variables.
  • sonar.scanner.dumpToFile
    • Outputs to the specified file the full list of properties passed to the scanner API as a means to debug analysis. The equivalent output is available in Your Project >  Administration > Background Tasks > 3-dots menu > Show SonarScanner Context.
    • Possible values: path to the output file name
    • Note: If the analysis report fails, the list is not generated and there won't be anything available on the server.
  • sonar.scanner.metadataFilePath
    • Sets the location where the scanner writes the report-task.txt file containing among other things the ceTaskId.
    • Default: The value of sonar.working.directory.

Quality gate

  • sonar.qualitygate.wait
    • Forces the analysis step to poll the SonarQube instance and wait for the Quality Gate status. If there are no other options, you can use this to fail a pipeline build when the Quality Gate is failing. 
    • Possible values: true or false
    • Default: false
  • sonar.qualitygate.timeout
    • Number of seconds that the scanner should wait for a report to be processed.
    • Default: 300

Import of external issues

This section lists only the properties used to import generic and SARIF issues. For the properties used to import reports generated by third-party tools supported by SonarQube, see Importing third-party issues.

  • sonar.links.ci
    • URL of the continuous integration system used.
    • Default from build: Maven
  • sonar.links.homepage
    • URL of the build project home page.
    • Default from build: Maven
  • sonar.links.issue
    • URL to the issue tracker being used.
    • Default from build: Maven
  • sonar.links.scm
    • URL of the build project source code repository.
    • Default from build: Maven

Multi-branch

The following properties are available from the Developer Edition:

  • sonar.branch.name
  • sonar.pullrequest.key, sonar.pullrequest.branch, and sonar.pullrequest.base: see Pull request analysis.
  • sonar.referenceBranch
    • Sets the new code definition to Reference Branch  for this analysis, overriding the configuration on the server.  

Other parameters

  • sonar.scm.revision
    • Overrides the revision, for instance, the Git sha1, displayed in analysis results.
    • Note: May be provided by the CI environment or guessed from the checked-out sources.
  • sonar.buildString
    • The string passed with this property will be stored with the analysis and available in the results of api/project_analyses/search, thus allowing you to later identify a specific analysis and obtain its ID for use with api/project_analyses/set_baseline.
  • sonar.ws.timeout
    • Maximum time to wait for the response of a web service call, in seconds. Modifying this value from the default is useful only when you're experiencing timeouts during analysis while waiting for the server to respond to web service calls.
    • Default: 60
  • sonar.sourceEncoding
    • Encoding of the source files. For example, UTF-8, MacRoman, Shift_JIS. The list of available encodings depends on your JVM.
    • Default from build: Maven, Gradle
    • Default: System encoding.
  • sonar.working.directory
    • Path to the working directory used by the Sonar scanner during a project analysis to store temporary data. This property is not compatible with the SonarScanner for .NET. 
    • The path can be relative (to the sonar.projectBaseDir property) or absolute. It must be unique for each project.
    • Default from build: Gradle, Maven
    • Default: .sonar
    • Warning: The specified directory is deleted before each analysis.
  • sonar.scm.forceReloadAll
    • By default, blame information is only retrieved for changed files. Set this property to true to load blame information for all files, which may significantly increase analysis duration. This can be useful if you feel that some SCM data is outdated but SonarQube does not get the latest information from the SCM engine and this analysis parameter should not be a permanent part of your analysis configuration.
    • Default: false
  • sonar.analysis.<key>=<value>
    • This property stub allows you to insert custom key/value pairs into the analysis context, which will also be passed forward to webhooks.
    • Example: sonar.analysis.buildNumber=12345
    • Note: Depending on the environment, using this property in the command line may not work.

Deprecated parameters

  • sonar.login
  • sonar.password
  • sonar.projectDate

© 2008-2023, SonarSource S.A, Switzerland. Except where otherwise noted, content in this space is licensed under a Creative Commons Attribution-NonCommercial 3.0 United States License. SONARQUBE is a trademark of SonarSource SA. All other trademarks and copyrights are the property of their respective owners.

Creative Commons License