Skip to content

Commit ee0314e

Browse files
committed
Merge branch 'feat/python-docs-improvement-clean' of https://github.com/getsentry/sentry-docs into feat/python-docs-improvement-clean
* 'feat/python-docs-improvement-clean' of https://github.com/getsentry/sentry-docs: docs(replay): Bring replay nav item to all apple platforms (#14710) User Feedback Basics Page (#14670) Update AM3 and legacy billing for logs GA, DO NOT MERGE BEFORE LOGS GA (#14589) Add LLMSteering component for hidden documentation instructions (#14744) New data retention policy page (#14661) Adding error prediction to Prevent AI docs (#14641)
2 parents d99feb3 + 97c5e58 commit ee0314e

File tree

18 files changed

+386
-50
lines changed

18 files changed

+386
-50
lines changed

docs/platforms/apple/guides/ios/session-replay/customredact.mdx renamed to docs/platforms/apple/common/session-replay/customredact.mdx

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,21 @@
11
---
22
title: Using Custom Masking for Session Replay
33
sidebar_order: 5501
4-
notSupported:
54
description: "Learn how to mask parts of your app's data in Session Replay."
5+
notSupported:
6+
- apple.macos
7+
- apple.watchos
8+
- apple.tvos
9+
- apple.visionos
610
---
711

12+
<PlatformSection notSupported={["apple.ios"]}>
13+
14+
<Include name="apple-session-replay-support-alert" />
15+
16+
</PlatformSection>
17+
18+
<PlatformSection notSupported={["apple", "apple.macos", "apple.tvos", "apple.watchos", "apple.visionos"]}>
819
<Alert>
920

