mirror of
https://github.com/supabase/supabase.git
synced 2026-10-05 09:25:06 +03:00
1d4d1875e7
## I have read the [CONTRIBUTING.md](https://github.com/supabase/supabase/blob/master/CONTRIBUTING.md) file. YES ## What kind of change does this PR introduce? Docs update. ## What is the current behavior? No docs for client-side trace propagation with the JS SDK. Users with OpenTelemetry-instrumented apps had no way to find out that supabase-js can attach W3C Trace Context headers and that `trace_id` shows up in API Gateway and Edge Function logs. ## What is the new behavior? New guide at `/guides/telemetry/client-side-tracing` covering requirements, opt-in setup (`tracePropagation: true`), advanced options, domain scoping, where `trace_id` appears in Supabase logs, and troubleshooting. Linked from the Logging & observability nav. Preview: https://docs-git-docs-otel-sdk-supabase.vercel.app/docs/guides/telemetry/client-side-tracing ## Additional context First of several planned SDK tracing guides. When the next SDK gets one we'll restructure into a shared `tracing/` folder. ## Summary by CodeRabbit * **Documentation** * New comprehensive guide for client-side trace propagation with the JS SDK: explains W3C Trace Context header behavior, requirements, setup steps, opt-in examples, advanced configuration, domain/security notes, and troubleshooting when trace IDs are missing. * Added a new "Tracing with the JS SDK" entry in the Logging & observability navigation for easy access to the guide. <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **Documentation** * New comprehensive guide for client-side trace propagation with the JS SDK: explains W3C Trace Context header behavior, requirements, setup steps, opt-in examples, advanced configuration, domain/security notes, and troubleshooting when trace IDs are missing. * Added a "Tracing with the JS SDK" entry under Logging & observability for quick access. * Documentation metadata updated to reference the latest source snapshots. * Lint rules updated to allow "OpenTelemetry", "Zipkin", and "noop". <!-- review_stack_entry_start --> [](https://app.coderabbit.ai/change-stack/supabase/supabase/pull/46218?utm_source=github_walkthrough&utm_medium=github&utm_campaign=change_stack) <!-- review_stack_entry_end --> <!-- end of auto-generated comment: release notes by coderabbit.ai --> --------- Co-authored-by: Chris Chinchilla <chris.ward@supabase.io> Co-authored-by: Chris Chinchilla <chris@chrischinchilla.com> Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Reference Docs
Supabase Reference Docs
Maintainers
If you are a maintainer of any tools in the Supabase ecosystem, you can use this site to provide documentation for the tools & libraries that you maintain.
Versioning
All tools have versioned docs, which are kept in separate folders. For example, the CLI has the following folders and files:
cli: the "next" release.cli_spec: contains the DocSpec for the "next" release (see below).cli_versioned_docs: a version of the documentation for every release (including the most current version).cli_versioned_sidebars: a version of the sidebar for every release (including the most current version).
When you release a new version of a tool, you should also release a new version of the docs. You can do this via the command line. For example, if you just released the CLI version 1.0.1:
npm run cli:version 1.0.1
DocSpec
We use documentation specifications which can be used to generate human-readable docs.
- OpenAPI: for documenting API endpoints.
- SDKSpec (custom to Supabase): for SDKs and client libraries.
- ConfigSpec (custom to Supabase): for configuration options.
- CLISpec (custom to Supabase): for CLI commands and usage.
The benefit of using custom specifications is that we can generate many other types from a strict schema (eg, HTML and manpages). It also means that we can switch to any documentation system we want. On this site we use Next.js, but on Supabase's official website, we use a custom React site and expose only a subset of the available API for each tool.
Contributing
To contribute to docs, see the developers' guide and contributing guide.