Skip to content

docs(js): Update the OpenTelemetry pages for v11, keep v10 versions - #19515

Closed
JPeer264 wants to merge 2 commits into
js-v11-docsfrom
janpeer/sdk-1351-prepare-pr-to-remove-custom-otel-setup-page
Closed

JPeer264 wants to merge 2 commits into
js-v11-docsfrom
janpeer/sdk-1351-prepare-pr-to-remove-custom-otel-setup-page

Conversation

@JPeer264

Copy link
Copy Markdown
Member

DESCRIBE YOUR PR

closes SDK-1351

Every page in the OpenTelemetry section documented APIs that v11 removed:

  • skipOpenTelemetrySetup was replaced by enableOpenTelemetrySetup.
  • SentryContextManager, SentrySampler, SentrySpanProcessor and
    validateOpenTelemetrySetup were removed, so wiring Sentry's
    components into a provider you own is no longer possible.
  • The openTelemetryInstrumentations and openTelemetrySpanProcessors
    options were removed.

Snapshot all three pages as __v10.x so readers on v10 keep working
instructions, since every one of those APIs is valid there, and rewrite
the current pages around what v11 ships.

  • The landing page claimed OpenTelemetry instrumentation is picked up
    "without any further configuration". It isn't: the SDK registers no
    tracer provider by default, so spans from @opentelemetry/api are not
    captured. Describe the two ways to connect the pipelines instead.
  • "Using Your Existing OpenTelemetry Setup" was built end to end on the
    removed components. It now covers the two setups that exist, and says
    what happened to the components it used to document.
  • "Using OpenTelemetry APIs" loses the two sections built on the removed
    options. Adding instrumentation goes through OpenTelemetry's own
    registerInstrumentations(), and the page states that it assumes
    enableOpenTelemetrySetup: true.

The performance/opentelemetry-setup includes are left alone: only the v10 page renders them now, and they document v10 correctly.

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

LEGAL BOILERPLATE

Look, I get it. The entity doing business as "Sentry" was incorporated in the State of Delaware in 2015 as Functional Software, Inc. and is gonna need some rights from me in order to utilize my contributions in this here PR. So here's the deal: I retain all rights, title and interest in and to my contributions, and by keeping this boilerplate intact I confirm that Sentry can use, modify, copy, and redistribute my contributions, under Sentry's choice of terms.

EXTRA RESOURCES

JPeer264 and others added 2 commits September 17, 2026 16:56
…egration

v11 has no lightweight mode. `@sentry/node-core` was merged back into
`@sentry/node`, so `@sentry/node-core/light` no longer exists and the
whole page described a setup that cannot be followed.

The OTLP half of that page survives in a different form. The integration
moved to the main export of every server SDK and was renamed to
`openTelemetryIntegration()`, because it sends nothing over OTLP. Give it
its own integration page covering what it does, the exporter wiring
through `getOtlpTracesEndpoint()`, and the `enableOpenTelemetrySetup`
caveat for `@sentry/nextjs` and `@sentry/sveltekit`.

The removed `setupOtlpTracesExporter` and `collectorUrl` options are not
carried over: you configure the exporter yourself now.

- Drop the lightweight entry from the installation methods page.
- Point the "simpler way to bridge your existing setup" line on the
  custom OpenTelemetry setup page at the new integration.
- Point the Node.js card on the OTLP concepts page there too.
- Redirect `/install/lightweight/` to the new page for the seven guides
  that served it.

Refs SDK-1352
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Every page in the OpenTelemetry section documented APIs that v11 removed:

- `skipOpenTelemetrySetup` was replaced by `enableOpenTelemetrySetup`.
- `SentryContextManager`, `SentrySampler`, `SentrySpanProcessor` and
  `validateOpenTelemetrySetup` were removed, so wiring Sentry's
  components into a provider you own is no longer possible.
- The `openTelemetryInstrumentations` and `openTelemetrySpanProcessors`
  options were removed.

Snapshot all three pages as `__v10.x` so readers on v10 keep working
instructions, since every one of those APIs is valid there, and rewrite
the current pages around what v11 ships.

- The landing page claimed OpenTelemetry instrumentation is picked up
  "without any further configuration". It isn't: the SDK registers no
  tracer provider by default, so spans from `@opentelemetry/api` are not
  captured. Describe the two ways to connect the pipelines instead.
- "Using Your Existing OpenTelemetry Setup" was built end to end on the
  removed components. It now covers the two setups that exist, and says
  what happened to the components it used to document.
- "Using OpenTelemetry APIs" loses the two sections built on the removed
  options. Adding instrumentation goes through OpenTelemetry's own
  `registerInstrumentations()`, and the page states that it assumes
  `enableOpenTelemetrySetup: true`.

The `performance/opentelemetry-setup` includes are left alone: only the
v10 page renders them now, and they document v10 correctly.

Refs SDK-1351
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
@JPeer264 JPeer264 self-assigned this Sep 18, 2026
@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 18, 2026 12:06pm UTC
1 Skipped Deployment
Project Deployment Actions Updated
develop-docs Ignored Ignored Sep 18, 2026 12:06pm UTC

Request Review

@linear-code

linear-code Bot commented Sep 18, 2026

Copy link
Copy Markdown

SDK-1351

@github-actions github-actions Bot added the Priority: Needs Triage The PR description is missing valid priority information label Sep 18, 2026
@JPeer264
JPeer264 added this pull request to stack #19517 September 18, 2026 12:03
@andreiborza
andreiborza removed this pull request from stack #19517 September 22, 2026 12:15
@andreiborza
andreiborza changed the base branch from janpeer/sdk-1352-prepare-pr-to-remove-lightweight-mode-page to js-v11-docs September 22, 2026 12:15
@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
You can add your own `@opentelemetry/instrumentation-http` instance in your OpenTelemetry setup. However, in this case, you need to disable span creation in Sentry's `httpIntegration`. You can also set `tracePropagation: false` to prevent Sentry from injecting trace headers, letting your OpenTelemetry setup handle propagation instead:

<PlatformSection notSupported={["javascript.bun"]}>
```javascript

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 v10 documentation snapshot custom-setup__v10.x.mdx contains an empty <Alert> block, which will render a confusing, empty box for users viewing v10-specific documentation.
Severity: LOW

Suggested Fix

Restore the original content about 'lightweight mode' inside the <Alert> block within the custom-setup__v10.x.mdx file. This will ensure the v10 documentation snapshot is complete and provides the necessary context for users.

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/opentelemetry/custom-setup__v10.x.mdx#L119

Potential issue: The documentation snapshot for v10, `custom-setup__v10.x.mdx`, contains
an empty `<Alert>` block. This block was intended to preserve content about 'lightweight
mode' for users of the v10 SDK. Instead, it will render a visually empty and confusing
alert box for users viewing the v10 documentation for specific platforms like Node,
Express, and others. While this does not cause a functional failure in the SDK, it
creates a regression in documentation quality and leaves v10 users without important
guidance that was supposed to be preserved.

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

@msonnb

msonnb commented Sep 22, 2026

Copy link
Copy Markdown
Member

superseded by #19458

@msonnb msonnb closed this Sep 22, 2026

This branch was successfully deployed

1 active deployment
Preview – sentry-docs 4cdfb28c Deployed Sep 18, 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