Metric definitions
On this page
SonarCloud analysis produces many types of code analysis metrics.
Complexity
Complexity (complexity) It is the cyclomatic complexity calculated based on the number of paths through the code. Whenever the control flow of a function splits, the complexity counter gets incremented by one. Each function has a minimum complexity of 1. This calculation varies slightly by language because keywords and functionalities do.
| Language | Notes |
|---|---|
| ABAP | The following keywords increase the complexity by one: AND, CATCH, CONTINUE, DO, ELSEIF, IF, LOOP, LOOPAT, OR, PROVIDE, SELECT…ENDSELECT, TRY, WHEN, WHILE. |
| C/C++/Objective-C | The complexity gets incremented by one for: each control statement such as if, while, do while, for; switch statement keywords such as case, default; the && and || operators; the ? ternary operator and lambda expression definitions. |
| C# | The complexity gets incremented by one for each of these function declarations: method, constructor, destructor, property, accessor, operator, or local function declaration. In addition, the count is incremented one for each: conditional expression, conditional access, switch case and switch expression arm, each |
| COBOL | The following commands increase the complexity by one (except when they are used in a copybook): ALSO, ALTER, AND, DEPENDING, END_OF_PAGE, ENTRY, EOP, EXCEPTION, EXIT, GOBACK, CONTINUE, IF, INVALID, OR, OVERFLOW, SIZE, STOP, TIMES, UNTIL, USE, VARYING, WHEN, EXEC CICS HANDLE, EXEC CICS LINK, EXEC CICS XCTL, EXEC CICS RETURN. |
| Dart | The complexity is incremented by one for each of these function declarations: top-level functions, top-level function expressions (lambdas), methods, accessors, and constructors. The complexity isn't incremented in nested function declarations or expressions. In addition, the count is incremented by one for each: short-circuit binary expression or logical patterns ( |
| Java | Keywords incrementing the complexity: if, for, while, case, &&, ||, ?, ->. |
| JS/TS, PHP | Complexity is incremented by one for each: function (i.e non-abstract and non-anonymous constructors, functions, procedures or methods), if, short-circuit (AKA lazy) logical conjunction (&&), short-circuit (AKA lazy) logical disjunction (||), ternary conditional expressions, loop, case clause of a switch statement, throw and catch statement, go to statement (only for PHP). |
| PL/I | The following keywords increase the complexity by one: For procedures having more than 1 return statement: each additional return statement except for the last one, will increment the complexity metric. |
| PL/SQL | The complexity gets incremented by one for: the main PL/SQL anonymous block (not inner ones), CREATE PROCEDURE, CREATE TRIGGER, basic LOOP statement, WHEN clause statement (the “WHEN” of simple CASE statement and searched CASE statement), CONTINUE statement, cursor FOR LOOP statement, CONTINUE / EXIT WHEN clause (The “WHEN” part of the CONTINUE and EXIT statements), exception handler (every individual “WHEN”), EXIT statement, FORLOOP statement, FORALL statement, IF statement, ELSIF clause, RAISE statement, RETURN statement, WHILELOOP statement, AND expression (“AND” reserved word used within PL/SQL expressions), OR expression (“OR” reserved word used within PL/SQL expressions), WHEN clause expression (the “WHEN” of simple CASE expression and searched CASE expression). |
| VB.NET | The complexity gets incremented by one for: method or constructor declaration (Sub, Function), AndAlso, Case, Continue, Do, End, Error, Exit, For, ForEach, GoTo, If, Loop, On Error, OrElse, Resume, Stop, Throw, Try, While. |
Cognitive Complexity (cognitive_complexity) How hard it is to understand the code's control flow. See the Cognitive Complexity White Paper for a complete description of the mathematical model applied to compute this measure.
Duplications
Duplicated blocks: (duplicated_blocks) Number of duplicated blocks of lines.
For a block of code to be considered as duplicated:
In Non-Java projects:
- There should be at least 100 successive and duplicated tokens.
- Those tokens should be spread at least on:
- 30 lines of code for COBOL
- 20 lines of code for ABAP
- 10 lines of code for other languages
In Java projects: there should be at least 10 successive and duplicated statements whatever the number of tokens and lines. Differences in indentation and in string literals are ignored while detecting duplications.
In JavaScript projects: differences in indentation and in string literals are ignored while detecting duplications. In addition, tokens from import statements and require calls are skipped altogether.
Duplicated files: (duplicated_files) Number of files involved in duplications.
Duplicated lines: (duplicated_lines) Number of lines involved in duplications.
Duplicated lines (%): (duplicated_lines_density) = duplicated_lines / lines * 100
Issues
The issue severity feature has evolved. It is no longer possible to change the severity of an issue. Severity is now tied to the software qualities impacted. See Code analysis based on Clean Code for more details.
New issues (new_violations) Number of issues raised for the first time in the new code period.
New xxx issues (new_xxx_violations) Number of issues of the specified severity raised for the first time in the new code period, where xxx is one of: blocker, critical, major, minor, info.
Issues (violations) Total count of issues in all states.
xxx issues (xxx_violations) Total count of issues of the specified severity, where xxx is one of: blocker, critical, major, minor, info.
False positive issues (false_positive_issues) Total count of issues marked false positive.
Open issues (open_issues) Total count of issues in the open state.
Confirmed issues (confirmed_issues) Deprecated. Total count of issues in the confirmed state.
Reopened issues (reopened_issues) Total count of issues in the reopened state.
Maintainability
Code Smells (code_smells) Total count of code smell issues.
New Code Smells (new_code_smells) Total count of code smell issues raised for the first time in the new code period.
Maintainability Rating (sqale_rating) (Formerly the SQALE rating.) Rating given to your project related to the value of your technical debt ratio. The default maintainability rating grid is:
- A=0-0.05
- B=0.06-0.1
- C=0.11-0.20
- D=0.21-0.5
- E=0.51-1
The maintainability rating scale can be alternately stated by saying that if the outstanding remediation cost is:
- <=5% of the time that has already gone into the application, the rating is A
- between 6 to 10% the rating is a B
- between 11 to 20% the rating is a C
- between 21 to 50% the rating is a D
- anything over 50% is an E
Technical Debt (sqale_index) The technical debt is the sum of the code smell remediation costs. A code smell remediation cost is the effort (in minutes) evaluated to fix the code smell. This cost is taken over from the effort assigned to the rule that raised the code smell.
An 8-hour day is assumed when the technical debt is shown in days.
Technical Debt on New Code (new_technical_debt) Effort to fix all code smells raised for the first time in the new code period.
Technical Debt Ratio (sqale_debt_ratio) The technical debt ratio is the ratio between the cost to develop the software and the technical debt (the cost to fix it). It is calculated based on the following formula:
technicalDebt /(costToDevelop1lineOfCode * numberOfLinesOfCode)
Where the cost to develop one line of code is 0.06 days.
Example
- Technical debt: 122,563
- Number of lines of code: 63,987
- Cost to develop one line of code: 30 minutes
- Technical debt ratio: 6.4%
Technical Debt Ratio on New Code (new_sqale_debt_ratio) Ratio between the cost to develop the code changed in the new code period and the cost of the issues linked to it.
Quality Gates
Quality Gate Status (alert_status) State of the quality gate associated to your project. Possible values are : ERROR, OK WARN value has been removed since 7.6.
Quality Gate Details (quality_gate_details) For all the conditions of your quality gate, you know which condition is failing and which is not.
Reliability
Bugs (bugs) Number of bug issues.
New Bugs (new_bugs) Number of new bug issues.
Reliability Rating (reliability_rating)
- A = 0 Bugs
- B = at least 1 Minor Bug
- C = at least 1 Major Bug
- D = at least 1 Critical Bug
- E = at least 1 Blocker Bug.
Reliability remediation effort (reliability_remediation_effort) Effort to fix all bug issues. The measure is stored in minutes in the DB. An 8-hour day is assumed when values are shown in days.
Reliability remediation effort on new code (new_reliability_remediation_effort) Same as reliability remediation effort but on the code changed in the new code period.
Security
Vulnerabilities (vulnerabilities) Number of vulnerability issues.
Vulnerabilities on new code (new_vulnerabilities) Number of new vulnerability issues.
Security Rating (security_rating)
- A = 0 Vulnerabilities
- B = at least 1 Minor Vulnerability
- C = at least 1 Major Vulnerability
- D = at least 1 Critical Vulnerability
- E = at least 1 Blocker Vulnerability.
Security remediation effort (security_remediation_effort) Effort to fix all vulnerability issues. The measure is stored in minutes in the DB. An 8-hour day is assumed when values are shown in days.
Security remediation effort on new code (new_security_remediation_effort) Same as security remediation effort but on the code changed in the new code period.
Security Hotspots (security_hotspots) Number of security hotspots.
Security Hotspots on new code (new_security_hotspots) Number of new security hotspots in the new code period.
Security Review Rating (security_review_rating) The Security Review Rating is a letter grade based on the percentage of reviewed (Fixed or Safe) security hotspots.
- A = >= 80%
- B = >= 70% and <80%
- C = >= 50% and <70%
- D = >= 30% and <50%
- E = < 30%
Security Review Rating on new code (new_security_review_rating) Security Review Rating for the new code period.
Security Hotspots Reviewed (security_hotspots_reviewed) Percentage of reviewed (fixed or safe) security hotspots.
Ratio Formula: Number of Reviewed (Fixed or Safe) Hotspots x 100 / (To_Review Hotspots + Reviewed Hotspots)
New security hotspots reviewed: Percentage of reviewed security hotspots (fixed or safe) for the new code period.
Size
Classes (classes) Number of classes (including nested classes, interfaces, enums, annotations, mixins, extensions and extension types).
Comment lines (comment_lines) Number of lines containing either comment or commented-out code.
Non-significant comment lines (empty comment lines, comment lines containing only special characters, etc.) do not increase the number of comment lines.
The following piece of code contains 9 comment lines:
/** +0 => empty comment line
* +0 => empty comment line
* This is my documentation +1 => significant comment
* although I don't +1 => significant comment
* have much +1 => significant comment
* to say +1 => significant comment
* +0 => empty comment line
*************************** +0 => non-significant comment
* +0 => empty comment line
* blabla... +1 => significant comment
*/ +0 => empty comment line
/** +0 => empty comment line
* public String foo() { +1 => commented-out code
* System.out.println(message); +1 => commented-out code
* return message; +1 => commented-out code
* } +1 => commented-out code
*/ +0 => empty comment line| Language | Note |
|---|---|
| COBOL | Lines containing the following instructions are counted both as comments and lines of code: AUTHOR, INSTALLATION, DATE-COMPILED, DATE-WRITTEN, SECURITY. |
| Java and Dart | File headers are not counted as comment lines (because they usually define the license). |
Comments (%) (comment_lines_density) Density of comment lines = Comment lines / (Lines of code + Comment lines) * 100
With such a formula:
- 50% means that the number of lines of code equals the number of comment lines
- 100% means that the file only contains comment lines
Files (files) Number of files.
Lines (lines) Number of physical lines (number of carriage returns).
Lines of code (ncloc) Number of physical lines that contain at least one character which is neither a whitespace nor a tabulation nor part of a comment.
| Language | Note |
|---|---|
| COBOL | Generated lines of code and pre-processing instructions (SKIP1, SKIP2, SKIP3, COPY, EJECT, REPLACE) are not counted as lines of code. |
Lines of code per language (ncloc_language_distribution) Non commenting lines of code distributed by language
Functions (functions) Number of functions. Depending on the language, a function is either a function or a method or a paragraph.
| Language | Note |
|---|---|
| COBOL | It is the number of paragraphs. |
| Dart | Any function expression is included, whether it's the body of a function declaration, of a method, constructor, getter, top-level or nested function, or a top-level or nested lambda. |
| Java | Methods in anonymous classes are ignored. |
| VB.NET | Accessors are not considered to be methods. |
Statements (statements) Number of statements.
Tests
Condition coverage (branch_coverage) On each line of code containing some boolean expressions, the condition coverage simply answers the following question: 'Has each boolean expression been evaluated both to true and false?'. This is the density of possible conditions in flow control structures that have been followed during unit tests execution.
Condition coverage = (CT + CF) / (2*B) where
- CT = conditions that have been evaluated to 'true' at least once
- CF = conditions that have been evaluated to 'false' at least once
- B = total number of conditions
Condition coverage on new code (new_branch_coverage) Identical to condition coverage but restricted to new / updated source code.
Condition coverage hits (branch_coverage_hits_data) List of covered conditions.
Conditions by line (conditions_by_line) Number of conditions by line.
Covered conditions by line (covered_conditions_by_line) Number of covered conditions by line.
Coverage (coverage) It is a mix of line coverage and condition coverage. Its goal is to provide an even more accurate answer to the following question: How much of the source code has been covered by the unit tests?
Coverage = (CT + CF + LC)/(2*B + EL) where
- CT = conditions that have been evaluated to 'true' at least once
- CF = conditions that have been evaluated to 'false' at least once
- LC = covered lines = lines_to_cover - uncovered_lines
- B = total number of conditions
- EL = total number of executable lines (
lines_to_cover)
Coverage on new code (new_coverage) Identical to Coverage but restricted to new / updated source code.
Line coverage (line_coverage) On a given line of code, Line coverage simply answers the following question: Has this line of code been executed during the execution of the unit tests?. It is the density of covered lines by unit tests:
Line coverage = LC / EL where
- LC = covered lines (
lines_to_cover-uncovered_lines) - EL = total number of executable lines (
lines_to_cover)
Line coverage on new code (new_line_coverage) Identical to Line coverage but restricted to new / updated source code.
Line coverage hits (coverage_line_hits_data) List of covered lines.
Lines to cover (lines_to_cover) Number of lines of code which could be covered by unit tests (for example, blank lines or full comments lines are not considered as lines to cover).
Lines to cover on new code (new_lines_to_cover) Identical to Lines to cover but restricted to new / updated source code.
Skipped unit tests (skipped_tests) Number of skipped unit tests.
Uncovered conditions (uncovered_conditions) Number of conditions which are not covered by unit tests.
Uncovered conditions on new code (new_uncovered_conditions) Identical to uncovered conditions but restricted to new / updated source code.
Uncovered lines (uncovered_lines) Number of lines of code which are not covered by unit tests.
Uncovered lines on new code (new_uncovered_lines) Identical to uncovered lines but restricted to new / updated source code.
Unit tests (tests) Number of unit tests.
Unit tests duration (test_execution_time) Time required to execute all the unit tests.
Unit test errors (test_errors) Number of unit tests that have failed.
Unit test failures (test_failures) Number of unit tests that have failed with an unexpected exception.
Unit test success density (%) (test_success_density) Test success density = (Unit tests - (Unit test errors + Unit test failures)) / Unit tests * 100
Was this page helpful?
© 2008-2024 SonarSource SA. All rights reserved. SONAR, SONARSOURCE, SONARLINT, SONARQUBE, SONARCLOUD, and CLEAN AS YOU CODE are trademarks of SonarSource SA.
