| Info | ||||
|---|---|---|---|---|
| ||||
|
When looking at the code quality of an application and willing to decide of an action plan, it is sometimes not sufficient to get a snapshot of the quality at a given time. You also need some visibility on the application history to take the right decision.
...
The Time Machine is made of two generic widgets that can be instantiated and configured in any dashboard.
Timeline Widget
The Timeline widget provides the capability to display a chart containing historical data of up to 3 metrics. Passing your mouse over the timeline will display the different values.
...
| Note | ||
|---|---|---|
| ||
By default, historical information is not kept on directories/packages and therefore the timeline has not value to display. This can be changed by logging in as an administrator, going to Settings > Configuration > General Settings > Database Cleaner and setting the Clean history data of directories/packages property to truefalse. This will increase the volume of data to be stored in the database. |
...
This widget can be customized:
History Table Widget
The History Table widget provides the capability to display a table with the historical data up to 10 metrics:
...
This widget can be customized:
Default Dashboard
| Info | ||
|---|---|---|
| ||
|
A default Time Machine dashboard comes out-of-the-box when installing Sonar. This is a combination of Timeline and History Table widgets:
Tendencies
What are Tendencies?
The tendencies are arrows that are displayed next to metrics in the dashboards. Those arrows show the trend for the measure.
How to Read Tendencies?
Sonar uses 5 levels to describe the tendency of a measure. Each level is represented by an arrow:
...
Sonar uses black ( ) arrows to represent tendencies on the quantitative metrics (the ones that are not reflecting quality of the code, for example number of lines of code).
Sonar uses red ( ) or green (
) arrows to represent tendencies on the qualitative metrics (the ones that are reflecting quality of the code, for example code coverage). The red is used when the quality decreases, the green when it increases.
Of course, it is to be noted that if the percentage of duplicated lines decreases it will be represented in green by because it is considered as an improvement.
How are Tendencies Calculated?
To compute the tendencies, making a simple difference between the last two measures of each metric would not be accurate enough. Therefore Sonar implements a more advanced algorithm: the least squares method. The least squares is a linear regression analysis that helps removing the noise in order to determine a trend on discrete measures. In other words, Sonar takes all the measure taken in the last XX days, checks that the set of measures makes some sense (by testing the correlation rate), determines an estimated slope and displays it using the arrows.
...
It is possible to configure the tendencies by logging in as an administrator and going to Configuration Settings > Configuration > General Settings > Differential Views.
- To activate/deactivate the computation of tendencies, set the Skip tendencies property to true/false. Default is true.
- To configure the number of days used to compute tendencies, set the Tendency period property to the desired number of days. Default is 30.
...
Whatever the reason (wrong quality profile, issue with analysis, etc.), it is possible to remove a snapshot to polish the Time Machine widgets. Note that the last snapshot can never be deleted.
| Note | ||
|---|---|---|
| ||
Deleting a snapshot is a 2-step process:
|
At project level, go to Configuration > History.
For every snapshot, it is possible to manually:
- Add, rename or remove a version
- Add, rename or remove an event
House Cleaning
Removing Useless Data
When you do a new analysis of your project, some data that were present in Sonar will not be accessible anymore. For example the source code of the previous analysis, measures at file level... Those These data will automatically be removed at the end of a new analysis.
Removing
...
Unnecessary Analysis
This is very useful to analyze frequently a project in Sonar to see progress on quality. It is also very useful to be able to see the trends over weeks / months / years. But when you are back in time, you do not really need the same level of details as you would for one week ago. Therefore, since Sonar 2.5, a new "Database Cleaner" has been added to Sonar. It The Database Cleaner aims to delete some rows in database to save some space and to improve overall performances. Here is its default configuration:
...
These settings can be changed in the page Settings > Configuration > General Settings > Database Cleaner.
Deprecated - Previous Version of the Time Machine
Exploring the Time Machine
...
The Custom Chart
...
The Chosen Analysis
When launching the Time Machine, Sonar displays the first snapshot ever and the last 5 events in the system.
...
| Note |
|---|
The chosen columns do not currently have any influence on the custom chart |
The Metric Table
...
The Complexity Chart
...
