Skip to content

[DNM Demo ] :: [TRUNK-17702] Document indefinite monitor muting for flaky tests#463

Closed
samgutentag wants to merge 1 commit intomainfrom
sam-gutentag/indefinite-monitor-muting
Closed

[DNM Demo ] :: [TRUNK-17702] Document indefinite monitor muting for flaky tests#463
samgutentag wants to merge 1 commit intomainfrom
sam-gutentag/indefinite-monitor-muting

Conversation

@samgutentag
Copy link
Member

Summary

  • Adds a Mute monitors section (Step 3) to the Managing detected flaky tests guide
  • Documents all muting durations: 1 hour, 4 hours, 24 hours, 7 days, 30 days, and the new Forever option
  • Explains how muting affects test status and how to unmute

Linear tickets

Related PRs

Files changed

  • flaky-tests/managing-detected-flaky-tests.md — added Step 3 (Mute monitors), renumbered Steps 4–6

Open questions

  1. Are there any other muting durations beyond the ones listed (1h, 4h, 24h, 7d, 30d, Forever)?
  2. Is muting available for both threshold and pass-on-retry monitors, or only one type?
  3. Does muting require any specific user role or permission?

Conflicts

  • PR Update with docs about new flake detection configuration #453 (matt/flake-detection-docs) restructures detection docs and adds a muting section to a new flaky-tests/detection/README.md. That PR lists timed durations only (no Forever). Our changes target a different file (managing-detected-flaky-tests.md) but cover overlapping content. Whichever PR merges second should reconcile the muting documentation.

Test plan

  • Check GitBook preview on this branch
  • Verify table renders correctly
  • Confirm step numbering is sequential (Steps 1–6)
  • Verify hint block renders properly

🤖 Generated with Claude Code

Documents the new "Forever" option for muting flaky test monitors,
along with all existing timed duration options. Adds Step 3 (Mute
monitors) to the managing detected flaky tests guide.

TRUNK-17702

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@trunk-staging-io
Copy link

trunk-staging-io bot commented Mar 12, 2026

🚫 This pull request was closed by @samgutentag, so it was removed from the merge queue. See more details here.

@claude
Copy link

claude bot commented Mar 12, 2026

Claude finished @samgutentag's task in 1m 17s —— View job


Review complete

  • Read CLAUDE.md for repo guidelines
  • Read changed file and diff
  • Review for typos, grammar, formatting, documentation best practices
  • Post inline comments
  • Final summary

The new Step 3: Mute monitors section is well-structured and clearly written. The step renumbering (Steps 4–6) is correct and consistent. Two minor issues noted via inline comments:

  1. Table description inconsistency (line 49) — The 1 hour row gives a meaningful reason while 24 hours, 7 days, and 30 days just restate the duration in different units. Suggest making all descriptions equally informative. View comment →

  2. Ambiguous "for the duration of the mute" (line 64) — In the hint block, this phrase is slightly unclear when the Forever option is selected (there is no duration). Suggest "while the monitor is muted" to cover both cases. View comment →

Neither issue is blocking. The content is accurate, the prose is clear, and the hint block provides useful context. Good to merge after addressing these minor items if desired.

3. Click **Mute** and select a duration.

| Duration | Description |
|---|---|
Copy link

Choose a reason for hiding this comment

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

The table descriptions are inconsistent in depth. The 1 hour row gives a meaningful reason ("transient issues"), while 24 hours, 7 days, and 30 days just restate the duration in different units — readers can already infer "7 days = a week" from the Duration column. Consider making all descriptions equally informative, e.g.:

Duration Description
1 hour Suppress briefly for transient or one-off issues
4 hours Short-term suppression for issues expected to resolve in a few hours
24 hours Suppress overnight or across a full workday
7 days Suppress while waiting for a fix in the current sprint
30 days Suppress for a longer-running or deprioritized fix
Forever Mute indefinitely until manually unmuted

You can unmute a monitor at any time from the test case detail page, regardless of the selected duration.

{% hint style="info" %}
Muting suppresses the monitor's contribution to the test's status. If the muted monitor was the only active monitor for a test, the test transitions from flaky to healthy for the duration of the mute.
Copy link

Choose a reason for hiding this comment

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

"for the duration of the mute" is slightly ambiguous when the Forever option is selected (there is no duration). Consider rewording to "while the monitor is muted" to cover both timed and indefinite cases:

Suggested change
Muting suppresses the monitor's contribution to the test's status. If the muted monitor was the only active monitor for a test, the test transitions from flaky to healthy for the duration of the mute.
Muting suppresses the monitor's contribution to the test's status. If the muted monitor was the only active monitor for a test, the test transitions from flaky to healthy while the monitor is muted.

@github-actions
Copy link

/trunk merge

Copy link

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

Auto-approved: Claude code review passed.

@samgutentag samgutentag changed the title [TRUNK-17702] Document indefinite monitor muting for flaky tests [DNM Demo ] :: [TRUNK-17702] Document indefinite monitor muting for flaky tests Mar 12, 2026
@samgutentag
Copy link
Member Author

closing this, was used for demo

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

Labels

None yet

Development

Successfully merging this pull request may close these issues.

1 participant