Create reports and dashboards

2 minute readExtensibilityDeveloper productivity

The GitLab plugin allows you to collect reporting data to create CloudBees Analytics reports and dashboards.

Builds
Figure 1. Continuous integration dashboard

Configure procedures to collect reporting data

The following procedures allow you to configure the GitLab plugin to set up schedules to periodically retrieve data from GitLab and send it to the CloudBees Analytics server:

  • GitLab Setup build for DevOps Insight

  • GitLab Setup deployment for DevOps Insight

  • GitLab Setup feature for DevOps Insight

  • GitLab Setup incident for DevOps Insight

    You can also use the Git Setup for DevOps Insight procedure to configure the Git plugin to monitor code velocity across teams and SCM repositories over time. For more information, refer to Code Commit Trends dashboard.

To configure and run the procedure:

  1. Select DevOps Essentials  Procedures.

  2. From the All Projects list, select CloudBees and then select Apply. The list of GitLab procedures for the CloudBees project appears.

    After you install the GitLab plugin, the setup procedures are available in the CloudBees project. If you uninstall the plugin, the setup procedures are no longer available in the CloudBees project.
  3. Select the Run button for the appropriate procedure and then select New run.

  4. Enter the parameter values. For descriptions of the parameters for this procedure, refer to Collect reporting data with the GitLab plugin.

  5. Select OK.

Configure additional options for incidents and features

The GitLab plugin supports additional options for custom reports and dashboards for:

When defining labels for your reports, entries can only contain letters, digits, hyphens, underscores, and periods. Entries cannot contain spaces, XML entities, or other special characters. If entries contain restricted characters, the report cannot be downloaded from the CloudBees CD/RO UI. For more information, refer to Export reports.

Incidents

For incidents, the GitLab plugin allows you to specify a custom status label.

To specify the category, use labels in the following format: category::<category_name>.

Status

To specify the status, use labels in the following format: status::<status_name>.

Table 1. Status labels for incidents
Status Label GitLab state

Active

status::active

Opened

New

status::new

Opened

Resolved

status::resolved

Closed

Closed

status::closed

Closed

Features

For features, the GitLab plugin allows you to specify custom labels for type, resolution, and status.

For calculating story points, use Time tracking: Estimated, where 1 story point equals 1 work day.

Type

To specify the type, use labels in the following format: type::<type_name>:

Table 2. Type labels for features
Type Label

Improvement

type::improvement

New Feature

type::new_feature

Story

type::story

Resolution

To specify the resolution, use labels in the following format: resolution::<resolution_name>:

Table 3. Resolution labels for features
Resolution Label

Cannot Reproduce

resolution::cannot_reproduce

Duplicate

resolution::duplicate

Fixed

resolution::fixed

Incomplete

resolution::incomplete

Won’t Fix

resolution::wont_fix

Status

To specify the status, use labels in the following format: status::<status_name>.

Table 4. Status labels for features
Status Label GitLab state

Open

status::open

Opened

In Progress

status::inprogress

Opened

Reopened

status::reopened

Opened

Resolved

status::resolved

Closed

Closed

status::closed

Closed

Export reports

You can export reports created with the GitHub plugin as XML and JSON. For more information on exporting reports, refer to Export reports.