Reporting for the integration build

From current

Contents 1 Viewing reports 2 Filtering reports 3 Available fields 4 Creating a report 4.1 Example 1: Creating a build summary report 4.2 Example 2: Creating an issue trend report 5 Report types 5.1 Issues 5.2 Top Issues 5.3 Fix Activity 5.4 Category Details 5.5 Citing Backlog 5.6 Citing Activity 5.7 Complexity Details 5.8 Complexity Trend 5.9 Size Trend 5.10 Churn Trend 5.11 Project Configuration 6 Editing reports 7 Sharing reports 8 What's next? 9 See also

Klocwork Review reports provide a comprehensive view of the complexity of your software project and the risks facing it. Reports allow you to:

• check your organization's compliance to coding standards, such as MISRA C or MISRA C++
• identify problematic modules
• determine whether developers are finding and fixing issues before check-in

If the default reports don't provide enough information, you can edit them or create new ones.

Viewing reports

To view reports, log into Klocwork Review and click the reports link from one of the projects in the Project List.

The Reports list in the left pane displays a categorized list of default reports, with the Project Summary page displayed on the right. Like all default reports, the Project Summary page is customizable, so you can decide what appears here.

Tip: You can re-size or hide the Reports list to maximize the viewing space by clicking and/or dragging on the arrows. Click on the arrows again to unhide it.

You can "drill down" with a single click on a report item, legend item or link. When you drill down, you're narrowing the view of the data being presented (to show issues within a selected module, for example). What you see varies by report type:

• For some reports, clicking an active area brings you directly to an issue list in the Issues tab for a selected module. If the active area of the report is from a previous build, then an issue list from that previous build is displayed. For more information about detected issues, see Investigating and citing issues in the integration build.
• For other reports, you can drill down through modules to the file level.

Breadcrumbs across the top display your location in a hierarchy (modules or taxonomy), allowing you to quickly navigate back to a previous level.

For issue reports, you can click the browse issues link to display the issue list for the currently displayed modules or owners.

The reporting timeline appears below your chart when you have builds on your x-axis and allows you to focus on builds within a certain timeframe.

Note: By default, only new and existing defects are shown in reports that show states. In order to see fixed defects, you can edit the report and add state as a filter. Once this filter has been added, you can check off Fixed to see these types of defects in the report.

Troubleshooting: See Empty report or issue list in Klocwork Review.

Filtering reports

You can use filters to narrow the focus of your report and focus on specific variables. They are:

• specified during report creation
• used when viewing reports

For example, the Status filter allows you to look at 'New' issues only if you want to see what issues have been introduced since your last build.

For most report types, when you edit a default report or create your own report, you can specify which filters to make available for those who can view your report.

Available fields

When creating a new report, the variables that make up a report are labeled Fields to report. You can drag-and-drop them on to the series (Σ, which shows data breakdown within the chart), x-axis and filters. The y-axis is not editable and is determined by the type of report you choose to create (For example, if you create an Issue Report, issues are on the y-axis). The list of available fields is determined by your report type. The possible fields are as follows:

• Build
• Module
• Owner
• Severity
• State
• Status
• Taxonomy

Creating a report

1. Click Create a new report in the Reports list.
2. Select your Report type.
3. Drag and drop fields from Fields to report onto the filters, series and X-axis. The report type determines which fields are available.

   

