Skip to content

docs(js): broaden server integration support via categories - #19512

Open
mydea wants to merge 2 commits into
guide-cat/16-special-use-casesfrom
guide-cat/17-server-integration-matrix
Open

mydea wants to merge 2 commits into
guide-cat/16-special-use-casesfrom
guide-cat/17-server-integration-matrix

Conversation

@mydea

@mydea mydea commented Sep 18, 2026

Copy link
Copy Markdown
Member

DESCRIBE YOUR PR

Stacked PR. Part of the JavaScript guide-categories series (#19492#19513). Depends on #19511; review/merge bottom-up.

Several Node/framework integrations were pinned to a handful of frameworks in hand-maintained lists even though the SDK exports them across server runtimes. Move them to supportedCategories: [server], listing only the runtimes the SDK genuinely does not support under notSupported, verified against getsentry/sentry-javascript.

  • childProcess: node-only → exclude bun, deno, cloudflare (keep electron).
  • fastify: available across all server runtimes (node, bun, deno, cloudflare) — no exclusions.
  • koa / hapi: available across all server runtimes (node, bun, deno, cloudflare) — no exclusions.
  • postgresjs: available across all server runtimes (node, bun, deno, cloudflare) — no exclusions (the previous list wrongly listed only cloudflare/deno and omitted node/bun).
  • Removed the stale "only works in the Node.js and Bun runtimes" alerts from fastify, koa, and hapi.
  • connect and nest were left as-is — connectIntegration does not exist and nestIntegration is @sentry/nestjs-only (connect removal handled in the next PR).

IS YOUR CHANGE URGENT?

Help us prioritize incoming PRs by letting us know when the change needs to go live.
Select exactly one option. For deadlines, replace YYYY-MM-DD with the due date. You can update this information later by editing the PR description.

  • Urgent deadline (GA date, etc.): YYYY-MM-DD
  • Other deadline: YYYY-MM-DD
  • No deadline: 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 supplied a deadline.

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

vercel Bot commented Sep 18, 2026

Copy link
Copy Markdown

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

Project Deployment Actions Updated
sentry-docs Ready Ready Preview Sep 22, 2026 1:31pm UTC
1 Skipped Deployment
Project Deployment Actions Updated
develop-docs Ignored Ignored Preview Sep 22, 2026 1:31pm UTC

Request Review

@mydea
mydea added this pull request to stack #19507 September 18, 2026 11:29
@github-actions github-actions Bot added the Priority: Needs Triage The PR description is missing valid priority information label Sep 18, 2026
@github-actions github-actions Bot added Priority: Normal Docs review has no urgent deadline and removed Priority: Needs Triage The PR description is missing valid priority information labels Sep 18, 2026
@mydea
mydea marked this pull request as ready for review September 21, 2026 07:23
@codeowner-assignment
codeowner-assignment Bot requested a review from a team September 21, 2026 07:23
@mydea
mydea force-pushed the guide-cat/17-server-integration-matrix branch from 959316e to bcb3b23 Compare September 21, 2026 08:07
@mydea
mydea force-pushed the guide-cat/17-server-integration-matrix branch from bcb3b23 to 22e96cc Compare September 21, 2026 08:18
Comment on lines 1 to 8
---
title: Postgres.js
description: "Adds instrumentation for the postgres (postgres.js) library."
supported:
- javascript.cloudflare
- javascript.deno
supportedCategories:
- server
---

<AvailableSince version="10.41.0" />

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Bug: The documentation for the postgresjs integration is incorrectly shown for Node.js and Bun runtimes, where the integration is not actually supported.
Severity: LOW

Suggested Fix

Update the supportedCategories in postgresjs.mdx to accurately list only the supported runtimes, such as ['deno', 'cloudflare'], instead of the general [server] category. This will ensure the documentation is only visible for platforms where the integration is available.

Prompt for AI Agent
Review the code at the location below. A potential bug has been identified by an AI
agent. Verify if this is a real issue. If it is, propose a fix; if not, explain why it's
not valid.

Location:
docs/platforms/javascript/common/configuration/integrations/postgresjs.mdx#L1-L8

Potential issue: The change to `supportedCategories: [server]` in the `postgresjs.mdx`
file incorrectly makes the documentation for the `postgresjs` integration visible for
all server runtimes, including Node.js and Bun. However, the `instrumentPostgresJsSql`
integration is not supported on these platforms; it is only available for Deno and
Cloudflare. This inconsistency will mislead users on Node.js and Bun into thinking the
feature is available to them, causing confusion and potential implementation errors when
they find it doesn't work.

Did we get this right? 👍 / 👎 to inform future reviews.

@mydea
mydea removed this pull request from stack #19507 September 22, 2026 13:07
@mydea
mydea added this pull request to stack #19556 September 22, 2026 13:08
mydea and others added 2 commits September 22, 2026 15:22
These integrations are exported from `@sentry/node` (and re-exported by the
edge runtimes that support them), so they are available across all server SDKs
rather than the handful of frameworks the hand-maintained lists enumerated.
Move them to `supportedCategories: [server]` with the runtimes the SDK does
not support listed under `notSupported`, verified against the exports in
getsentry/sentry-javascript.

- childProcess: node-only → exclude bun, deno, cloudflare (keep electron).
- fastify: node+bun → exclude deno, cloudflare.
- koa: node+bun+deno → exclude cloudflare.
- hapi: node+bun+deno → exclude cloudflare.
- postgresjs: node+bun+deno → exclude cloudflare (the previous list wrongly
  listed only cloudflare/deno and omitted node/bun).

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
These integrations are also available on the edge runtimes, so drop the
notSupported runtime exclusions and let them show across all server SDKs:

- fastify: also available on deno and cloudflare.
- hapi: also available on cloudflare.
- koa: also available on cloudflare.
- postgresjs: also available on cloudflare.

Remove the "only works in Node.js and Bun runtimes" alerts from fastify,
hapi, and koa, which no longer hold.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

This branch was successfully deployed

1 active deployment
Preview – sentry-docs 5d854247 Deployed Sep 22, 2026 by vercel[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Priority: Normal Docs review has no urgent deadline

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants