debian-mirror-gitlab/doc/user/analytics/productivity_analytics.md

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

107 lines
4.4 KiB
Markdown
Raw Normal View History

2020-05-24 23:13:21 +05:30
---
stage: Manage
2021-02-22 17:27:13 +05:30
group: Optimize
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments
2020-05-24 23:13:21 +05:30
---
2019-12-04 20:38:33 +05:30
# Productivity Analytics **(PREMIUM)**
2021-11-18 22:05:49 +05:30
> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/12079) in GitLab 12.3.
2019-12-04 20:38:33 +05:30
Track development velocity with Productivity Analytics.
2020-06-23 00:09:42 +05:30
For many companies, the development cycle is a black box and getting an estimate of how
2019-12-04 20:38:33 +05:30
long, on average, it takes to deliver features is an enormous endeavor.
2021-01-03 14:25:43 +05:30
While [Value Stream Analytics](../analytics/value_stream_analytics.md) focuses on the entire
2020-04-08 14:13:33 +05:30
Software Development Life Cycle (SDLC) process, Productivity Analytics provides a way for Engineering Management to drill down in a systematic way to uncover patterns and causes for success or failure at an individual, project, or group level.
2019-12-04 20:38:33 +05:30
2021-12-11 22:18:48 +05:30
Productivity can slow down for many reasons ranging from degrading codebase to quickly growing teams. To investigate, department or team leaders can start by visualizing the time it takes for merge requests to be merged.
2019-12-04 20:38:33 +05:30
2021-12-11 22:18:48 +05:30
## Visualizations and metrics
2019-12-04 20:38:33 +05:30
2021-12-11 22:18:48 +05:30
With Productivity Analytics, GitLab users can:
2019-12-04 20:38:33 +05:30
2021-12-11 22:18:48 +05:30
- Visualize typical merge request (MR) lifetime and statistics. A histogram shows the distribution of the time elapsed between creating and merging merge requests.
- Drill down into the most time consuming merge requests, select outliers, and filter subsequent charts to investigate potential causes.
2020-04-08 14:13:33 +05:30
- Filter by group, project, author, label, milestone, or a specific date range. For example, filter down to the merge requests of a specific author in a group or project during a milestone or specific date range.
2021-12-11 22:18:48 +05:30
- Measure velocity over time. To observe progress, visualize the trends of each metric from the charts over time. Zoom in on a particular date range if you notice outliers.
2019-12-04 20:38:33 +05:30
2021-12-11 22:18:48 +05:30
## Metrics charts
2019-12-04 20:38:33 +05:30
2021-12-11 22:18:48 +05:30
To access the charts, navigate to a group's sidebar and select **Analytics > Productivity Analytics**.
Metrics and visualizations of **merged** merge requests are available on a project or group level.
2019-12-04 20:38:33 +05:30
2021-12-11 22:18:48 +05:30
### Time to merge
2019-12-04 20:38:33 +05:30
2022-01-26 12:08:38 +05:30
The **Time to merge** histogram shows the number of merge requests and the number
2021-12-11 22:18:48 +05:30
of days it took to merge after creation. Select a column to filter subsequent charts.
2019-12-04 20:38:33 +05:30
2021-12-11 22:18:48 +05:30
![Metrics for number of days merge requests per number of days](img/productivity_analytics_time_to_merge_v14_4.png)
### Trendline
2022-01-26 12:08:38 +05:30
The **Trendline** scatterplot shows all merge requests on a certain date,
2021-12-11 22:18:48 +05:30
and the days it took to complete the action and a 30 day rolling median. Select the dropdown to view:
- Time from first commit to first comment.
- Time from first comment until last commit.
- Time from last commit to merge.
- Number of commits per merge request.
- Number of lines of code (LOC) per commit.
- Number of files touched.
![Metrics for amount of merge requests merged on a certain date](img/productivity_analytics_trendline_v14_4.png)
### Commits and merge request size
2022-01-26 12:08:38 +05:30
Under the **Trendline** scatterplot, the left-side histogram shows
the time taken (in hours) between commits and comments until the merge
2021-12-11 22:18:48 +05:30
request is merged. Select the dropdown to view:
- Time from first commit to first comment.
- Time from first comment until last commit.
- Time from last commit to merge.
2022-01-26 12:08:38 +05:30
The right-side histogram shows the size or complexity of a merge request.
2021-12-11 22:18:48 +05:30
Select the dropdown to view:
2022-04-04 11:22:00 +05:30
2021-12-11 22:18:48 +05:30
- Number of commits per merge request.
- Number of lines of code (LOC) per commit.
- Number of files touched.
![Metrics for amount of commits and complexity of changes per merge request.](img/product_analytics_commits_per_mr_v14_4.png)
### Merge request list
2022-01-26 12:08:38 +05:30
The **List** table shows a list of merge requests with their respective time duration metrics.
2021-12-11 22:18:48 +05:30
Sort metrics by:
- Time from first commit to first comment.
- Time from first comment until last commit.
- Time from last commit to merge.
Filter metrics by:
2022-01-26 12:08:38 +05:30
2021-12-11 22:18:48 +05:30
- Number of commits per merge request.
- Number of lines of code per commit.
- Number of files touched.
## Filter by date range
2019-12-26 22:10:19 +05:30
2020-06-23 00:09:42 +05:30
> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/13188) in GitLab 12.4.
2019-12-26 22:10:19 +05:30
2021-11-11 11:23:49 +05:30
You can filter analytics based on a date range. To filter results:
2019-12-26 22:10:19 +05:30
1. Select a group.
2021-11-11 11:23:49 +05:30
1. Optional. Select a project.
1. Select a date range by using the available date pickers.
2019-12-26 22:10:19 +05:30
2019-12-04 20:38:33 +05:30
## Permissions
The **Productivity Analytics** dashboard can be accessed only:
2021-11-18 22:05:49 +05:30
- On [GitLab Premium](https://about.gitlab.com/pricing/) and above.
2022-04-04 11:22:00 +05:30
- By users with at least the Reporter role.