Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions flaky-tests/detection/failure-count-monitor.md
Original file line number Diff line number Diff line change
Expand Up @@ -98,6 +98,26 @@

You can temporarily mute a failure count monitor for a specific test case. See [Muting monitors](README.md#muting-monitors) for details.

## Preview Panel

When creating or editing a failure count monitor, a preview panel shows which tests the current configuration would flag based on recent data.

### Status Filter

A **status filter dropdown** in the preview panel lets you filter the test list to any combination of statuses: **Healthy**, **Flaky**, and **Broken**. By default, all statuses are shown.

Filtering to **Healthy** is the most useful view: it shows tests that are currently healthy but would be flagged by this monitor if created with the current settings. This lets you see the new coverage the monitor adds without noise from tests already detected by other monitors.

Selecting multiple statuses (for example, Healthy and Flaky) shows tests matching any of the selected statuses.

When a status filter is active, the info tooltip in the panel header shows "X of Y tests" to indicate how many tests are visible relative to the total that match the monitor configuration.

Check failure on line 113 in flaky-tests/detection/failure-count-monitor.md

View workflow job for this annotation

GitHub Actions / Trunk Check

vale(error)

[new] Did you really mean 'tooltip'?

If no tests match the active filter, the empty state includes a hint to clear the filter.

### Large Repo Truncation

For repositories with a large number of matching tests, preview results may be truncated. When this happens, an amber warning appears in the panel. The truncation applies to the list of tests shown, not to the underlying detection logic — the monitor evaluates all matching tests when active.

## Choosing Between Monitors

| Scenario | Recommended monitor |
Expand Down
19 changes: 19 additions & 0 deletions flaky-tests/detection/failure-rate-monitor.md
Original file line number Diff line number Diff line change
Expand Up @@ -163,6 +163,25 @@
`main` and `release/*`), ideally showing the tag/chip-style UI for
each pattern. -->

## Preview Panel

When creating or editing a failure rate monitor, a preview panel shows which tests the current configuration would flag based on recent data. The panel is split into two sections: **Current** and **Proposed**.

- **Current** shows tests flagged by the existing configuration (if editing an existing monitor).
- **Proposed** shows tests that would be flagged with the settings currently entered in the form.

The Current section is collapsed by default so the Proposed view is immediately visible when you open the form.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Missing comma before "so" in this compound sentence.

Suggested change
The Current section is collapsed by default so the Proposed view is immediately visible when you open the form.
The Current section is collapsed by default, so the Proposed view is immediately visible when you open the form.


### Status Filter

A **status filter dropdown** in the preview panel lets you filter the test list to any combination of statuses: **Healthy**, **Flaky**, and **Broken**. By default, all statuses are shown.

Filtering to **Healthy** shows tests that are currently healthy but would be flagged by this monitor — the new coverage it adds beyond tests already detected. Filtering to other statuses, or combining them, adjusts the visible list without affecting the underlying detection counts.

When a filter is active, the info tooltip shows "X of Y tests" to indicate how many tests are visible relative to the total matching the configuration. If no tests match the active filter, the empty state includes a hint to clear the filter.

Check failure on line 181 in flaky-tests/detection/failure-rate-monitor.md

View workflow job for this annotation

GitHub Actions / Trunk Check

vale(error)

[new] Did you really mean 'tooltip'?

The status filter applies to the **Proposed** section. The not-in-window count in the Current section reflects the full unfiltered result set and is not affected by the filter.

## Resolution Behavior

A flagged test resolves in one of two ways:
Expand Down
Loading