Skip to content

docs: document the supabase-js /tracing opt-in subpath - #48529

Open
mandarini wants to merge 4 commits into
masterfrom
docs/js-tracing-optin-subpath
Open

docs: document the supabase-js /tracing opt-in subpath#48529
mandarini wants to merge 4 commits into
masterfrom
docs/js-tracing-optin-subpath

Conversation

@mandarini

@mandarini mandarini commented Jul 31, 2026

Copy link
Copy Markdown
Contributor

What kind of change does this PR introduce?

Documentation update for apps/docs/content/guides/monitoring-and-debugging/client-side-tracing.mdx.

As of @supabase/supabase-js 2.112.0 (supabase/supabase-js#2583), the OpenTelemetry integration moved out of the main bundle into an opt-in subpath. Enabling trace propagation now takes two steps: import '@supabase/supabase-js/tracing' at the application entry point, plus the existing tracePropagation: true client option.

Guide changes:

  • Requirements: documents the subpath import (2.112.0+), the loud-resolution behavior when @opentelemetry/api is missing, the one-time warning when the runtime isn't loaded, the version note for 2.106.0–2.111.x (no import there), and that the CDN/UMD build does not support tracing.
  • Both code samples now start with the subpath import.
  • Troubleshooting: new first check (runtime not loaded → one-time console warning), updated @opentelemetry/api semantics per version, new CDN/UMD entry.

The JS reference (typeSpec.json) is regenerated automatically by the docs-update pipeline from the supabase-js spec and is not touched here.

Timing note: merge once 2.112.0 is promoted to latest (currently on beta/canary) so the guide doesn't get ahead of the stable release.

Summary by CodeRabbit

  • Documentation
    • Updated client-side tracing guidance for @supabase/supabase-js 2.112.0 and later.
    • Added setup examples for the required one-time opt-in import.
    • Clarified behavior when tracing dependencies are missing and documented CDN usage limitations.
    • Expanded troubleshooting guidance for runtime loading, module resolution, and UMD usage.

@mandarini
mandarini requested a review from a team as a code owner July 31, 2026 09:47
@mandarini mandarini added the do-not-merge Not ready to be merged yet; pending other dependencies label Jul 31, 2026
@vercel

vercel Bot commented Jul 31, 2026

Copy link
Copy Markdown

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

Project Deployment Actions Updated (UTC)
docs Ready Ready Preview, v0 Jul 31, 2026 3:02pm
6 Skipped Deployments
Project Deployment Actions Updated (UTC)
studio Ignored Ignored Jul 31, 2026 3:02pm
design-system Skipped Skipped Jul 31, 2026 3:02pm
studio-self-hosted Skipped Skipped Jul 31, 2026 3:02pm
studio-staging Skipped Skipped Jul 31, 2026 3:02pm
ui-library Skipped Skipped Jul 31, 2026 3:02pm
zone-www-dot-com Skipped Skipped Jul 31, 2026 3:02pm

Request Review

@github-actions github-actions Bot added the documentation Improvements or additions to documentation label Jul 31, 2026
@supabase

supabase Bot commented Jul 31, 2026

Copy link
Copy Markdown

This pull request has been ignored for the connected project xguihxuzqibwxjnimxev because there are no changes detected in supabase directory. You can change this behaviour in Project Integrations Settings ↗︎.


Preview Branches by Supabase.
Learn more about Supabase Branching ↗︎.

@mandarini mandarini self-assigned this Jul 31, 2026
@coderabbitai

coderabbitai Bot commented Jul 31, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro Plus

Run ID: 3344afc2-cebb-42e8-b439-adeb6888c821

📥 Commits

Reviewing files that changed from the base of the PR and between 1b330e4 and 786eae0.

📒 Files selected for processing (1)
  • apps/docs/content/guides/monitoring-and-debugging/client-side-tracing.mdx
🚧 Files skipped from review as they are similar to previous changes (1)
  • apps/docs/content/guides/monitoring-and-debugging/client-side-tracing.mdx

📝 Walkthrough

Walkthrough

The client-side tracing guide documents the required tracing runtime import for @supabase/supabase-js 2.112.0+, legacy behavior, dependency resolution, CDN limitations, setup examples, and troubleshooting. The spelling lint allow-list includes related tracing terms.

Changes

Client-side tracing documentation

Layer / File(s) Summary
Tracing runtime setup and troubleshooting
apps/docs/content/guides/monitoring-and-debugging/client-side-tracing.mdx
Documents the tracing subpath import, version-specific loading behavior, dependency resolution, CDN limitations, configuration examples, and troubleshooting outcomes.
Tracing documentation spelling validation
supa-mdx-lint/Rule003Spelling.toml
Allows the terms “bundler,” “no-op,” and “subpath” in singular and plural forms where applicable.

Estimated code review effort: 2 (Simple) | ~10 minutes

Possibly related PRs

Suggested reviewers: jeremenichelli

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly identifies the documentation change for the supabase-js tracing opt-in subpath.
Description check ✅ Passed The description clearly explains the documentation update, tracing behavior, version guidance, examples, troubleshooting, and release timing.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches 💡 1
🛠️ Fix failing CI checks 💡
  • Fix failing CI checks
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/js-tracing-optin-subpath

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@mandarini

Copy link
Copy Markdown
Contributor Author

Thanks @jeremenichelli , I'll merge on Monday after I release!

mandarini and others added 2 commits July 31, 2026 16:44
…tracing.mdx

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

do-not-merge Not ready to be merged yet; pending other dependencies documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants