docs(solidstart): Add SolidStart SDK #11071

andreiborza · 2024-08-13T12:07:28Z

DESCRIBE YOUR PR

Adds docs for our new SolidStart SDK.

Closes: getsentry/sentry-javascript#12556

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.):
Other deadline:
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

LEGAL BOILERPLATE

Look, I get it. The entity doing business as "Sentry" was incorporated in the State of Delaware in 2015 as Functional Software, Inc. and is gonna need some rights from me in order to utilize my contributions in this here PR. So here's the deal: I retain all rights, title and interest in and to my contributions, and by keeping this boilerplate intact I confirm that Sentry can use, modify, copy, and redistribute my contributions, under Sentry's choice of terms.

EXTRA RESOURCES

Sentry Docs contributor guide

vercel · 2024-08-13T12:07:31Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
changelog	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Aug 26, 2024 8:40am
sentry-docs	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Aug 26, 2024 8:40am

1 Skipped Deployment

Name	Status	Preview	Comments	Updated (UTC)
develop-docs	⬜️ Ignored (Inspect)	Visit Preview		Aug 26, 2024 8:40am

codecov · 2024-08-13T12:10:58Z

Bundle Report

Changes will increase total bundle size by 21.17kB ⬆️

Bundle name	Size	Change
sentry-docs-server	8.26MB	11.01kB ⬆️
sentry-docs-edge-server	254.34kB	3 bytes ⬇️
sentry-docs-client	6.26MB	10.16kB ⬆️

s1gr1d · 2024-08-13T12:23:48Z

docs/platforms/javascript/guides/solidstart/features/solid-router.mdx

+To get started, import `solidRouterBrowserTracingIntegration` from `@sentry/solidstart/solidrouter` and add it to `Sentry.init`
+instead of the regular `Sentry.browserTracingIntegration` to enable performance tracing.


Just a general question: Isn't the browserTracingIntegration always included? Not sure if there was a PR for solidstart as well.

It's not yet, I should create an issue for that.

getsentry/sentry-javascript#13352

s1gr1d · 2024-08-13T12:27:22Z

platform-includes/getting-started-config/javascript.solidstart.mdx

+
+### Server-side Setup
+
+Create an instrument file `instrument.server.mjs` and initialize the Sentry SDK.


M: Specify, where this file should be located. If it isn't root, you can also add the path to the filename in the code snippet.

s1gr1d · 2024-08-13T12:28:12Z

platform-includes/getting-started-config/javascript.solidstart.mdx

+
+### Client-side Setup
+
+Initialize the Sentry SDK in your `entry-client.tsx` file.


M: Specify, where this file should be located. And maybe also add jsx (or any other supported file endings)

Not sure we can/should specify the location. It depends on project structure, I think it's clear to people who have created a SolidStart project where this is located.

Also was considering the jsx but feels pointless as the code here isn't really different. Can add tho, no strong feeligns.

s1gr1d · 2024-08-13T12:32:00Z

platform-includes/getting-started-config/javascript.solidstart.mdx

+
+### Instrumentation
+
+Complete the setup by adding the Sentry middleware to your `middleware.ts` file. If you don't have a `middleware.ts` file yet, create one:


