docs(solidstart): Add SolidStart SDK

getsentry · Aug 13, 2024 · 14b04df · 14b04df
1 parent 450cdfb
commit 14b04df
Show file tree

Hide file tree

Showing 53 changed files with 476 additions and 24 deletions.
diff --git a/docs/platforms/javascript/common/best-practices/web-workers.mdx b/docs/platforms/javascript/common/best-practices/web-workers.mdx
@@ -14,6 +14,8 @@ notSupported:
   - javascript.nextjs
   - javascript.nuxt
   - javascript.react
+  - javascript.solid
+  - javascript.solidstart
   - javascript.vue
   - javascript.wasm
   - javascript.node

diff --git a/docs/platforms/javascript/common/configuration/application-not-responding.mdx b/docs/platforms/javascript/common/configuration/application-not-responding.mdx
@@ -16,6 +16,7 @@ supported:
   - javascript.electron
   - javascript.nextjs
   - javascript.nuxt
+  - javascript.solidstart
   - javascript.sveltekit
   - javascript.remix
   - javascript.astro

diff --git a/docs/platforms/javascript/common/configuration/integrations/anr.mdx b/docs/platforms/javascript/common/configuration/integrations/anr.mdx
@@ -15,6 +15,7 @@ supported:
   - javascript.electron
   - javascript.nextjs
   - javascript.nuxt
+  - javascript.solidstart
   - javascript.sveltekit
   - javascript.remix
   - javascript.astro

diff --git a/docs/platforms/javascript/common/configuration/integrations/console.mdx b/docs/platforms/javascript/common/configuration/integrations/console.mdx
@@ -15,6 +15,7 @@ supported:
   - javascript.electron
   - javascript.nextjs
   - javascript.nuxt
+  - javascript.solidstart
   - javascript.sveltekit
   - javascript.remix
   - javascript.astro

diff --git a/docs/platforms/javascript/common/configuration/integrations/graphql.mdx b/docs/platforms/javascript/common/configuration/integrations/graphql.mdx
@@ -15,6 +15,7 @@ supported:
   - javascript.electron
   - javascript.nextjs
   - javascript.nuxt
+  - javascript.solidstart
   - javascript.sveltekit
   - javascript.remix
   - javascript.astro

diff --git a/docs/platforms/javascript/common/configuration/integrations/http.mdx b/docs/platforms/javascript/common/configuration/integrations/http.mdx
@@ -15,6 +15,7 @@ supported:
   - javascript.electron
   - javascript.nextjs
   - javascript.nuxt
+  - javascript.solidstart
   - javascript.sveltekit
   - javascript.remix
   - javascript.astro

diff --git a/docs/platforms/javascript/common/configuration/integrations/localvariables.mdx b/docs/platforms/javascript/common/configuration/integrations/localvariables.mdx
@@ -15,6 +15,7 @@ supported:
   - javascript.electron
   - javascript.nextjs
   - javascript.nuxt
+  - javascript.solidstart
   - javascript.sveltekit
   - javascript.remix
   - javascript.astro

diff --git a/docs/platforms/javascript/common/configuration/integrations/modules.mdx b/docs/platforms/javascript/common/configuration/integrations/modules.mdx
@@ -15,6 +15,7 @@ supported:
   - javascript.electron
   - javascript.nextjs
   - javascript.nuxt
+  - javascript.solidstart
   - javascript.sveltekit
   - javascript.remix
   - javascript.astro

diff --git a/docs/platforms/javascript/common/configuration/integrations/mongo.mdx b/docs/platforms/javascript/common/configuration/integrations/mongo.mdx
@@ -15,6 +15,7 @@ supported:
   - javascript.electron
   - javascript.nextjs
   - javascript.nuxt
+  - javascript.solidstart
   - javascript.sveltekit
   - javascript.remix
   - javascript.astro

diff --git a/docs/platforms/javascript/common/configuration/integrations/mysql.mdx b/docs/platforms/javascript/common/configuration/integrations/mysql.mdx
@@ -15,6 +15,7 @@ supported:
   - javascript.electron
   - javascript.nextjs
   - javascript.nuxt
