2022-07-13: Enable gitlab metrics exporter in pre-prod & gstg
Production Change
Change Summary
We are looking to roll out a new application metrics exporter for gitlab-rails (gitlab-metrics-exporter, GME). It was integrated in gitlab-rails here.
The new server is activated via an environment variable: GITLAB_GOLANG_METRICS_SERVER.
We are enabling GITLAB_GOLANG_METRICS_SERVER for both sidekiq and webservice in pre and gstg environments.
Change Details
- Services Impacted - ServiceSidekiq ServiceWeb
- Change Technician - @nmilojevic1
- Change Reviewer - @skarbek
- Time tracking - 120
- Downtime Component - none
Detailed steps for the change
Rollout plan:
Change Steps - steps to take to execute the change
Estimated Time to Complete (mins) - 60
-
Set label changein-progress /label ~change::in-progress -
Merge MR gitlab-com/gl-infra/k8s-workloads/gitlab-com!2188 (merged) -
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) - 60
-
Rollback gitlab-com/gl-infra/k8s-workloads/gitlab-com!2188 (merged) -
Set label changeaborted /label ~change::aborted
Monitoring
- https://nonprod-log.gitlab.net/goto/51e6a880-4eed-11ed-9af2-6131f0ee4ce6
- https://nonprod-log.gitlab.net/goto/94d5f920-4eed-11ed-9af2-6131f0ee4ce6
Key metrics to observe
-
Metric: web_exporter logs
- Location: https://nonprod-log.gitlab.net/goto/51e6a880-4eed-11ed-9af2-6131f0ee4ce6
- We expect that once we switch to gitlab metrics exporter, it should continue emitting these metric
-
Metric: sidekiq_exporter logs
- Location: https://nonprod-log.gitlab.net/goto/94d5f920-4eed-11ed-9af2-6131f0ee4ce6
- We expect that once we switch to gitlab metrics exporter, it should continue emitting these metric
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 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-oncalland 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 (If needed! Cases include DB change) prior to change being rolled out. (In #production channel, mention
@release-managersand 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 John Skarbek