Skip to content
Merged
Show file tree
Hide file tree
Changes from 10 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
62 changes: 62 additions & 0 deletions docs/product/onboarding/alerts-dashboards.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
---
title: Sentry Alerts and Dashboards
sidebar_title: Alerts and Dashboards
description: "Get started with Sentry alerts and dashboards to monitor key metrics, track issue trends, and gain real-time insights into your application performance."
sidebar_order: 6000
---

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.

## 1. Alerting Strategy

Now that you've integrated with Slack and have added 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.

### Alert Recommendations

- **Error Alert (High-Frequency)** - Triggers when a new or existing production issue suddenly spikes in frequency.

<Arcade src="https://demo.arcade.software/YaLyaOnchFhnNgnnegdx?embed" />

- **Performance Alert** - Detects and alerts for specific performance metrics when they exceed a specified threshold.

<Arcade src="https://demo.arcade.software/OKhoLV2GUeP1xHQIDAbM?embed" />

- **Crash Rate Alert** - Monitors application stability by tracking the percentage of users experiencing crashes within a given time frame.

<Arcade src="https://demo.arcade.software/r2YOeIh3sj9Lzmc3vBmj?embed" />

- **Anomaly Detection** - Sentry can simplify your alerting needs by automatically detecting anomalies and proactively alerting you.

<Arcade src="https://demo.arcade.software/lkvlGb3Cxh4ZwvEbfM0X?embed" />

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).

<Arcade src="https://demo.arcade.software/Ij5ofpPdcu6i71HPdKX2?embed" />

## 2. Sentry Dashboards and Discover

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.

### Recommended Dashboards

1. **Error Overview Dashboard** - Provides a high-level view of application health, showing you error trends, most frequent issues, and spikes in error occurrences.

2. **Performance Monitoring Dashboard** - Tracks transaction durations, slow API calls, and database query performance to identify bottlenecks.

3. **Mobile Crash Rate and Release Health Dashboard** - Monitors application stability and release impact by tracking crash rates across different versions.

4. **Critical Experience Dashboard** - Tracks errors or performance bottlenecks in your application's critical experiences. [See an example](https://sandbox.sentry.io/dashboard/126679/).

Congratulations on completing the Sentry onboarding guide! You now have the foundation to make the most out of Sentry. Here are some highlights on what you've implemented:

- **Projects and Integrations**: Connect your projects and integrate with your tools to track errors and performance.

- **Team Members**: Invite teammates and manage permissions for better collaboration.

- Adding Custom Context and performance instrumentation.

- **Alerts**: Set up custom alerts to say on top of critical issues.

- **Dashboards**: Create custom dashboards for quick project insights.

- **Filtering and Grouping**: Organize and group issues for easy racking.
49 changes: 49 additions & 0 deletions docs/product/onboarding/data-enrichment.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
---
title: Data Enrichment
description: "Instrument the data you send to Sentry for easier grouping and filtering."
sidebar_order: 5000
---