+  - javascript.solidstart
   - javascript.sveltekit
   - javascript.remix
   - javascript.astro

diff --git a/docs/platforms/javascript/common/configuration/integrations/mysql2.mdx b/docs/platforms/javascript/common/configuration/integrations/mysql2.mdx
@@ -15,6 +15,7 @@ supported:
   - javascript.electron
   - javascript.nextjs
   - javascript.nuxt
+  - javascript.solidstart
   - javascript.sveltekit
   - javascript.remix
   - javascript.astro

diff --git a/docs/platforms/javascript/common/configuration/integrations/nodecontext.mdx b/docs/platforms/javascript/common/configuration/integrations/nodecontext.mdx
@@ -15,6 +15,7 @@ supported:
   - javascript.electron
   - javascript.nextjs
   - javascript.nuxt
+  - javascript.solidstart
   - javascript.sveltekit
   - javascript.remix
   - javascript.astro

diff --git a/docs/platforms/javascript/common/configuration/integrations/nodefetch.mdx b/docs/platforms/javascript/common/configuration/integrations/nodefetch.mdx
@@ -15,6 +15,7 @@ supported:
   - javascript.electron
   - javascript.nextjs
   - javascript.nuxt
+  - javascript.solidstart
   - javascript.sveltekit
   - javascript.remix
   - javascript.astro

diff --git a/docs/platforms/javascript/common/configuration/integrations/nodeprofiling.mdx b/docs/platforms/javascript/common/configuration/integrations/nodeprofiling.mdx
@@ -15,6 +15,7 @@ supported:
   - javascript.electron
   - javascript.nextjs
   - javascript.nuxt
+  - javascript.solidstart
   - javascript.sveltekit
   - javascript.remix
   - javascript.astro

diff --git a/.../platforms/javascript/common/configuration/integrations/onuncaughtexception.mdx b/.../platforms/javascript/common/configuration/integrations/onuncaughtexception.mdx
@@ -15,6 +15,7 @@ supported:
   - javascript.electron
   - javascript.nextjs
   - javascript.nuxt
+  - javascript.solidstart
   - javascript.sveltekit
   - javascript.remix
   - javascript.astro

diff --git a/docs/platforms/javascript/common/configuration/integrations/postgres.mdx b/docs/platforms/javascript/common/configuration/integrations/postgres.mdx
@@ -15,6 +15,7 @@ supported:
   - javascript.electron
   - javascript.nextjs
   - javascript.nuxt
+  - javascript.solidstart
   - javascript.sveltekit
   - javascript.remix
   - javascript.astro

diff --git a/docs/platforms/javascript/common/configuration/integrations/prisma.mdx b/docs/platforms/javascript/common/configuration/integrations/prisma.mdx
@@ -14,6 +14,7 @@ supported:
   - javascript.nestjs
   - javascript.nextjs
   - javascript.nuxt
+  - javascript.solidstart
   - javascript.sveltekit
   - javascript.remix
   - javascript.astro

diff --git a/docs/platforms/javascript/common/configuration/integrations/redis.mdx b/docs/platforms/javascript/common/configuration/integrations/redis.mdx
@@ -15,6 +15,7 @@ supported:
   - javascript.electron
   - javascript.nextjs
   - javascript.nuxt
+  - javascript.solidstart
   - javascript.sveltekit
   - javascript.remix
   - javascript.astro

diff --git a/docs/platforms/javascript/common/configuration/integrations/requestdata.mdx b/docs/platforms/javascript/common/configuration/integrations/requestdata.mdx
@@ -16,6 +16,7 @@ supported:
   - javascript.nestjs
   - javascript.nextjs
   - javascript.nuxt
+  - javascript.solidstart
   - javascript.sveltekit
   - javascript.remix
   - javascript.astro

diff --git a/docs/platforms/javascript/common/configuration/integrations/trpc.mdx b/docs/platforms/javascript/common/configuration/integrations/trpc.mdx
@@ -15,6 +15,7 @@ supported:
   - javascript.electron
   - javascript.nextjs
   - javascript.nuxt
