Collect Deploy Timing Metrics per Stage
Instrument the deploy pipeline to emit per-stage duration metrics so regressions in deploy time are visible on a dashboard.
Task
Automate echo "deploy_stage_duration{stage=\"build\"} $(($(date +%s)-START))" >> metrics.prom so pipeline failures are caught before merge and never reach production.
When to use this
A pull request merges with a broken echo "deploy_stage_duration{stage=\"build\"} $(($(date +%s)-START))" >> metrics.prom step because the workflow did not gate on it, causing a failed deploy.
Prerequisites
- Node.js 22 and pnpm available
- A CI workflow file in .github/workflows
Steps
1. Configure echo "deploy_stage_duration{stage=\"build\"} $(($(date +%s)-START))" >> metrics.prom in the project configuration file with the recommended defaults.
echo "deploy_stage_duration{stage=\"build\"} $(($(date +%s)-START))" >> metrics.prom
Expected output: The configuration is accepted and echo "deploy_stage_duration{stage=\"build\"} $(($(date +%s)-START))" >> metrics.prom runs without errors on the first invocation.
2. Run the check locally to verify echo "deploy_stage_duration{stage=\"build\"} $(($(date +%s)-START))" >> metrics.prom produces the expected result before pushing.
pnpm test
Expected output: Local run matches CI behavior; no surprises after push.
3. Add the gate to the CI pipeline so echo "deploy_stage_duration{stage=\"build\"} $(($(date +%s)-START))" >> metrics.prom blocks merge on failure.
- name: Run add deploy timing metrics
run: pnpm test
Expected output: Pull requests with failing echo "deploy_stage_duration{stage=\"build\"} $(($(date +%s)-START))" >> metrics.prom are blocked from merging.
Troubleshooting
Problem
The check passes locally but fails in CI
Solution
Pin dependency versions and the runtime to match CI exactly; reproduce with the same Docker image or act.
Problem
Configuration is rejected with a schema error
Solution
Check the tool version matches the config schema; older versions may not support newer fields.
Limitations
- The gate only runs on events that trigger the workflow; locally pushed commits bypass it.
- Configuration drift is possible if someone edits settings outside version control.
Gate the pipeline before merge
Start by measuring the problem. Instrument the deploy pipeline to emit per-stage duration metrics so regressions in deploy time are visible on a dashboard. The most common mistake is adding the gate without first confirming it catches the issue you care about. Run echo “deploy_stage_duration{stage="build"} $(($(date +%s)-START))” >> metrics.prom against the current codebase and inspect the output before wiring it into CI.
echo "deploy_stage_duration{stage=\"build\"} $(($(date +%s)-START))" >> metrics.promMake failures actionable
Once the gate is in place, make failures actionable. A failing echo “deploy_stage_duration{stage="build"} $(($(date +%s)-START))” >> metrics.prom should point to the exact file and line, not a generic error. Pin the tool version in the lockfile so a upstream release does not silently change behavior. Review the gate output in every pull request just like a test result.