1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
|
import dateFormat, { masks } from '~/lib/dateformat';
import { nDaysBefore, getStartOfDay } from '~/lib/utils/datetime_utility';
import { s__ } from '~/locale';
import { helpPagePath } from '~/helpers/help_page_helper';
export const DATE_RANGE_LIMIT = 180;
export const PROJECTS_PER_PAGE = 50;
const { isoDate, mediumDate } = masks;
export const dateFormats = {
isoDate,
defaultDate: mediumDate,
defaultDateTime: 'mmm d, yyyy h:MMtt',
month: 'mmmm',
};
const startOfToday = getStartOfDay(new Date(), { utc: true });
const last180Days = nDaysBefore(startOfToday, DATE_RANGE_LIMIT, { utc: true });
const formatDateParam = (d) => dateFormat(d, dateFormats.isoDate, true);
export const METRIC_POPOVER_LABEL = s__('ValueStreamAnalytics|View details');
export const ISSUES_COMPLETED_TYPE = 'issues_completed';
export const FLOW_METRICS = {
LEAD_TIME: 'lead_time',
CYCLE_TIME: 'cycle_time',
ISSUES: 'issues',
ISSUES_COMPLETED: ISSUES_COMPLETED_TYPE,
COMMITS: 'commits',
DEPLOYS: 'deploys',
};
export const DORA_METRICS = {
DEPLOYMENT_FREQUENCY: 'deployment_frequency',
LEAD_TIME_FOR_CHANGES: 'lead_time_for_changes',
TIME_TO_RESTORE_SERVICE: 'time_to_restore_service',
CHANGE_FAILURE_RATE: 'change_failure_rate',
};
const VSA_FLOW_METRICS_GROUP = {
key: 'key_metrics',
title: s__('ValueStreamAnalytics|Key metrics'),
keys: Object.values(FLOW_METRICS),
};
export const VSA_METRICS_GROUPS = [VSA_FLOW_METRICS_GROUP];
export const VULNERABILITY_CRITICAL_TYPE = 'vulnerability_critical';
export const VULNERABILITY_HIGH_TYPE = 'vulnerability_high';
export const VULNERABILITY_METRICS = {
CRITICAL: VULNERABILITY_CRITICAL_TYPE,
HIGH: VULNERABILITY_HIGH_TYPE,
};
export const MERGE_REQUEST_THROUGHPUT_TYPE = 'merge_request_throughput';
export const MERGE_REQUEST_METRICS = {
THROUGHPUT: MERGE_REQUEST_THROUGHPUT_TYPE,
};
export const METRIC_TOOLTIPS = {
[DORA_METRICS.DEPLOYMENT_FREQUENCY]: {
description: s__(
'ValueStreamAnalytics|Average number of deployments to production per day. This metric measures how often value is delivered to end users.',
),
groupLink: '-/analytics/ci_cd?tab=deployment-frequency',
projectLink: '-/pipelines/charts?chart=deployment-frequency',
docsLink: helpPagePath('user/analytics/dora_metrics', { anchor: 'deployment-frequency' }),
},
[DORA_METRICS.LEAD_TIME_FOR_CHANGES]: {
description: s__(
'ValueStreamAnalytics|The time to successfully deliver a commit into production. This metric reflects the efficiency of CI/CD pipelines.',
),
groupLink: '-/analytics/ci_cd?tab=lead-time',
projectLink: '-/pipelines/charts?chart=lead-time',
docsLink: helpPagePath('user/analytics/dora_metrics', { anchor: 'lead-time-for-changes' }),
},
[DORA_METRICS.TIME_TO_RESTORE_SERVICE]: {
description: s__(
'ValueStreamAnalytics|The time it takes an organization to recover from a failure in production.',
),
groupLink: '-/analytics/ci_cd?tab=time-to-restore-service',
projectLink: '-/pipelines/charts?chart=time-to-restore-service',
docsLink: helpPagePath('user/analytics/dora_metrics', { anchor: 'time-to-restore-service' }),
},
[DORA_METRICS.CHANGE_FAILURE_RATE]: {
description: s__(
'ValueStreamAnalytics|Percentage of deployments that cause an incident in production.',
),
groupLink: '-/analytics/ci_cd?tab=change-failure-rate',
projectLink: '-/pipelines/charts?chart=change-failure-rate',
docsLink: helpPagePath('user/analytics/dora_metrics', { anchor: 'change-failure-rate' }),
},
[FLOW_METRICS.LEAD_TIME]: {
description: s__('ValueStreamAnalytics|Median time from issue created to issue closed.'),
groupLink: '-/analytics/value_stream_analytics',
projectLink: '-/value_stream_analytics',
docsLink: helpPagePath('user/analytics/value_stream_analytics', {
anchor: 'view-the-lead-time-and-cycle-time-for-issues',
}),
},
[FLOW_METRICS.CYCLE_TIME]: {
description: s__(
"ValueStreamAnalytics|Median time from the earliest commit of a linked issue's merge request to when that issue is closed.",
),
groupLink: '-/analytics/value_stream_analytics',
projectLink: '-/value_stream_analytics',
docsLink: helpPagePath('user/analytics/value_stream_analytics', {
anchor: 'view-the-lead-time-and-cycle-time-for-issues',
}),
},
[FLOW_METRICS.ISSUES]: {
description: s__('ValueStreamAnalytics|Number of new issues created.'),
groupLink: '-/issues_analytics',
projectLink: '-/analytics/issues_analytics',
docsLink: helpPagePath('user/analytics/issue_analytics'),
},
[FLOW_METRICS.ISSUES_COMPLETED]: {
description: s__('ValueStreamAnalytics|Number of issues closed by month.'),
groupLink: '-/analytics/value_stream_analytics',
projectLink: '-/value_stream_analytics',
docsLink: helpPagePath('user/analytics/value_streams_dashboard', {
anchor: 'dashboard-metrics-and-drill-down-reports',
}),
},
[FLOW_METRICS.DEPLOYS]: {
description: s__('ValueStreamAnalytics|Total number of deploys to production.'),
groupLink: '-/analytics/productivity_analytics',
projectLink: '-/analytics/merge_request_analytics',
docsLink: helpPagePath('user/analytics/merge_request_analytics'),
},
[VULNERABILITY_METRICS.CRITICAL]: {
description: s__('ValueStreamAnalytics|Critical vulnerabilities over time.'),
groupLink: '-/security/vulnerabilities?severity=CRITICAL',
projectLink: '-/security/vulnerability_report?severity=CRITICAL',
docsLink: helpPagePath('user/application_security/vulnerabilities/severities.html'),
},
[VULNERABILITY_METRICS.HIGH]: {
description: s__('ValueStreamAnalytics|High vulnerabilities over time.'),
groupLink: '-/security/vulnerabilities?severity=HIGH',
projectLink: '-/security/vulnerability_report?severity=HIGH',
docsLink: helpPagePath('user/application_security/vulnerabilities/severities.html'),
},
[MERGE_REQUEST_METRICS.THROUGHPUT]: {
description: s__('ValueStreamAnalytics|The number of merge requests merged by month.'),
groupLink: '-/analytics/productivity_analytics',
projectLink: `-/analytics/merge_request_analytics?start_date=${formatDateParam(
last180Days,
)}&end_date=${formatDateParam(startOfToday)}`,
docsLink: helpPagePath('user/analytics/merge_request_analytics', {
anchor: 'view-the-number-of-merge-requests-in-a-date-range',
}),
},
};
// TODO: Remove this once the migration to METRIC_TOOLTIPS is complete
// https://gitlab.com/gitlab-org/gitlab/-/issues/388067
export const METRICS_POPOVER_CONTENT = {
lead_time: {
description: s__('ValueStreamAnalytics|Median time from issue created to issue closed.'),
},
cycle_time: {
description: s__(
"ValueStreamAnalytics|Median time from the earliest commit of a linked issue's merge request to when that issue is closed.",
),
},
lead_time_for_changes: {
description: s__(
'ValueStreamAnalytics|Median time between merge request merge and deployment to a production environment for all MRs deployed in the given time period.',
),
},
issues: { description: s__('ValueStreamAnalytics|Number of new issues created.') },
deploys: { description: s__('ValueStreamAnalytics|Total number of deploys to production.') },
deployment_frequency: {
description: s__('ValueStreamAnalytics|Average number of deployments to production per day.'),
},
commits: {
description: s__('ValueStreamAnalytics|Number of commits pushed to the default branch'),
},
time_to_restore_service: {
description: s__(
'ValueStreamAnalytics|Median time an incident was open on a production environment in the given time period.',
),
},
change_failure_rate: {
description: s__(
'ValueStreamAnalytics|Percentage of deployments that cause an incident in production.',
),
},
};
|
