Copy Page

You are not logged in. Any changes you make will be marked as anonymous. You may want to Log In if you already have an account. You can also Sign Up for a new account.

<table class="wysiwyg-macro" data-macro-name="info" data-macro-parameters="icon=false|title=Table of Contents" style="background-image: url(/plugins/servlet/confluence/placeholder/macro-heading?definition=e2luZm86aWNvbj1mYWxzZXx0aXRsZT1UYWJsZSBvZiBDb250ZW50c30&amp;locale=en_GB&amp;version=2); background-repeat: no-repeat;" data-macro-body-type="RICH_TEXT"><tr><td class="wysiwyg-macro-body"><img class="editor-inline-macro" src="/plugins/servlet/confluence/placeholder/macro?definition=e3RvY30&amp;locale=en_GB&amp;version=2" data-macro-name="toc"></td></tr></table><h1>Architecture</h1><table class="confluenceTable"><tbody><tr><th class="confluenceTh">Concept</th><th class="confluenceTh">Definition</th><th class="confluenceTh">Related Topics</th></tr><tr><td colspan="1" class="confluenceTd"><img class="editor-inline-macro" src="/plugins/servlet/confluence/placeholder/macro?definition=e2FuY2hvcjphbmFseXplcn0&amp;locale=en_GB&amp;version=2" data-macro-name="anchor" data-macro-default-parameter="analyzer">Analyzer</td><td colspan="1" class="confluenceTd">Batch that analyzes the source code to compute snapshots.</td><td colspan="1" class="confluenceTd">See <a class="confluence-link" href="/display/SONAR/Architecture+Overview" data-linked-resource-id="229736899" data-linked-resource-type="page" data-linked-resource-default-alias="Architecture Overview" data-base-url="http://docs.codehaus.org">Architecture Overview</a>.</td></tr><tr><td colspan="1" class="confluenceTd"><img class="editor-inline-macro" src="/plugins/servlet/confluence/placeholder/macro?definition=e2FuY2hvcjpjbGllbnR9&amp;locale=en_GB&amp;version=2" data-macro-name="anchor" data-macro-default-parameter="client">Client</td><td colspan="1" class="confluenceTd">Batch that runs the analyzers.</td><td colspan="1" class="confluenceTd">See <a class="confluence-link" href="/display/SONAR/Architecture+Overview" data-linked-resource-id="229736899" data-linked-resource-type="page" data-linked-resource-default-alias="Architecture Overview" data-base-url="http://docs.codehaus.org">Architecture Overview</a>.</td></tr><tr><td colspan="1" class="confluenceTd"><img class="editor-inline-macro" src="/plugins/servlet/confluence/placeholder/macro?definition=e2FuY2hvcjpkYXRhYmFzZX0&amp;locale=en_GB&amp;version=2" data-macro-name="anchor" data-macro-default-parameter="database">Database</td><td colspan="1" class="confluenceTd">Stores:<ul><li>configuration</li><li>snapshots</li></ul></td><td colspan="1" class="confluenceTd">See <a class="confluence-link" href="/display/SONAR/Architecture+Overview" data-linked-resource-id="229736899" data-linked-resource-type="page" data-linked-resource-default-alias="Architecture Overview" data-base-url="http://docs.codehaus.org">Architecture Overview</a>.</td></tr><tr><td colspan="1" class="confluenceTd"><img class="editor-inline-macro" src="/plugins/servlet/confluence/placeholder/macro?definition=e2FuY2hvcjpzZXJ2ZXJ9&amp;locale=en_GB&amp;version=2" data-macro-name="anchor" data-macro-default-parameter="server">Server</td><td colspan="1" class="confluenceTd"> Web Server that is used to navigate the snapshots and make configuration changes</td><td colspan="1" class="confluenceTd">See <a class="confluence-link" href="/display/SONAR/Architecture+Overview" data-linked-resource-id="229736899" data-linked-resource-type="page" data-linked-resource-default-alias="Architecture Overview" data-base-url="http://docs.codehaus.org">Architecture Overview</a> .</td></tr></tbody></table> <h1>Quality</h1><table class="confluenceTable"><tbody><tr><th class="confluenceTh">Concept</th><th class="confluenceTh">Definition</th><th class="confluenceTh">Related Topics</th></tr><tr><td colspan="1" class="confluenceTd">Check</td><td colspan="1" class="confluenceTd">Check = Coding Rule.</td><td colspan="1" class="confluenceTd"> </td></tr><tr><td colspan="1" class="confluenceTd"><img class="editor-inline-macro" src="/plugins/servlet/confluence/placeholder/macro?definition=e2FuY2hvcjpjb2RpbmdSdWxlfQ&amp;locale=en_GB&amp;version=2" data-macro-name="anchor" data-macro-default-parameter="codingRule">Coding Rule</td><td colspan="1" class="confluenceTd">A good coding practice. Not complying to coding rules leads to quality flaws and creation of issues in SonarQube.Coding rules can check quality on files, unit tests or packages.</td><td colspan="1" class="confluenceTd">See <a class="confluence-link" href="/display/SONAR/Resource+Viewer#ResourceViewer-viewingUnitTests" data-anchor="viewingUnitTests" data-linked-resource-id="111706389" data-linked-resource-type="page" data-linked-resource-default-alias="Resource Viewer#viewingUnitTests" data-base-url="http://docs.codehaus.org">Viewing Unit Tests &gt; Issues Tab</a></td></tr><tr><td class="confluenceTd"><img class="editor-inline-macro" src="/plugins/servlet/confluence/placeholder/macro?definition=e2FuY2hvcjptZXRyaWN9&amp;locale=en_GB&amp;version=2" data-macro-name="anchor" data-macro-default-parameter="metric">Metric</td><td class="confluenceTd">A property of a resource. Examples: number of lines of code, complexity, etc.A metric may be either:<ul><li>qualitative: gives a quality indication on the resource (ex: density of duplicated lines, line coverage by unit tests, etc.)</li><li>or quantitative: does not give a quality indication on the resource (ex: number of lines of code, complexity, etc.)</li></ul>The value of the metric for a given resource is called measure.</td><td class="confluenceTd">See <a class="confluence-link" href="/display/SONAR/Metric+definitions" data-linked-resource-id="230397406" data-linked-resource-type="page" data-linked-resource-default-alias="Metric definitions" data-base-url="http://docs.codehaus.org">detailed documentation on metrics</a>.</td></tr><tr><td colspan="1" class="confluenceTd"><img class="editor-inline-macro" src="/plugins/servlet/confluence/placeholder/macro?definition=e2FuY2hvcjptZWFzdXJlfQ&amp;locale=en_GB&amp;version=2" data-macro-name="anchor" data-macro-default-parameter="measure">Measure</td><td colspan="1" class="confluenceTd">The value of a metric for a given resource at a given time.Examples:<ul><li>125 lines of code on class myClass</li><li>Density of duplicated lines of 30.5% on project myProject</li></ul></td><td colspan="1" class="confluenceTd"> </td></tr><tr><td colspan="1" class="confluenceTd"><img class="editor-inline-macro" src="/plugins/servlet/confluence/placeholder/macro?definition=e2FuY2hvcjpxdWFsaXR5UHJvZmlsZX0&amp;locale=en_GB&amp;version=2" data-macro-name="anchor" data-macro-default-parameter="qualityProfile">Quality Profile</td><td colspan="1" class="confluenceTd">A set of coding rules.Each snapshot is based on a single quality profile.</td><td colspan="1" class="confluenceTd">See <a class="confluence-link" href="/display/SONAR/Quality+Profiles" data-linked-resource-id="114786474" data-linked-resource-type="page" data-linked-resource-default-alias="Quality Profiles" data-base-url="http://docs.codehaus.org">Quality Profiles</a>.</td></tr><tr><td colspan="1" class="confluenceTd"><img class="editor-inline-macro" src="/plugins/servlet/confluence/placeholder/macro?definition=e2FuY2hvcjpyZXNvdXJjZX0&amp;locale=en_GB&amp;version=2" data-macro-name="anchor" data-macro-default-parameter="resource">Resource</td><td colspan="1" class="confluenceTd">A piece of software. Examples: project, package, module, file, etc.</td><td colspan="1" class="confluenceTd"> </td></tr><tr><td colspan="1" class="confluenceTd"><img class="editor-inline-macro" src="/plugins/servlet/confluence/placeholder/macro?definition=e2FuY2hvcjpzbmFwaHNob3R9&amp;locale=en_GB&amp;version=2" data-macro-name="anchor" data-macro-default-parameter="snaphshot">Snapshot</td><td colspan="1" class="confluenceTd">A set of measures and issues on a given resource at a given time.A snapshot is generated for each analysis.</td><td colspan="1" class="confluenceTd"> </td></tr><tr><td colspan="1" class="confluenceTd"><img class="editor-inline-macro" src="/plugins/servlet/confluence/placeholder/macro?definition=e2FuY2hvcjppc3N1ZX0&amp;locale=en_GB&amp;version=2" data-macro-name="anchor" data-macro-default-parameter="issue">Issue</td><td colspan="1" class="confluenceTd">When a resource does not comply with a coding rule, an issue is logged (was violation prior to SonarQube 3.6) on the snapshot.An issue can be logged on a source file or a unit test file.</td><td colspan="1" class="confluenceTd"> </td></tr></tbody></table><h1>Web Interface</h1> <table class="confluenceTable"><tbody><tr><th class="confluenceTh">Concept</th><th class="confluenceTh">Definition</th><th class="confluenceTh">Related Topics</th></tr><tr><td colspan="1" class="confluenceTd"><img class="editor-inline-macro" src="/plugins/servlet/confluence/placeholder/macro?definition=e2FuY2hvcjpkYXNoYm9hcmR9&amp;locale=en_GB&amp;version=2" data-macro-name="anchor" data-macro-default-parameter="dashboard">Dashboard</td><td colspan="1" class="confluenceTd">Web page that provides a way to display any data stored in the database.A dashboard is a set of widgets.</td><td colspan="1" class="confluenceTd">See <a class="confluence-link" href="/display/SONAR/Dashboards" data-linked-resource-id="163872785" data-linked-resource-type="page" data-linked-resource-default-alias="Dashboards" data-base-url="http://docs.codehaus.org">Dashboards</a>.</td></tr><tr><td colspan="1" class="confluenceTd"><img class="editor-inline-macro" src="/plugins/servlet/confluence/placeholder/macro?definition=e2FuY2hvcjp3aWRnZXR9&amp;locale=en_GB&amp;version=2" data-macro-name="anchor" data-macro-default-parameter="widget">Widget</td><td colspan="1" class="confluenceTd">It is a box that displays data on a dashboard.There are two types of widget:<ul><li>Global widget that can display data from multiple projects</li><li>Project widget that only displays data from a specific project</li></ul></td><td colspan="1" class="confluenceTd"> </td></tr></tbody></table> http://docs.codehaus.org/display/SONAR/Documentation