2023-10-23: Enable Google Cloud Profiler For gitlab-zoekt-indexer
Production Change
Change Summary
As part of gitlab-org/gitlab#409608 (closed) we are enabling the Google Cloud Profiler for the gitlab-zoekt-indexer. This just requires setting an env var in the container. Support was added to the indexer in gitlab-org/gitlab-zoekt-indexer!68 (merged) .
Change Details
- Services Impacted - ServiceZoekt
-
Change Technician -
@DylanGriffith
- Change Reviewer - @gsgl
- Time tracking - 45 minutes
- Downtime Component - none
Set Maintenance Mode in GitLab
If your change involves scheduled maintenance, add a step to set and unset maintenance mode per our runbooks. This will make sure SLA calculations adjust for the maintenance period.
Detailed steps for the change
Change Steps - steps to take to execute the change
Estimated Time to Complete (mins) - Estimated Time to Complete in Minutes
-
Set label changein-progress /label ~change::in-progress
-
Merge GSTG: gitlab-com/gl-infra/k8s-workloads/gitlab-com!3126 (merged) -
Wait until deploy finishes -
Perform a Zoekt search in staging.gitlab.com -
Merge GPRD: gitlab-com/gl-infra/k8s-workloads/gitlab-com!3127 (merged) -
Wait until deploy finishes -
Perform a Zoekt search in gitlab.com -
Confirm that we can actually see the Google Cloud Profiler data coming into https://console.cloud.google.com/profiler -
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) - Estimated Time to Complete in Minutes
-
Revert the merged MR(s) -
Set label changeaborted /label ~change::aborted
Monitoring
Key metrics to observe
- Metric: General Zoekt Metrics
- Location: https://dashboards.gitlab.net/d/search-zoekt/search-zoekt-info?orgId=1
- What changes to this metric should prompt a rollback: Any problematic impacts to utilization
- Metric: K8s container/pod resources
- Location: https://dashboards.gitlab.net/d/kubernetes-resources-pod/kubernetes-compute-resources-pod?orgId=1&refresh=5m&var-datasource=default&var-cluster=gprd-gitlab-gke&var-namespace=gitlab&var-pod=gitlab-gitlab-zoekt-0
- What changes to this metric should prompt a rollback: Any problematic impacts to utilization
- Metric: Zoekt logs
- Location: https://log.gprd.gitlab.net/app/discover#/?_g=(filters:!(),refreshInterval:(pause:!t,value:60000),time:(from:now-15m,to:now))&_a=(columns:!(),filters:!(),hideChart:!f,index:'3f6d1a00-e8b6-11ed-a017-0d32180b1390',interval:auto,query:(language:kuery,query:''),sort:!(!('@timestamp',desc)))
- What changes to this metric should prompt a rollback: Zoekt webserver having issues starting
- Metric: Zoekt::IndexerWorker logs
- Location: https://log.gprd.gitlab.net/app/discover#/?_g=(filters:!(),refreshInterval:(pause:!t,value:60000),time:(from:now-15m,to:now))&_a=(columns:!(),filters:!(('$state':(store:appState),meta:(alias:!n,disabled:!f,field:json.class.keyword,index:AWNABDRwNDuQHTm2tH6l,key:json.class.keyword,negate:!f,params:(query:'Zoekt::IndexerWorker'),type:phrase),query:(match_phrase:(json.class.keyword:'Zoekt::IndexerWorker')))),hideChart:!f,index:AWNABDRwNDuQHTm2tH6l,interval:auto,query:(language:kuery,query:''),sort:!(!(json.time,desc)))
- What changes to this metric should prompt a rollback: Zoekt indexer having errors indexing
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 Gonzalo Servat