[Feature flag] Rollout of `report_artifact_build_completed_metrics_on_build_completion`
Summary
This issue is to rollout !80334 (merged) on production,
that is currently behind the report_artifact_build_completed_metrics_on_build_completion
feature flag.
This feature flag enables observability metrics for the Ci::Build
completed state transitions by incrementing
counters to measure reports by artifact type.
Eventually breaking this down by scanner would be ideal but that's a future improvement.
Note this generic counter is subject to the same limitations as #329114 but provides a more generic baseline to iterate against.
Owners
- Team: groupstatic analysis
- Most appropriate slack channel to reach out to:
#g_secure-static-analysis
- Best individual to reach out to: @theoretick
- PM: @connorgilbert
Stakeholders
FF lies within hotpath of grouppipeline execution since we had additional overhead on all build completions.
Expectations
What are we expecting to happen?
GitLab Prometheus Metrics will now contain counters for build completions corresponding to report-type artifact builds by status and artifact type.
When is the feature viable?
Once enabled, performance will be evaluated to determine added overhead. If additional performance is considered negligible, will become enabled by default.
What might happen if this goes wrong?
This MR may add a significant performance overhead to state transitions on build completion. It should not interfere with any additional state transitions.
since this is tied to Observability enhancement if issues occur, we can disable the flag with no side-effects.
What can we monitor to detect problems with this?
Consider mentioning checks for 5xx errors or other anomalies like an increase in redirects (302 HTTP response status)
What can we check for monitoring production after rollouts?
Consider adding links to check for Sentry errors, Production logs for 5xx, 302s, etc.
Rollout Steps
Rollout on non-production environments
- Ensure that the feature MRs have been deployed to non-production environments.
-
/chatops run auto_deploy status <merge-commit-of-your-feature>
-
-
Enable the feature globally on non-production environments. -
/chatops run feature set report_artifact_build_completed_metrics_on_build_completion true --dev --staging --staging-ref
-
-
Verify that the feature works as expected. Posting the QA result in this issue is preferable. The best environment to validate the feature in is staging-canary as this is the first environment deployed to. Note you will need to make sure you are configured to use canary as outlined here when accessing the staging environment in order to make sure you are testing appropriately.
Specific rollout on production
- Ensure that the feature MRs have been deployed to both production and canary.
-
/chatops run auto_deploy status <merge-commit-of-your-feature>
-
- If you're using project-actor, you must enable the feature on these entries:
-
/chatops run feature set --project=gitlab-org/gitlab,gitlab-org/gitlab-foss,gitlab-com/www-gitlab-com report_artifact_build_completed_metrics_on_build_completion true
-
- If you're using group-actor, you must enable the feature on these entries:
-
/chatops run feature set --group=gitlab-org,gitlab-com report_artifact_build_completed_metrics_on_build_completion true
-
- If you're using user-actor, you must enable the feature on these entries:
-
/chatops run feature set --user=<your-username> report_artifact_build_completed_metrics_on_build_completion true
-
-
Verify that the feature works on the specific entries. Posting the QA result in this issue is preferable.
Preparation before global rollout
-
Check if the feature flag change needs to be accompanied with a change management issue. Cross link the issue here if it does. -
Ensure that you or a representative in development can be available for at least 2 hours after feature flag updates in production. If a different developer will be covering, or an exception is needed, please inform the oncall SRE by using the @sre-oncall
Slack alias. -
Ensure that documentation has been updated (More info). -
Announce on the feature issue an estimated time this will be enabled on GitLab.com. -
Ensure that any breaking changes have been announced following the release post process to ensure GitLab customers are aware. -
Notify #support_gitlab-com
and your team channel (more guidance when this is necessary in the dev docs).
Global rollout on production
For visibility, all /chatops
commands that target production should be executed in the #production
slack channel and cross-posted (with the command results) to the responsible team's slack channel (#g_TEAM_NAME
).
-
Incrementally roll out the feature. - If the feature flag in code has an actor, perform actor-based rollout.
-
/chatops run feature set report_artifact_build_completed_metrics_on_build_completion <rollout-percentage> --actors
-
- If the feature flag in code does NOT have an actor, perform time-based rollout (random rollout).
-
/chatops run feature set report_artifact_build_completed_metrics_on_build_completion <rollout-percentage> --random
-
- Enable the feature globally on production environment.
-
/chatops run feature set report_artifact_build_completed_metrics_on_build_completion true
-
- If the feature flag in code has an actor, perform actor-based rollout.
-
Announce on the feature issue that the feature has been globally enabled. -
Wait for at least one day for the verification term.
Release the feature
After the feature has been deemed stable, the clean up should be done as soon as possible to permanently enable the feature and reduce complexity in the codebase.
You can either create a follow-up issue for Feature Flag Cleanup or use the checklist below in this same issue.
-
Create a merge request to remove report_artifact_build_completed_metrics_on_build_completion
feature flag. Ask for review and merge it.-
Remove all references to the feature flag from the codebase. -
Remove the YAML definitions for the feature from the repository. -
Create a changelog entry.
-
-
Ensure that the cleanup MR has been included in the release package. If the merge request was deployed before the monthly release was tagged, the feature can be officially announced in a release blog post. -
/chatops run release check <merge-request-url> <milestone>
-
-
Close the feature issue to indicate the feature will be released in the current milestone. -
If not already done, clean up the feature flag from all environments by running these chatops command in #production
channel:-
/chatops run feature delete report_artifact_build_completed_metrics_on_build_completion --dev --staging --staging-ref --production
-
-
Close this rollout issue.
Rollback Steps
-
This feature can be disabled by running the following Chatops command:
/chatops run feature set report_artifact_build_completed_metrics_on_build_completion false