2023-12-13: Update prometheus_alert_db_indicators_settings ApplicationSetting with gitlab_main_cell schema on gprd (production)
Production Change
Change Summary
gitlab-org/gitlab!138556 (merged) updates PrometheusAlertIndicator to support gitlab_main_cell
schema in database health check framework, which currently only supports main
and ci
schemas.
This CR aims to add the necessary configuration to ApplicationSetting.prometheus_alert_db_indicators_settings
on gprd - PRODUCTION, similar to what was done for #16191 (closed)
Note: the code that will query gitlab_main_cell
schema health is behind bulk_import_deferred_workers feature flag. The FF will be enabled after the CR and gitlab-org/gitlab!138556 (merged) goes in.
Commands to be run in the console
The following command is a sanity check to ensure that the old_config
used in the rollback command is updated. Please do not proceed to the following command if the output says Old configuration incorrect, do not proceed.
old_config = {
"apdex_slo" => {
"ci" => 0.997,
"main" => 0.997
},
"wal_rate_slo" => {
"ci" => 70000000,
"main" => 70000000
},
"apdex_sli_query" => {
"ci" => "avg_over_time(gitlab_service_apdex:ratio_5m{env='gprd',environment='gprd',monitor='global',type='patroni-ci'}[5m])",
"main" => "avg_over_time(gitlab_service_apdex:ratio_5m{env='gprd',environment='gprd',monitor='global',type='patroni'}[5m])"
},
"prometheus_api_url" => "http://thanos-query-frontend-internal.ops.gke.gitlab.net:9090",
"wal_rate_sli_query" => {
"ci" => "avg(postgres:pg_xlog_bytes_per_second:rate5m{env='gprd', type='patroni-ci'})",
"main" => "avg(postgres:pg_xlog_bytes_per_second:rate5m{env='gprd', type='patroni'})"
}
}
if old_config == ApplicationSetting.last.prometheus_alert_db_indicators_settings
puts "Old configuration as expected."
else
puts "Old configuration incorrect, do not proceed."
end
Command to update the configuration
application_setting = ApplicationSetting.last
prometheus_alert_db_indicators_settings = application_setting.prometheus_alert_db_indicators_settings
# Output previous configuration
puts prometheus_alert_db_indicators_settings
application_setting.update(prometheus_alert_db_indicators_settings: prometheus_alert_db_indicators_settings.deep_merge({
"apdex_slo" => {
"main_cell" => 0.997
},
"wal_rate_slo" => {
"main_cell" => 70000000
},
"apdex_sli_query" => {
"main_cell" => "avg_over_time(gitlab_service_apdex:ratio_5m{env='gprd',environment='gprd',monitor='global',type='patroni'}[5m])"
},
"wal_rate_sli_query" => {
"main_cell" => "avg(postgres:pg_xlog_bytes_per_second:rate5m{env='gprd', type='patroni'})"
}
}))
# Output applied configuration
puts ApplicationSetting.last.prometheus_alert_db_indicators_settings
Rollback commands
old_config = {
"apdex_slo" => {
"ci" => 0.997,
"main" => 0.997
},
"wal_rate_slo" => {
"ci" => 70000000,
"main" => 70000000
},
"apdex_sli_query" => {
"ci" => "avg_over_time(gitlab_service_apdex:ratio_5m{env='gprd',environment='gprd',monitor='global',type='patroni-ci'}[5m])",
"main" => "avg_over_time(gitlab_service_apdex:ratio_5m{env='gprd',environment='gprd',monitor='global',type='patroni'}[5m])"
},
"prometheus_api_url" => "http://thanos-query-frontend-internal.ops.gke.gitlab.net:9090",
"wal_rate_sli_query" => {
"ci" => "avg(postgres:pg_xlog_bytes_per_second:rate5m{env='gprd', type='patroni-ci'})",
"main" => "avg(postgres:pg_xlog_bytes_per_second:rate5m{env='gprd', type='patroni'})"
}
}
application_setting = ApplicationSetting.last
application_setting.update(prometheus_alert_db_indicators_settings: old_config)
Change Details
- Services Impacted - Thanos Query FE, Direct Transfer workers, background migrations
- Change Technician - @cmcfarland
- Change Reviewer - @skarbek
- Time tracking - The command will be executed in a couple of seconds
- 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
-
Run above commands in the rails console in gprd
ENV -
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
-
Run rollback commands in the rails console in gprd
ENV -
Set label changeaborted /label ~change::aborted
Monitoring
Key metrics to observe
We can monitor Kibana for unexpected errors. The link below will show the errors.
https://log.gprd.gitlab.net/app/r/s/Y2DrC
-
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.