1021
Before enabling Session Replay in production, verify your masking configuration to ensure no sensitive data is captured. Our default settings aggressively mask potentially sensitive data, but if you modify these settings or update UI frameworks or system SDKs, you must thoroughly test your application. If you find any masking issues or sensitive data that should be masked but isn't, please [create a GitHub issue](https://github.com/getsentry/sentry-cocoa/issues/new/choose) and avoid deploying to production with Session Replay enabled until the issue is resolved.
@@ -112,3 +123,5 @@ struct ContentView_Previews: PreviewProvider {
112123
}
113124
}
114125
```
126+
127+
</PlatformSection>

docs/platforms/apple/guides/ios/session-replay/index.mdx renamed to docs/platforms/apple/common/session-replay/index.mdx

Lines changed: 10 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,18 @@
22
title: Set Up Session Replay
33
sidebar_title: Session Replay
44
sidebar_order: 5500
5-
notSupported:
65
description: "Learn how to enable Session Replay in your mobile app."
6+
notSupported:
77
---
88

9+
<PlatformSection notSupported={["apple.ios"]}>
10+
11+
<Include name="apple-session-replay-support-alert" />
12+
13+
</PlatformSection>
14+
15+
<PlatformSection notSupported={["apple", "apple.macos", "apple.tvos", "apple.watchos", "apple.visionos"]}>
16+
917
<Alert level="warning">
1018

1119
Before enabling Session Replay in production, verify your masking configuration to ensure no sensitive data is captured. Our default settings aggressively mask potentially sensitive data, but if you modify these settings or update UI frameworks or system SDKs, you must thoroughly test your application. If you find any masking issues or sensitive data that should be masked but isn't, please [create a GitHub issue](https://github.com/getsentry/sentry-cocoa/issues/new/choose) and avoid deploying to production with Session Replay enabled until the issue is resolved.
@@ -105,24 +113,4 @@ Errors that happen while a replay is running will be linked to the replay, makin
105113
- The replay was deleted by a member of your org.
106114
- There were network errors and the replay wasn't saved.
107115

108-
## FAQ
109-
110-
Q: **Does Session Replay work with SwiftUI?**
111-
112-
A: Yes. It works with both UIKit and SwiftUI.
113-
114-
Q: **Why are parts of my replay not masked?**
115-
116-
A: Text views, input views, images, video players and webviews are all masked by default. Images with bundled assets aren't masked because the likelihood of these assets containing PII is low. If you encounter a view that should be masked by default, consider opening a [GitHub issue](https://github.com/getsentry/sentry-cocoa/issues).
117-
118-
Q: **What's the lowest version of iOS supported?**
119-
120-
A: Session Replay recording happens even on the lowest version supported by the Sentry SDK, which is aligend with appstore support.
121-
122-
Q: **Why is my issue missing a replay?**
123-
124-
A: An issue may be missing a replay because the user's device was [offline](/product/explore/session-replay/mobile#frequently-asked-questions) while `sessionSampleRate` was specified, your project/organization was rate-limited, or (in rare cases) the device failed to capture the replay video.
125-
126-
Q: **Does Session Replay work on macOS, watchOS, tvOS and visionOS?**
127-
128-
A: We don't actively prevent you from using Session Replay on these platforms, but we only officially support it on iOS. As a consequence, we can't make guarantees about its functionality and performance on other platforms.
116+
</PlatformSection>

docs/platforms/apple/guides/ios/session-replay/performance-overhead.mdx renamed to docs/platforms/apple/common/session-replay/performance-overhead.mdx

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,22 @@
11
---
22
title: Performance Overhead
33
sidebar_order: 5502
4-
notSupported:
54
description: "Learn about how enabling Session Replay impacts the performance of your application."
5+
notSupported:
6+
- apple.macos
7+
- apple.watchos
8+
- apple.tvos
9+
- apple.visionos
610
---
711

12+
<PlatformSection notSupported={["apple.ios"]}>
13+
14+
<Include name="apple-session-replay-support-alert" />
15+
16+
</PlatformSection>
17+
18+
<PlatformSection notSupported={["apple", "apple.macos", "apple.tvos", "apple.watchos", "apple.visionos"]}>
19+
820
If you're considering enabling Session Replay, it's important to first understand the potential performance impact to your app. While accurate metrics require realistic testing where you apply typical access patterns and correlate the results with your business metrics, to provide a baseline, we measured the overhead using the open-source [Pocket Casts](https://github.com/Automattic/pocket-casts-ios) app.
921

1022
You can learn more about the various performance overhead optimizations implemented in the iOS Replay SDK in the [Replay Performance Overhead](/product/explore/session-replay/mobile/performance-overhead/) docs.
@@ -78,3 +90,5 @@ SentrySDK.start(configureOptions: { options in
7890
The old view renderer will be deprecated and removed in a future release.
7991

8092
</Alert>
93+
94+
</PlatformSection>

docs/platforms/apple/guides/ios/session-replay/troubleshooting.mdx renamed to docs/platforms/apple/common/session-replay/troubleshooting.mdx

Lines changed: 45 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,52 @@
11
---
22
title: Troubleshooting
33
sidebar_order: 5503
4-
notSupported:
54
description: "Troubleshoot and resolve common issues with the iOS Session Replay."
5+
notSupported:
6+
- apple.macos
7+
- apple.watchos
8+
- apple.tvos
9+
- apple.visionos
610
---
711

12+
<PlatformSection notSupported={["apple.ios"]}>
13+
14+
<Include name="apple-session-replay-support-alert" />
15+
16+
</PlatformSection>
17+
18+
<PlatformSection notSupported={["apple", "apple.macos", "apple.tvos", "apple.watchos", "apple.visionos"]}>
19+
20+
<Expandable title="Does Session Replay work with UIKit, SwiftUI or AppKit?" permalink>
21+
22+
Session Replay works with both UIKit and SwiftUI.
23+
24+
</Expandable>
25+
26+
<Expandable title="Does Session Replay work on macOS, watchOS, tvOS and visionOS?" permalink>
27+
28+
We don't actively prevent you from using Session Replay on these platforms, but we only officially [support it on iOS](/platforms/apple/guides/ios/session-replay/). As a consequence, we can't make guarantees about its functionality and performance on other platforms.
29+
30+
</Expandable>
31+
32+
<Expandable title="Why are parts of my replay not masked?" permalink>
33+
34+
Text views, input views, images, video players and webviews are all masked by default. Images with bundled assets aren't masked because the likelihood of these assets containing PII is low. If you encounter a view that should be masked by default, consider opening a [GitHub issue](https://github.com/getsentry/sentry-cocoa/issues).
35+
36+
</Expandable>
37+
38+
<Expandable title="What's the lowest version of iOS supported?" permalink>
39+
40+
Session Replay recording happens even on the lowest version supported by the Sentry SDK, which is aligend with appstore support.
41+
42+
</Expandable>
43+
44+
<Expandable title="Why is my issue missing a replay?" permalink>
45+
46+
An issue may be missing a replay because the user's device was [offline](/product/explore/session-replay/mobile#frequently-asked-questions) while `sessionSampleRate` was specified, your project/organization was rate-limited, or (in rare cases) the device failed to capture the replay video.
47+
48+
</Expandable>
49+
850
<Expandable title="AVFoundation views and layers are not rendered" permalink>
951

1052
Session Replay currently cannot capture content from AVFoundation views and layers. This includes:
@@ -87,3 +129,5 @@ final class SceneDelegate: NSObject, UIWindowSceneDelegate {
87129
```
88130

