Skip to content

docs(span-links): Add message_origin link type for queues - #20023

Merged
JPeer264 merged 5 commits into
masterfrom
jp/message-origin-link-type
Oct 22, 2026
Merged

JPeer264 merged 5 commits into
masterfrom
jp/message-origin-link-type

Conversation

@JPeer264

@JPeer264 JPeer264 commented Oct 16, 2026 •

Copy link
Copy Markdown
Member

DESCRIBE YOUR PR

This adds the message_origin link type to the span links page. A queue consumer span uses it to link to the producer span that published the message, like cache_origin does for cached values. The BullMQ integration of the JavaScript SDK sets it first (getsentry/sentry-javascript#21777), and the conventions added it in getsentry/sentry-conventions#724.

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

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@vercel

vercel Bot commented Oct 16, 2026 •

Copy link
Copy Markdown

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

Project Deployment Actions Updated
develop-docs Ready Ready Preview Oct 21, 2026 8:48am UTC
1 Skipped Deployment
Project Deployment Actions Updated
sentry-docs Ignored Ignored Preview Oct 21, 2026 8:48am UTC

Request Review

@github-actions github-actions Bot added sdk-develop-docs PRs touching develop-docs/sdk Priority: Normal Docs review has no urgent deadline labels Oct 16, 2026
@JPeer264
JPeer264 marked this pull request as ready for review October 20, 2026 13:52
@JPeer264 JPeer264 self-assigned this Oct 20, 2026
@JPeer264
JPeer264 requested review from a team, nicohrubec and s1gr1d October 20, 2026 13:52
@cursor

cursor Bot commented Oct 20, 2026 •

Copy link
Copy Markdown
Contributor

The change adds one span-link type and a link to the queues module page. The plan checks SDK page loads, telemetry-path 404s, and production errors. An issue escalates when those 404s rise or the error rate rises.

Rollout complete

Services: develop-docs.

Plan

What changed

The Span Links page now documents the message_origin link type for queue consumers. It also says when to start a new consumer trace and when not to add the link. It links to the Queues module distributed tracing section. A batch processor adds one link for each distinct producer span. This is live after a production deploy of develop-docs. Deploy config maps the Vercel project develop-docs to that service. The Sentry project tag on that build is develop-docs.

Risk

Broken MDX can 404 the Span Links page or fail client render. The new Queues module link can 404 if that sibling page fails to render. Sibling SDK telemetry pages share the same layout and MDX pipeline. A render fault can also show as hydration errors for readers.

Intended effect

This is a docs edit. The new message_origin copy has no queryable effect. No metric increments when the heading, sample, and queues link go live. Leave intended_effect unknown. Do not treat missing errors as proof.

Regression watch

A bad render on this page can 404 the telemetry path or raise client errors. Watch SDK section volume on the same tree. Hydration errors already fire on self-hosted. Do not treat that issue as this change.

Signal Baseline Window Source Rule
Production error rate versus page loads 1.8-2.3% 2026-10-20T10:44Z to 2026-10-22T10:44Z Sentry errors environment:production count, divided by docs.page.load environment:production. Project develop-docs. Last 24h: 35 errors and 1992 loads. Prior 24h: 36 errors and 1563 loads. Hold in band. Escalate if the rate rises above 2.3%.
404s on sdk/telemetry 1-2 counts per 24h against 303-305 SDK loads 2026-10-20T10:44Z to 2026-10-22T10:44Z Sentry metric docs.page.not_found query requested_path:sdk/telemetry environment:production. Last 24h: 2. Prior 24h: 1. Denominator is docs.page.load page_type:sdk. Stay in that count band. Escalate if 404s rise above 2 while SDK loads hold.
SDK page loads 303-305 per 24h 2026-10-20T10:44Z to 2026-10-22T10:44Z Sentry metric docs.page.load query page_type:sdk environment:production. Last 24h: 305. Prior 24h: 303. Hold in band. A drop below 303 with rising 404s is a regression.
MDX missing-file warn logs 0 of those warns against 1563-1992 page loads 2026-10-20T10:44Z to 2026-10-22T10:44Z Sentry logs severity:warn message:"*MDX file not found at runtime*". Project develop-docs. Last 24h: 0. Prior 24h: 0. Remain at 0. If they appear, check the path.

If the error rate rises, check hydration errors on SDK paths. If 404s rise, check the Queues module target and the Span Links page.

Not observable

The new heading text is not in telemetry. Page loads for /sdk/telemetry/traces/span-links/ were 7 then 0 across the two 24h slices. That volume is too sparse to decide. Page loads for /sdk/telemetry/traces/modules/queues/ had no series in 24h. The 48h query for that path timed out.

Get Slack DMs about this change: cursor.com/automations/rollouts

@coolguyzone coolguyzone left a comment

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.

Looks good, thanks for adding!

@JPeer264
JPeer264 merged commit ddb6cbb into master Oct 22, 2026
24 checks passed
@JPeer264
JPeer264 deleted the jp/message-origin-link-type branch October 22, 2026 10:43

This branch was successfully deployed

1 active deployment
Preview – develop-docs — ba272789 Deployed Oct 21, 2026 by vercel[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Priority: Normal Docs review has no urgent deadline sdk-develop-docs PRs touching develop-docs/sdk

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants