Skip to content

Latest commit

 

History

History
92 lines (59 loc) · 7.11 KB

File metadata and controls

92 lines (59 loc) · 7.11 KB
description Learn how Trunk detects and labels flaky and broken tests

Flake Detection

Flake Detection automatically identifies problematic tests in your test suite by monitoring test behavior over time. Instead of a single set of built-in detection rules, Trunk uses monitors, independent detectors that each watch for a specific pattern. When any monitor flags a test, it's marked as flaky or broken. When all monitors agree the test has recovered, it returns to healthy.

How Monitors Work

Each monitor independently observes your test runs and tracks two states per test: active (problematic behavior detected) or inactive (no problematic behavior). A test's overall status is determined by combining all of its monitors, with the most severe status winning:

Priority Status Condition
Highest Broken Any enabled broken-type monitor (failure rate or failure count) is active for this test
Middle Flaky Any enabled flaky-type monitor (failure rate, failure count, or pass-on-retry) is active
Lowest Healthy No active monitors

If a test triggers both a broken monitor and a flaky monitor simultaneously, it shows as Broken. When the broken monitor resolves (e.g., you fix the regression and the failure rate drops), the test transitions to Flaky if a flaky monitor is still active, or to Healthy if no monitors remain active.

A test stays in its detected state until every relevant monitor that flagged it has independently resolved.

Disabling or Deleting a Monitor

When you disable or delete a monitor, it is immediately set to resolved for every test case in the repo. This triggers a status re-evaluation for all affected tests. If the disabled monitor was the only active monitor for a test, that test transitions to healthy. If other monitors are still active, the test remains in the most severe active state.

For example, if you have a broken failure rate monitor and a flaky pass-on-retry monitor, and you disable the broken monitor, any test that was only flagged by the broken monitor will become healthy. A test flagged by both will transition from broken to flaky (because pass-on-retry is still active).

Monitor Types

Monitor What it detects Detection type Plan availability Default state
Pass-on-Retry A test fails then passes on the same commit (retry after failure) Flaky Team and above Enabled
Failure Rate Failure rate exceeds a configured percentage over a time window Flaky or Broken Paid plans Disabled
Failure Count A test accumulates a configured number of failures in a rolling window Flaky or Broken Paid plans Disabled

You can run multiple monitors simultaneously. For example, you might use pass-on-retry to catch classic retry-based flakiness while also running failure rate monitors scoped to different branches. A common pattern is to pair a broken-type failure rate monitor (catching consistently failing tests) with a flaky-type failure rate monitor (catching intermittently failing tests). See Failure Rate Monitor: Recommended Configurations for details.

The failure count monitor complements failure rate monitors by reacting to individual failures rather than failure rates. Use it on branches where any failure is a meaningful signal, like main or merge queue branches.

If you need to manually flag a test that automated monitors haven't caught, use Flag as Flaky from the test detail page.

Branch-Aware Detection

Tests often behave differently depending on where they run. Failures on main are usually unexpected and signal flakiness. Failures on PR branches may be expected during active development. Merge queue failures are suspicious because the code has already passed PR checks.

Rather than applying a single set of branch rules automatically, Trunk gives you control over how detection treats different branches through branch scoping on failure rate monitors. You can create separate monitors with different thresholds and windows for your stable branch, PR branches, and merge queue branches. See Failure Rate Monitor: Recommended configurations for specific guidance.

Pass-on-retry detection is branch-agnostic. It flags any test that fails and passes on the same commit, regardless of which branch the test ran on.

Muting Monitors

You can temporarily mute a monitor for a specific test case. A muted monitor continues to run and record detections, but it won't contribute to the test's flaky status until the mute expires.

This is useful when you know a test is flaky but want to suppress the signal temporarily, for example while a fix is in progress or during a known infrastructure issue. Unlike Flag as Flaky, which is a persistent user override, muting preserves the detection history and automatically re-enables itself after the mute period.

How Muting Works

You can mute a monitor from the test case view in the Trunk app. When muting, you choose a duration:

Duration
1 hour
4 hours
24 hours
7 days
30 days

While muted, the monitor is excluded from the test's status calculation. If the muted monitor was the only active monitor, the test transitions from flaky to healthy for the duration of the mute. When the mute expires, the monitor is automatically included in the next status evaluation. If it's still active, the test will be flagged as flaky again.

You can also unmute a monitor early from the test case view.

{% hint style="info" %} You can only mute a monitor that has already detected flaky behavior for a test. If a monitor has never been active for a test, the mute option is disabled. {% endhint %}

When to Mute vs. Other Options

Situation Recommended action
Fix is in progress and you want to suppress noise temporarily Mute the monitor for a few days
Test is flaky but no automated monitor has caught it Use Flag as Flaky to mark it as flaky
You want to stop a monitor from evaluating a test permanently Adjust the monitor's branch scope or thresholds instead
You want to suppress all flaky signals for a test Mute each active monitor individually, or address the root cause

Variants

If you run the same tests across different environments or architectures, you can use variants to separate these runs into distinct test cases. This lets monitors detect environment-specific flakes. For example, a test might be flaky on iOS but stable on Android. Using variants, monitors isolate flakes on the iOS variant instead of marking the test as flaky across all environments. See the Trunk Analytics CLI docs for details on how to upload with variants.