Skip to content

Commit 2ec2465

Browse files
authored
fix transaction quota management content (#5114)
* added inbound filters to transaction quota mgmt, removed beforeSend, and fixed inbound filter reference on quotas index page * fixed typo
1 parent 407365f commit 2ec2465

File tree

2 files changed

+16
-12
lines changed

2 files changed

+16
-12
lines changed

src/docs/product/accounts/quotas/index.mdx

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -39,11 +39,11 @@ Sentry completes a thorough evaluation of each event to determine if it counts t
3939

4040
4. **Event repetition**
4141

42-
Event repetition only applies to error events, not transactions or attachments. The following rules apply for event repetition and your quota:
42+
Event repetition only applies to error events, not transactions or attachments. The following rules apply for event repetition and your quota:
4343

44-
- If you have chosen to "Delete & Discard" an issue, then _future_ error events with the same fingerprint do not count toward your quota.
45-
- If you previously resolved an issue, a new error event counts toward your quota because it may represent a regression in your code.
46-
- If you have chosen to ignore alerts about error events with the same fingerprint, a new event counts toward your quota because the event is still occurring. Learn more in [Inbound Filters](#inbound-data-filters).
44+
- If you have chosen to "Delete & Discard" an issue, then _future_ error events with the same fingerprint do not count toward your quota.
45+
- If you previously resolved an issue, a new error event counts toward your quota because it may represent a regression in your code.
46+
- If you have chosen to ignore alerts about error events with the same fingerprint, a new event counts toward your quota because the event is still occurring. Learn more in [Inbound Filters](#inbound-data-filters).
4747

4848
5. **Spike protection**
4949

@@ -57,7 +57,7 @@ In addition, depending on your project’s configuration and the plan you subscr
5757

5858
7. **Inbound filters**
5959

60-
If any inbound filter is set for a type of error event, and your subscription allows, the event will not be counted. Learn more in the [Inbound Filters section of our error quota management guide](/product/accounts/quotas/manage-event-stream-guide/#3-inbound-data-filters) or in [Inbound Data Filter](#inbound-data-filters). This does not apply to transactions or attachments.
60+
If any inbound filter is set for a type of event or attachment, and your subscription allows, the event or attachment won't be counted. Learn more in [Inbound Data Filters](#inbound-data-filters).
6161

6262
After these checks are processed, the event counts toward your quota. It is accepted into Sentry, where it persists and is stored.
6363

@@ -194,7 +194,7 @@ Per-key rate limits allow you to set the maximum volume of error events a key wi
194194

195195
For example, you may have a project in production that generates a lot of noise. A rate limit allows you to set the maximum amount of data to “500 events per minute”. Additionally, you can create a second key for the same project for your staging environment, which is unlimited, ensuring your QA process is still untouched.
196196

197-
To set up rate limits, navigate to **[Project] > Settings > Client Keys** and click "Configure"**". Select an individual key or create a new one, then you’ll be able to define a rate limit as well as view a breakdown of events received by that key. For additional information and examples, see [Rate Limiting in our guide to managing your error quota](/product/accounts/quotas/manage-event-stream-guide/#6-rate-limiting).
197+
To set up rate limits, navigate to **[Project] > Settings > Client Keys** and click "Configure"\*\*". Select an individual key or create a new one, then you’ll be able to define a rate limit as well as view a breakdown of events received by that key. For additional information and examples, see [Rate Limiting in our guide to managing your error quota](/product/accounts/quotas/manage-event-stream-guide/#6-rate-limiting).
198198

199199
<Note>
200200

@@ -220,7 +220,7 @@ Inbound filters include:
220220
- From specific release versions of your code
221221
- From certain IP addresses.
222222

223-
Explore these by navigating to **[Project] > Settings > Inbound Filters**. Commonly-set filters are discussed here for your quick reference. For additional information and examples, see [Inbound Data Filters in our guide to managing your error quota](/product/accounts/quotas/manage-event-stream-guide/#3-inbound-data-filters). Commonly-set filters include:
223+
Explore these by navigating to **[Project] > Settings > Inbound Filters**.
224224

225225
### IP Filters
226226

@@ -290,7 +290,7 @@ The 24-hour window ends at the beginning of the current hour, not at the current
290290

291291
This means if you experience a spike, we'll temporarily protect you, but if the increase in volume is sustained, the spike protection limit will gradually **increase until Sentry accepts all events**.
292292

293-
For example, in the last 24 hours, your organization has been receiving, on average, 10 events per minute (after any inbound filters have been applied). That means your current per-minute limit is 6 * 10 or 60 events. There have been no spikes in that time, so spike control is "inactive". Something breaks, and in the next minute, your organization sends Sentry 100 events. When we see the 61st event, three things happen:
293+
For example, in the last 24 hours, your organization has been receiving, on average, 10 events per minute (after any inbound filters have been applied). That means your current per-minute limit is 6 \* 10 or 60 events. There have been no spikes in that time, so spike control is "inactive". Something breaks, and in the next minute, your organization sends Sentry 100 events. When we see the 61st event, three things happen:
294294

295295
1. Spike protection becomes "active".
296296

src/docs/product/accounts/quotas/manage-transaction-quota.mdx

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,17 @@ description: "Learn how to use the tools Sentry provides to control the type and
77

88
In most cases, sending all [transaction](/product/performance/transaction-summary/#what-is-a-transaction) events to Sentry would generate more performance data than you might find useful and might use up your transactions quota too quickly. Sentry provides tools to control the _type_ and _amount_ of transactions that are monitored. This allows you to have transaction data that's actionable and meaningful, and to manage your quota. Applying the proper SDK configuration is an iterative and on-going process, but these tips will show you how to best use Sentry's tools to get the most out of your transaction events.
99

10-
## 1. SDK Filtering: beforeSend
10+
## 1. SDK Configuration: Tracing Options {#2-sdk-configuration-tracing-options}
1111

12-
All Sentry SDKs support the `beforeSend` callback method. Once implemented, the method is invoked when the SDK captures an event, right before sending it to your Sentry account. It receives the event object as a parameter, so you can use that to modify the event's data or drop it completely (by returning `null`) based on your custom logic and the data available on the event, like _tags_, _environment_, _release version_, and so on. Learn more in [Filtering Events](/platform-redirect/?next=/configuration/filtering/).
12+
When you configure your the SDK, you can control the number of transactions that are sent to Sentry by setting the [tracing options](/platform-redirect/?next=/configuration/options/%23tracing-options). You can also set up [custom instrumentation](/platform-redirect/?next=/performance/instrumentation/custom-instrumentation/) for performance monitoring to capture certain types of transactions.
1313

14-
## 2. SDK Configuration: Tracing Options
14+
## 2. Inbound Data Filters
1515

16-
When you configure your the SDK, you can control the number of transactions that are sent to Sentry by setting the [tracing options](/platform-redirect/?next=/configuration/options/%23tracing-options). You can also set up [custom instrumentation](/platform-redirect/?next=/performance/instrumentation/custom-instrumentation/) for performance monitoring to capture certain types of transactions.
16+
While SDK configuration requires changes to your source code and depends on your next deployment, server-side filters can be easily configured per project in the "Data Filters" section of **[Project] > Settings > Inbound Filters**. Learn more in [Inbound Filters](/product/accounts/quotas/#inbound-data-filters).
17+
18+
Once applied, you can track the filtered events (numbers and cause) using the graph provided at the top of the "Inbound Filters" page.
19+
20+
![Built-in Inbound Filters](manage-event-stream-03.png)
1721

1822
## 3. Event Usage Stats
1923

0 commit comments

Comments
 (0)