Add slowlog to Global Search ES indexes for production
Production Change
Change Summary
Previous enable of slowlog: #15789 (closed)
Enable slowlog for all production indices so we can have more insight into problematic queries
index | slowlog enabled? |
---|---|
gitlab-production |
|
gitlab-production-commits |
|
gitlab-production-epics |
|
gitlab-production-issues |
|
gitlab-production-merge_requests |
|
gitlab-production-notes |
|
gitlab-production-projects |
|
gitlab-production-users |
|
gitlab-production-wikis |
Change Details
- Services Impacted - ServiceSearch
- Change Technician - @maddievn
- Change Reviewer -
- Time tracking - 60 minutes
- Downtime Component - 0 minutes
Detailed steps for the change
Change Steps - steps to take to execute the change
Estimated Time to Complete (mins) - 60
-
Set label changein-progress /label ~change::in-progress
Settings request to enable info and warn
PUT /<index_name>/_settings
{
"index.search.slowlog.threshold.query.warn": "30s",
"index.search.slowlog.threshold.query.info": "10s",
"index.search.slowlog.threshold.query.debug": "-1",
"index.search.slowlog.threshold.query.trace": "-1",
"index.search.slowlog.threshold.fetch.warn": "30s",
"index.search.slowlog.threshold.fetch.info": "10s",
"index.search.slowlog.threshold.fetch.debug": "-1",
"index.search.slowlog.threshold.fetch.trace": "-1"
}
-
perform the settings PUT request for each index (using alias names) -
gitlab-production-epics
-
gitlab-production-issues
-
gitlab-production-merge_requests
-
gitlab-production-notes
-
gitlab-production-projects
-
gitlab-production-users
-
gitlab-production-wikis
-
-
slowlog entries can be seen here: https://00a4ef3362214c44a044feaa539b4686.us-central1.gcp.cloud.es.io:9243/app/discover#/?_g=(filters:!(),refreshInterval:(pause:!t,value:0),time:(from:now-24h,to:now))&_a=(columns:!(_index),filters:!(('$state':(store:appState),meta:(alias:!n,disabled:!f,index:'3fdde960-1f73-11eb-9ead-c594f004ece2',key:fileset.name,negate:!f,params:(query:slowlog),type:phrase),query:(match_phrase:(fileset.name:(query:slowlog))))),index:'3fdde960-1f73-11eb-9ead-c594f004ece2',interval:auto,query:(language:kuery,query:''),sort:!(!(' @timestamp',desc))) -
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 minutes
Settings request to disable info and warn
PUT /<index_name>/_settings
{
"index.search.slowlog.threshold.query.warn": "-1",
"index.search.slowlog.threshold.query.info": "-1",
"index.search.slowlog.threshold.query.debug": "-1",
"index.search.slowlog.threshold.query.trace": "-1",
"index.search.slowlog.threshold.fetch.warn": "-1",
"index.search.slowlog.threshold.fetch.info": "-1",
"index.search.slowlog.threshold.fetch.debug": "-1",
"index.search.slowlog.threshold.fetch.trace": "-1",
}
-
perform the settings PUT request for each index (using alias names) -
gitlab-production-epics
-
gitlab-production-issues
-
gitlab-production-merge_requests
-
gitlab-production-notes
-
gitlab-production-projects
-
gitlab-production-users
-
gitlab-production-wikis
-
-
Set label changeaborted /label ~change::aborted
Monitoring
Key metrics to observe
- Metric: Search service RPS
- Location: Advanced search dashboard
- What changes to this metric should prompt a rollback: Any drop in search service RPS or slowdown in response times
- Metric: api Service Apdex, global_search SLI Apdex
- Location: SLI dashboard
- What changes should prompt a rollback: Any severe impact to SLI/Apdex
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-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.