+  - javascript.solidstart
   - javascript.sveltekit
   - javascript.remix
   - javascript.astro

diff --git a/docs/platforms/javascript/common/configuration/integrations/unhandledrejection.mdx b/docs/platforms/javascript/common/configuration/integrations/unhandledrejection.mdx
@@ -15,6 +15,7 @@ supported:
   - javascript.electron
   - javascript.nextjs
   - javascript.nuxt
+  - javascript.solidstart
   - javascript.sveltekit
   - javascript.remix
   - javascript.astro

diff --git a/docs/platforms/javascript/common/configuration/tree-shaking.mdx b/docs/platforms/javascript/common/configuration/tree-shaking.mdx
@@ -27,7 +27,7 @@ The Sentry SDK ships with code that is not strictly required for it to collect y
   you use certain features.
 </Note>
 
-<PlatformSection notSupported={["javascript.nextjs", "javascript.nuxt", "javascript.sveltekit", "javascript.remix", "javascript.astro"]}>
+<PlatformSection notSupported={["javascript.nextjs", "javascript.nuxt", "javascript.solidstart", "javascript.sveltekit", "javascript.remix", "javascript.astro"]}>
 
 ### Tree Shaking With Sentry Bundler Plugins
 
@@ -144,7 +144,7 @@ Replacing this flag with `true` will tree shake any SDK code that's related to t
 </PlatformSection>
 </PlatformCategorySection>
 
-<PlatformSection notSupported={["javascript.nextjs", "javascript.nuxt", "javascript.sveltekit", "javascript.remix", "javascript.astro"]}>
+<PlatformSection notSupported={["javascript.nextjs", "javascript.nuxt", "javascript.solidstart", "javascript.sveltekit", "javascript.remix", "javascript.astro"]}>
 
 ### Tree Shaking With Webpack
 
