Skip to content

Commit 0fba2d6

Browse files
coolguyzoneAlex Krawiecsfanahata
authored
Add data enrichment page to new onboarding guide (#13508)
<!-- 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 9c5a9cd commit 0fba2d6

File tree

2 files changed

+53
-0
lines changed

2 files changed

+53
-0
lines changed
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
---
2+
title: Data Enrichment
3+
description: "Instrument the data you send to Sentry for easier grouping and filtering."
4+
sidebar_order: 5000
5+
---
6+
7+
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.
8+
9+
## Step 1: Enriching Your Event Data
10+
11+
### Adding Custom Context
12+
13+
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:
14+
15+
<Arcade src="https://demo.arcade.software/M87cMrcak4N6SLyUiI1D?embed" />
16+
17+
## Step 2: Ensure Your Traces Are Instrumented Properly
18+
19+
### Verify That Sentry's Tracing Auto-Instrumentation is Set Up Optimally
20+
21+
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.
22+
23+
<Alert>
24+
Learn how [Sentry helps create actionable insights](/product/sentry-basics/performance-monitoring/#ways-to-monitor-performance-in-sentry) from your performance data.
25+
</Alert>
26+
27+
### Custom Instrumentation For Any Additional Performance Metrics
28+
29+
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.
30+
31+
The video below is an example of what's possible with custom instrumentation:
32+
33+
<iframe src="https://drive.google.com/file/d/1U2of7oByT1ECdprvRRC30QwuZwQRk6cA/preview" width="640" height="480" allow="autoplay"></iframe>
34+
35+
## Step 3: Filtering Unwanted events
36+
37+
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/):
38+
39+
<Arcade src="https://demo.arcade.software/4utB0eYW8Uz81WTT84FL?embed" />
40+
<div style={{marginBottom:'40px'}}></div>
41+
42+
<Alert>
43+
Transactions/spans must be filtered out using `beforeSendSpan` and/or `beforeSendTransaction` [within the SDK](/platform-redirect?next=/configuration/filtering/#using-before-send).
44+
</Alert>
45+
46+
## Step 4: Grouping Your issues
47+
48+
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/).
49+

docs/product/onboarding/index.mdx

+4
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ description: "An easy onboarding guide for Sentry."
44
sidebar_order: 4000
55
---
66

7+
78
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.
89

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

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

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

2325

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

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

30+
2831
## Step 2: Get your team on Sentry by implementing SSO or SCIM - For New organizations
2932

3033

34+
3135
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/)).
3236

3337
## Step 3: integrations

0 commit comments

Comments
 (0)