Skip to content

Commit

Permalink
feat(stats-detectors): Add initial endpoint regression issue docs (#8427
Browse files Browse the repository at this point in the history
)

* feat(stats-detectors): Add endpoint regression docs

* add screenshot

* [getsentry/action-github-commit] Auto commit

* fix broken link

* Update src/docs/product/issues/issue-details/performance-issues/endpoint-regression/index.mdx

Co-authored-by: Liza Mock <liza.mock@sentry.io>

* Update src/docs/product/issues/issue-details/performance-issues/endpoint-regression/index.mdx

Co-authored-by: Liza Mock <liza.mock@sentry.io>

* Update src/docs/product/issues/issue-details/performance-issues/endpoint-regression/index.mdx

Co-authored-by: Liza Mock <liza.mock@sentry.io>

* Update src/docs/product/issues/issue-details/performance-issues/endpoint-regression/index.mdx

Co-authored-by: Liza Mock <liza.mock@sentry.io>

* Update src/docs/product/issues/issue-details/performance-issues/endpoint-regression/index.mdx

Co-authored-by: Liza Mock <liza.mock@sentry.io>

* [getsentry/action-github-commit] Auto commit

* [getsentry/action-github-commit] Auto commit

* [getsentry/action-github-commit] Auto commit

* [getsentry/action-github-commit] Auto commit

* add more details

* remove mentions of the throughput

* update screenshot

* update title

* rename folder

* update table description

---------

Co-authored-by: getsantry[bot] <66042841+getsantry[bot]@users.noreply.github.com>
Co-authored-by: Liza Mock <liza.mock@sentry.io>
  • Loading branch information
3 people committed Nov 9, 2023
1 parent 75dbfc7 commit 68b89da
Show file tree
Hide file tree
Showing 3 changed files with 41 additions and 0 deletions.
1 change: 1 addition & 0 deletions src/docs/product/accounts/early-adopter-features/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -23,4 +23,5 @@ Limitations:
- [Priority Sort](/product/issues#issue-sort) algorithm improvements
- [Issue Reprocessing](/product/issues/reprocessing/)
- [Span Summary](/product/performance/transaction-summary/#span-summary)
- [Endpoint Regression Issues](/product/issues/issue-details/performance-issues/endpoint-regressions)
- [Function Regression Issues](/product/issues/issue-details/performance-issues/function-regressions/)
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
---
title: "Endpoint Regression"
sidebar_order: 41
description: "Learn more about Endpoint Regression issues and how to diagnose and fix them."
---

<Include name="feature-available-for-user-group-early-adopter.mdx" />

Endpoint Regression issues are a generic class of problems where the duration of a transaction increases over time and degrades application performance. Sentry proactively monitors common endpoints out of the box and reports any possible regressions, grouping them as Endpoint Regression issue types.

## Detection Criteria

The detector for performance issues periodically checks the 95th percentile transaction duration of the most common endpoints in your project. When a significant increase in the p95 value is detected and has been sustained for some time, a regression issue is created.

## Regression Evidence

To find additional info, go to the Issues page and click on the Endpoint Regression issue you're interested in. In the top section of the "Details" tab, you'll find the following:

- **Endpoint Name:** The name of the transaction that has regressed.
- **Change in Duration:** The value of absolute and relative change in duration.
- **Approximate Start Time:** The approximate time when the regression occurred.

## Chart

The below chart shows the p95 transaction duration over a period of up to 14 days before and 14 days after the regression was identified.

![Endpoint Regression Issue Chart](endpoint-regression-chart.png)

## Potential Causes

The "Potential Causes" section shows a list of spans that may have contributed to the slowdown the most. Next to each span, you'll find the following:

- Span description that leads to the [Span Summary](/product/performance/transaction-summary/) page where you can find more information about that specific span.
- P95 of span self time before the regression.
- P95 of span self time after the regression.
- The percentage change in p95 span self time before and after the regression.

## Compare Events

The "Compare Events" section lets you compare example events from before and after the regression occurred. We call events that are close to the original P95 baseline duration "Baseline events", and events that are close to the new P95 baseline "Regressed events".

1 comment on commit 68b89da

@vercel
Copy link

@vercel vercel bot commented on 68b89da Nov 9, 2023

Choose a reason for hiding this comment

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

Successfully deployed to the following URLs:

sentry-docs – ./

sentry-docs.sentry.dev
docs.sentry.io
sentry-docs-git-master.sentry.dev

Please sign in to comment.