diff options
Diffstat (limited to 'doc/user/analytics/merge_request_analytics.md')
| -rw-r--r-- | doc/user/analytics/merge_request_analytics.md | 127 |
1 files changed, 37 insertions, 90 deletions
diff --git a/doc/user/analytics/merge_request_analytics.md b/doc/user/analytics/merge_request_analytics.md index bb110ab495f..f9ca06c0ef9 100644 --- a/doc/user/analytics/merge_request_analytics.md +++ b/doc/user/analytics/merge_request_analytics.md @@ -1,119 +1,66 @@ --- -description: "Merge Request Analytics help you understand the efficiency of your code review process, and the productivity of your team." # Up to ~200 chars long. They will be displayed in Google Search snippets. It may help to write the page intro first, and then reuse it here. +description: "Merge request analytics help you understand the efficiency of your code review process, and the productivity of your team." # Up to ~200 chars long. They will be displayed in Google Search snippets. It may help to write the page intro first, and then reuse it here. stage: Manage 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 --- -# Merge Request Analytics **(PREMIUM)** +# Merge request analytics **(PREMIUM)** > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/229045) in GitLab 13.3. > - Moved to GitLab Premium in 13.9. -Merge Request Analytics helps you understand the efficiency of your code review process, and the productivity of your team. +Use merge request analytics to view: -## Overview +- The number of merge requests your organization merged per month. +- The average time between merge request creation and merge. +- Information about each merged merge request. -Merge Request Analytics displays information that will help you evaluate the efficiency and productivity of your merge request process. +You can use merge request analytics to identify: -The Throughput chart shows the number of merge requests merged, by month. Merge request throughput is -a common measure of productivity in software engineering. Although imperfect, the average throughput can -be a meaningful benchmark of your team's overall productivity. +- Low or high productivity months. +- Efficiency and productivity of your merge request process. +- Efficiency of your code review process. -To access Merge Request Analytics: +## View merge request analytics + +You must have at least the Reporter role to view merge request analytics. + +To view merge request analytics: 1. On the top bar, select **Menu > Projects** and find your project. 1. On the left sidebar, select **Analytics > Merge request**. -## Use cases +## View merge requests merged per month -This feature is designed for [development team leaders](https://about.gitlab.com/handbook/marketing/strategic-marketing/roles-personas/#delaney-development-team-lead) -and others who want to understand broad patterns in code review and productivity. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/232651) in GitLab 13.3. +> - Filtering [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/229266) in GitLab 13.4 -You can use Merge Request Analytics to expose when your team is most and least productive, and -identify improvements that might substantially accelerate your development cycle. +To view the number of merge requests merged per month: -Merge Request Analytics could be used when: - -- You want to know if you were more productive this month than last month, or 12 months ago. -- You want to drill into low- or high-productivity months to understand the work that took place. +1. On the top bar, select **Menu > Projects** and find your project. +1. On the left sidebar, select **Analytics > Merge request**. +1. Optional. Filter results: + 1. Select the filter bar. + 1. Select a parameter. + 1. Select a value or enter text to refine the results. + 1. To adjust the date range: + - In the **From** field, select a start date. + - In the **To** field, select an end date. -## Visualizations and data +The **Throughput** chart shows the number of merge requests merged per month. -The following visualizations and data are available, representing all merge requests that were merged in the given date range. +The table shows up to 20 merge requests per page, and includes +information about each merge request. -### Mean time to merge +## View average time between merge request creation and merge > [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/229389) in GitLab 13.9. -The mean time to merge (MTTM) metric shows the average time between when a merge request is created, -and when it is merged. To view how the MTTM changes over time, compare MTTM across different date ranges. - - - -### Throughput chart - -The throughput chart shows the number of merge requests merged per month. - - - -### Throughput table - -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/232651) in GitLab 13.3. - -The Throughput table displays the most recent merge requests merged in the date range. The -table displays up to 20 merge requests at a time. If there are more than 20 merge requests, -you can paginate to them. For each merge request, you can review the following data: - -- Title (as a link to the merge request itself) -- ID -- Pipeline status -- Label count -- Comment count -- Approval count (if approved) -- Date merged -- Time to merge -- Milestone -- Commit count -- Pipeline count -- Line change counts -- Assignees - - +Use the number in **Mean time to merge** to view the average time between when a merge request is +created and when it's merged. -## Filter the data +To view **Mean time to merge**: -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/229266) in GitLab 13.4 - -You can filter the data that is presented on the page based on the following parameters: - -- Author -- Assignee -- Label -- Milestone -- Source branch -- Target branch - -To filter results: - -1. Select the filter bar. -1. Select a parameter to filter by. -1. Select a value from the autocompleted results, or enter search text to refine the results. -1. Press Enter. - -## Date range - -The date range is set to the past 12 months by default. You can modify the date range by changing the "From" and/or "To" values that appear alongside the filter bar. After changing either value, the data displayed on the page will update automatically. - -## Tip: Bookmark preferred settings - -You can bookmark preferred filters and date ranges. After you have applied a change to the -filter bar or the date range, you'll see that information in the URL. You can create a -bookmark for those preferred settings in your browser. - -## Permissions - -The **Merge Request Analytics** feature can be accessed only: - -- On [GitLab Premium](https://about.gitlab.com/pricing/) and above. -- By users with at least the Reporter [role](../permissions.md). +1. On the top bar, select **Menu > Projects** and find your project. +1. On the left sidebar, select **Analytics > Merge request**. |