@@ -191,7 +191,7 @@ module.exports = {
 
 </PlatformSection>
 
-<PlatformSection notSupported={["javascript.nextjs", "javascript.nuxt", "javascript.sveltekit", "javascript.remix", "javascript.astro"]}>
+<PlatformSection notSupported={["javascript.nextjs", "javascript.nuxt", "javascript.solidstart", "javascript.sveltekit", "javascript.remix", "javascript.astro"]}>
 
 ### Tree Shaking With Rollup
 

diff --git a/docs/platforms/javascript/common/index.mdx b/docs/platforms/javascript/common/index.mdx
@@ -43,7 +43,7 @@ If you prefer to follow video instructions, see [How to Install the Sentry Next.
 
 <PlatformSection notSupported={["javascript.deno"]}>
 
-<PlatformSection notSupported={["javascript", "javascript.astro", "javascript.cordova", "javascript.nextjs", "javascript.nuxt", "javascript.remix", "javascript.sveltekit", "javascript.bun"]}>
+<PlatformSection notSupported={["javascript", "javascript.astro", "javascript.cordova", "javascript.nextjs", "javascript.nuxt", "javascript.remix", "javascript.solidstart", "javascript.sveltekit", "javascript.bun"]}>
 
 ## Features
 
@@ -63,7 +63,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.svelte", "javascript.vue"]}>
+<PlatformSection notSupported={["javascript", "javascript.astro", "javascript.cordova", "javascript.nextjs", "javascript.nuxt", "javascript.remix", "javascript.solidstart", "javascript.sveltekit", "javascript.bun", "javascript.capacitor", "javascript.ember", "javascript.angular", "javascript.react", "javascript.solid", "javascript.solidstart", "javascript.svelte", "javascript.vue"]}>
 
 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/).
 

diff --git a/docs/platforms/javascript/common/install/index.mdx b/docs/platforms/javascript/common/install/index.mdx
@@ -19,6 +19,7 @@ notSupported:
   - javascript.wasm
   - javascript.remix
   - javascript.solid
+  - javascript.solidstart
   - javascript.svelte
   - javascript.sveltekit
   - javascript.aws-lambda

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

diff --git a/docs/platforms/javascript/common/opentelemetry/custom-setup.mdx b/docs/platforms/javascript/common/opentelemetry/custom-setup.mdx
@@ -14,6 +14,7 @@ supported:
   - javascript.koa
   - javascript.nestjs
   - javascript.nuxt
+  - javascript.solidstart
   - javascript.sveltekit
   - javascript.astro
   - javascript.remix

diff --git a/docs/platforms/javascript/common/opentelemetry/index.mdx b/docs/platforms/javascript/common/opentelemetry/index.mdx
@@ -15,6 +15,7 @@ supported:
   - javascript.koa
   - javascript.nestjs
   - javascript.nuxt
+  - javascript.solidstart
   - javascript.sveltekit
   - javascript.astro
   - javascript.remix

diff --git a/docs/platforms/javascript/common/opentelemetry/using-opentelemetry-apis.mdx b/docs/platforms/javascript/common/opentelemetry/using-opentelemetry-apis.mdx
@@ -14,6 +14,7 @@ supported:
   - javascript.koa
   - javascript.nestjs
   - javascript.nuxt
+  - javascript.solidstart
   - javascript.sveltekit
   - javascript.astro
   - javascript.remix

diff --git a/docs/platforms/javascript/common/sourcemaps/uploading/cli.mdx b/docs/platforms/javascript/common/sourcemaps/uploading/cli.mdx
@@ -5,6 +5,7 @@ sidebar_order: 6
 notSupported:
   - javascript.nextjs
   - javascript.remix
+  - javascript.solidstart
   - javascript.sveltekit
   - javascript.astro
   - javascript.nuxt

diff --git a/docs/platforms/javascript/common/sourcemaps/uploading/index.mdx b/docs/platforms/javascript/common/sourcemaps/uploading/index.mdx
@@ -5,6 +5,7 @@ sidebar_order: 1
 notSupported:
   - javascript.nextjs
   - javascript.remix
+  - javascript.solidstart
   - javascript.sveltekit
   - javascript.astro
   - javascript.nuxt

diff --git a/...ascript/common/tracing/instrumentation/custom-instrumentation/caches-module.mdx b/...ascript/common/tracing/instrumentation/custom-instrumentation/caches-module.mdx
@@ -18,6 +18,7 @@ supported:
   - javascript.nextjs
   - javascript.nuxt
   - javascript.astro
+  - javascript.solidstart
   - javascript.sveltekit
   - javascript.remix
 ---

diff --git a/...ascript/common/tracing/instrumentation/custom-instrumentation/queues-module.mdx b/...ascript/common/tracing/instrumentation/custom-instrumentation/queues-module.mdx
@@ -18,6 +18,7 @@ supported:
   - javascript.nextjs
   - javascript.nuxt
   - javascript.astro
+  - javascript.solidstart
   - javascript.sveltekit
   - javascript.remix
 ---

diff --git a/docs/platforms/javascript/guides/solid/features/error-boundary.mdx b/docs/platforms/javascript/guides/solid/features/error-boundary.mdx
@@ -3,32 +3,23 @@ title: Solid Error Boundary
 description: "Learn how to wrap Solid error boundaries to automatically capture errors."
 ---
 
-The Solid SDK exports a function to wrap the native Solid error boundary component to automatically capture exceptions
+The Sentry SDK exports a function to wrap the native Solid error boundary component to automatically capture exceptions
 from inside a component tree and render a fallback component.
 
 Wrap the native Solid `ErrorBoundary` component with `Sentry.withSentryErrorBoundary`.
 
-<SignInNote />
-
 ```jsx
 import * as Sentry from "@sentry/solid";
 import { ErrorBoundary } from "solid-js";
-import App from "./app";
-
-Sentry.init({
-  dsn: "__PUBLIC_DSN__",
-  tracesSampleRate: 1.0, //  Capture 100% of the transactions
-});
 
 // Wrap Solid"s ErrorBoundary to automatically capture exceptions
 const SentryErrorBoundary = Sentry.withSentryErrorBoundary(ErrorBoundary);
 
-render(
-  () => (
+export default function SomeComponent() {
+  return (
     <SentryErrorBoundary fallback={err => <div>Error: {err.message}</div>}>
-      <App />
+        <div>Some Component</div>
     </SentryErrorBoundary>
-  ),
-  document.getElementById("root"),
-);
+  );
+}
 ```
diff --git a/docs/platforms/javascript/guides/solid/features/index.mdx b/docs/platforms/javascript/guides/solid/features/index.mdx
@@ -6,9 +6,9 @@ description: "Learn how Sentry's Solid SDK exposes features for first class inte
 <Note>
 
   This SDK is considered **experimental and in an alpha state**. It may experience breaking changes. Please reach out on
-  [GitHub](https://github.com/getsentry/sentry-javascript/issues/new/choose) if you have any feedback or concerns. This
-  SDK currently only supports [Solid](https://www.solidjs.com/) and is not yet officially compatible with
-  [Solid Start](https://start.solidjs.com/).
+  [GitHub](https://github.com/getsentry/sentry-javascript/issues/new/choose) if you have any feedback or concerns.
+  This SDK is for [Solid](https://www.solidjs.com/), for [SolidStart](https://start.solidjs.com/) see our
+  [SolidStart SDK](/platforms/javascript/guides/solidstart).
 
 </Note>
 

diff --git a/docs/platforms/javascript/guides/solid/features/solid-router.mdx b/docs/platforms/javascript/guides/solid/features/solid-router.mdx
@@ -7,7 +7,7 @@ description: "Learn about Sentry's Solid Router integration."
   The routing instrumentation supports [Solid Router](https://docs.solidjs.com/solid-router) 0.13.4 and up.
 </Note>
 
-The Solid SDK provides a routing instrumentation for Solid Router to create navigation spans to ensure
+The Sentry SDK provides a routing instrumentation for Solid Router to create navigation spans to ensure
 you collect meaningful performance data about the health of your page loads and associated requests.
 
 To get started, import `solidRouterBrowserTracingIntegration` from `@sentry/solid/solidrouter` and add it to `Sentry.init`

diff --git a/docs/platforms/javascript/guides/solidstart/config.yml b/docs/platforms/javascript/guides/solidstart/config.yml
@@ -0,0 +1,6 @@
+title: SolidStart
+description: SolidStart is a framework for full-stack web apps and websites. Learn how to set it up with Sentry.
+sdk: sentry.javascript.solidstart
+categories:
+  - browser
+  - server
diff --git a/docs/platforms/javascript/guides/solidstart/features/error-boundary.mdx b/docs/platforms/javascript/guides/solidstart/features/error-boundary.mdx
@@ -0,0 +1,25 @@
+---
+title: Solid Error Boundary
+description: "Learn how to wrap Solid error boundaries to automatically capture errors."
+---
+
+The Sentry SDK exports a function to wrap the native Solid error boundary component to automatically capture exceptions
+from inside a component tree and render a fallback component.
+
+Wrap the native Solid `ErrorBoundary` component with `Sentry.withSentryErrorBoundary`.
+
+```jsx
+import * as Sentry from "@sentry/solidstart";
+import { ErrorBoundary } from "solid-js";
+
+// Wrap Solid"s ErrorBoundary to automatically capture exceptions
+const SentryErrorBoundary = Sentry.withSentryErrorBoundary(ErrorBoundary);
+
+export default function SomeComponent() {
+  return (
+    <SentryErrorBoundary fallback={err => <div>Error: {err.message}</div>}>
+      <div>Some Component</div>
+    </SentryErrorBoundary>
+  );
+}
+```
diff --git a/docs/platforms/javascript/guides/solidstart/features/index.mdx b/docs/platforms/javascript/guides/solidstart/features/index.mdx
@@ -0,0 +1,15 @@
+---
+title: SolidStart Features
+description: "Learn how Sentry's SolidStart SDK exposes features for first class integration with Solid."
+---
+
+<Note>
+
+  This SDK is considered **experimental and in an alpha state**. It may experience breaking changes. Please reach out on
+  [GitHub](https://github.com/getsentry/sentry-javascript/issues/new/choose) if you have any feedback or concerns.
+
+</Note>
+
+The Sentry SolidStart SDK offers Solid-specific features for first class integration with the framework.
+
+<PageGrid />