gitlab.com/gitlab-org group setting - enable analytics pointer project for the Value Streams Dashboard
Production Change
Change Summary
groupoptimize wants to Dogfooding the value stream dashboards yaml config feature (https://docs.gitlab.com/ee/user/analytics/value_streams_dashboard.html#customize-the-dashboard-panels). To do that, we need to enable the analytics dashboard pointer project setting to point to the insights-config
project in the gitlab-org
group.
Related MR for the insights project: gitlab-org/quality/insights-config!32
Change Details
-
Services Impacted - ServiceGitlab (for
gitlab-org
group) - Change Technician - TBD
- Change Reviewer - @pshutsin
- Time tracking - 5 minutes
- Downtime Component - none
Detailed steps for the change
Change Steps - steps to take to execute the change
Estimated Time to Complete (mins) - 2 minutes
-
Set label changein-progress /label ~change::in-progress
-
Log in to GitLab. -
Navigate to the gitlab-org
group. -
Navigate to the settings page: Settings > General > Open the Analytics tab -
In the first box ( Select the project containing Analytics Dashboards configuration files
) find theinsights-config
project. (url: https://gitlab.com/gitlab-org/quality/insights-config/) -
Click save changes. -
Set label changecomplete /label ~change::complete
Rollback
Rollback steps - steps to be taken in the event of a need to rollback this change
Estimated Time to Complete (mins) - 2 minutes
-
Log in to GitLab. -
Navigate to the gitlab-org
group. -
Navigate to the settings page: Settings > General > Open the Analytics tab -
In the first box ( Select the project containing Analytics Dashboards configuration files
) unset the project. -
Click save changes. -
Set label changeaborted /label ~change::aborted
Monitoring
Key metrics to observe
We don't expect performance degradation from this change, one thing we could check is that the dashboards page still loads: https://gitlab.com/groups/gitlab-org/-/analytics/dashboards
Change Reviewer checklist
-
Check if the following applies: - The scheduled day and time of execution of the change is appropriate.
- The change plan is technically accurate.
- The change plan includes estimated timing values based on previous testing.
- The change plan includes a viable rollback plan.
- The specified metrics/monitoring dashboards provide sufficient visibility for the change.
-
Check if the following applies: - The complexity of the plan is appropriate for the corresponding risk of the change. (i.e. the plan contains clear details).
- The change plan includes success measures for all steps/milestones during the execution.
- The change adequately minimizes risk within the environment/service.
- The performance implications of executing the change are well-understood and documented.
- The specified metrics/monitoring dashboards provide sufficient visibility for the change.
- If not, is it possible (or necessary) to make changes to observability platforms for added visibility?
- The change has a primary and secondary SRE with knowledge of the details available during the change window.
- The change window has been agreed with Release Managers in advance of the change. If the change is planned for APAC hours, this issue has an agreed pre-change approval.
- The labels blocks deployments and/or blocks feature-flags are applied as necessary.
Change Technician checklist
-
Check if all items below are complete: - The change plan is technically accurate.
- This Change Issue is linked to the appropriate Issue and/or Epic
- Change has been tested in staging and results noted in a comment on this issue.
- A dry-run has been conducted and results noted in a comment on this issue.
- The change execution window respects the Production Change Lock periods.
- For C1 and C2 change issues, the change event is added to the GitLab Production calendar.
- For C1 and C2 change issues, the SRE on-call has been informed prior to change being rolled out. (In #production channel, mention
@sre-oncall
and this issue and await their acknowledgement.) - For C1 and C2 change issues, the SRE on-call provided approval with the eoc_approved label on the issue.
- For C1 and C2 change issues, the Infrastructure Manager provided approval with the manager_approved label on the issue.
- Release managers have been informed prior to any C1, C2, or blocks deployments change being rolled out. (In #production channel, mention
@release-managers
and this issue and await their acknowledgment.) - There are currently no active incidents that are severity1 or severity2
- If the change involves doing maintenance on a database host, an appropriate silence targeting the host(s) should be added for the duration of the change.
Edited by Adam Hegyi