feat(js): Add Documentation for Sentry Astro SDK #8267

Lms24 · 2023-10-17T14:21:27Z

Pre-merge checklist

If you work at Sentry, you're able to merge your own PR without review, but please don't unless there's a good reason.

Checked Vercel preview for correctness, including links
PR was reviewed and approved by any necessary SMEs
PR was reviewed and approved by a member of the Sentry docs team

Description of changes

This PR adds SDK docs for the new Sentry Astro SDK. It's still in Alpha which we clearly point out in the new docs.

This PR includes adjustments for Astro in the following pages:

Getting Started shows the semi-automatic setup via the astro CLI
Added "Manual Setup" page similarly, to SvelteKit, Remix and NextJS with all possible configuration options
Adjusted source map docs to not display the full range of source maps upload material. The Astro SDK ships with the Vite plugin, so there shouldn't be too much need for other resources than troubleshooting.
Added Astro specific setup for Replay (This is the first SDK that actually enables Replay by default. However, there are two ways how users can manually customize or add Replay).
Added various platform includes for performance monitoring snippets

ref: getsentry/sentry-javascript#9182

vercel · 2023-10-17T14:21:33Z

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

Name	Status	Preview	Comments	Updated (UTC)
sentry-docs	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Oct 23, 2023 9:43am

shanamatthews · 2023-10-18T03:04:47Z

Hey @Lms24 - Is there a date you'd like to get this out by? It might take me a bit longer to review it since it's a bigger PR and this week is a bit busier than usual!

Lms24 · 2023-10-18T16:23:12Z

Is there a date you'd like to get this out by?

Hi @shanamatthews ideally until the beginning of next week. I'm currently working on the getting started pages in sentry but can only add full Astro support to the Sentry frontend once these docs are live. Lmk if this is too soon (no problem then, just have to plan around it).
Also, we can iterate on the docs later, the SDK is still in alpha state.

shanamatthews · 2023-10-19T21:14:56Z

Sounds good, thanks @Lms24 ! I'm going to start on this today and hopefully finish up by tomorrow. Good to know that the SDK is still in alpha!

src/platform-includes/getting-started-primer/javascript.astro.mdx

src/platform-includes/getting-started-install/javascript.astro.mdx

src/platform-includes/getting-started-config/javascript.astro.mdx

src/platform-includes/session-replay/install/javascript.astro.mdx

src/platform-includes/session-replay/setup/javascript.astro.mdx

Co-authored-by: Shana Matthews <shana.l.matthews@gmail.com>

lforst · 2023-10-23T08:20:13Z

src/components/orgAuthTokenNote.tsx

