This guide assumes you’ve already integrated Sentry’s SDK into your code and sent an event. The list below provides Sentry’s recommendations for how best to use Sentry after you’ve taken your first steps.
Once you’ve integrated Sentry’s SDK, follow these best practices to customize your Sentry configuration and optimize your notification workflows.
We recommend creating Teams that align with your internal team structure. For example, every Sentry engineer uses Sentry. Because we have different teams of engineers responsible for different parts of our product, the Teams need to be named appropriately, like #SDK and #ops.
There’s no right or wrong way to separate your Sentry Projects, we recommend creating projects to align with the different services within your organization. Here are some important things to remember when determining project differentiation:
Configure SAML or an SSO provider to manage organization access.
Turn on open membership so that Sentry users authenticated with your Identity Provider can easily join your Sentry organization.
If you need assistance configuring Sentry with your Identity Provider, contact Sentry’s support team through your organization’s support page.
By default, Sentry sends email notifications to all members of a Project when an “event is first seen.” This default exists to make it easy to test if Sentry is working but can become noisy.
We recommend creating a few custom Alert Rules to make notifications actionable for your teams. We also recommend starting with these conditions:
Level-up your Sentry configuration with customization and advanced alert routing best practices to make debugging even more efficient.
Customize your SDK to collect context about your errors and unlock powerful functionality in Sentry.
# of users impactedalert condition to help determine the scope and severity of an error.
_For more information, check out this advanced guide on how to maximize your SDK configuration._
With richer error data you can create more advanced alert rules that link context, thresholds, environments, and Teams for more actionability around errors. We recommend starting with these customizations:
_For more information, check out this advanced guide on how to maximize the power of Alerts._
When you associate commits with errors in Sentry, you unlock the ability to identify regressions, decrease time to error resolution by predicting the commit causing the issue and who’s likely responsible, and resolve issues using the issue number in your commit message.
There are a few ways you can associate commit data with errors --- each with their own advantage:
Sentry Discover is the foundation for querying raw event data in Sentry, across all projects. It’s particularly valuable when you’ve enriched your event data because you can run queries based on your customized event context. Use Discover to build and save queries that are helpful to you in identifying trends in issues. Here are a few things that you can do using Discover:
Here are a few sample queries:
See a breakdown of the most common issues across the entire organization, limited to 1000 results.
Tally up which files in our projects are associated with the most errors to investigate which part of an application needs the most attention.
Error events split out by geography, showing which regions are responsible for the highest error volumes.
Sentry has core features that require little configuration.
Each project may have a dev, staging, and production environment associated with it. Sentry provides a top-level filter for each environment within a project.
Alert rules can also be specified based on environment.
Breadcrumbs are the actions a user took before encountering an error. Breadcrumbs are useful when you need to reproduce an error as part of the debugging process.
They can be customized with rich structured data and added whenever something interesting happens. For instance, it might make sense to record a breadcrumb if the user authenticates or another state change happens.
Set-up any of our global issue management integrations once and any project in your Sentry organization will be able to link Sentry issues to your third-party provider.
Sentry’s Slack integration is global to your Sentry organization and only needs to be set-up once. After it’s set-up, you can send issue notifications to different Slack channels and assign or resolve issues from directly within Slack.
For more information, read more about the integration’s potential here.
You can save searches in Sentry for quick reference to common queries you use. Saved searches are configurable so your entire organization can access them or you can save them to your own personal view. For example, you may want to save a search on issues that need triaging. It’s also possible to set a default search.
Manage your issues by taking action on them in one of four ways:
Surfacing context in your SDK configuration is a great first step to increasing visibility for all of the exceptions that come in to Sentry. By doing this, you can expose important pieces of metadata related to different parts of your application. As such, the suggestions below will enable your team to triage and prioritize issues in Sentry more effectively.