docs(elysia): Add @sentry/elysia SDK documentation#17107
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
1 Skipped Deployment
|
|
Currently failing because of the icon, I already have a PR in flight that will resolve that. |
1019251 to
7b47799
Compare
There was a problem hiding this comment.
Pull request overview
Adds initial documentation for the new @sentry/elysia JavaScript SDK and wires up the Elysia platform icon so the guide can appear alongside other JS frameworks.
Changes:
- Adds a new Elysia getting-started guide covering Bun and Node.js runtimes.
- Adds Elysia icons (small/large) and maps
javascript-elysiato the new icon key. - Bumps
platformiconsto a version which includes the Elysia icon assets.
Reviewed changes
Copilot reviewed 3 out of 4 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
src/components/platformIcon.tsx |
Imports Elysia SVGs and adds icon mappings for the new platform. |
docs/platforms/javascript/guides/elysia/index.mdx |
New getting-started guide and feature overview for @sentry/elysia. |
package.json |
Updates platformicons dependency to include Elysia assets. |
pnpm-lock.yaml |
Lockfile updates corresponding to the platformicons bump. |
Files not reviewed (1)
- pnpm-lock.yaml: Language not supported
Comments suppressed due to low confidence (1)
src/components/platformIcon.tsx:500
formatToSVGappears to be kept in alphabetical order by key in this file, but the newelysiaentry is inserted beforeelixir. Please reorder the entries to keep the mapping sorted (helps scanability and reduces merge conflicts).
electron: {
sm: ElectronSVG,
lg: ElectronSVGLarge,
},
elysia: {
sm: ElysiaSVG,
lg: ElysiaSVGLarge,
},
elixir: {
sm: ElixirSVG,
lg: ElixirSVGLarge,
},
There was a problem hiding this comment.
Cursor Bugbot has reviewed your changes and found 1 potential issue.
Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, enable autofix in the Cursor dashboard.
inventarSarah
left a comment
There was a problem hiding this comment.
Looks like a good first version for the new SDK! 🎉
I left some inline comments, but also wanted to share some general thoughts:
quick start guide structure:
I noticed that the guide differs from our other JS guides in a few places (see my comments). I wasn't sure if this was intentional and something you want us to revisit later or something we should look into now -> happy to discuss and support you with it!
auto-added pages
Since this branch adds a new docs section, it also automatically adds pages and menu items to it. Some of these don't seem applicable to Elysia, for example, "Session Replay" and "Installation Methods". Is there a plan to hide or suppress them in this PR, or will that be handled in a new pr?
|
|
||
| Visit `/debug-sentry` in your browser. The error should appear in your Sentry project within a few moments. | ||
|
|
||
| ## Features |
There was a problem hiding this comment.
The content here (+Runtime behavior) should be integrated into the Steps architecture above and/or moved to other pages. Some points are purely informational and are usually not included in our quick start guides (for example, tracing topics could go into the respective tracing docs pages).
I would say to leave this Features section as is for now, since this is a new SDK, and let's fine-tune it later. I can take care of it (with your input of course) if that sounds okay to you
There was a problem hiding this comment.
Sounds good, I will leave as and happy to help with it later.
|
@inventarSarah Thanks for taking a look, I will address all those comments as I think all those points make since and should be in the first draft. Thanks! 🙏 |
Add getting started guide for the new @sentry/elysia package covering Bun and Node.js runtimes, error capturing, automatic tracing, and distributed trace propagation. Wire up the Elysia platform icon. Refs getsentry/sentry-javascript#19509 Co-Authored-By: Claude <noreply@anthropic.com>
- Use correct sentry.javascript.elysia SDK identifier instead of bun - Fix inconsistent tab title casing (node → Node.js) - Clarify shouldHandleError example to avoid double-wrap confusion - Fix alphabetical ordering of elysia/elixir in icon map Co-Authored-By: Claude <noreply@anthropic.com>
Align the Elysia getting-started guide with other JS guides per reviewer feedback: add onboarding option buttons, sendDefaultPii, source maps step, structured verify section with issues/tracing/logs, troubleshooting expandable, and suppress inapplicable pages (Session Replay, Installation Methods) for the Elysia platform. Co-Authored-By: Claude <noreply@anthropic.com>
61943bc to
0380116
Compare
The common install page lists javascript.elysia in its notSupported frontmatter, so the /install route doesn't exist for this guide. Co-Authored-By: Claude <noreply@anthropic.com>
inventarSarah
left a comment
There was a problem hiding this comment.
Looks great, thanks for updating 🎉
I added two small suggestions
| </PlatformSection> | ||
|
|
||
| <PlatformSection supported={["javascript.azure-functions", "javascript.firebase", "javascript.connect", "javascript.express", "javascript.fastify", "javascript.gcp-functions", "javascript.hapi", "javascript.hono", "javascript.koa", "javascript.nestjs", "javascript.node"]}> | ||
| <PlatformSection supported={["javascript.azure-functions", "javascript.firebase", "javascript.connect", "javascript.elysia", "javascript.express", "javascript.fastify", "javascript.gcp-functions", "javascript.hapi", "javascript.hono", "javascript.koa", "javascript.nestjs", "javascript.node"]}> |
There was a problem hiding this comment.
Since the user didn't set up profiling in this guide, I would display only Issues, Tracing, and Logs for Elysia.
So, instead of adding it on Line 29, I suggest adding it here (see Line 38) in the file:
<PlatformSection supported={["javascript.bun", "javascript.cloudflare", "javascript.deno", "javascript.wasm"]}>
<FeatureInfo features={["issues", "tracing", "logs"]} type="findInSentry" />
</PlatformSection>
Co-authored-by: Sarah Mischinger <sarah@codingwriter.com>

DESCRIBE YOUR PR
Add getting started documentation for the new
@sentry/elysiapackage, a Sentry SDK for the Elysia web framework.docs/platforms/javascript/guides/elysia/covering Bun and Node.js runtimesplatformIcon.tsxBlocked on
platformiconsversion here)IS YOUR CHANGE URGENT?
Help us prioritize incoming PRs by letting us know when the change needs to go live.
SLA
Thanks in advance for your help!
PRE-MERGE CHECKLIST
Make sure you've checked the following before merging your changes:
🤖 Generated with Claude Code