Skip to content

Commit

Permalink
docs(solidstart): Add SolidStart SDK (#11071)
Browse files Browse the repository at this point in the history
* docs(solidstart): Add SolidStart SDK

* Add configuration file paths to code snippets

* Add middleware description and update how to run snippet

* Remove duplicate `javascript.solidstart` entry
  • Loading branch information
andreiborza committed Aug 26, 2024
1 parent 2d3a737 commit 5b06282
Show file tree
Hide file tree
Showing 53 changed files with 487 additions and 25 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@ notSupported:
- javascript.nextjs
- javascript.nuxt
- javascript.react
- javascript.solid
- javascript.solidstart
- javascript.vue
- javascript.wasm
- javascript.node
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ supported:
- javascript.electron
- javascript.nextjs
- javascript.nuxt
- javascript.solidstart
- javascript.sveltekit
- javascript.remix
- javascript.astro
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ supported:
- javascript.electron
- javascript.nextjs
- javascript.nuxt
- javascript.solidstart
- javascript.sveltekit
- javascript.remix
- javascript.astro
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ supported:
- javascript.electron
- javascript.nextjs
- javascript.nuxt
- javascript.solidstart
- javascript.sveltekit
- javascript.remix
- javascript.astro
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ supported:
- javascript.electron
- javascript.nextjs
- javascript.nuxt
- javascript.solidstart
- javascript.sveltekit
- javascript.remix
- javascript.astro
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ supported:
- javascript.electron
- javascript.nextjs
- javascript.nuxt
- javascript.solidstart
- javascript.sveltekit
- javascript.remix
- javascript.astro
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ supported:
- javascript.electron
- javascript.nextjs
- javascript.nuxt
- javascript.solidstart
- javascript.sveltekit
- javascript.remix
- javascript.astro
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ supported:
- javascript.electron
- javascript.nextjs
- javascript.nuxt
- javascript.solidstart
- javascript.sveltekit
- javascript.remix
- javascript.astro
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ supported:
- javascript.electron
- javascript.nextjs
- javascript.nuxt
- javascript.solidstart
- javascript.sveltekit
- javascript.remix
- javascript.astro
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ supported:
- javascript.electron
- javascript.nextjs
- javascript.nuxt
- javascript.solidstart
- javascript.sveltekit
- javascript.remix
- javascript.astro
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ supported:
- javascript.electron
- javascript.nextjs
- javascript.nuxt
- javascript.solidstart
- javascript.sveltekit
- javascript.remix
- javascript.astro
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ supported:
- javascript.electron
- javascript.nextjs
- javascript.nuxt
- javascript.solidstart
- javascript.sveltekit
- javascript.remix
- javascript.astro
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ supported:
- javascript.electron
- javascript.nextjs
- javascript.nuxt
- javascript.solidstart
- javascript.sveltekit
- javascript.remix
- javascript.astro
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ supported:
- javascript.electron
- javascript.nextjs
- javascript.nuxt
- javascript.solidstart
- javascript.sveltekit
- javascript.remix
- javascript.astro
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ supported:
- javascript.electron
- javascript.nextjs
- javascript.nuxt
- javascript.solidstart
- javascript.sveltekit
- javascript.remix
- javascript.astro
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ supported:
- javascript.electron
- javascript.nextjs
- javascript.nuxt
- javascript.solidstart
- javascript.sveltekit
- javascript.remix
- javascript.astro
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ supported:
- javascript.nestjs
- javascript.nextjs
- javascript.nuxt
- javascript.solidstart
- javascript.sveltekit
- javascript.remix
- javascript.astro
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ supported:
- javascript.electron
- javascript.nextjs
- javascript.nuxt
- javascript.solidstart
- javascript.sveltekit
- javascript.remix
- javascript.astro
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ supported:
- javascript.nestjs
- javascript.nextjs
- javascript.nuxt
- javascript.solidstart
- javascript.sveltekit
- javascript.remix
- javascript.astro
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ supported:
- javascript.electron
- javascript.nextjs
- javascript.nuxt
- javascript.solidstart
- javascript.sveltekit
- javascript.remix
- javascript.astro
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ supported:
- javascript.electron
- javascript.nextjs
- javascript.nuxt
- javascript.solidstart
- javascript.sveltekit
- javascript.remix
- javascript.astro
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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

Expand Down Expand Up @@ -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
Expand Down
8 changes: 5 additions & 3 deletions docs/platforms/javascript/common/index.mdx
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
<PlatformSection notSupported={["javascript.capacitor", "javascript.cordova"]}>
<PlatformContent includePath="getting-started-primer" />

<PlatformSection notSupported={["javascript.capacitor", "javascript.cordova", "javascript.solid", "javascript.solidstart"]}>

<Note>
We've released v8 of the JavaScript SDKs. If you're using version
Expand Down Expand Up @@ -53,7 +55,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

Expand All @@ -73,7 +75,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.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/).

Expand Down
1 change: 1 addition & 0 deletions docs/platforms/javascript/common/install/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ notSupported:
- javascript.wasm
- javascript.remix
- javascript.solid
- javascript.solidstart
- javascript.svelte
- javascript.sveltekit
- javascript.aws-lambda
Expand Down
2 changes: 2 additions & 0 deletions docs/platforms/javascript/common/install/npm.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@ notSupported:
- javascript.vue
- javascript.wasm
- javascript.remix
- javascript.solid
- javascript.solidstart
- javascript.svelte
- javascript.sveltekit
- javascript.node
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ supported:
- javascript.koa
- javascript.nestjs
- javascript.nuxt
- javascript.solidstart
- javascript.sveltekit
- javascript.astro
- javascript.remix
Expand Down
1 change: 1 addition & 0 deletions docs/platforms/javascript/common/opentelemetry/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ supported:
- javascript.koa
- javascript.nestjs
- javascript.nuxt
- javascript.solidstart
- javascript.sveltekit
- javascript.astro
- javascript.remix
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ supported:
- javascript.koa
- javascript.nestjs
- javascript.nuxt
- javascript.solidstart
- javascript.sveltekit
- javascript.astro
- javascript.remix
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ sidebar_order: 6
notSupported:
- javascript.nextjs
- javascript.remix
- javascript.solidstart
- javascript.sveltekit
- javascript.astro
- javascript.nuxt
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ sidebar_order: 1
notSupported:
- javascript.nextjs
- javascript.remix
- javascript.solidstart
- javascript.sveltekit
- javascript.astro
- javascript.nuxt
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ supported:
- javascript.nextjs
- javascript.nuxt
- javascript.astro
- javascript.solidstart
- javascript.sveltekit
- javascript.remix
---
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ supported:
- javascript.nextjs
- javascript.nuxt
- javascript.astro
- javascript.solidstart
- javascript.sveltekit
- javascript.remix
---
Expand Down
21 changes: 6 additions & 15 deletions docs/platforms/javascript/guides/solid/features/error-boundary.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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"),
);
);
}
```
6 changes: 3 additions & 3 deletions docs/platforms/javascript/guides/solid/features/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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`
Expand Down
6 changes: 6 additions & 0 deletions docs/platforms/javascript/guides/solidstart/config.yml
Original file line number Diff line number Diff line change
@@ -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
Original file line number Diff line number Diff line change
@@ -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>
);
}
```
Loading

0 comments on commit 5b06282

Please sign in to comment.