Skip to content

docs(hono): Document dedicated @sentry/hono SDK#17557

Merged
s1gr1d merged 6 commits intomasterfrom
sig/hono-docs
May 5, 2026
Merged

docs(hono): Document dedicated @sentry/hono SDK#17557
s1gr1d merged 6 commits intomasterfrom
sig/hono-docs

Conversation

@s1gr1d
Copy link
Copy Markdown
Member

@s1gr1d s1gr1d commented Apr 30, 2026

DESCRIBE YOUR PR

The Hono docs previously documented the setup using other SDKs, but not @sentry/hono. This PR changes the quick setup page to include the new setup.

Closes getsentry/sentry-javascript#20402

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

@vercel
Copy link
Copy Markdown

vercel Bot commented Apr 30, 2026

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

Project Deployment Actions Updated (UTC)
sentry-docs Ready Ready Preview, Comment May 5, 2026 9:11am
1 Skipped Deployment
Project Deployment Actions Updated (UTC)
develop-docs Ignored Ignored Preview May 5, 2026 9:11am

Request Review

@s1gr1d s1gr1d requested review from a team and inventarSarah April 30, 2026 09:12
Comment thread docs/platforms/javascript/guides/hono/index.mdx
Comment thread docs/platforms/javascript/guides/hono/index.mdx Outdated
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.

Hey @s1gr1d 👋
left some questions and suggestions -- thank you!

- **Cloudflare Workers**: Use `@sentry/cloudflare` – see our [Hono on Cloudflare guide](/platforms/javascript/guides/cloudflare/frameworks/hono/)
- **Deno**: Use `@sentry/deno` – see our [Deno guide](/platforms/javascript/guides/deno/) (Beta)
- **Bun**: Use `@sentry/bun` – see our [Bun guide](/platforms/javascript/guides/bun/)
The community middleware `@hono/sentry` has been deprecated in favor of `@sentry/hono`, which provides better performance and more features. If you're currently using `@hono/sentry`, see the [migration section](#migrating-from-honosentry) below.
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.

You could create an Expandable section "Are you using @hono/sentry?", add this content inside it, and then also the migration section from the end of the guide.
This would still only require minimal space, and it removes the migration part at the end, which currently looks a bit lost.
What do you think?

options={["error-monitoring", "performance", "logs"]}
/>

<Include name="quick-start-features-expandable" />
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.

This still lists "Profiling" -> you can update this in the include file

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

I think I'll just add profiling as people can still use it when they are on the Node runtime.


## Configure

<Expandable title="Cloudflare Workers: Enable Node.js Compatibility">
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.

What is our plan regarding the Hono on Cloudflare guide?
Currently, the installation of the hono SDK is missing here (otherwise it looks alright?). If we want to keep the CF guide, we could remove the Cloudflare instructions from this guide and link to Cloudflare.

Copy link
Copy Markdown
Member Author

@s1gr1d s1gr1d May 4, 2026

Choose a reason for hiding this comment

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

True, it makes sense to include this to the list of frameworks there. As this is using the cloudflare sdk under the hood, it makes sense to already be in the cloudflare docs.
However, we could also link from cloudflare to the hono docs? Then we would have the hono docs in one place and just need different code snippets. What do you think @inventarSarah ?

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.

Yes, that sounds okay to me.
It's definitely easier for us to maintain.

So we need to:

  • replace the link to Hono on the CF quick start guide
  • remove the content from "hono on CF" and link to the Hono quick start guide instead (I don't think we can link to the Hono guide directly from the CF navigation, right?)

That should be it, I think 🤔

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Changed that here: 4a4bd1b

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.

Perfect, thank you!

Comment thread docs/platforms/javascript/guides/hono/index.mdx
Comment thread docs/platforms/javascript/guides/hono/index.mdx
Comment thread docs/platforms/javascript/guides/hono/index.mdx
Comment thread docs/platforms/javascript/guides/hono/index.mdx
Comment thread docs/platforms/javascript/guides/hono/index.mdx
Comment thread docs/platforms/javascript/guides/hono/index.mdx
Comment thread docs/platforms/javascript/guides/hono/index.mdx
Comment thread docs/platforms/javascript/guides/hono/index.mdx
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.

Thanks for the updates!

We only need to update Hono on CF :)

<SplitSection>
<SplitSectionText>

Profiling is available for the Node.js runtime. Install the `@sentry/profiling-node` package:
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.

Suggested change
Profiling is available for the Node.js runtime. Install the `@sentry/profiling-node` package:
Profiling is only available for the Node.js runtime. Install the `@sentry/profiling-node` package:

adding "only" here again just to make sure users don't miss this


## Configure

<Expandable title="Cloudflare Workers: Enable Node.js Compatibility">
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.

Yes, that sounds okay to me.
It's definitely easier for us to maintain.

So we need to:

  • replace the link to Hono on the CF quick start guide
  • remove the content from "hono on CF" and link to the Hono quick start guide instead (I don't think we can link to the Hono guide directly from the CF navigation, right?)

That should be it, I think 🤔

Copy link
Copy Markdown
Member

@chargome chargome left a comment

Choose a reason for hiding this comment

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

Just found a small bug, other than that lgtm!

Comment on lines +223 to +229
```bash
node --import ./instrument.mjs app.js
```

```bash
NODE_OPTIONS="--import ./instrument.mjs"
```
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

This does not render properly with the same title, you might need to give it a filename or rename the tab title it seems

Comment thread platform-includes/set-environment/javascript.hono.mdx
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.

Thank you 🎉

@s1gr1d s1gr1d merged commit 3039062 into master May 5, 2026
18 checks passed
@s1gr1d s1gr1d deleted the sig/hono-docs branch May 5, 2026 10:59
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.

[Hono] Add official docs

3 participants