Skip to content

[Feature flag] Enable caching issues count in group sidebar

What

Remove the :cached_sidebar_open_issues_count feature flag ...

Owners

  • Team: Plan
  • Most appropriate slack channel to reach out to: #s_plan-be
  • Best individual to reach out to: @egrieff

Expectations

What are we expecting to happen?

  1. When a group has more than 1000 issues:
  • Loading times for all group pages should be reduced (1 fewer count query).
  • Redis calls will increase (Cached value expire every 24 hours).
  • The sidebar will display a truncated count for open issues. Example: 1.3k.
  1. When a group has fewer than 1000 issues:
  • No changes.

What might happen if this goes wrong?

Negative feedback from users no longer seeing a precise issues count at the group level. No performance impact.

What can we monitor to detect problems with this?

Beta groups/projects

If applicable, any groups/projects that are happy to have this feature turned on early. Some organizations may wish to test big changes they are interested in with a small subset of users ahead of time for example.

  • gitlab-org/gitlab project
  • gitlab-org/gitlab-com groups
  • ...

Roll Out Steps

  • Enable on staging (/chatops run feature set feature_name true --staging)
  • Test on staging
  • Ensure that documentation has been updated
  • Enable on GitLab.com for individual groups/projects listed above and verify behaviour (/chatops run feature set --project=gitlab-org/gitlab feature_name true)
  • Coordinate a time to enable the flag with the SRE oncall and release managers
    • In #production mention @sre-oncall and @release-managers. Once an SRE on call and Release Manager on call confirm, you can proceed with the rollout
  • Announce on the issue an estimated time this will be enabled on GitLab.com
  • Enable on GitLab.com by running chatops command in #production (/chatops run feature set feature_name true)
  • Cross post chatops Slack command to #support_gitlab-com (more guidance when this is necessary in the dev docs) and in your team channel
  • Announce on the issue that the flag has been enabled
  • Remove feature flag and add changelog entry. Ensure that the feature flag definition YAML file has been removed in the same MR that is removing the feature flag from the code
  • After the flag removal is deployed, clean up the feature flag by running chatops command in #production channel

Rollback Steps

  • This feature can be disabled by running the following Chatops command:
/chatops run feature set --project=gitlab-org/gitlab feature_name false
Edited by Eugenia Grieff