89131
</Expandable>
132+
133+
</PlatformSection>

docs/pricing/index.mdx

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,8 @@ This page gives you an in-depth understanding of our pricing and billing structu
3131
We bill based on the amount of data processed. Each [paid plan](https://sentry.io/pricing/) comes with the below pre-set monthly event volume, which is included in the price:
3232

3333
- 50k errors
34-
- 10M spans
34+
- 5GB logs
35+
- 5M spans
3536
- 50 replays
3637
- 1 uptime monitor
3738
- 1 cron monitor
@@ -66,13 +67,21 @@ Please note that all per-category prices listed below have been rounded.
6667
| >10M-20M | $0.0001300 | $0.0001625 | $0.0002600 | $0.0003250 |
6768
| >20M | $0.0001200 | $0.0001500 | $0.0002400 | $0.0003000 |
6869

70+
#### Logs Pricing
71+
72+
All Sentry plans include 5GB of logs. Additional usage can only be purchased with your PAYG budget.
73+
74+
| Team PAYG | Business PAYG |
75+
| ------------ | ------------- |
76+
| $0.50/GB | $0.50/GB |
77+
6978
#### Tracing Pricing
7079

7180
Tracing is enabled by and will be billed for in spans.
7281

7382
| Span Volume | Team Reserved | Team PAYG | Business Reserved | Business PAYG |
7483
| ----------- | ------------- | ---------- | ----------------- | ------------- |
75-
| >10M-100M | $0.0000016 | $0.0000020 | $0.0000032 | $0.0000040 |
84+
| >5M-100M | $0.0000016 | $0.0000020 | $0.0000032 | $0.0000040 |
7685
| >100M | $0.0000014 | $0.0000018 | $0.0000029 | $0.0000036 |
7786

7887
#### Replays Pricing

docs/pricing/legacy-pricing.mdx

Lines changed: 47 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -25,13 +25,13 @@ We bill based on the amount of data you want us to process. Our [Developer, Team
2525
On top of that, you can choose to pay for a set, prepaid volume of additional data at a discounted price. You can also set aside an on-demand budget to cover potential overages, which will only be used once the prepaid budget has run out.
2626

2727
- **Prepaid volume:** A predetermined amount of data you pay for in advance at a discount, on a monthly or annual basis.
28-
- **On-demand volume** An overage budget that kicks in only if your prepaid volume has been used up. Having this makes it possible to control the maximum amount you will spend for overages each month.
28+
- **On-demand volume** An overage budget that kicks in only if your prepaid volume has been used up. Having this makes it possible to control the maximum amount you will spend for overages each month (on new plans we call this Pay-As-You-Go or PAYG pricing).
2929

3030
If you run out of **both** your prepaid and on-demand volume, any new data you send will be rejected and you won't be charged for it.
3131

3232
### Per-Category Pricing
3333

34-
If you'd like to buy either prepaid or on-demand data on top of what's included in your plan, you can buy as much as you think you'll need per data category. [Errors](#errors-pricing), [Performance and Profiling](#performance-and-profiling-pricing), [Replays](#replays-pricing), [Cron Monitors](#cron-monitors-pricing), [Uptime Monitors](#uptime-monitors-pricing), and [Attachments](#attachments-pricing) each have their own unique pricing structures, as listed in the tables below:
34+
You can either buy prepaid volumes on select data categories or set an on-demand budget on top of what is included in your plan. [Errors](#errors-pricing), [Logs](#logs-pricing), [Performance and Profiling](#performance-and-profiling-pricing), [Replays](#replays-pricing), [Cron Monitors](#cron-monitors-pricing), [Uptime Monitors](#uptime-monitors-pricing), and [Attachments](#attachments-pricing) each have their own unique pricing structures, as listed in the tables below:
3535

3636
<Alert>
3737

@@ -52,6 +52,14 @@ Please note that all per-category prices listed below have been rounded to the n
5252
| >10M-20M | $0.000130 | $0.000169 | $0.000251 | $0.000326 |
5353
| >20M-50M | $0.000120 | $0.000156 | $0.000144 | $0.000187 |
5454

55+
#### Logs Pricing
56+
57+
All plans include 5GB of logs. Additional usage can only be purchased with your shared on-demand budget.
58+
59+
| Volume | Team/Business On-Demand |
60+
| ------------ | ----------------------- |
61+
| >5GB | $0.50/GB |
62+
5563
#### Performance and Profiling Pricing
5664

5765
Performance Units can be used towards multiple Performance event types, depending on what you've enabled:
@@ -89,15 +97,15 @@ Profile hours are determined by the length of the profile in milliseconds and is
8997

9098
**Continuous Profile Hours**
9199

92-
| Team On-Demand | Business On-Demand |
93-
| ------------ | ------------- |
94-
| $0.0315/hour | $0.0315/hour |
100+
| Team/Business On-Demand |
101+
| ----------------------- |
102+
| $0.0315/hour |
95103

96104
**UI Profile Hours**
97105

98-
| Team On-Demand | Business On-Demand |
99-
| ---------- | ------------- |
100-
| $0.25/hour | $0.25/hour |
106+
| Team/Business On-Demand |
107+
| ----------------------- |
108+
| $0.25/hour |
101109

102110
#### Replays Pricing
103111

@@ -136,6 +144,31 @@ Monitors for Uptime can't be purchased in advance. Uptime monitors are available
136144

137145
{/* <!-- prettier-ignore-end --> */}
138146

147+
#### Seer Pricing
148+
149+
[Seer](/product/ai-in-sentry/seer/) is Sentry's AI agent that triages, debugs, and fixes application issues automatically. Access Seer by adding it to your existing subscription for an additional $20 per month. This $20 gives you $25 worth of Seer event credits, which can be used for any combination of [Issue Scans](/pricing/#issue-scans) or [Issue Fixes](/pricing/#issue-fixes) (see pricing tables below). Any usage beyond this $25 credit will draw from your [on-demand budget](/pricing/#terminology).
150+
151+
#### Issue Scans
152+
153+
Issue Scan automatically classifies and triages issues to determine which are the most likely to be fixable with a code change. Issue Scans are billed per run.
154+
155+
| Issue Scans Volume | Team/Business On-Demand |
156+
| ------------------ | ----------------------- |
157+
| >0-10k | $0.0030000 |
158+
| >10k-100k | $0.0027000 |
159+
| >100k-500k | $0.0024300 |
160+
| >500k | $0.0021870 |
161+
162+
#### Issue Fixes
163+
164+
Issue Fix performs a deep root cause analysis of an issue, using all of the context that is available to Sentry, generating a code fix, and opening a pull request in GitHub.
165+
166+
Issue Fixes are billed per run. Interactions with the same run will only be billed once; restarting a run with the "Start Over" button will be billed as a separate run.
167+
168+
| Team/Business On-Demand |
169+
| ----------------------- |
170+
| $1.00/run |
171+
139172
#### Consolidated Pricing
140173

141174
If the amount of prepaid data you want to buy falls in between increments, you may want to consider setting an on-demand budget instead, since on-demand is set in dollar amounts rather than data volume.
@@ -154,7 +187,7 @@ Your volume is the total number of events and attachments — or the total amoun
154187

155188
When you buy reserved volume (or quota), you prepay for data at significant discounts. Your prepaid, reserved volume can be allocated on either a pooled basis between projects, or, if you have [Spend Allocation](/pricing/quotas/spend-allocation/) enabled, it can be set on both a pooled and a per-project basis. Unused reserved volume expires at the end of each billing month.
156189

157-
Each Sentry plan includes different amounts of reserved volume. For example, our Team plan includes a minimum of 50k errors, 100k performance units, 500 replays, 1 cron monitor, 1 uptime monitor, and 1GB of attachments per month. To see prepaid pricing for each plan, check out our [per-category-pricing](#per-category-pricing).
190+
Each Sentry plan includes different amounts of reserved volume. For example, our Team plan includes a minimum of 50k errors, 5GB logs, 100k performance units, 500 replays, 1 cron monitor, 1 uptime monitor, and 1GB of attachments per month. To see prepaid pricing for each plan, check out our [per-category-pricing](#per-category-pricing).
158191

159192
### On-Demand Volume
160193

@@ -174,12 +207,16 @@ On-demand volume is billed at the end of each billing month. To see on-demand pr
174207

175208
Organizations on all plans have the option to set a shared on-demand strategy. Organizations on plans with [Insights](/product/insights/) features have the ability to choose between a shared or per-category on-demand strategy:
176209

177-
- **Shared:** Your on-demand budget is shared between all categories on a first come, first serve basis. There are no restrictions for any single category consuming the entire budget.
210+
- **Shared:** (default) Your on-demand budget is shared between all categories on a first come, first serve basis. There are no restrictions for any single category consuming the entire budget.
178211

179212
- **Per-category:** Your on-demand budgets for categories such as errors, transactions, and replays, are set up individually so that any overages in one category won't consume the budget of another category.
180213

181214
![On-Demand Budgets settings in Subscriptions](./img/on-demand-budgets.png)
182215

216+
<Alert>
217+
Seer and logs are only available through a shared on-demand budget.
218+
</Alert>
219+
183220
### Changing Plans Mid-cycle
184221

185222
If you decide to increase your on-demand budget mid-month, Sentry will start processing additional data as soon as the increase becomes effective.
@@ -297,8 +334,6 @@ All Canadian federal and provincial taxes will be calculated based on billing ad
297334

298335
In the European Union (EU) and United Kingdom (UK), in accordance with EU VAT and UK VAT legislation respectively, VAT will be applied only to orders where exemption documentation or a valid VAT ID has not been supplied prior to or at the time of payment.
299336

300-
The VAT in other countries such as Switzerland, South Africa, and Russia is applicable on all taxable sales where valid exemption documentation has not been provided to Sentry prior to payment.
301-
302337
### B2B and B2C Taxation - Differences
303338

304339
Internationally, sales tax rules differ based on whether the customer is business-to-business (B2B) or business-to-consumer (B2C). In most countries, B2C sales are taxable, while B2B customers are not charged sales tax at the point of sale, but self-assess when they file their returns.

0 commit comments

Comments
 (0)