Skip to content

Commit c4dd30d

Browse files
Alex KrawiecAlex Krawiec
authored andcommitted
Add an overview of sample rates
1 parent 894cd1c commit c4dd30d

File tree

1 file changed

+22
-4
lines changed

1 file changed

+22
-4
lines changed

docs/concepts/key-terms/sample-rates.mdx

Lines changed: 22 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,23 +4,41 @@ sidebar_order: 11
44
description: Learn how to manage the amount of data you send and are billed for in Sentry by adjusting the sample rates of various Sentry products including Traces and Session Replays.
55
---
66

7+
## Overview
8+
9+
### What Is a Sample Rate?
10+
11+
Adding Sentry to your app gives you a lot of valuable information about errors and performance you wouldn't otherwise get. And lots of information is good -- as long as it's the right information, at a reasonable volume. You can use sample rates to capture only a specified percentage of events like errors and traces.
12+
13+
14+
### Why Not Capture All Events?
15+
16+
We recommend sampling your transactions for two reasons:
17+
18+
1. Capturing a single trace involves minimal overhead, but capturing traces for every page load or every API request may add an undesirable load to your system.
19+
20+
1. Enabling sampling allows you to better manage the number of events sent to Sentry, so you can tailor your volume to your organization's needs and budget.
21+
22+
Choose a sampling rate with the goal of finding a balance between performance and volume concerns with data accuracy. You don't want to collect too much data, but you want to collect sufficient data from which to draw meaningful conclusions. If you’re not sure what rate to choose, start with a low value and gradually increase it as you learn more about your traffic patterns and volume.
23+
24+
## Sampling Rate Options
25+
726
<Note>
827
Some of the options below aren't available in every SDK; check out our platform-specific docs for more info.
928
</Note>
1029

11-
## Error Events
30+
### Error Events
1231

1332
- **SampleRate** - Configures the sample rate for error events, in the range of 0.0 to 1.0. The default is 1.0, which means that 100% of error events will be sent. If set to 0.1, only 10% of error events will be sent. Events are picked randomly.
1433

15-
## Tracing
34+
### Tracing
1635

1736
- **tracesSampleRate** - A number between 0 and 1, controlling the percentage chance a given transaction will be sent to Sentry. (0 represents 0% while 1 represents 100%.) Applies equally to all transactions created in the app. Either this or `tracesSampler` must be defined to enable tracing.
1837

1938
- **tracesSampler** - A function responsible for determining the percentage chance a given transaction will be sent to Sentry. It will automatically be passed information about the transaction and the context in which it's being created, and must return a number between 0 (0% chance of being sent) and 1 (100% chance of being sent). Can also be used for filtering transactions, by returning 0 for those that are unwanted. Either this or `tracesSampleRate` must be defined to enable tracing.
2039

21-
## Session Replay
40+
### Session Replay
2241

2342
- **replaysSessionSampleRate** - The sample rate for replays that begin recording immediately and last the entirety of the user's session. 1.0 collects all replays, and 0 collects none.
2443

2544
- **replaysOnErrorSampleRate** - The sample rate for replays that are recorded when an error happens. This type of replay will record up to a minute of events prior to the error and continue recording until the session ends. 1.0 captures all sessions with an error, and 0 captures none.
26-

0 commit comments

Comments
 (0)