Skip to content

docs: add performance issue fields to bug report template#5305

Open
siavashs wants to merge 1 commit into
prometheus:mainfrom
siavashs:new-issue-template
Open

docs: add performance issue fields to bug report template#5305
siavashs wants to merge 1 commit into
prometheus:mainfrom
siavashs:new-issue-template

Conversation

@siavashs

Copy link
Copy Markdown
Contributor

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.

  • Please list all open issue(s) discussed with maintainers related to this change
    • Fixes #
  • Is this a new Receiver integration?
  • Is this a bugfix?
    • I have added tests that can reproduce the bug which pass with this bugfix applied
  • Is this a new feature?
    • I have added tests that test the new feature's functionality
  • Does this change affect performance?
    • I have provided benchmarks comparison that shows performance is improved or is not degraded
      • You can use benchstat to compare benchmarks
    • I have added new benchmarks if required or requested by maintainers
  • Is this a breaking change?
    • My changes do not break the existing cluster messages
    • My changes do not break the existing api
  • I have added/updated the required documentation
  • I have signed-off my commits
  • I will follow best practices for contributing to this project

Which user-facing changes does this PR introduce?


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>
@siavashs siavashs requested a review from a team as a code owner June 13, 2026 12:52
@coderabbitai

coderabbitai Bot commented Jun 13, 2026

Copy link
Copy Markdown

Review Change Stack

📝 Walkthrough

Walkthrough

The 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.

Changes

Bug Report Template Enhancement

Layer / File(s) Summary
Performance and prometheus-operator diagnostic sections
.github/ISSUE_TEMPLATE/bug_report.yml
New "Performance issues" section prompts for CPU profiles, memory (heap) profiles, and approximate workload metrics (alert and silence counts). New "Using prometheus-operator?" section adds a checkbox checklist to confirm issue context and reproducibility without prometheus-operator.

🎯 1 (Trivial) | ⏱️ ~5 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and accurately describes the main change: adding performance issue fields to the bug report template.
Description check ✅ Passed The description is mostly complete with clear explanation of changes and signed-off commits, though release notes are left empty.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🧹 Nitpick comments (1)
.github/ISSUE_TEMPLATE/bug_report.yml (1)

83-91: ⚡ Quick win

Performance 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

📥 Commits

Reviewing files that changed from the base of the PR and between 37a5cd7 and 17eb08e.

📒 Files selected for processing (1)
  • .github/ISSUE_TEMPLATE/bug_report.yml

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant