You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: doc/development/service_ping/metrics_lifecycle.md
+9-7
Original file line number
Diff line number
Diff line change
@@ -72,14 +72,16 @@ WARNING:
72
72
If a metric is not used in Sisense or any other system after 6 months, the
73
73
Product Intelligence team marks it as inactive and assigns it to the group owner for review.
74
74
75
-
We are working on automating this process. See [this issue](https://gitlab.com/gitlab-org/gitlab/-/issues/338466) for details.
75
+
We are working on automating this process. See [this epic](https://gitlab.com/groups/gitlab-org/-/epics/8988) for details.
76
76
77
77
Product Intelligence removes metrics from Service Ping if they are not used in any Sisense dashboard.
78
78
79
-
For an example of the metric removal process, see this [example issue](https://gitlab.com/gitlab-org/gitlab/-/issues/297029).
79
+
For an example of the metric removal process, see this [example issue](https://gitlab.com/gitlab-org/gitlab/-/issues/388236).
80
80
81
81
To remove a metric:
82
82
83
+
1. Create an issue for removing the metric if none exists yet. The issue needs to outline why the metric should be deleted. You can use this issue to document the removal process.
84
+
83
85
1. Check the following YAML files and verify the metric is not used in an aggregate:
[GitLab Data Team project](https://gitlab.com/gitlab-data/analytics/-/issues).
112
114
Ask for confirmation that the metric is not referred to in any SiSense dashboards and
113
115
can be safely removed from Service Ping. Use this
114
-
[example issue](https://gitlab.com/gitlab-data/analytics/-/issues/7539) for guidance.
116
+
[example issue](https://gitlab.com/gitlab-data/analytics/-/issues/15266) for guidance.
117
+
118
+
1. Notify the Customer Success Ops team (`@csops-team`), Analytics Engineers (`@gitlab-data/analytics-engineers`), and Product Analysts (`@gitlab-data/product-analysts`) by `@` mentioning those groups in a comment in the issue regarding the deletion of the metric.
119
+
Many Service Ping metrics are relied upon for health score and XMAU reporting and unexpected changes to those metrics could break reporting.
115
120
116
121
1. After you verify the metric can be safely removed,
117
122
update the attributes of the metric's YAML definition:
118
123
119
124
- Set the `status:` to `removed`.
120
-
- Set `removed_by_url:` to the URL of the MR removing the metric
125
+
- Set `removed_by_url:` to the URL of the issue removing the metric
121
126
- Set `milestone_removed:` to the number of the
122
127
milestone in which the metric was removed.
123
128
@@ -139,6 +144,3 @@ To remove a metric:
139
144
1. Remove any other records related to the metric:
140
145
- The feature flag YAML file at [`config/feature_flags/*/*.yaml`](https://gitlab.com/gitlab-org/gitlab/-/tree/master/config/feature_flags).
141
146
- The entry in the known events YAML file at [`lib/gitlab/usage_data_counters/known_events/*.yaml`](https://gitlab.com/gitlab-org/gitlab/-/tree/master/lib/gitlab/usage_data_counters/known_events).
142
-
143
-
1. Notify the Customer Success Ops team (`@csops-team`), Analytics Engineers (`@gitlab-data/analytics-engineers`), and Product Analysts (`@gitlab-data/product-analysts`) by `@` mentioning those groups in a comment on the MR.
144
-
Many Service Ping metrics are relied upon for health score and XMAU reporting and unexpected changes to those metrics could break reporting.
Copy file name to clipboardexpand all lines: doc/development/service_ping/review_guidelines.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -68,7 +68,7 @@ are regular backend changes.
68
68
Read the [stages file](https://gitlab.com/gitlab-com/www-gitlab-com/blob/master/data/stages.yml).
69
69
- Check the file location. Consider the time frame, and if the file should be under `ee`.
70
70
- Check the tiers.
71
-
- If a metric was changed or removed: Make sure the MR author notified the Customer Success Ops team (`@csops-team`), Analytics Engineers (`@gitlab-data/analytics-engineers`), and Product Analysts (`@gitlab-data/product-analysts`) by `@` mentioning those groups in a comment on the MR.
71
+
- If a metric was changed or removed: Make sure the MR author notified the Customer Success Ops team (`@csops-team`), Analytics Engineers (`@gitlab-data/analytics-engineers`), and Product Analysts (`@gitlab-data/product-analysts`) by `@` mentioning those groups in a comment on the issue for the MR and all of these groups have acknowledged the removal.
72
72
- Metrics instrumentations
73
73
- Recommend using metrics instrumentation for new metrics, [if possible](metrics_instrumentation.md#support-for-instrumentation-classes).
74
74
- Approve the MR, and relabel the MR with `~"product intelligence::approved"`.
0 commit comments