Skip to content

docs(elysia): Add @sentry/elysia SDK documentation#17107

Merged
logaretm merged 9 commits intomasterfrom
awad/elysia-sdk
Apr 2, 2026
Merged

docs(elysia): Add @sentry/elysia SDK documentation#17107
logaretm merged 9 commits intomasterfrom
awad/elysia-sdk

Conversation

@logaretm
Copy link
Copy Markdown
Member

@logaretm logaretm commented Mar 24, 2026

DESCRIBE YOUR PR

Add getting started documentation for the new @sentry/elysia package, a Sentry SDK for the Elysia web framework.

  • New guide at docs/platforms/javascript/guides/elysia/ covering Bun and Node.js runtimes
  • Error capturing, automatic lifecycle tracing, distributed tracing, and manual spans
  • Platform icon wiring in platformIcon.tsx

Blocked on

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

🤖 Generated with Claude Code

@vercel
Copy link
Copy Markdown

vercel bot commented Mar 24, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
sentry-docs Ready Ready Preview, Comment Apr 2, 2026 1:25pm
1 Skipped Deployment
Project Deployment Actions Updated (UTC)
develop-docs Ignored Ignored Preview Apr 2, 2026 1:25pm

Request Review

@logaretm
Copy link
Copy Markdown
Member Author

Currently failing because of the icon, I already have a PR in flight that will resolve that.

@logaretm logaretm marked this pull request as ready for review March 27, 2026 17:16
Copilot AI review requested due to automatic review settings March 27, 2026 17:16
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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-elysia to the new icon key.
  • Bumps platformicons to 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

  • formatToSVG appears to be kept in alphabetical order by key in this file, but the new elysia entry is inserted before elixir. 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,
  },

Copy link
Copy Markdown
Contributor

@cursor cursor bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cursor Bugbot has reviewed your changes and found 1 potential issue.

Fix All in Cursor

Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, enable autofix in the Cursor dashboard.

Copy link
Copy Markdown
Collaborator

@inventarSarah inventarSarah left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Copy Markdown
Member Author

@logaretm logaretm Mar 31, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sounds good, I will leave as and happy to help with it later.

@logaretm
Copy link
Copy Markdown
Member Author

logaretm commented Mar 31, 2026

@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! 🙏

logaretm and others added 6 commits April 1, 2026 09:14
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>
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>
Copy link
Copy Markdown
Collaborator

@inventarSarah inventarSarah left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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"]}>
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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>
@logaretm logaretm merged commit 3f84cdc into master Apr 2, 2026
19 of 20 checks passed
@logaretm logaretm deleted the awad/elysia-sdk branch April 2, 2026 13:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants