docs(js/react-router): Add setup guide for react router (framework) (#…

…12068)
getsentry · Dec 17, 2024 · 296b1be · 296b1be
1 parent 06a67c1
commit 296b1be
Show file tree

Hide file tree

Showing 50 changed files with 274 additions and 9 deletions.
diff --git a/docs/platforms/javascript/common/configuration/application-not-responding.mdx b/docs/platforms/javascript/common/configuration/application-not-responding.mdx
@@ -19,6 +19,7 @@ supported:
   - javascript.solidstart
   - javascript.sveltekit
   - javascript.remix
+  - javascript.react-router
   - javascript.astro
 keywords:
   [

diff --git a/docs/platforms/javascript/common/configuration/integrations/amqplib.mdx b/docs/platforms/javascript/common/configuration/integrations/amqplib.mdx
@@ -20,6 +20,7 @@ supported:
   - javascript.solidstart
   - javascript.sveltekit
   - javascript.remix
+  - javascript.react-router
   - javascript.astro
   - javascript.bun
 ---

diff --git a/docs/platforms/javascript/common/configuration/integrations/anr.mdx b/docs/platforms/javascript/common/configuration/integrations/anr.mdx
@@ -18,6 +18,7 @@ supported:
   - javascript.solidstart
   - javascript.sveltekit
   - javascript.remix
+  - javascript.react-router
   - javascript.astro
 ---
 

diff --git a/docs/platforms/javascript/common/configuration/integrations/childProcess.mdx b/docs/platforms/javascript/common/configuration/integrations/childProcess.mdx
@@ -17,6 +17,7 @@ supported:
   - javascript.nuxt
   - javascript.sveltekit
   - javascript.remix
+  - javascript.react-router
   - javascript.astro
 ---
 

diff --git a/docs/platforms/javascript/common/configuration/integrations/console.mdx b/docs/platforms/javascript/common/configuration/integrations/console.mdx
@@ -19,6 +19,7 @@ supported:
   - javascript.solidstart
   - javascript.sveltekit
   - javascript.remix
+  - javascript.react-router
   - javascript.astro
   - javascript.bun
   - javascript.deno

diff --git a/docs/platforms/javascript/common/configuration/integrations/dataloader.mdx b/docs/platforms/javascript/common/configuration/integrations/dataloader.mdx
@@ -17,6 +17,7 @@ supported:
   - javascript.nuxt
   - javascript.sveltekit
   - javascript.remix
+  - javascript.react-router
   - javascript.astro
   - javascript.bun
 ---

diff --git a/docs/platforms/javascript/common/configuration/integrations/fs.mdx b/docs/platforms/javascript/common/configuration/integrations/fs.mdx
@@ -17,6 +17,7 @@ supported:
   - javascript.nuxt
   - javascript.sveltekit
   - javascript.remix
+  - javascript.react-router
   - javascript.astro
   - javascript.bun
 ---

diff --git a/docs/platforms/javascript/common/configuration/integrations/genericpool.mdx b/docs/platforms/javascript/common/configuration/integrations/genericpool.mdx
@@ -17,6 +17,7 @@ supported:
   - javascript.nuxt
   - javascript.sveltekit
   - javascript.remix
+  - javascript.react-router
   - javascript.astro
   - javascript.bun
 ---

diff --git a/docs/platforms/javascript/common/configuration/integrations/graphql.mdx b/docs/platforms/javascript/common/configuration/integrations/graphql.mdx
@@ -18,6 +18,7 @@ supported:
   - javascript.solidstart
   - javascript.sveltekit
   - javascript.remix
+  - javascript.react-router
   - javascript.astro
   - javascript.bun
 ---

diff --git a/docs/platforms/javascript/common/configuration/integrations/http.mdx b/docs/platforms/javascript/common/configuration/integrations/http.mdx
@@ -18,6 +18,7 @@ supported:
   - javascript.solidstart
   - javascript.sveltekit
   - javascript.remix
+  - javascript.react-router
   - javascript.astro
   - javascript.bun
 ---

diff --git a/docs/platforms/javascript/common/configuration/integrations/kafka.mdx b/docs/platforms/javascript/common/configuration/integrations/kafka.mdx
@@ -17,6 +17,7 @@ supported:
   - javascript.nuxt
   - javascript.sveltekit
   - javascript.remix
+  - javascript.react-router
   - javascript.astro
   - javascript.bun
 ---

diff --git a/docs/platforms/javascript/common/configuration/integrations/knex.mdx b/docs/platforms/javascript/common/configuration/integrations/knex.mdx
@@ -17,6 +17,7 @@ supported:
   - javascript.nuxt
   - javascript.sveltekit
   - javascript.remix
+  - javascript.react-router
   - javascript.astro
   - javascript.bun
 ---

diff --git a/docs/platforms/javascript/common/configuration/integrations/localvariables.mdx b/docs/platforms/javascript/common/configuration/integrations/localvariables.mdx
@@ -18,6 +18,7 @@ supported:
   - javascript.solidstart
   - javascript.sveltekit
   - javascript.remix
+  - javascript.react-router
   - javascript.astro
   - javascript.bun
   - javascript.cloudflare

diff --git a/docs/platforms/javascript/common/configuration/integrations/lrumemoizer.mdx b/docs/platforms/javascript/common/configuration/integrations/lrumemoizer.mdx
@@ -20,6 +20,7 @@ supported:
   - javascript.solidstart
   - javascript.sveltekit
   - javascript.remix
+  - javascript.react-router
   - javascript.astro
   - javascript.bun
 ---

diff --git a/docs/platforms/javascript/common/configuration/integrations/modules.mdx b/docs/platforms/javascript/common/configuration/integrations/modules.mdx
@@ -18,6 +18,7 @@ supported:
   - javascript.solidstart
   - javascript.sveltekit
   - javascript.remix
+  - javascript.react-router
   - javascript.astro
   - javascript.bun
   - javascript.deno

diff --git a/docs/platforms/javascript/common/configuration/integrations/mongo.mdx b/docs/platforms/javascript/common/configuration/integrations/mongo.mdx
@@ -18,6 +18,7 @@ supported:
   - javascript.solidstart
   - javascript.sveltekit
   - javascript.remix
+  - javascript.react-router
   - javascript.astro
   - javascript.bun
 ---

diff --git a/docs/platforms/javascript/common/configuration/integrations/mongoose.mdx b/docs/platforms/javascript/common/configuration/integrations/mongoose.mdx
@@ -17,6 +17,7 @@ supported:
   - javascript.nuxt
   - javascript.sveltekit
   - javascript.remix
+  - javascript.react-router
   - javascript.astro
   - javascript.bun
 ---

diff --git a/docs/platforms/javascript/common/configuration/integrations/mysql.mdx b/docs/platforms/javascript/common/configuration/integrations/mysql.mdx
@@ -18,6 +18,7 @@ supported:
   - javascript.solidstart
   - javascript.sveltekit
   - javascript.remix
+  - javascript.react-router
   - javascript.astro
   - javascript.bun
 ---

diff --git a/docs/platforms/javascript/common/configuration/integrations/mysql2.mdx b/docs/platforms/javascript/common/configuration/integrations/mysql2.mdx
@@ -18,6 +18,7 @@ supported:
   - javascript.solidstart
   - javascript.sveltekit
   - javascript.remix
+  - javascript.react-router
   - javascript.astro
   - javascript.bun
 ---

diff --git a/docs/platforms/javascript/common/configuration/integrations/nodecontext.mdx b/docs/platforms/javascript/common/configuration/integrations/nodecontext.mdx
@@ -18,6 +18,7 @@ supported:
   - javascript.solidstart
   - javascript.sveltekit
   - javascript.remix
+  - javascript.react-router
   - javascript.astro
   - javascript.bun
 ---

diff --git a/docs/platforms/javascript/common/configuration/integrations/nodefetch.mdx b/docs/platforms/javascript/common/configuration/integrations/nodefetch.mdx
@@ -19,6 +19,7 @@ supported:
   - javascript.solidstart
   - javascript.sveltekit
   - javascript.remix
+  - javascript.react-router
   - javascript.astro
   - javascript.bun
 ---

diff --git a/docs/platforms/javascript/common/configuration/integrations/nodeprofiling.mdx b/docs/platforms/javascript/common/configuration/integrations/nodeprofiling.mdx
@@ -18,6 +18,7 @@ supported:
   - javascript.solidstart
   - javascript.sveltekit
   - javascript.remix
+  - javascript.react-router
   - javascript.astro
 ---
 

diff --git a/.../platforms/javascript/common/configuration/integrations/onuncaughtexception.mdx b/.../platforms/javascript/common/configuration/integrations/onuncaughtexception.mdx
@@ -18,6 +18,7 @@ supported:
   - javascript.solidstart
   - javascript.sveltekit
   - javascript.remix
+  - javascript.react-router
   - javascript.astro
   - javascript.bun
   - javascript.deno

diff --git a/docs/platforms/javascript/common/configuration/integrations/postgres.mdx b/docs/platforms/javascript/common/configuration/integrations/postgres.mdx
@@ -18,6 +18,7 @@ supported:
   - javascript.solidstart
   - javascript.sveltekit
   - javascript.remix
+  - javascript.react-router
   - javascript.astro
   - javascript.bun
 ---

diff --git a/docs/platforms/javascript/common/configuration/integrations/prisma.mdx b/docs/platforms/javascript/common/configuration/integrations/prisma.mdx
@@ -17,6 +17,7 @@ supported:
   - javascript.solidstart
   - javascript.sveltekit
   - javascript.remix
+  - javascript.react-router
   - javascript.astro
   - javascript.bun
 ---

diff --git a/...forms/javascript/common/configuration/integrations/processThreadsBreadcrumb.mdx b/...forms/javascript/common/configuration/integrations/processThreadsBreadcrumb.mdx
@@ -17,6 +17,7 @@ supported:
   - javascript.nuxt
   - javascript.sveltekit
   - javascript.remix
+  - javascript.react-router
   - javascript.astro
 ---
 

diff --git a/docs/platforms/javascript/common/configuration/integrations/redis.mdx b/docs/platforms/javascript/common/configuration/integrations/redis.mdx
@@ -18,6 +18,7 @@ supported:
   - javascript.solidstart
   - javascript.sveltekit
   - javascript.remix
+  - javascript.react-router
   - javascript.astro
   - javascript.bun
 ---

diff --git a/docs/platforms/javascript/common/configuration/integrations/requestdata.mdx b/docs/platforms/javascript/common/configuration/integrations/requestdata.mdx
@@ -19,6 +19,7 @@ supported:
   - javascript.solidstart
   - javascript.sveltekit
   - javascript.remix
+  - javascript.react-router
   - javascript.astro
   - javascript.cloudflare
 ---

diff --git a/docs/platforms/javascript/common/configuration/integrations/tedious.mdx b/docs/platforms/javascript/common/configuration/integrations/tedious.mdx
@@ -20,6 +20,7 @@ supported:
   - javascript.solidstart
   - javascript.sveltekit
   - javascript.remix
+  - javascript.react-router
   - javascript.astro
   - javascript.bun
 ---

diff --git a/docs/platforms/javascript/common/configuration/integrations/trpc.mdx b/docs/platforms/javascript/common/configuration/integrations/trpc.mdx
@@ -18,6 +18,7 @@ supported:
   - javascript.solidstart
   - javascript.sveltekit
   - javascript.remix
+  - javascript.react-router
   - javascript.astro
   - javascript.deno
   - javascript.bun

diff --git a/docs/platforms/javascript/common/configuration/integrations/unhandledrejection.mdx b/docs/platforms/javascript/common/configuration/integrations/unhandledrejection.mdx
@@ -18,6 +18,7 @@ supported:
   - javascript.solidstart
   - javascript.sveltekit
   - javascript.remix
+  - javascript.react-router
   - javascript.astro
   - javascript.bun
   - javascript.deno

diff --git a/docs/platforms/javascript/common/crons/index.mdx b/docs/platforms/javascript/common/crons/index.mdx
@@ -6,6 +6,7 @@ supported:
   - javascript.nextjs
   - javascript.sveltekit
   - javascript.remix
+  - javascript.react-router
   - javascript.astro
   - javascript.bun
   - javascript.deno

diff --git a/docs/platforms/javascript/common/crons/troubleshooting.mdx b/docs/platforms/javascript/common/crons/troubleshooting.mdx
@@ -6,6 +6,7 @@ supported:
   - javascript.nextjs
   - javascript.sveltekit
   - javascript.remix
+  - javascript.react-router
   - javascript.astro
   - javascript.bun
   - javascript.deno

diff --git a/docs/platforms/javascript/common/index.mdx b/docs/platforms/javascript/common/index.mdx
@@ -22,7 +22,7 @@ Check out the other SDKs we support in the left-hand dropdown.
 
 <PlatformSection notSupported={["javascript.deno"]}>
 
-<PlatformSection notSupported={["javascript", "javascript.astro", "javascript.cordova", "javascript.nextjs", "javascript.nuxt", "javascript.remix", "javascript.solidstart", "javascript.sveltekit", "javascript.bun", "javascript.cloudflare"]}>
+<PlatformSection notSupported={["javascript", "javascript.astro", "javascript.cordova", "javascript.nextjs", "javascript.nuxt", "javascript.remix", "javascript.solidstart", "javascript.sveltekit", "javascript.bun", "javascript.cloudflare", "javascript.react-router"]}>
 
 ## Features
 
@@ -40,7 +40,7 @@ Select which Sentry features you'd like to install in addition to Error Monitori
   </PlatformSection>
 </PlatformCategorySection>
 
-<PlatformSection notSupported={["javascript", "javascript.astro", "javascript.cordova", "javascript.nextjs", "javascript.nuxt", "javascript.remix", "javascript.sveltekit", "javascript.bun", "javascript.capacitor", "javascript.ember", "javascript.angular", "javascript.react", "javascript.solid", "javascript.solidstart", "javascript.svelte", "javascript.vue", "javascript.cloudflare"]}>
+<PlatformSection notSupported={["javascript", "javascript.astro", "javascript.cordova", "javascript.nextjs", "javascript.nuxt", "javascript.remix", "javascript.sveltekit", "javascript.bun", "javascript.capacitor", "javascript.ember", "javascript.angular", "javascript.react", "javascript.solid", "javascript.solidstart", "javascript.svelte", "javascript.vue", "javascript.cloudflare", "javascript.react-router"]}>
 
 In addition to capturing errors, you can monitor interactions between multiple services or applications by [enabling tracing](/concepts/key-terms/tracing/). You can also collect and analyze performance profiles from real users with [profiling](/product/explore/profiling/).
 
@@ -72,7 +72,7 @@ Sentry captures data by using an SDK within your application’s runtime.
 
 ## Configure
 
-<PlatformSection notSupported={["javascript.nextjs", "javascript.astro", "javascript.react"]}>
+<PlatformSection notSupported={["javascript.nextjs", "javascript.astro", "javascript.react", "javascript.react-router"]}>
 
 Configuration should happen as early as possible in your application's lifecycle.
 

diff --git a/docs/platforms/javascript/common/install/index.mdx b/docs/platforms/javascript/common/install/index.mdx
@@ -26,6 +26,7 @@ notSupported:
   - javascript.azure-functions
   - javascript.gcp-functions
   - javascript.cloudflare
+  - javascript.react-router
 ---
 
 <PageGrid />

diff --git a/docs/platforms/javascript/common/install/loader.mdx b/docs/platforms/javascript/common/install/loader.mdx
@@ -18,6 +18,7 @@ notSupported:
   - javascript.vue
   - javascript.wasm
   - javascript.remix
+  - javascript.react-router
   - javascript.svelte
   - javascript.sveltekit
   - javascript.node

diff --git a/docs/platforms/javascript/common/install/npm.mdx b/docs/platforms/javascript/common/install/npm.mdx
@@ -18,6 +18,7 @@ notSupported:
   - javascript.vue
   - javascript.wasm
   - javascript.remix
+  - javascript.react-router
   - javascript.solid
   - javascript.solidstart
   - javascript.svelte

diff --git a/docs/platforms/javascript/common/opentelemetry/custom-setup.mdx b/docs/platforms/javascript/common/opentelemetry/custom-setup.mdx
@@ -18,6 +18,7 @@ supported:
   - javascript.sveltekit
   - javascript.astro
   - javascript.remix
+  - javascript.react-router
 notSupported:
   - javascript
 sidebar_order: 0

diff --git a/docs/platforms/javascript/common/opentelemetry/index.mdx b/docs/platforms/javascript/common/opentelemetry/index.mdx
@@ -19,6 +19,7 @@ supported:
   - javascript.sveltekit
   - javascript.astro
   - javascript.remix
+  - javascript.react-router
 notSupported:
   - javascript
 ---

diff --git a/docs/platforms/javascript/common/opentelemetry/using-opentelemetry-apis.mdx b/docs/platforms/javascript/common/opentelemetry/using-opentelemetry-apis.mdx
@@ -18,6 +18,7 @@ supported:
   - javascript.sveltekit
   - javascript.astro
   - javascript.remix
+  - javascript.react-router
 notSupported:
   - javascript
 sidebar_order: 1

diff --git a/docs/platforms/javascript/guides/react-router/config.yml b/docs/platforms/javascript/guides/react-router/config.yml
@@ -0,0 +1,8 @@
+title: React Router
+description: React Router (v7) is a framework for building full-stack web apps and websites. Learn how to set it up with Sentry.
+sdk: sentry.javascript.react-router
+categories:
+  - javascript
+  - browser
+  - server
+  - server-node
diff --git a/package.json b/package.json
@@ -74,7 +74,7 @@
     "next-themes": "^0.3.0",
     "nextjs-toploader": "^1.6.6",
     "parse-numeric-range": "^1.3.0",
-    "platformicons": "^6.0.3",
+    "platformicons": "^7.0.3",
     "prism-sentry": "^1.0.2",
     "query-string": "^6.13.1",
     "react": "rc",
@@ -137,4 +137,4 @@
     "node": "20.11.0",
     "yarn": "1.22.22"
   }
-}
+}