-
-
Notifications
You must be signed in to change notification settings - Fork 1.6k
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
Changes from all commits
Commits
Show all changes
11 commits
Select commit
Hold shift + click to select a range
6bdc912
Add first onboarding guide to docs
9ef5c3d
Fix typo in link causing 404
cba8ecc
Add minor copy edits after discussion with stakeholder
5a29367
Start work on data enrichment page
092f3a2
Remove code comment
1f8bcbb
Fix broken links
6b25063
Remove unrelated change
db16670
Update with description
fb321f1
Update docs/product/onboarding/data-enrichment.mdx
coolguyzone c024832
Add leading slash to link
coolguyzone e9c1f80
Merge branch 'master' into ob-data
coolguyzone File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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> | ||
|
||
## 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/). | ||
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
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."