Collect reporting data with the GitLab plugin

This plugin provides integration with CloudBees Analytics reports and/or dashboards to focus on key metrics across releases and pipelines - from code commit to deployment. The ability to visualize this information as dashboards enables enterprises to understand the overall status of their release and deployment process, identify hotspots that require action, understand trends, and find opportunities for further improvement.

You can create reports and dashboards by adding data sources for different external tools you are using in your release. The supported tools are based on the installed plugins that support collecting data for the dashboard to send to the CloudBees Analytics server. For more information, refer to Monitoring with CloudBees Analytics.

Build

Collects build data from GitLab, allowing you to create reports and dashboards to monitor key metrics for builds that can be used to gain insight into your organization’s build throughput and identify any potential build issues.

Input parameters

Table 1. Build input parameters
Parameter	Description
GitLab project ID or path	Required. A path or identifier of a GitLab project.
Branch or tag name	A branch or tag name of a GitLab project.
Starting commit ID	A starting commit identifier. This commit ID is used to get the starting build number of a GitLab project.
Test category	The category for the tests.
Initial records count	The count of records to retrieve from the server for the first time. If omitted, it is set to `10`.
Metadata property path	The property sheet where run metadata is stored. If omitted, `/mySchedule/GitLab-%JobName%-%Report Object Type%` is used for schedule contest. For all other contexts, the root is `/myProject`.
Transform script	Allows you to provide Groovy closure for payload customization.

Deployment

Collects application data from CloudBees CD/RO, allowing you to create reports and dashboards to display key metrics for application deployments that can be used to gain insight into your organization’s throughput and to raise awareness for any potential bottlenecks in your application deployment processes, so that they can be addressed quickly.

Input parameters

Table 2. Deployment input parameters
Parameter	Description
GitLab project ID or path	Required. A path or identifier of a GitLab project.
Branch or tag name	A branch or tag name of a GitLab project.
Starting commit ID	A starting commit identifier. This commit ID is used to get the starting build number of a GitLab project.
Initial records count	The count of records to retrieve from the server for the first time. If omitted, it is set to `10`.
Metadata property path	The property sheet where run metadata is stored. If omitted, `/mySchedule/GitLab-%JobName%-%Report Object Type%` is used for schedule contest. For all other contexts, the root is `/myProject`.
Transform script	Allows you to provide Groovy closure for payload customization.

Feature

Collects feature data from CloudBees CD/RO, allowing you to create reports and dashboards to track stories or features in GitLab.

Input parameters

Table 3. Feature input parameters
Parameter	Description
GitLab project ID or path	Required. A path or identifier of a GitLab project.
Assignee username	Return issues assigned to the given username. In GitLab CE, the `assignee_username` array can only contain a single value. Otherwise, an invalid parameter error is returned.
Author username	Returns issues created by the given username.
Iteration title	Returns issues assigned to the iteration with the given title.
Labels	A newline-separated list of label names. Issues must have all labels to be returned. Pre-defined label names are case-insensitive. None: Lists all issues with no labels. Any: Lists all issues with at least one label.
Milestone	The milestone title. None: Lists all issues with no milestone. Any: Lists all issues that have an assigned milestone.
Initial records count	The count of records to retrieve from the server for the first time. If omitted, it is set to `10`.
Metadata property path	The property sheet where run metadata is stored. If omitted, `/mySchedule/GitLab-%JobName%-%Report Object Type%` is used for schedule contest. For all other contexts, the root is `/myProject`.
Transform script	Allows you to provide Groovy closure for payload customization.

Incident

Collects incident data, allowing you to create reports and dashboards to display key incident metrics associated with the deployed release (post-production).

Input parameters

Table 4. Incident input parameters
Parameter	Description
GitLab project ID or path	Required. A path or identifier of a GitLab project.
Assignee username	Returns issues assigned to the given username. In GitLab CE, the `assignee_username` array can only contain a single value. Otherwise, an invalid parameter error is returned.
Author username	Returns issues created by the given username.
Iteration title	Returns issues assigned to the iteration with the given title.
Labels	A newline-separated list of label names. Issues must have all labels to be returned. Pre-defined label names are case-insensitive. None: Lists all issues with no labels. Any: Lists all issues with at least one label.
Milestone	The milestone title. None: Lists all issues with no milestone. Any: Lists all issues that have an assigned milestone.
Initial records count	The count of records to retrieve from the server for the first time. If omitted, it is set to `10`.
Metadata property path	The property sheet where run metadata is stored. If omitted, `/mySchedule/GitLab-%JobName%-%Report Object Type%` is used for schedule contest. For all other contexts, the root is `/myProject`.
Transform script	Allows you to provide Groovy closure for payload customization.