Skip to content

docs(javascript): Apply httpIntegration option renames - #19548

Merged
chargome merged 2 commits into
js-v11-docsfrom
httpintegration-renames
Sep 22, 2026
Merged

chargome merged 2 commits into
js-v11-docsfrom
httpintegration-renames

Conversation

@chargome

@chargome chargome commented Sep 22, 2026 •

Copy link
Copy Markdown
Member

DESCRIBE YOUR PR

Docs still described httpIntegration options that v11 renamed or removed.

  • Rename: trackIncomingRequestsAsSessions → sessions, maxIncomingRequestBodySize → maxRequestBodySize, ignoreIncomingRequestBody → ignoreRequestBody, dropSpansForIncomingRequestStatusCodes → ignoreStatusCodes, incomingRequestSpanHook → onSpanCreated
  • Flag ignoreStatusCodes as deprecated and traceLifecycle: 'static' only
  • Replace the removed instrumentation hooks with onSpanCreated / outgoingRequestHook, and document the two other outgoing hooks
  • Fix three pre-existing errors found while verifying against the SDK source: the spans default, ignoreOutgoingRequests trace headers, and the intro

Fixes SDK-1476

JavaScript SDK v11 renamed several httpIntegration options and removed the
deprecated instrumentation.{requestHook,responseHook,applyCustomAttributesOnSpan}
hooks. Update the HTTP integration reference and the session tracking includes so
they no longer document options that were removed.

Also correct three details that were already stale, found while verifying every
option on the page against the SDK source: the spans default, the trace header
behavior of ignoreOutgoingRequests, and the integration summary, which omitted
incoming spans and sessions.

Fixes SDK-1476
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
@vercel

vercel Bot commented Sep 22, 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:27pm UTC
1 Skipped Deployment
Project Deployment Actions Updated
develop-docs Ignored Ignored Preview Sep 22, 2026 1:27pm UTC

Request Review

@linear-code

linear-code Bot commented Sep 22, 2026

Copy link
Copy Markdown

SDK-1476

@github-actions github-actions Bot added the Priority: Normal Docs review has no urgent deadline label Sep 22, 2026
@chargome chargome self-assigned this Sep 22, 2026
@github-actions github-actions Bot added Priority: Needs Triage The PR description is missing valid priority information and removed Priority: Normal Docs review has no urgent deadline labels Sep 22, 2026
@chargome
chargome marked this pull request as ready for review September 22, 2026 08:47
@chargome
chargome marked this pull request as draft September 22, 2026 08:47
_Type: `boolean`_ (Defaults to `true` when tracing is enabled)

If set to true, spans will be created for outgoing HTTP requests.
If set to false, no spans will be created for HTTP requests, neither for incoming nor for outgoing ones. Only the Sentry-specific instrumentation for request isolation is applied.

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.

q/l: Do we even need to mention the request isolation here? Seems like an implementation detail.


<Alert level="warning">

This option is deprecated and will be removed in the next major version without a replacement. It only has an effect when `traceLifecycle` is set to `'static'`. With span streaming, child spans are sent as they end, before the response status code is known, so spans can't be dropped based on the status code. To keep requests out of Sentry, use [`ignoreIncomingRequests`](#ignoreincomingrequests), `tracesSampler`, or `ignoreSpans` instead.

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.

l: Can we also link to tracesSpampler and ignoreSpans headings like we did for ignoreIncomingRequests?

@andreiborza
andreiborza changed the base branch from master to js-v11-docs September 22, 2026 12:13
@andreiborza
andreiborza marked this pull request as ready for review September 22, 2026 13:16
@github-actions

Copy link
Copy Markdown
Contributor

Please update the IS YOUR CHANGE URGENT? section of the PR description:

  • Select exactly one option.
  • If you selected an urgent or other deadline, provide the date as YYYY-MM-DD.

This information helps the Docs team prioritize your review.

@codeowner-assignment
codeowner-assignment Bot requested a review from a team September 22, 2026 13:17
Drop the request isolation note from the spans option, since that's an
implementation detail readers don't need.

Link tracesSampler and ignoreSpans from the ignoreStatusCodes deprecation
note, so all three suggested alternatives are reachable, matching how
ignoreIncomingRequests is already linked.

Refs SDK-1476
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
@chargome
chargome merged commit bd02b21 into js-v11-docs Sep 22, 2026
8 checks passed
@chargome
chargome deleted the httpintegration-renames branch September 22, 2026 13:38

This branch was successfully deployed

1 active deployment
Preview – sentry-docs — 0084b661 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

js-v11-docs Priority: Needs Triage The PR description is missing valid priority information

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants