Skip to content

Commit cd95194

Browse files
coolguyzoneAlex Krawiecsfanahata
authored
Ad alerts and dashboard page to new quickstart guide (#13522)
<!-- Use this checklist to make sure your PR is ready for merge. You may delete any sections you don't need. --> ## DESCRIBE YOUR PR *Tell us what you're changing and why. If your PR **resolves an issue**, please link it so it closes automatically.* ## 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 --> - [x] Other deadline: 4/29 - [ ] 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) ## LEGAL BOILERPLATE <!-- Sentry employees and contractors can delete or ignore this section. --> Look, I get it. The entity doing business as "Sentry" was incorporated in the State of Delaware in 2015 as Functional Software, Inc. and is gonna need some rights from me in order to utilize my contributions in this here PR. So here's the deal: I retain all rights, title and interest in and to my contributions, and by keeping this boilerplate intact I confirm that Sentry can use, modify, copy, and redistribute my contributions, under Sentry's choice of terms. ## EXTRA RESOURCES - [Sentry Docs contributor guide](https://docs.sentry.io/contributing/) --------- Co-authored-by: Alex Krawiec <[email protected]> Co-authored-by: Shannon Anahata <[email protected]>
1 parent 0fba2d6 commit cd95194

File tree

3 files changed

+62
-4
lines changed

3 files changed

+62
-4
lines changed
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
---
2+
title: Sentry Alerts and Dashboards
3+
sidebar_title: Alerts and Dashboards
4+
description: "Get started with Sentry alerts and dashboards to monitor key metrics, track issue trends, and gain real-time insights into your application's performance."
5+
sidebar_order: 6000
6+
---
7+
8+
By the end of this guide you'll be able to create and customize Sentry alerts and dashboards to monitor key metrics, track issue trends, and gain real-time insights in to your application performance. If you get stuck anywhere, try [asking Sentry AI](/?askAI=true) or join our [Discord](https://discord.gg/sentry) community.
9+
10+
## 1. Alerting Strategy
11+
12+
After [integrating with Slack](https://sentry-docs-git-ob-alerts.sentry.dev/organization/integrations/notification-incidents/slack/) and adding your members and teams, it's time to create [Sentry alerts](/product/alerts/best-practices/) to ensure real-time issue detection, enabling faster debugging and reducing downtime. Configuring alerts using specific thresholds or conditions helps prioritize problems, improving system reliability and incident response time.
13+
14+
### Alert Recommendations
15+
16+
- **Error Alert (High-Frequency)** - Triggers when a new or existing production issue suddenly spikes in frequency.
17+
18+
<Arcade src="https://demo.arcade.software/YaLyaOnchFhnNgnnegdx?embed" />
19+
20+
- **Performance Alert** - Detects and alerts for specific performance metrics when they exceed a specified threshold.
21+
22+
<Arcade src="https://demo.arcade.software/OKhoLV2GUeP1xHQIDAbM?embed" />
23+
24+
- **Crash Rate Alert** - Monitors application stability by tracking the percentage of users experiencing crashes within a given time frame.
25+
26+
<Arcade src="https://demo.arcade.software/r2YOeIh3sj9Lzmc3vBmj?embed" />
27+
28+
- **Anomaly Detection** - Sentry can simplify your alerting needs by automatically detecting anomalies and proactively alerting you.
29+
30+
<Arcade src="https://demo.arcade.software/lkvlGb3Cxh4ZwvEbfM0X?embed" />
31+
32+
You can also create metric alerts for all you custom-instrumented transactions/spans based on key performance indicators such as [throughput](/product/alerts/alert-types/#performance).
33+
34+
<Arcade src="https://demo.arcade.software/Ij5ofpPdcu6i71HPdKX2?embed" />
35+
36+
## 2. Sentry Dashboards and Discover
37+
38+
Setting up Sentry dashboards is crucial for speeding up triage and offering a real-time view of critical issues, trends, and performance in your app. If an irregularity is observed, Sentry dashboards allow users to jump directly into troubleshooting with a few clicks.
39+
40+
### Recommended Dashboards
41+
42+
1. **Error Overview Dashboard** - Provides a high-level view of application health, showing you error trends, most frequent issues, and spikes in error occurrences.
43+
44+
2. **Performance Monitoring Dashboard** - Tracks transaction durations, slow API calls, and database query performance to identify bottlenecks.
45+
46+
3. **Mobile Crash Rate and Release Health Dashboard** - Monitors application stability and release impact by tracking crash rates across different versions.
47+
48+
4. **Critical Experience Dashboard** - Tracks errors or performance bottlenecks in your application's critical experiences. [See an example](https://sandbox.sentry.io/dashboard/126679/).
49+
50+
### Congratulations on completing the Sentry onboarding guide!
51+
52+
You now have the foundation to make the most out of Sentry. Here are some highlights on what you've implemented:
53+
54+
- **Track errors** and performance by connecting projects and integrating your tools.
55+
56+
- **Add custom context** and performance instrumentation.
57+
58+
- **Stay on top of critical issues** with alerts.
59+
60+
- **Create dashboards** for insights, and filter or group issues for easy tracking.

docs/product/onboarding/data-enrichment.mdx

+1
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ description: "Instrument the data you send to Sentry for easier grouping and fil
44
sidebar_order: 5000
55
---
66

7+
78
By now, you should have events flowing into your project(s). If you don't, start [here](/product/onboarding/).This guide will cover essential topics such as data enrichment, filtering unwanted events, and issue grouping. If you get stuck anywhere, please [Ask Sentry AI](https://sentry.zendesk.com/hc/en-us?askAI=true) or join our [Discord](https://discord.gg/sentry) community.
89

910
## Step 1: Enriching Your Event Data

docs/product/onboarding/index.mdx

+1-4
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,7 @@ By the end of this step, you'll have enabled a few features, mapped data into Se
1919

2020
<Arcade src="https://demo.arcade.software/rxKoIgKxfVE5rXhizlEL?embed" />
2121

22-
23-
3. Add [Environments](/concepts/key-terms/environments/) and [Releases](/platform-redirect/?next=/configuration/releases/) to your Sentry init.
24-
22+
3. Add [Environments](/concepts/key-terms/environments/#creating-environments) and [Releases](/platform-redirect/?next=/configuration/releases/) to Your Sentry init.
2523

2624
- Set up environments (production, staging, etc.) and releases in Sentry to streamline error tracking. Environments filter issues by context, while releasing link errors to code versions for easier debugging.
2725

@@ -31,7 +29,6 @@ By the end of this step, you'll have enabled a few features, mapped data into Se
3129
## Step 2: Get your team on Sentry by implementing SSO or SCIM - For New organizations
3230

3331

34-
3532
To manage user authentication and provisioning, you can configure Single Sign-On ([SSO](/organization/authentication/sso/)) and System for Cross-Domain Identity Management ([SCIM](/organization/authentication/sso/okta-sso/okta-scim/)).
3633

3734
## Step 3: integrations

0 commit comments

Comments
 (0)