cycle_analytics.md 9,0 КБ
Newer Older
Achilleas Pipinellis's avatar
Achilleas Pipinellis включено в состав коммита
1
2
# Cycle Analytics

Mike Lewis's avatar
Mike Lewis включено в состав коммита
3
4
Cycle Analytics measures the time spent to go from an [idea to production] - also known
as cycle time - for each of your projects. Cycle Analytics displays the median time for an idea to
Eric Brinkman's avatar
Eric Brinkman включено в состав коммита
5
6
7
8
9
reach production, along with the time typically spent in each DevOps stage along the way.

Cycle Analytics is useful in order to quickly determine the velocity of a given
project. It points to bottlenecks in the development process, enabling management
to uncover, triage, and root-cause slowdowns in the software development life cycle.
Achilleas Pipinellis's avatar
Achilleas Pipinellis включено в состав коммита
10

Ismail S's avatar
Ismail S включено в состав коммита
11
Cycle Analytics is tightly coupled with the [GitLab flow] and
Achilleas Pipinellis's avatar
Achilleas Pipinellis включено в состав коммита
12
13
14
15
calculates a separate median for each stage.

## Overview

Eric Brinkman's avatar
Eric Brinkman включено в состав коммита
16
You can find the Cycle Analytics page under your project's **Project ➔ Cycle
Achilleas Pipinellis's avatar
Achilleas Pipinellis включено в состав коммита
17
18
19
20
Analytics** tab.

![Cycle Analytics landing page](img/cycle_analytics_landing_page.png)

Eric Brinkman's avatar
Eric Brinkman включено в состав коммита
21
There are seven stages that are tracked as part of the Cycle Analytics calculations.
Achilleas Pipinellis's avatar
Achilleas Pipinellis включено в состав коммита
22
23

- **Issue** (Tracker)
Marcel Amirault's avatar
Marcel Amirault включено в состав коммита
24
  - Time to schedule an issue (by milestone or by adding it to an issue board)
Achilleas Pipinellis's avatar
Achilleas Pipinellis включено в состав коммита
25
- **Plan** (Board)
Marcel Amirault's avatar
Marcel Amirault включено в состав коммита
26
  - Time to first commit
Achilleas Pipinellis's avatar
Achilleas Pipinellis включено в состав коммита
27
- **Code** (IDE)
Marcel Amirault's avatar
Marcel Amirault включено в состав коммита
28
  - Time to create a merge request
Achilleas Pipinellis's avatar
Achilleas Pipinellis включено в состав коммита
29
- **Test** (CI)
Marcel Amirault's avatar
Marcel Amirault включено в состав коммита
30
  - Time it takes GitLab CI/CD to test your code
Achilleas Pipinellis's avatar
Achilleas Pipinellis включено в состав коммита
31
- **Review** (Merge Request/MR)
Marcel Amirault's avatar
Marcel Amirault включено в состав коммита
32
  - Time spent on code review
Achilleas Pipinellis's avatar
Achilleas Pipinellis включено в состав коммита
33
- **Staging** (Continuous Deployment)
Marcel Amirault's avatar
Marcel Amirault включено в состав коммита
34
  - Time between merging and deploying to production
Achilleas Pipinellis's avatar
Achilleas Pipinellis включено в состав коммита
35
- **Production** (Total)
Marcel Amirault's avatar
Marcel Amirault включено в состав коммита
36
  - Total lifecycle time; i.e. the velocity of the project or team
Achilleas Pipinellis's avatar
Achilleas Pipinellis включено в состав коммита
37
38
39

## How the data is measured

James Lopez's avatar
James Lopez включено в состав коммита
40
Cycle Analytics records cycle time and data based on the project issues with the
Evan Read's avatar
Evan Read включено в состав коммита
41
exception of the staging and production stages, where only data deployed to
James Lopez's avatar
James Lopez включено в состав коммита
42
production are measured.
Achilleas Pipinellis's avatar
Achilleas Pipinellis включено в состав коммита
43
44

Specifically, if your CI is not set up and you have not defined a `production`
Toon Claes's avatar
Toon Claes включено в состав коммита
45
or `production/*` [environment], then you will not have any data for those stages.
Achilleas Pipinellis's avatar
Achilleas Pipinellis включено в состав коммита
46
47
48
49
50
51

Below you can see in more detail what the various stages of Cycle Analytics mean.

