generated from shayancoin/aieng-template-mvp
-
Notifications
You must be signed in to change notification settings - Fork 0
Add CI performance budgets and observability checks #99
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
shayancoin
merged 3 commits into
main
from
codex/extend-performance-budget-configuration
Oct 17, 2025
Merged
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,34 @@ | ||
| # Release Checklist | ||
|
|
||
| This checklist captures the operational gates that must be satisfied before promoting a build to production. It ties runtime telemetry, CI results, and preview deployments together so on-call responders have a consistent view of system health. | ||
|
|
||
| ## 1. Verify CI performance budgets | ||
|
|
||
| 1. Inspect the **perf-budget** job in the CI workflow. Confirm the Playwright run stores the latest navigation and LCP percentiles in the `perf-results` artifact or that they appear in Grafana when the Pushgateway integration is configured. | ||
| 2. Ensure the homepage → configurator journey meets the navigation (P90 < 3s) and Largest Contentful Paint (P95 < 4s) budgets. Any regression should block the release until a remediation plan is documented. | ||
| 3. Cross check the JUnit report (or Pushgateway metrics) against historical trends before approving the release branch merge. | ||
|
|
||
| ## 2. Review canary latency and error budgets | ||
|
|
||
| 1. Open the **observability-budgets** job logs for the Prometheus/Tempo regression check. Confirm the P95 API latency and error-rate budgets are below their configured thresholds and have not regressed more than the allowed tolerance from the previous build. | ||
| 2. If the job fails, review the Prometheus dashboards for the affected service and either mitigate or roll back before continuing the release. | ||
|
|
||
| ## 3. Validate Grafana alerts and on-call notifications | ||
|
|
||
| 1. Check that the Grafana dashboard for the configurator experience displays the latest CI metrics (either from the Pushgateway metrics or the uploaded JUnit results). | ||
| 2. Confirm Grafana alert rules reference the same Prometheus queries used in CI and that alert routing targets the active on-call channel (PagerDuty, Opsgenie, or Slack On-call). Perform a synthetic alert test each quarter to verify paging works end-to-end. | ||
| 3. Update the on-call schedule if coverage changed since the previous release. | ||
|
|
||
| ## 4. Preview environment gating | ||
|
|
||
| 1. Before cutting a release tag, verify that the preview deployment (staging or review app) is healthy: | ||
| - Synthetic navigation checks load within the CI-defined budgets. | ||
| - Error budgets are green in Grafana/Prometheus for the staging namespace. | ||
| 2. Confirm preview environment alerts route to the same on-call channel so responders see issues ahead of production rollout. | ||
| 3. Capture a short Loom or screenshot walkthrough of the configurator flow and attach it to the release ticket to document the state of the UI prior to launch. | ||
|
|
||
| ## 5. Final approval | ||
|
|
||
| 1. Ensure all checklist items above are marked complete in the release issue template. | ||
| 2. Obtain sign-off from the engineering lead (performance budgets) and on-call lead (alert routing) before performing the production deploy. | ||
| 3. After deployment, monitor Grafana dashboards for at least one full canary window to confirm runtime telemetry stays within budget. If alerts fire, follow the incident response playbook and update the release retrospective. | ||
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.