doc/user/analytics/value_streams_dashboard.md
{{< details >}}
{{< /details >}}
{{< history >}}
group_analytics_dashboards_page. Disabled by default.group_analytics_dashboards_page. Enabled by default.group_analytics_dashboards_page removed.{{< /history >}}
The Value Streams Dashboard is a customizable dashboard you can use to identify trends, patterns, and opportunities for digital transformation improvements. The centralized UI in the Value Streams Dashboard acts as the single source of truth (SSOT), where all stakeholders can access and view the same set of metrics that are relevant to the organization. The Value Streams Dashboard includes panels that visualize the following metrics:
With the Value Streams Dashboard, you can:
For a click-through demo, see the Value Stream Management product tour.
To view the Value Streams Dashboard as an analytics dashboard for a group:
[!note] Data displayed on the Value Streams Dashboard is continuously collected in the backend. If you upgrade to the Ultimate tier, you get access to historical data, and can view metrics about past GitLab usage and performance.
The Value Streams Dashboard panels have a default configuration, but you can also customize the dashboard panels.
{{< history >}}
group_analytics_dashboard_dynamic_vsd. Disabled by default.group_analytics_dashboard_dynamic_vsd removed in GitLab 17.0.{{< /history >}}
The Overview panel provides a holistic view of the top-level namespace activity by visualizing key DevOps metrics. The panel displays metrics for:
Data displayed in the Overview panel is collected by batch processing. GitLab stores record counts for each subgroup in the database, then aggregates the record counts to provide metrics for the top-level group. Data is aggregated monthly, around the end of the month, on a best-effort basis depending on the load on GitLab systems.
For more information, see epic 10417.
{{< history >}}
ai_impact_table visualization in GitLab 18.5.{{< /history >}}
The DevSecOps metrics comparison panels display metrics for a group or project over the past six months. These visualizations help you understand whether the key DevSecOps metrics improve month over month. The Value Stream Dashboard displays three DevSecOps metric comparison panels:
In each comparison panel, you can:
When you hover over a metric, a tooltip displays an explanation of the metric and a link to the related documentation page.
The Change % column also indicates a percentage increase or decrease of the metric value from the previous month, compared to six months prior.
The Trend column displays sparklines to help you identify patterns in metric trends (such as seasonal changes) over time. The sparkline color ranges from blue to green, where green indicates a positive trend, and blue indicates a negative trend.
{{< details >}}
{{< /details >}}
{{< history >}}
dora_performers_score_panel. Disabled by default.dora_performers_score_panel removed.{{< /history >}}
The DORA Performers score panel is a group-level bar chart that visualizes the status of the organization's DevOps performance levels across different projects for the last full calendar month.
The chart is a breakdown of your project's DORA scores, categorized as high, medium, or low. The chart aggregates all the child projects in the group.
The chart bars display the total number of projects per score category, calculated monthly. To exclude data from the chart (for example, Not included), in the legend select the series you want to exclude. Hovering over each bar reveals a dialog that explains the score's definition.
For example, if a project has a high score for deployment frequency (velocity), it means that the project has one or more deploys to production per day.
| Metric | High | Medium | Low | Description |
|---|---|---|---|---|
| Deployment frequency | ≥30 | 1-29 | <1 | The number of deploys to production per day |
| Lead time for changes | ≤7 | 8-29 | ≥30 | The number of days to go from code committed to code successfully running in production |
| Time to restore service | ≤1 | 2-6 | ≥7 | The number of days to restore service when a service incident or a defect that impacts users occurs |
| Change failure rate | ≤15% | 16%-44% | ≥45% | The percentage of changes to production resulted in degraded service |
To learn more, see the blog post Inside DORA Performers score in GitLab Value Streams Dashboard.
When you customize dashboards with a YAML configuration, you can filter the displayed projects by assigned topics.
panels:
- title: 'My dora performers scores'
visualization: dora_performers_score
queryOverrides:
namespace: group/my-custom-group
filters:
projectTopics:
- JavaScript
- Vue.js
If multiple topics are provided, all topics must match for the project to be included in the results.
{{< details >}}
{{< /details >}}
{{< history >}}
{{< /history >}}
The Projects by DORA metric panel is a group-level table that lists the status of the organization's DevOps performance levels across projects.
The table lists all projects with their DORA metrics, aggregating data from child projects in groups and subgroups. The metrics are aggregated for the last full calendar month.
You can sort the projects by metric values, helping you identify high, medium, and low-performing projects. For further investigation, you can select a project name to drill down into that project's page.
{{< details >}}
{{< /details >}}
{{< history >}}
value_stream_dashboard_on_off_setting. Disabled by default.value_stream_dashboard_on_off_setting removed in GitLab 16.6.{{< /history >}}
To enable or disable the overview count aggregation for the Value Streams Dashboard:
To retrieve aggregated usage counts in the group, use the GraphQL API.
Prerequisites:
To view the Value Streams Dashboard for a group:
/analytics/dashboards/value_streams_dashboard to the group URL (for example, https://gitlab.com/groups/gitlab-org/-/analytics/dashboards/value_streams_dashboard).{{< history >}}
project_analytics_dashboard_dynamic_vsd. Disabled by default.project_analytics_dashboard_dynamic_vsd removed in GitLab 17.5.{{< /history >}}
To view the Value Streams Dashboard as an analytics dashboard for a project:
You can schedule reports using the CI/CD component Value Streams Dashboard Scheduled Reports tool. This tool saves time and effort by eliminating the need to manually search for the right dashboard with the relevant data, so that you can focus on analyzing insights. By scheduling reports, you can ensure that the decision-makers in your organization receive proactive, timely, and relevant information.
The Scheduled Reports tool collects metrics from projects or groups through the public GitLab GraphQL API, then builds a report using GitLab Flavored Markdown, and opens an issue in a specified project. The issue includes a comparison metrics table in Markdown format.
See an example scheduled report. To learn more, see the blog post New Scheduled Reports Generation tool simplifies value stream management.
You can customize the Value Streams Dashboard and configure what subgroups and projects to include in the page.
To customize the default content of the page, you need to create a YAML configuration file in a project of your choice. In this file, you can define various settings and parameters, such as title, description, and number of panels. The file is schema-driven and managed with version control systems like Git. This enables tracking and maintaining a history of configuration changes, reverting to previous versions if necessary, and collaborating effectively with team members. Query parameters can still be used to override the YAML configuration.
Before you customize the dashboard panels, you must select a project to store your YAML configuration file.
Prerequisites:
After you have set up the project, set up the configuration file:
.gitlab/analytics/dashboards/value_streams/value_streams.yaml.value_streams.yaml configuration file, fill in the configuration options:| Field | Description |
|---|---|
title | Custom name for the panel |
queryOverrides (formerly data) | Overrides data query parameters specific to each visualization. |
namespace (subfield of queryOverrides) | Group or project path to use for the panel |
filters (subfield of queryOverrides) | Filters the query for each supported visualization type. |
visualization | The type of visualization to be rendered. Supported options are ai_impact_table, dora_performers_score, and usage_overview. |
gridAttributes | The size and positioning of the panel |
xPos (subfield of gridAttributes) | Horizontal position of the panel |
yPos (subfield of gridAttributes) | Vertical position of the panel |
width (subfield of gridAttributes) | Width of the panel (max. 12) |
height (subfield of gridAttributes) | Height of the panel |
# version - The latest version of the analytics dashboard schema
version: '2'
# title - Change the title of the Value Streams Dashboard.
title: 'Custom Dashboard title'
# description - Change the description of the Value Streams Dashboard. [optional]
description: 'Custom description'
# panels - List of panels that contain panel settings.
# title - Change the title of the panel.
# visualization - The type of visualization to be rendered
# gridAttributes - The size and positioning of the panel
# queryOverrides.namespace - The Group or Project path to use for the chart panel
# queryOverrides.filters.includeMetrics - Shows rows by metric ID in the table panel.
panels:
- title: 'Group usage overview'
visualization: usage_overview
queryOverrides:
namespace: group
filters:
include:
- groups
- projects
gridAttributes:
yPos: 1
xPos: 1
height: 1
width: 12
- title: 'Group dora and issue metrics'
visualization: ai_impact_table
queryOverrides:
namespace: group
filters:
includeMetrics:
- deployment_frequency
- deploys
gridAttributes:
yPos: 2
xPos: 1
height: 12
width: 12
- title: 'My dora performers scores'
visualization: dora_performers_score
queryOverrides:
namespace: group/my-project
filters:
projectTopics:
- ruby
- javascript
gridAttributes:
yPos: 26
xPos: 1
height: 12
width: 12
The filters subfield on the queryOverrides field can be used to customize the data displayed in a panel.
Filters for the ai_impact_table visualization.
| Filter | Description | Supported values |
|---|---|---|
includeMetrics | Shows rows by metric ID in the table panel. Takes priority over excludeMetrics. | Any ID from available metrics. |
excludeMetrics | Hides rows by metric ID from the table panel. | Any ID from available metrics. |
Filters for the dora_performers_score visualization.
| Filter | Description | Supported values |
|---|---|---|
projectTopics | Filters the projects shown based on their assigned topics | Any available group topic |
Filters for the usage_overview visualization.
| Filter | Description | Supported values |
|---|---|---|
include | Limits the metrics returned, by default displays all available | groups, projects, issues, merge_requests, pipelines, users |
| Filter | Description | Supported values |
|---|---|---|
include | Limits the metrics returned, by default displays all available | issues, merge_requests, pipelines |
[!warning] The
dora_chartvisualization was deprecated in GitLab 18.5.
Filters for the dora_chart visualization.
| Filter | Description | Supported values |
|---|---|---|
labels | Filters data by labels | Any available group label. Label filtering is supported by the following metrics: lead_time, cycle_time, issues, issues_completed, merge_request_throughput, median_time_to_merge. |
{{< history >}}
{{< /history >}}
The following table provides an overview of the metrics available in the Value Streams Dashboard, along with their descriptions and the name of the drill-down report where they are displayed.
| Metric | Description | Drill-down report | ID |
|---|---|---|---|
| Deployment frequency | Average number of deployments to production per day. This metric measures how often value is delivered to end users. | Deployment frequency tab | deployment_frequency |
| Lead time for changes | The time to successfully deliver a commit into production. This metric reflects the efficiency of CI/CD pipelines. | Lead time tab | lead_time_for_changes |
| Time to restore service | The time it takes an organization to recover from a failure in production. | Time to restore service tab | time_to_restore_service |
| Change failure rate | Percentage of deployments that cause an incident in production. | Change failure rate tab | change_failure_rate |
| Lead time | Median time from issue created to issue closed. | Value Stream Analytics | lead_time |
| Cycle time | Median time from the earliest commit of a linked issue's merge request to when that issue is closed. | Lifecycle metrics section in Value Stream Analytics | cycle_time |
| Issues created | Number of new issues created. | Issue analytics | issues |
| Issues closed | Number of issues closed by month. | Issue analytics | issues_completed |
| Number of deploys | Total number of deploys to production. | Merge request analytics | deploys |
| Merge request throughput | The number of merge requests merged by month. | Productivity analytics | merge_request_throughput |
| Median time to merge | Median time between merge request created and merge request merged. | Productivity analytics | median_time_to_merge |
| Contributor count | Number of monthly unique users with contributions in the group. | Contribution analytics | contributor_count |
| Critical vulnerabilities over time | Critical vulnerabilities over time in project or group | Vulnerability report | vulnerability_critical |
| High vulnerabilities over time | High vulnerabilities over time in project or group | Vulnerability report | vulnerability_high |
| Total pipeline runs | The total number of pipelines that have run in the selected time period. | CI/CD analytics | pipeline_count |
| Pipeline median duration | The median time it takes for pipelines to complete. | CI/CD analytics | pipeline_duration_median |
| Pipeline success rate | The percentage of pipelines that completed successfully. | CI/CD analytics | pipeline_success_rate |
| Pipeline failure rate | The percentage of pipelines that failed. | CI/CD analytics | pipeline_failed_rate |
| Feature usage | Number of contributors who used any GitLab Duo feature. | duo_used_count | |
| Code Suggestions usage | Number of users who used Code Suggestions. | code_suggestions_users_count | |
| Code Suggestions acceptance rate | Code Suggestions accepted out of total Code Suggestions generated. | code_suggestions_acceptance_rate | |
| Non-Agentic Chat usage | Number of users who used Non-Agentic Chat. | duo_chat_users_count | |
| Root Cause Analysis usage | Number of users who used Root Cause Analysis. | duo_rca_users_count |
The following metrics do not depend on using Jira: