Skip to content

Commit 0bc1af8

Browse files
authored
docs(tanstackstart): Add alpha notice (#14380)
## DESCRIBE YOUR PR Add alpha notice and information about not auto-capturing errors on the server-side. ## 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 --> - [ ] Other deadline: <!-- ENTER DATE HERE --> - [ ] 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)
1 parent cc85e57 commit 0bc1af8

File tree

1 file changed

+18
-3
lines changed
  • docs/platforms/javascript/guides/tanstackstart-react

1 file changed

+18
-3
lines changed

docs/platforms/javascript/guides/tanstackstart-react/index.mdx

Lines changed: 18 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,17 @@ title: TanStack Start React
33
description: "Learn how to set up and configure Sentry in your TanStack Start React application, capturing your first errors, and viewing them in Sentry."
44
---
55

6+
<Alert>
7+
8+
This SDK is currently in **ALPHA**. Alpha features are still in progress, may have bugs and might include breaking changes.
9+
Please reach out on [GitHub](https://github.com/getsentry/sentry-javascript/issues/new/choose) if you have any feedback or concerns.
10+
This SDK is for [TanStack Start (React)](https://tanstack.com/start/latest/docs/framework/react/overview), for
11+
using [TanStack Router (React)](https://tanstack.com/router/latest/docs/framework/react/overview) see our React docs for
12+
[TanStack Router](/platforms/javascript/guides/react/features/tanstack-router).
13+
14+
</Alert>
15+
16+
617
<PlatformContent includePath="getting-started-prerequisites" />
718

819
## Step 1: Install
@@ -44,11 +55,11 @@ const router = createRouter();
4455

4556
Sentry.init({
4657
dsn: "___PUBLIC_DSN___",
47-
58+
4859
// Adds request headers and IP for users, for more info visit:
4960
// https://docs.sentry.io/platforms/javascript/guides/tanstackstart-react/configuration/options/#sendDefaultPii
5061
sendDefaultPii: true,
51-
62+
5263
integrations: [
5364
// ___PRODUCT_OPTION_START___ performance
5465
Sentry.tanstackRouterBrowserTracingIntegration(router),
@@ -96,7 +107,7 @@ import * as Sentry from "@sentry/tanstackstart-react";
96107

97108
Sentry.init({
98109
dsn: "___PUBLIC_DSN___",
99-
110+
100111
// Adds request headers and IP for users, for more info visit:
101112
// https://docs.sentry.io/platforms/javascript/guides/tanstackstart-react/configuration/options/#sendDefaultPii
102113
sendDefaultPii: true,
@@ -171,6 +182,10 @@ registerGlobalMiddleware({
171182

172183
### Capture Errors in your Error Boundaries and Components
173184

185+
<Alert level="info">
186+
Automatic error monitoring is not yet supported on the on the server-side of TanStack Start. Use `captureException` to manually capture errors in your server-side code.
187+
</Alert>
188+
174189
The Sentry SDK cannot capture errors that you manually caught yourself with error boundaries.
175190

176191
If you have React error boundaries in your app and you want to report errors that these boundaries catch to Sentry, apply the [`withErrorBoundary` wrapper](/platforms/javascript/guides/react/features/error-boundary/) to your `ErrorBoundary`:

0 commit comments

Comments
 (0)