[Feature flag] Enable roll out of return structured errors in UserRevert
What
Enable the :return_structed_errors_in_revert
feature flag. The feature flag starts returning errors properly as statuses as opposed to error strings within successful responses.
Operations: return structured errors in UserRevert (!6716 - merged)
Owners
- Team: Gitaly
- Most appropriate slack channel to reach out to:
#g_gitaly
- Best individual to reach out to: @samihiltunen
Expectations
What release does this feature occur in first?
What are we expecting to happen?
Modify the RPC UserRevert to return structured errors instead of inline errors.
What might happen if this goes wrong?
Errors may be handled incorrectly and reported in undesired ways.
What can we monitor to detect problems with this?
- Production: https://dashboards.gitlab.net/d/000000199/gitaly-feature-status?orgId=1&refresh=5m&var-environment=gprd&var-method=UserRevert&var-prometheus=PA5EEDCB71676F488
- Staging: https://dashboards.gitlab.net/d/000000199/gitaly-feature-status?orgId=1&refresh=5m&var-environment=gstg&var-method=UserRevert&var-prometheus=P2F38159078D7ED24
Roll Out Steps
-
Enable on staging -
Is the required code deployed on staging? (howto) -
Enable on staging (howto) -
Add featureflagstaging to this issue (howto) -
Test on staging (howto) -
Verify the feature flag was used by checking Prometheus metric gitaly_feature_flag_checks_total
-
-
Enable on production -
Is the required code deployed on production? (howto) -
Progressively enable in production (howto) -
Add featureflagproduction to this issue -
Verify the feature flag was used by checking Prometheus metric gitaly_feature_flag_checks_total
-
-
Create subsequent issues -
To default enable the feature flag (optional, only required if backwards-compatibility concerns exist) -
Create issue using the Feature Flag Default Enable
template. -
Set milestone to current+1 release
-
-
To Remove feature flag -
Create issue using the Feature Flag Removal
template. -
Set milestone to current+1 (+2 if we created an issue to default enable the flag).
-
-
Please refer to the documentation of feature flags for further information.
Edited by Sami Hiltunen