By now, you should have events flowing into your project(s). 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](/?askAI=true) or join our [Discord](https://discord.gg/sentry) community.

## Step 1: Enriching Your Event Data

### Adding Custom Context

There are several ways you can [enrich your data](/platform-redirect?next=/enriching-events/) in Sentry. Adding tags, custom contexts, and breadcrumbs will help organize, filter, and analyze errors more effectively. See this quick walkthrough on adding a tag:

<Arcade src="https://demo.arcade.software/M87cMrcak4N6SLyUiI1D?embed" />

## Step 2: Ensure Your Traces Are Instrumented Properly

### Verify That Sentry's Tracing Auto-Instrumentation is Set Up Optimally

Once Tracing is turned on, Sentry will auto-instrument your spans. If any additional instrumentation is needed, look into your platform's [instrumentation documentation](/platform-redirect?next=/tracing/instrumentation/automatic-instrumentation/) for additional options.

<Alert>
Learn how [Sentry helps create actionable insights](/product/sentry-basics/performance-monitoring/#ways-to-monitor-performance-in-sentry) from your performance data.
</Alert>

### Custom Instrumentation For Any Additional Performance Metrics

For any gaps in Sentry's auto-instrumentation, you can use [custom instrumentation](/platform-redirect/?next=/tracing/instrumentation/custom-instrumentation/) to collect additional spans and span metrics. This enables you to focus your instrumentation on critical areas of your application to optimize you configuration. For example, if you have an e-commerce app, you may want to track pageloads and checkout errors to pinpoint issues by provider, region, or app version.

The video below is an example of what's possible with custom instrumentation:

<iframe src="https://drive.google.com/file/d/1U2of7oByT1ECdprvRRC30QwuZwQRk6cA/preview" width="640" height="480" allow="autoplay"></iframe>

## Step 3: Filtering Unwanted events

Filtering out events that are not actionable or expected during normal operations is essential for maintaining a clean and relevant issue tracking system. Issue and trace filtering are project-specific and can be accomplished [within the SDK](/platform-redirect?next=/configuration/filtering/#using-before-send) or the server via [inbound filters](/concepts/data-management/filtering/):

<Arcade src="https://demo.arcade.software/4utB0eYW8Uz81WTT84FL?embed" />
<div style={{marginBottom:'40px'}}></div>

<Alert>
Transactions/spans must be filtered out using `beforeSendSpan` and/or `beforeSendTransaction` [within the SDK](/platform-redirect?next=/configuration/filtering/#using-before-send).
</Alert>

## Step 4: Grouping Your issues

If you are noticing individual errors that should be grouped together, you can customize your issue grouping algorithm. Additional grouping customization can be accomplished via [issue merging](/concepts/data-management/event-grouping/merging-issues/) or Sentry's [custom grouping](/concepts/data-management/event-grouping/).

Binary file added docs/product/onboarding/img/auto-resolve.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
63 changes: 63 additions & 0 deletions docs/product/onboarding/index.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
---
title: Quick-Start Guide
description: "An easy onboarding guide for Sentry."
sidebar_order: 4000
---

By the end of this guide, you'll be able to create and configure projects in Sentry to gain detailed insights into issues, including the exact lines of code affected, the environment in which they occurred, and the releases they originated from. Additionally, we'll walk you through Sentry's most essential integrations. If you get stuck anywhere, please [Ask Sentry AI](/?askAI=true) or join our [Discord](https://discord.gg/sentry) community.

## Step 1: Initial Project Creation and Configuration

1. Check out this [step-by-step walkthrough](https://sentry.io/orgredirect/projects/new/) on creating and configuring a Sentry project within your environment.


- Sentry's in-app project creation workflow allows you to enable Tracing and Session Replay. At a minimum, this will allow you to take advantage of the free allocated Tracing and Session replay quota.


2. The Sentry project creation flow includes a "Source Map Wizard" to help streamline the uploading of your artifacts (source maps, debug information files, symbols).


- Source Maps (JS) and Debug Symbols are crucial for translating minified or obfuscated code back into a human-readable format, allowing you to pinpoint the exact lines of code causing your issues. Here you can find instructions for [JavaScript](/platforms/javascript/sourcemaps/uploading/) as well as [Android](/platforms/android/enhance-errors/source-context/) and [iOS](/platforms/apple/guides/ios/sourcecontext/).

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

3. Add [Environments](/concepts/key-terms/environments/) and [Releases](/platform-redirect/?next=/configuration/releases/) to Your Sentry init.


- 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.

<Arcade src="https://demo.arcade.software/MKxHyDhuA1edeTqEhESL?embed" />

## Step 2: Implementing SSO or SCIM - For New organizations


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/)).

## Step 3: integrations

[Source Code Management](): Integrating your SCM with Sentry is critical for efficient issue resolution. It links code changes to errors, helping you identify and resolve issues quickly. WIth commit tracking and Suspect Commits, users can pinpoint problematic changes and trace them to the relevant stack trace.

<Alert>
SCM (GitHub) integration highlights include:
- [Stack trace linking](/organization/integrations/source-code-mgmt/github/#stack-trace-linking)
- [Highlight suspect commits within an issue detail](/organization/integrations/source-code-mgmt/github/#suspect-commits-and-suggested-assignees)
- [Automatically link code owners](/organization/integrations/source-code-mgmt/github/#code-owners)

<Arcade src="https://demo.arcade.software/qFzrbkftPVGTGLveRedZ?embed" />
</Alert>

[Messaging/Notifications](/organization/integrations/notification-incidents/): A messaging integration will allow you to configure alerts based on issue severity, resolving or ignoring issues directly from Slack, and links back to Sentry for deeper investigation. This keeps teams proactive by instantly alerting them about critical issues.

[Issue Tracking](/organization/integrations/#issue-tracking): Helps teams track and manage Sentry issues within their ticketing system. You will be able to trigger the automatic creations of issues from Sentry events, sync status updates between tools, and link Sentry issues to existing tickets for streamlined resolution.


- Linking Sentry to JIRA keeps issue statuses synced, automatically marking Sentry issues as resolved when appropriate. This ensures that reappearing issues get flagged regressions.
<Arcade src="https://demo.arcade.software/atttrvOjh9g1x9V7c8Z9?embed" />


- To manage stale issues within Sentry, enable auto-resolve for those unseen within a set timeframe. **We recommend setting auto-resolve to 2 weeks** for optimal issue and regression tracking. Configure this in **Project Settings > General Settings > Auto Resolve**.

![Auto Resolve Settings Screenshot](./img/auto-resolve.png)


By following this guide, you should have Sentry projects created, your integrations set up, and be configured for SSO/SCIM. For further customization, explore the official Sentry Documentation or [ask Sentry AI](/?askAI=true).