docs: add performance issue fields to bug report template#5305
Conversation
Ask reporters of performance issues to provide CPU and memory profiles from both the previous and current versions, along with the number of alerts and silences. Reference the upstream Go diagnostics docs for capturing profiles and point to pprof.me for uploading and sharing profile diffs. Also add a prometheus-operator checklist so users confirm the issue is not a missing operator feature or that it reproduces when running Alertmanager directly. Signed-off-by: Siavash Safi <siavash@cloudflare.com>
📝 WalkthroughWalkthroughThe bug report issue template is enhanced with two new diagnostic sections. The "Performance issues" section collects CPU profiles, memory profiles, and approximate alert/silence counts. The "Using prometheus-operator?" section adds a checklist to determine if the issue relates to prometheus-operator features or if it reproduces with direct Alertmanager execution. ChangesBug Report Template Enhancement
🎯 1 (Trivial) | ⏱️ ~5 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
🧹 Nitpick comments (1)
.github/ISSUE_TEMPLATE/bug_report.yml (1)
83-91: ⚡ Quick winPerformance profile descriptions assume regression scenarios.
The description requests profiles from "both the previous version (where performance was acceptable) and the current version" (also on line 96 for memory profiles). This wording may confuse users reporting new performance issues rather than regressions, or users who don't have a previous version available.
Consider rephrasing to make it clear that providing only current-version profiles is acceptable, with previous-version profiles being helpful for comparison if available.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In @.github/ISSUE_TEMPLATE/bug_report.yml around lines 83 - 91, The guidance text under the "CPU profiles" (label: CPU profiles) should be reworded to make previous-version profiles optional: change the phrasing that currently assumes a regression from "Please attach CPU profiles from both the previous version (where performance was acceptable) and the current version (where you observe the regression)" to something like "Please attach CPU profiles from the current version; if available, include profiles from a previous version for comparison." Apply the same optional/clarifying change to the analogous "Memory profiles" description so both blocks accept a single current-version profile and treat previous-version profiles as helpful but not required.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Nitpick comments:
In @.github/ISSUE_TEMPLATE/bug_report.yml:
- Around line 83-91: The guidance text under the "CPU profiles" (label: CPU
profiles) should be reworded to make previous-version profiles optional: change
the phrasing that currently assumes a regression from "Please attach CPU
profiles from both the previous version (where performance was acceptable) and
the current version (where you observe the regression)" to something like
"Please attach CPU profiles from the current version; if available, include
profiles from a previous version for comparison." Apply the same
optional/clarifying change to the analogous "Memory profiles" description so
both blocks accept a single current-version profile and treat previous-version
profiles as helpful but not required.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Enterprise
Run ID: f4bce020-edf2-44d7-9e60-711a07423ccd
📒 Files selected for processing (1)
.github/ISSUE_TEMPLATE/bug_report.yml
Ask reporters of performance issues to provide CPU and memory profiles from both the previous and current versions, along with the number of alerts and silences. Reference the upstream Go diagnostics docs for capturing profiles and point to pprof.me for uploading and sharing profile diffs.
Also add a prometheus-operator checklist so users confirm the issue is not a missing operator feature or that it reproduces when running Alertmanager directly.
Pull Request Checklist
Please check all the applicable boxes.
benchstatto compare benchmarksWhich user-facing changes does this PR introduce?