Skip to content

Commit d2154c4

Browse files
sfanahataShannon Anahatathomasrockhu-codecov
authored
Updated test analytics doc for more details on how to read the data (#15494)
## DESCRIBE YOUR PR Added a new section with details on how to read the trickier data on the dashboard. ## IS YOUR CHANGE URGENT? Help us prioritize incoming PRs by letting us know when the change needs to go live. - [ ] Urgent deadline (GA date, etc.): <!-- ENTER DATE HERE --> - [ ] Other deadline: <!-- ENTER DATE HERE --> - [x] None: Not urgent, can wait up to 1 week+ ## SLA - Teamwork makes the dream work, so please add a reviewer to your PRs. - Please give the docs team up to 1 week to review your PR unless you've added an urgent due date to it. Thanks in advance for your help! ## PRE-MERGE CHECKLIST *Make sure you've checked the following before merging your changes:* - [ ] Checked Vercel preview for correctness, including links - [ ] PR was reviewed and approved by any necessary SMEs (subject matter experts) - [ ] PR was reviewed and approved by a member of the [Sentry docs team](https://github.com/orgs/getsentry/teams/docs) --------- Co-authored-by: Shannon Anahata <shannonanahata@gmail.com> Co-authored-by: Tom Hu <88201630+thomasrockhu-codecov@users.noreply.github.com>
1 parent 20dd174 commit d2154c4

File tree

2 files changed

+14
-2
lines changed

2 files changed

+14
-2
lines changed
42.3 KB
Loading

docs/product/test-analytics/index.mdx

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -90,15 +90,27 @@ Now that you've configured your CI to upload your test results, you can inspect
9090

9191
After your workflow runs, view failed tests in the [failed tests dashboard](https://sentry.io/prevent/tests/?filterBy=failedTests), or in your GitHub pull request comments.
9292

93-
![Test Analytics comment](./img/TA-comment.png)
93+
![Test Analytics comment =800x](./img/TA-comment.png)
9494

95-
You can see a complete overview of your test analytics in the [test analytics dashboard](https://sentry.io/prevent/tests/). **Note**: The `All Branches`dashboard refreshes every 24 hours.
95+
### Reading Test Analytics Data
96+
You can see a complete overview of your test analytics in the [test analytics dashboard](https://sentry.io/prevent/tests/).
97+
**Note**: The `All Branches`dashboard refreshes every 24 hours.
98+
99+
![ALl branches dashboard](./img/all-branches-dash.png)
100+
101+
- `Failed Tests`: Shows all failed tests across all branches. Because of this, the _total run time_ may be higher than the filtered time range selected.
102+
- `Flaky Tests`: These are tests that go from fail to pass or pass to fail compared to the default branch. This analysis will only run when:
103+
- The commit is merged to the default branch
104+
- Flake detection is enabled on your yaml (default is true)
105+
- Either: The repo is public (regardless of plan type); Or: The repo is private, and is above free or team plan types
106+
- `Cumulative Failures`: Shows the number of individual test failures, only on the default branch.
96107

97108
## Permissions and Repository Tokens
98109
When configuring Test Analytics, you'll be asked to choose your upload permissions. For GitHub Actions, you can use [OpenID Connect](https://docs.github.com/en/actions/security-for-github-actions/security-hardening-your-deployments/about-security-hardening-with-openid-connect), or generate a repository token. Using the CLI, generate a repository token.
99110

100111
You can find a list of repository tokens on the Sentry Prevent [tokens page](https://sentry.io/prevent/tokens/).
101112

113+
102114
## Read Next
103115

104116
<PageGrid />

0 commit comments

Comments
 (0)