You could link to the middleware docs here (for people who don't have this file yet, this might be useful).

M: Also interesting here: Where should this be located

Location again depends on the project structure. I could default it to src but feel like it doesn't really add any extra info.

Rewrote this section a bit, added the link and location of the middleware file.

s1gr1d · 2024-08-13T12:35:24Z

platform-includes/getting-started-config/javascript.solidstart.mdx

+Add an `--import` flag to the `NODE_OPTIONS` environment variable wherever you run your application.
+
+```bash {tabTitle: npm}
+NODE_OPTIONS='--import=./src/instrument.server.mjs npm start
+```
+
+```bash {tabTitle: yarn}
+NODE_OPTIONS='--import=./src/instrument.server.mjs yarn start
+```
+
+```bash {tabTitle: pnpm}
+NODE_OPTIONS='--import=./src/instrument.server.mjs pnpm start
+```


L: Just a suggestion as I did this differently in the Nuxt docs (see here): I added the code of how it should look like in the package.json. It might be easier to understand for users where they have to add it. I also included a version for when the app is started with node (where you can directly add the --import option without the env variable)

That's a nice approach, will change!

Updated but I opted not to use node directly as it's not mentioned by SolidStart nor vinxi.

chargome · 2024-08-26T07:40:54Z

docs/platforms/javascript/common/index.mdx

@@ -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.solidstart", "javascript.sveltekit", "javascript.bun", "javascript.capacitor", "javascript.ember", "javascript.angular", "javascript.react", "javascript.solid", "javascript.solidstart", "javascript.svelte", "javascript.vue"]}>


Suggested change

<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"]}>

<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.svelte", "javascript.vue"]}>

solidstart is twice in this array

andreiborza requested review from mydea, chargome, lizokm and s1gr1d August 13, 2024 12:07

vercel bot deployed to Preview – changelog August 13, 2024 12:07 View deployment

vercel bot deployed to Preview – develop-docs August 13, 2024 12:12 View deployment

vercel bot deployed to Preview – sentry-docs August 13, 2024 12:24 View deployment

s1gr1d requested changes Aug 13, 2024

View reviewed changes

andreiborza force-pushed the ab/solidstart-docs branch from 306c632 to 14b04df Compare August 13, 2024 12:42

vercel bot deployed to Preview – changelog August 13, 2024 12:44 View deployment

vercel bot deployed to Preview – develop-docs August 13, 2024 12:49 View deployment

vercel bot deployed to Preview – sentry-docs August 13, 2024 12:59 View deployment

chargome approved these changes Aug 13, 2024

View reviewed changes

vercel bot deployed to Preview – changelog August 16, 2024 14:01 View deployment

vercel bot deployed to Preview – sentry-docs August 16, 2024 14:15 View deployment

andreiborza requested a review from s1gr1d August 16, 2024 15:18

vercel bot deployed to Preview – changelog August 16, 2024 15:18 View deployment

vercel bot deployed to Preview – sentry-docs August 16, 2024 15:31 View deployment

andreiborza added 3 commits August 26, 2024 09:30

docs(solidstart): Add SolidStart SDK

4ce6b31

Add configuration file paths to code snippets

1006915

Add middleware description and update how to run snippet

8b71354

andreiborza force-pushed the ab/solidstart-docs branch from 7f16309 to 8b71354 Compare August 26, 2024 07:37

andreiborza requested a review from chargome August 26, 2024 07:37

vercel bot deployed to Preview – changelog August 26, 2024 07:39 View deployment

chargome reviewed Aug 26, 2024

View reviewed changes

chargome approved these changes Aug 26, 2024

View reviewed changes

vercel bot deployed to Preview – sentry-docs August 26, 2024 07:54 View deployment

Remove duplicate javascript.solidstart entry

68a1a66

vercel bot deployed to Preview – changelog August 26, 2024 07:58 View deployment

vercel bot deployed to Preview – sentry-docs August 26, 2024 08:11 View deployment

s1gr1d approved these changes Aug 26, 2024

View reviewed changes

andreiborza merged commit 5b06282 into master Aug 26, 2024
11 checks passed

andreiborza deleted the ab/solidstart-docs branch August 26, 2024 08:57

github-actions bot locked and limited conversation to collaborators Sep 11, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs(solidstart): Add SolidStart SDK #11071

docs(solidstart): Add SolidStart SDK #11071

andreiborza commented Aug 13, 2024 •

edited

Loading

vercel bot commented Aug 13, 2024 •

edited

Loading

codecov bot commented Aug 13, 2024 •

edited

Loading

s1gr1d Aug 13, 2024

andreiborza Aug 13, 2024

andreiborza Aug 13, 2024

s1gr1d Aug 13, 2024

andreiborza Aug 16, 2024

s1gr1d Aug 13, 2024

andreiborza Aug 13, 2024

andreiborza Aug 16, 2024

s1gr1d Aug 13, 2024

andreiborza Aug 13, 2024

andreiborza Aug 16, 2024

s1gr1d Aug 13, 2024

andreiborza Aug 13, 2024

andreiborza Aug 16, 2024

chargome Aug 26, 2024

chargome Aug 26, 2024

andreiborza Aug 26, 2024

		To get started, import `solidRouterBrowserTracingIntegration` from `@sentry/solidstart/solidrouter` and add it to `Sentry.init`
		instead of the regular `Sentry.browserTracingIntegration` to enable performance tracing.


		### Server-side Setup

		Create an instrument file `instrument.server.mjs` and initialize the Sentry SDK.


		### Client-side Setup

		Initialize the Sentry SDK in your `entry-client.tsx` file.


		### Instrumentation

		Complete the setup by adding the Sentry middleware to your `middleware.ts` file. If you don't have a `middleware.ts` file yet, create one:

	<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"]}>
	<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.svelte", "javascript.vue"]}>

docs(solidstart): Add SolidStart SDK #11071

docs(solidstart): Add SolidStart SDK #11071

Conversation

andreiborza commented Aug 13, 2024 • edited Loading

DESCRIBE YOUR PR

IS YOUR CHANGE URGENT?

SLA

PRE-MERGE CHECKLIST

LEGAL BOILERPLATE

EXTRA RESOURCES

vercel bot commented Aug 13, 2024 • edited Loading

codecov bot commented Aug 13, 2024 • edited Loading

Bundle Report

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

andreiborza commented Aug 13, 2024 •

edited

Loading

vercel bot commented Aug 13, 2024 •

edited

Loading

codecov bot commented Aug 13, 2024 •

edited

Loading