> ## Documentation Index
> Fetch the complete documentation index at: https://codspeed.io/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Setting up Continuous Performance Checks

> Learn how to enable performance safeguards in your project

CodSpeed provides a performance **status check** to your branches and pull
requests. The status of this check is based on the performance change between
the current branch and your main branch (and the project's
[regression threshold](https://codspeed.io/docs/features/customization.md#regression-threshold)).

You can configure the performance check to fail if the performance metrics of a
branch or pull request are overshooting your regression threshold. Thus,
**blocking the pull request** from being merged if the performance issue is
neither fixed nor [acknowledged](#acknowledge-regressions-or-benchmark-drops).

## Setup performance checks

**1. Access repository settings**

Once your project has run at least one benchmark, go to your repository's settings on GitHub.

**2. Navigate to branch protection**

Under the **Code and automation** section, open the **Branches** tab.

**3. Configure branch protection rule**

Add a new branch protection rule or update the one already protecting your
main branch.

**4. Set branch name pattern**

![Set the branch name pattern](https://mintcdn.com/codspeed/jKaxX6yy-Kzw1C-0/features/performance-checks/assets/branch-name-pattern.png?fit=max\&auto=format\&n=jKaxX6yy-Kzw1C-0\&q=85\&s=36d03a48636c6c2e371154a9ebe7a255)

In the branch name pattern field, enter the name of your default branch

**5. Enable status checks requirement**

Tick the **Require status checks to pass before merging** checkbox.

**6. Add CodSpeed status check**

Under this section, search for **CodSpeed Performance Analysis** and click on the item to enable the check:

![Configuration of the status check](https://mintcdn.com/codspeed/jKaxX6yy-Kzw1C-0/features/performance-checks/assets/status-check-configuration.png?fit=max\&auto=format\&n=jKaxX6yy-Kzw1C-0\&q=85\&s=cf1b4cd4aa386daad367d23753be2e98)

**7. Save changes**

**Save the changes** and you're done! 🎉 Your performance checks are now
configured and will run on future pull requests, preventing you from merging
pull requests that introduce performance regressions.

![Pull Request Checks failing because of the performance regression](https://mintcdn.com/codspeed/q5Q3QnyKsjTld2tv/assets/quickstart-regression-checks.png?fit=max\&auto=format\&n=q5Q3QnyKsjTld2tv\&q=85\&s=cafac36f9a791d06187e998b6ee8d6d7)

Pull Request Checks failing because of the performance regression

## Acknowledge regressions or benchmark drops

If you're aware of performance issues that are not yet fixed or were totally
intentional, you can acknowledge them to **prevent the performance check from
failing**.

> [!NOTE]
>
> **Acknowledgement Permission**: When working with an organization's
> repository, **only admins** are allowed to acknowledge regressions.

Once all the regressions are fixed or acknowledged, the performance check will
pass and you can safely merge your pull request while being **aware of your
performance issues**.

### Acknowledge a single benchmark

First, head to the CodSpeed report (you can access it from the link in the
inline performance report or directly from your
[CodSpeed Dashboard](https://app.codspeed.io/dashboard)).

Then, go to the regressed benchmark you want to acknowledge:

![failing benchmark](https://mintcdn.com/codspeed/03672jtP0I3gWCvv/features/performance-checks/assets/failing-benchmark.png?fit=max\&auto=format\&n=03672jtP0I3gWCvv\&q=85\&s=e0bf7a717b3f1b610f019b6baee49b11)

Click on the the benchmark to expand its content:

![Expanded benchmark](https://mintcdn.com/codspeed/03672jtP0I3gWCvv/features/performance-checks/assets/expanded-benchmark.png?fit=max\&auto=format\&n=03672jtP0I3gWCvv\&q=85\&s=e28452f1e23a027aec788b3136ab4941)

Click on the "Acknowledge regression" button and that's it 🎉 :

![Acknowledged benchmark](https://mintcdn.com/codspeed/03672jtP0I3gWCvv/features/performance-checks/assets/acknowledged-benchmark.png?fit=max\&auto=format\&n=03672jtP0I3gWCvv\&q=85\&s=016dd5f94d693cdec57bce35fc7a3d9b)

### Acknowledge multiple benchmarks

To acknowledge multiple benchmarks at once:

Filter the benchmark list to show only regressions using the **Status** filter
or by typing `is:regression` in the search bar:

![Acknowledge multiple benchmarks](https://mintcdn.com/codspeed/yDUzQZhwEA7SNuSf/features/performance-checks/assets/acknowledge-multiple.png?fit=max\&auto=format\&n=yDUzQZhwEA7SNuSf\&q=85\&s=775a6368d32799445c64f0f8b44df31a)

Select the benchmarks you want to acknowledge using the checkboxes:

![Acknowledge selected benchmarks](https://mintcdn.com/codspeed/03672jtP0I3gWCvv/features/performance-checks/assets/acknowledge-selected.png?fit=max\&auto=format\&n=03672jtP0I3gWCvv\&q=85\&s=f2f60b5e560e5e5b4098e148097a55cd)

Click the **Acknowledge selected** button that appears in the list header and
that's it 🎉 :

![Acknowledged multiple benchmarks](https://mintcdn.com/codspeed/03672jtP0I3gWCvv/features/performance-checks/assets/acknowledged-multiple-benchmarks.png?fit=max\&auto=format\&n=03672jtP0I3gWCvv\&q=85\&s=463092efb39102d6db5c7234d6ea8ca3)

## Understanding Performance Regressions

> [card] [How Performance Metrics Work](https://codspeed.io/docs/features/understanding-the-metrics.md)
>
> Learn how CodSpeed calculates performance impact and regression thresholds

> [card] [Debug with Flamegraphs](https://codspeed.io/docs/features/profiling.md)
>
> Use detailed profiling data to identify and fix performance bottlenecks

## Related Guides

> [card] [Configure Regression Thresholds](https://codspeed.io/docs/features/customization.md)
>
> Customize when performance changes trigger failures

> [card] [CI Integration Setup](https://codspeed.io/docs/integrations/ci.md)
>
> Set up CodSpeed in your continuous integration pipeline


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.