| **Stage** | **Description** |
| --------- | --------------- |
| Issue     | Measures the median time between creating an issue and taking action to solve it, by either labeling it or adding it to a milestone, whatever comes first. The label will be tracked only if it already has an [Issue Board list][board] created for it. |
Achilleas Pipinellis's avatar
Achilleas Pipinellis включено в состав коммита
52
53
| Plan      | Measures the median time between the action you took for the previous stage, and pushing the first commit to the branch. The very first commit of the branch is the one that triggers the separation between **Plan** and **Code**, and at least one of the commits in the branch needs to contain the related issue number (e.g., `#42`). If none of the commits in the branch mention the related issue number, it is not considered to the measurement time of the stage. |
| Code      | Measures the median time between pushing a first commit (previous stage) and creating a merge request (MR) related to that commit. The key to keep the process tracked is to include the [issue closing pattern] to the description of the merge request (for example, `Closes #xxx`, where `xxx` is the number of the issue related to this merge request). If the issue closing pattern is not present in the merge request description, the MR is not considered to the measurement time of the stage. |
Małgorzata Ksionek's avatar
Małgorzata Ksionek включено в состав коммита
54
55
56
| Test      | Measures the median time to run the entire pipeline for that project. It's related to the time GitLab CI takes to run every job for the commits pushed to that merge request defined in the previous stage. It is basically the start->finish time for all pipelines. |
| Review    | Measures the median time taken to review the merge request that has closing issue pattern, between its creation and until it's merged. |
| Staging   | Measures the median time between merging the merge request with closing issue pattern until the very first deployment to production. It's tracked by the [environment] set to `production` or matching `production/*` (case-sensitive, `Production` won't work) in your GitLab CI configuration. If there isn't a production environment, this is not tracked. |
Achilleas Pipinellis's avatar
Achilleas Pipinellis включено в состав коммита
57
| Production| The sum of all time (medians) taken to run the entire process, from issue creation to deploying the code to production. |
Achilleas Pipinellis's avatar
Achilleas Pipinellis включено в состав коммита
58
59
60
61
62
63

---

Here's a little explanation of how this works behind the scenes:

1. Issues and merge requests are grouped together in pairs, such that for each
Achilleas Pipinellis's avatar
Achilleas Pipinellis включено в состав коммита
64
65
66
   `<issue, merge request>` pair, the merge request has the [issue closing pattern]
   for the corresponding issue. All other issues and merge requests are **not**
   considered.
Brett Walker's avatar
Brett Walker включено в состав коммита
67
1. Then the `<issue, merge request>` pairs are filtered out by last XX days (specified
James Lopez's avatar
James Lopez включено в состав коммита
68
   by the UI - default is 90 days). So it prohibits these pairs from being considered.
Achilleas Pipinellis's avatar
Achilleas Pipinellis включено в состав коммита
69
70
71
72
73
1. For the remaining `<issue, merge request>` pairs, we check the information that
   we need for the stages, like issue creation date, merge request merge time,
   etc.

To sum up, anything that doesn't follow the [GitLab flow] won't be tracked at all.
Toon Claes's avatar
Toon Claes включено в состав коммита
74
So, the Cycle Analytics dashboard won't present any data:
Evan Read's avatar
Evan Read включено в состав коммита
75

Toon Claes's avatar
Toon Claes включено в состав коммита
76
- For merge requests that do not close an issue.
Małgorzata Ksionek's avatar
Małgorzata Ksionek включено в состав коммита
77
- For issues not labeled with a label present in the Issue Board or for issues not assigned a milestone.
Toon Claes's avatar
Toon Claes включено в состав коммита
78
79
80
- For staging and production stages, if the project has no `production` or `production/*`
  environment.

Achilleas Pipinellis's avatar
Achilleas Pipinellis включено в состав коммита
81
82
83
84
## Example workflow

Below is a simple fictional workflow of a single cycle that happens in a
single day passing through all seven stages. Note that if a stage does not have
Małgorzata Ksionek's avatar
Małgorzata Ksionek включено в состав коммита
85
a start and a stop mark, it is not measured and hence not calculated in the median
Achilleas Pipinellis's avatar
Achilleas Pipinellis включено в состав коммита
86
87
88
89
90
91
92
93
94
95
96
97
98
time. It is assumed that milestones are created and CI for testing and setting
environments is configured.

1. Issue is created at 09:00 (start of **Issue** stage).
1. Issue is added to a milestone at 11:00 (stop of **Issue** stage / start of
   **Plan** stage).
1. Start working on the issue, create a branch locally and make one commit at
   12:00.
1. Make a second commit to the branch which mentions the issue number at 12.30
   (stop of **Plan** stage / start of **Code** stage).
1. Push branch and create a merge request that contains the [issue closing pattern]
   in its description at 14:00 (stop of **Code** stage / start of **Test** and
   **Review** stages).
Achilleas Pipinellis's avatar
Achilleas Pipinellis включено в состав коммита
99
100
1. The CI starts running your scripts defined in [`.gitlab-ci.yml`][yml] and
   takes 5min (stop of **Test** stage).
Achilleas Pipinellis's avatar
Achilleas Pipinellis включено в состав коммита
101
102
103
104
1. Review merge request, ensure that everything is OK and merge the merge
   request at 19:00. (stop of **Review** stage / start of **Staging** stage).