@@ -38,7 +38,7 @@ export function OrgAuthTokenNote() {
          <ExternalLink href={`https://sentry.io/auth/login/?next=${url}`}>
            sign in
          </ExternalLink>{' '}
-          to create a token directly from the docs.
+          to create a token directly from this page.


Good change

lforst · 2023-10-23T08:20:32Z

src/platform-includes/distributed-tracing/how-to-use/javascript.astro.mdx

+  integrations: [new BrowserTracing()],
+  tracePropagationTargets: [
+    "https://myproject.org",
+    "https://.*.otherservice.org/.*",


h: Do we actually support globbing here? I thought we only do regexp.match() or naive string.contains().

Hmm probably not the best example, let me come up with a better one (copy 🍝 so maybe also relevant for other pages)

~~.* is valid regex syntax though 🤔~~ scratch that, I see the problem now 😅

Addressed this for Astro in 7d18a09 but we have the same invalid string in a bunch of places. Will open a separate PR to fix there. Also asked mobile folks because the same string is used in flutter and apple docs.

lforst · 2023-10-23T08:26:07Z

src/platform-includes/getting-started-install/javascript.astro.mdx

+We recommend installing the SDK by using the `astro` CLI:
+
+```bash
+npx astro add @sentry/astro
+```


l: Wondering, is there a chance that astro will change some API and this will break? If so, will it make sense to build and recommend a wizard of some sort that will work independently of the astro CLI? (no action required right now, just sharing my thoughts)

Afaict, this is pretty stable for now (but the current approach has its limitations). We should keep an eye open for if they change things (I need to finally write up that RFC for Astro I've mentioned some time ago).

We could build a wizard because right now, folks still need to manually add their DSN, source maps config, etc. Ideally, the Astro CLI would invoke it for us, so we could retain the "Astro native" approach. But I guess that's just wishful thinking at this point 😅

lforst · 2023-10-23T08:57:01Z

src/platform-includes/sourcemaps/overview/javascript.astro.mdx

+
+### Working With Old Authentication Tokens
+
+Source maps work best with [organization-scoped auth tokens](/product/accounts/auth-tokens/#organization-auth-tokens). If you are using a different type of Sentry auth token, you'll need to additionally specify your `org` slug in your `sourceMapsUploadOptions`:


I would add here when people might want to follow this step, ie. when they're on an old self-hosted version that doesn't have org auth tokens.

feat(js): Add Documentation for Sentry Astro SDK

d2e350f

vercel bot deployed to Preview October 17, 2023 14:37 View deployment

add replay and more platform includes

f0a7308

Lms24 requested review from mydea, lforst and AbhiPrasad October 17, 2023 15:07

Lms24 marked this pull request as ready for review October 17, 2023 15:07

Lms24 requested review from a team October 17, 2023 15:07

Lms24 mentioned this pull request Oct 17, 2023

Sentry Astro SDK getsentry/sentry-javascript#9182

Closed

Lms24 self-assigned this Oct 17, 2023

vercel bot deployed to Preview October 17, 2023 15:10 View deployment

Lms24 mentioned this pull request Oct 19, 2023

feat(getting-started): Add Astro onboarding getsentry/sentry#58435

Merged

shanamatthews approved these changes Oct 20, 2023

View reviewed changes

Apply suggestions from code review

9eafc0d

Co-authored-by: Shana Matthews <shana.l.matthews@gmail.com>

vercel bot had a problem deploying to Preview October 23, 2023 08:02 Failure

[getsentry/action-github-commit] Auto commit

ad46d13

vercel bot had a problem deploying to Preview October 23, 2023 08:04 Failure

move source maps from manual setup to sourcemaps page

6023063

vercel bot deployed to Preview October 23, 2023 08:55 View deployment

lforst approved these changes Oct 23, 2023

View reviewed changes

add note about self-hosted

b628a1f

vercel bot deployed to Preview October 23, 2023 09:19 View deployment

fix invalid tracePropagationTargets value

7d18a09

vercel bot deployed to Preview October 23, 2023 09:43 View deployment

Lms24 mentioned this pull request Oct 23, 2023

fix: Remove glob syntax from tracePropagationTargets example #8312

Merged

Lms24 merged commit 648c30f into master Oct 23, 2023

Lms24 deleted the lms/feat-add-astro-docs branch October 23, 2023 09:59

github-actions bot locked and limited conversation to collaborators Nov 8, 2023


		### Working With Old Authentication Tokens

		Source maps work best with [organization-scoped auth tokens](/product/accounts/auth-tokens/#organization-auth-tokens). If you are using a different type of Sentry auth token, you'll need to additionally specify your `org` slug in your `sourceMapsUploadOptions`:

Uh oh!

feat(js): Add Documentation for Sentry Astro SDK #8267

feat(js): Add Documentation for Sentry Astro SDK #8267

Uh oh!

Conversation

Lms24 commented Oct 17, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Pre-merge checklist

Description of changes

Uh oh!

vercel bot commented Oct 17, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

shanamatthews commented Oct 18, 2023

Uh oh!

Lms24 commented Oct 18, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

shanamatthews commented Oct 19, 2023

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

lforst Oct 23, 2023

Choose a reason for hiding this comment

Uh oh!

lforst Oct 23, 2023

Choose a reason for hiding this comment

Uh oh!

Lms24 Oct 23, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Lms24 Oct 23, 2023

Choose a reason for hiding this comment

Uh oh!

lforst Oct 23, 2023

Choose a reason for hiding this comment

Uh oh!

Lms24 Oct 23, 2023

Choose a reason for hiding this comment

Uh oh!

lforst Oct 23, 2023

Choose a reason for hiding this comment

Uh oh!

Lms24 Oct 23, 2023

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Lms24 commented Oct 17, 2023 •

edited

Loading

vercel bot commented Oct 17, 2023 •

edited

Loading

Lms24 commented Oct 18, 2023 •

edited

Loading

Lms24 Oct 23, 2023 •

edited

Loading