4. Directly above the chart is a field with an auto-generated name (for example, 'Issues by Build grouped by Status'. If you'd like to rename it, erase the default name and type in your own.
5. On the right, there is a field labeled Folder. Type the name of the folder you want to put the report into. If the folder doesn't already exist, it is created after you click Save. If you do not specify a folder, the report is located at the bottom of the Reports list by default.
6. Select public to share your report with other members of the team. If you do not have the proper permissions, this setting is disabled.
7. Once you are satisfied, click Save.

   Note: For Issue Reports, Save is disabled until you set the required fields. For stackbar and sidebar charts, you must set the x-axis type. For pie charts, you must set the series type; the x-axis type is ignored.

Example 1: Creating a build summary report

If you're just getting started with Insight, you may only have a single project build. This example shows you how to get some interesting data from it. However, you can also use this example if you already have multiple project builds.

1. From the Reports list, click Create a new report.
2. A list of reports appears. Select Issue Report.
3. Drag-and-drop severity onto the x-axis.
4. Drag-and-drop state onto the Series(Σ) type.
5. Drag-and-drop severity onto the Filters field.

   Tip: If you want, change the report format from a stackbar to a sidebar or pie graph. Users who view the report later can also customize the format.

6. A descriptive title is created automatically based on the fields you selected, but you can change it. We'll name ours Issues grouped by Severity.
7. Under Select severities to show, select which severities you want to make available for viewers of this report. We'll select all of the severities.

   Tip: If your project has multiple builds, you can drag your cursor inside the timeline below the chart to focus on a certain number of builds. Again, users who view the report later can customize the timeline.

8. Once you're satisfied with your report, you have the option to categorize it into a folder. If you enter one of the existing folders in the Folder field, such as Issue Trend, your report appears below this heading. We'll create a new one by entering Custom Team Reports.
9. If you have permissions, the public checkbox is clickable. Making a report public means that it is available to all users for all projects on the current Klocwork Server.
10. Click Save and your report appears in the Reports list. It's also available for you to use on all projects on the current Klocwork Server.

Example 2: Creating an issue trend report

This example shows how to compare multiple builds. The report shows you what's new and what's been fixed -- useful for a team lead who wants to track team progress. You can create this report by following the basic steps above and changing the following settings:

• For the type of report, select Issue Report.
• Set build as the x-axis and state as the series.
• Set owner as the filter.

Report types

Issues

The chart shows you a high-level view of issues over several builds.

• X-Axis can be set to any field
• Series can be set to any field except build
• Filters can be set to any field except build

Top Issues

The chart displays issue counts for the issue types with the most issues in a build.

• Filters can be set to any field except build
• To set the maximum number of pie-segments displayed, type a number into the Top: field (default is 10)

Fix Activity

The chart displays the issues fixed between builds.

• X-Axis is set to builds
• Series is set as module
• Filters can be set to severity, taxonomy, module and owner
• You can also isolate system or desktop issues by selecting the desired option in the Show drop-down menu above the chart

Category Details

The report displays the issue distribution and summary of highest-density files/classes, by category.

• Filter is set to status
• Number of rows can be configured in the Table rows dialog box
• The build the report is representing can be set by clicking on the latest build dialog box

Citing Backlog

The chart displays number of issues in Analyze status awaiting review, plus the number of issues in Fix status awaiting a fix, summarized by user.

• X-Axis is set to builds by name and/or date
• The build that the report is representing can be set by clicking on the choose builds link
• The report displays both build names and dates.

  Note: If the start date doesn't fall on a build, the selected date is displayed. If the end date is on or after the latest build, the last label is 'Since <build name>'. If the start and end dates have no builds between them, only dates is displayed.

Citing Activity

The report displays all updates in the latest build, status updates over time, and a breakdown of the backlog and status updates by user.

Complexity Details

The report displays the number of instances of the top 15 complex methods and a list of modules that exceed the specified complexity threshold (default: 20).

• X-Axis is set to existing modules
• The threshold can be customized by entering a number in the Threshold field (default is 20)

Complexity Trend

The chart displays Number of functions or class-methods that exceed the specified cyclomatic complexity threshold (default: 20).

• X-Axis is set to builds
• Filters can be set to module and owner
• To set the threshold, type a number into the Threshold: field (default is 20)

Size Trend

The report shows total lines of non-blank, non-comment code, grouped by project or module. For C/C++ files, the report displays the number of lines of code after precompilation.

• X-Axis is set to builds
• Series is set as module
• Filters can be set as owner or module

Churn Trend

The chart displays the number of added, deleted or changed entities of a particular type as compared to previous builds.

• X-Axis is set to builds
• Series is set as module
• Filters can be set to module and owner
• Churn type can be customized by selecting one of the options from the Churn type drop-down menu above the chart.

Project Configuration

The report displays project information such as creation date, Klocwork Insight version and basic code metrics.

Editing reports

You can edit, move, print and delete default reports as well as reports you have created.

To edit any report, click on it in the Reports list and click the edit icon.

To move a report:

1. Click one of the reports that you created in the Reports list.
2. Click to edit it.
3. Click the Folder dialog and enter a folder name. If the folder does not already exist, it is created when you save.
4. Click Save.

To copy a report:

1. Click the report you wish to copy in the Reports list.
2. Click to edit it.
3. Type a new name into the name field.
4. Make changes to the report as needed.
5. Click Copy to save the new report.

Sharing reports

You can share reports you've created in two ways:

• If you're a project admin, you can make a report "public". This makes the report available to all users for all projects on the current Klocwork Server. You will see the public checkbox when you're editing a report.
• Otherwise, you can click . This opens a pop-up box that contains a link you can copy and paste to share with other developers.

What's next?

When you're more familiar with Klocwork Insight, you may wish to customize metrics and reporting for the integration build.

Customize issue detection and reporting by:

• adding file ownership to your integration project, so that you can filter reports by owner - Tracking issues by owner
• adding your own custom documents to the Reports list - Adding external documents to Klocwork Review

Customize metrics by:

• adding any of the 100 (or so) Insight metrics as a Metrics report type - Customizing metrics reports in Klocwork Review
• setting the metrics thresholds that you want reported - Changing the thresholds for reported metrics
• adding rules specific to your software system or quality objectives - Enforcing quality goals through usage rules

Track your projects by:

• comparing up to five of your projects in Klocwork Review - Tracking projects with the Cross-Project Report

See also

• Klocwork Review troubleshooting
• Advanced reporting for the integration build
• Default reports in Klocwork Review
• Organizing your code into modules
• Customizing your view of the integration build analysis
• Comparing two builds in Klocwork Review
• About Builds/Dates