1. Now that the merge request is merged, a deployment to the `production`
   environment starts and finishes at 19:30 (stop of **Staging** stage).
Achilleas Pipinellis's avatar
Achilleas Pipinellis включено в состав коммита
105
106
107
1. The cycle completes and the sum of the median times of the previous stages
   is recorded to the **Production** stage. That is the time between creating an
   issue and deploying its relevant merge request to production.
Achilleas Pipinellis's avatar
Achilleas Pipinellis включено в состав коммита
108
109
110
111
112
113
114
115
116
117

From the above example you can conclude the time it took each stage to complete
as long as their total time:

- **Issue**:  2h (11:00 - 09:00)
- **Plan**:   1h (12:00 - 11:00)
- **Code**:   2h (14:00 - 12:00)
- **Test**:   5min
- **Review**: 5h (19:00 - 14:00)
- **Staging**:  30min (19:30 - 19:00)
Achilleas Pipinellis's avatar
Achilleas Pipinellis включено в состав коммита
118
119
120
121
- **Production**: Since this stage measures the sum of median time off all
  previous stages, we cannot calculate it if we don't know the status of the
  stages before. In case this is the very first cycle that is run in the project,
  then the **Production** time is 10h 30min (19:30 - 09:00)
Achilleas Pipinellis's avatar
Achilleas Pipinellis включено в состав коммита
122
123
124

A few notes:

Achilleas Pipinellis's avatar
Achilleas Pipinellis включено в состав коммита
125
126
127
- In the above example we demonstrated that it doesn't matter if your first
  commit doesn't mention the issue number, you can do this later in any commit
  of the branch you are working on.
Achilleas Pipinellis's avatar
Achilleas Pipinellis включено в состав коммита
128
129
130
- You can see that the **Test** stage is not calculated to the overall time of
  the cycle since it is included in the **Review** process (every MR should be
  tested).
Achilleas Pipinellis's avatar
Achilleas Pipinellis включено в состав коммита
131
132
133
- The example above was just **one cycle** of the seven stages. Add multiple
  cycles, calculate their median time and the result is what the dashboard of
  Cycle Analytics is showing.
Achilleas Pipinellis's avatar
Achilleas Pipinellis включено в состав коммита
134

Achilleas Pipinellis's avatar
Achilleas Pipinellis включено в состав коммита
135
136
137
138
139
## Permissions

The current permissions on the Cycle Analytics dashboard are:

- Public projects - anyone can access
Jeremy Watson's avatar
Jeremy Watson включено в состав коммита
140
141
- Internal projects - any authenticated user can access
- Private projects - any member Guest and above can access
Achilleas Pipinellis's avatar
Achilleas Pipinellis включено в состав коммита
142
143
144
145
146
147
148

You can [read more about permissions][permissions] in general.

## More resources

Learn more about Cycle Analytics in the following resources:

Jason Colyer's avatar
Jason Colyer включено в состав коммита
149
- [Cycle Analytics feature page](https://about.gitlab.com/features/cycle-analytics/)
Achilleas Pipinellis's avatar
Achilleas Pipinellis включено в состав коммита
150
- [Cycle Analytics feature preview](https://about.gitlab.com/2016/09/16/feature-preview-introducing-cycle-analytics/)
Achilleas Pipinellis's avatar
Achilleas Pipinellis включено в состав коммита
151
- [Cycle Analytics feature highlight](https://about.gitlab.com/2016/09/21/cycle-analytics-feature-highlight/)
Achilleas Pipinellis's avatar
Achilleas Pipinellis включено в состав коммита
152

Achilleas Pipinellis's avatar
Achilleas Pipinellis включено в состав коммита
153
[board]: issue_board.md#creating-a-new-list
Achilleas Pipinellis's avatar
Achilleas Pipinellis включено в состав коммита
154
155
156
[ce-5986]: https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/5986
[ce-20975]: https://gitlab.com/gitlab-org/gitlab-ce/issues/20975
[environment]: ../../ci/yaml/README.md#environment
Achilleas Pipinellis's avatar
Achilleas Pipinellis включено в состав коммита
157
[GitLab flow]: ../../workflow/gitlab_flow.md
Achilleas Pipinellis's avatar
Achilleas Pipinellis включено в состав коммита
158
[idea to production]: https://about.gitlab.com/2016/08/05/continuous-integration-delivery-and-deployment-with-gitlab/#from-idea-to-production-with-gitlab
Marcel Amirault's avatar
Marcel Amirault включено в состав коммита
159
[issue closing pattern]: issues/managing_issues.md#closing-issues-automatically
Achilleas Pipinellis's avatar
Achilleas Pipinellis включено в состав коммита
160
[permissions]: ../permissions.md
Achilleas Pipinellis's avatar
Achilleas Pipinellis включено в состав коммита
161
[yml]: ../../ci/yaml/README.md