2022-08-12: Opstrace Error Tracking Open Beta Rollout

Production Change

Change Summary

For the open-beta rollout of Error Tracking, we are going to set the feature-flag to enable it instance wide.

This feature is at the beta phase https://docs.gitlab.com/ee/policy/alpha-beta-support.html , which means it has not completely passed the readiness review and does not have any guarantee of support or availability.

We have up until now done enough review to ensure there is no impact to GitLab availability, and ran a security review in https://gitlab.com/gitlab-com/gl-security/security-operations/infrastructure-security/bau/-/issues/131 so we feel comfortable enabling this feature for opt-in customers.

Change Details

1. Services Impacted - ServiceGitLab Rails
2. Change Technician - @ankitbhatnagar
3. Change Reviewer - @jarv
4. Time tracking - unknown
5. Downtime Component - none

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
• Confirm that the concerns have been addressed wrt monitoring readiness#37 (comment 1064577102) and infrasec security review readiness#37 (comment 1064546947)
• Confirm we have at least one GitLab inc. project enabled and receiving error events https://gitlab.com/gitlab-com/gl-infra/reliability/-/issues/16469
• Enable error tracking feature flag (/chatops run feature set integrated_error_tracking true --production)
• Enable clickhouse error tracking feature flag (/chatops run feature set use_click_house_database_for_error_tracking true --production)
  • In #production mention @sre-oncall that we are enabling the feature flag
• Announce on the issue an estimated time this will be enabled on GitLab.com
• Cross post chatops Slack command to #support_gitlab-com (more guidance when this is necessary in the dev docs) and in your team channel
• 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

• Disable error tracking feature flag (/chatops run feature set integrated_error_tracking false --production)
• Disable clickhouse error tracking feature flag (/chatops run feature set use_click_house_database_for_error_tracking false --production)
• Set label changeaborted /label ~change::aborted

Monitoring

Key metrics to observe

All metrics are available on thanos.gitlab.net, and should be filtered on store thanos-query.opstracegcp.com.

Pod health

sum(up{container="errortracking-api",environment="opstrace-prd"})

thanos query

Request success %

100 - 100*(sum(http_requests_total{code!="200",container="errortracking-api",environment="opstrace-prd"} or vector(0))/sum(http_requests_total{environment="opstrace-prd",container="errortracking-api"}))

thanos query

More specific metrics can be found on the runbook page.

Change Reviewer checklist

C4 C3 C2 C1:

• 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.

C2 C1:

• 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.
  • 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 (If needed! Cases include DB change) prior to 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.