docs(sdk): Add foundations/transport section#16404
Merged
stephanie-anderson merged 3 commits intomasterfrom Feb 17, 2026
Merged
docs(sdk): Add foundations/transport section#16404stephanie-anderson merged 3 commits intomasterfrom
stephanie-anderson merged 3 commits intomasterfrom
Conversation
Move "SDK Errors" and "Layer of Integration" from sdk/overview.mdx into working principles as "Never capture your own exceptions" and "Integrate at the lowest level". Drop "Ten" from the index description since the count is no longer fixed. Co-Authored-By: Claude <noreply@anthropic.com>
Create the foundations/ layer of the SDK docs restructure: - git mv envelopes, envelope-items from data-model/ to foundations/transport/ - git mv rate-limiting from expected-features/ to foundations/transport/ - git mv overview to foundations/, strip transport content already extracted into dedicated pages - New pages: authentication (DSN, auth headers, HTTP headers), compression (content-encoding, transfer encoding), transport index (response handling, server errors) - Add redirects for all moved pages in middleware.ts - Demote processes/ sidebar_order to 99 (being superseded) Co-Authored-By: Claude <noreply@anthropic.com>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
1 Skipped Deployment
|
stephanie-anderson
force-pushed
the
docs/add-sdk-foundations-transport
branch
from
04e0442 to
953bca5
Compare
6 tasks
Base automatically changed from
docs/add-sdk-principles-from-overview
to
master
February 17, 2026 14:16
dingsdax
reviewed
Feb 17, 2026
dingsdax
reviewed
Feb 17, 2026
dingsdax
reviewed
Feb 17, 2026
| 'https://sentry.example.com/api/1/store/' | ||
| ``` | ||
|
|
||
| <Alert title="Note" level="warning"> |
Contributor
There was a problem hiding this comment.
The alert says it's deprecated, below it says it will be deprecated. This is the type of content that f***s up agents. My suggestion is to either:
- remove alert and mark explicitly as deprecated or optional or without function
- or remove secret part completely, it it's entirely ignored anyways.
dingsdax
reviewed
Feb 17, 2026
| SDKs are encouraged to allow arbitrary options via the constructor, but must allow the first argument as a DSN string. This string contains the following bits: | ||
|
|
||
| ``` | ||
| '{PROTOCOL}://{PUBLIC_KEY}:{SECRET_KEY}@{HOST}{PATH}/{PROJECT_ID}' |
Contributor
There was a problem hiding this comment.
we never document what PATH can be, add examples?
dingsdax
reviewed
Feb 17, 2026
| Within the `HOST` segment you will find the ingest domain for your organization. For self-hosted instances this will be the base host of your instance, and for sentry.io it will contain a host in the pattern of `o{orgid}.ingest.{region}.sentry.io`. For US based accounts `o{orgid}.ingest.sentry.io` will also work. | ||
|
|
||
| <Alert title="Note" level="warning"> | ||
| All segments, including PROJECT_ID, are of type String. |
Contributor
There was a problem hiding this comment.
Suggested change
| All segments, including PROJECT_ID, are of type String. | |
| All DSN components, including PROJECT_ID, must be treated as strings. SDKs must not assume numeric types``` |
dingsdax
reviewed
Feb 17, 2026
| The resulting POST request for a plain JSON payload would then transmit to: | ||
|
|
||
| ``` | ||
| 'https://sentry.example.com/api/1/store/' |
Contributor
There was a problem hiding this comment.
bad example ... store is legacy afaik, better use an envelope example
dingsdax
reviewed
Feb 17, 2026
| The resulting POST request for a plain JSON payload would then transmit to: | ||
|
|
||
| ``` | ||
| 'https://sentry.example.com/api/1/store/' |
Contributor
There was a problem hiding this comment.
Suggested change
| 'https://sentry.example.com/api/1/store/' | |
| 'https://o123.ingest.us.sentry.io/api/456/envelope/' |
dingsdax
approved these changes
Feb 17, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
DESCRIBE YOUR PR
Create the
foundations/layer of the SDK docs restructure. This introduces the transport subsection with dedicated pages for each concern.Moved (git history preserved):
data-model/envelopes.mdx→foundations/transport/envelopes.mdxdata-model/envelope-items.mdx→foundations/transport/envelope-items.mdxexpected-features/rate-limiting.mdx→foundations/transport/rate-limiting.mdxoverview.mdx→foundations/overview.mdx(stripped to just "Writing an SDK" + "Usage for End-users")New pages (extracted from overview.mdx):
transport/authentication.mdx— DSN parsing, X-Sentry-Auth, HTTP headers, User-Agenttransport/compression.mdx— content-encoding, transfer encodingtransport/index.mdx— response handling, server errorsfoundations/index.mdx— hub pageRedirects added for all moved pages in
src/middleware.ts.Stacks on #16403.
IS YOUR CHANGE URGENT?
SLA
Thanks in advance for your help!
PRE-MERGE CHECKLIST
Co-Authored-By: Claude noreply@anthropic.com