Skip to content

Add data enrichment page to new onboarding guide #13508

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 11 commits into from
Apr 29, 2025
Merged
Show file tree
Hide file tree
Changes from all 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
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). 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.

## 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>
Copy link
Contributor

Choose a reason for hiding this comment

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

This is rendering as blocked in the preview: "This content is blocked. Contact the site owner to fix the issue."


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

4 changes: 4 additions & 0 deletions docs/product/onboarding/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ 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 and SSO/SCIM configuration. 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.

## Step 1: Initial Project Creation and Configuration
Expand All @@ -18,16 +19,19 @@ By the end of this step, you'll have enabled a few features, mapped data into Se

<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: Get your team on Sentry by 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
Expand Down