js(docs): Update Tracing pages for stream mode#17862
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
…an-first/js-tracing-updates
inventarSarah
requested review from
Lms24,
aniruddhacharya-glitch,
chargome,
cleptric,
mydea and
sfanahata
and removed request for
aniruddhacharya-glitch
| }); | ||
| ``` | ||
|
|
||
| ```javascript {tabTitle:Stream Mode} |
There was a problem hiding this comment.
I'm liking these additions!
|
|
||
| See <PlatformLink to="/tracing/new-spans/">New Spans</PlatformLink> for more information. | ||
|
|
||
| ## `ignoreSpans` Rules No Longer Work After Migrating to Stream Mode |
There was a problem hiding this comment.
Do they no longer work, or does the behavior change?
There was a problem hiding this comment.
Updated this to "... No Longer Work As Expected After Migrating ..."
There was a problem hiding this comment.
I guess I'm still not entirely clear what that means. Does it just not work, or will it still work but differently? We should be explicit.
There was a problem hiding this comment.
I updated the description in this section to be more specific.
The title is fitting imo though -- for some users it could not work at all, for others some spans get dropped correctly and some not -- it depends on their configuration
…an-first/js-tracing-updates
Co-authored-by: Shannon Anahata <shannon.anahata@gmail.com>
…try/sentry-docs into smi/span-first/js-tracing-updates
| }); | ||
| ``` | ||
|
|
||
| ```javascript {tabTitle:Stream Mode} |
…an-first/js-tracing-updates
![sentry[bot]](https://avatars.githubusercontent.com/in/12637?s=60&v=4){kind=small}
| See <PlatformLink to="/tracing/streamed-spans/">Streamed Spans</PlatformLink> for more information. | ||
|
|
||
| ## `ignoreSpans` Rules No Longer Work As Expected After Migrating to Stream Mode | ||
|
|
||
| In <PlatformLink to="/tracing/streamed-spans">stream mode</PlatformLink>, `ignoreSpans` is evaluated at span start rather than at transaction end as in transaction mode. This means rules that match on names and attributes added or updated while a span is active may no longer match the intended spans. Review your `ignoreSpans` rules after migrating to make sure the names and attributes you're matching on are available when the span is created. |
There was a problem hiding this comment.
Bug: This PR adds multiple links using <PlatformLink> to a page (/tracing/streamed-spans/) that does not exist yet, which will cause 404 errors for users.
Severity: MEDIUM
Suggested Fix
This pull request should only be merged after the dependent pull request #17834, which creates the /tracing/streamed-spans/ page, has been merged. This will ensure that all the newly added links resolve correctly and do not lead to 404 errors.
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/tracing/troubleshooting/index.mdx#L36-L40
Potential issue: The pull request introduces over ten `<PlatformLink>` components across
various documentation files that link to the `/tracing/streamed-spans/` page. However,
this destination page does not exist in the repository. The PR that creates this page
(#17834) has not been merged. If this PR is merged first, users clicking on these links
will encounter a 404 "Page Not Found" error, leading to a broken documentation
experience. The PR description acknowledges this dependency but there is no automated
mechanism to enforce the correct merge order.
Also affects:
docs/platforms/javascript/common/tracing/span-metrics/index.mdxdocs/platforms/javascript/common/tracing/instrumentation/index.mdxdocs/platforms/javascript/common/tracing/automatic-instrumentation.mdxdocs/platforms/javascript/common/tracing/configure-sampling/index.mdx
Did we get this right? 👍 / 👎 to inform future reviews.
3 participants
DESCRIBE YOUR PR
This branch contains light edits to the JavaScript Tracing pages, mentioning the New Spans and Stream Mode as needed.
Important
Must only be merged after #17834
This branch is separate from this PR and thus does not contain the new /tracing/new-spans page. However, this branch adds links to that page, which the 404 Linter identifies correctly as broken
Closes: #17836
IS YOUR CHANGE URGENT?
Help us prioritize incoming PRs by letting us know when the change needs to go live.
SLA
Thanks in advance for your help!
PRE-MERGE CHECKLIST
Make sure you've checked the following before merging your changes:
EXTRA RESOURCES