Skip to content

feat(develop-docs): Add instructions how to add a new client outcome reason#17347

Merged
Lms24 merged 2 commits intomasterfrom
lms/feat-dev-add-instructions-client-outcome-reasons
Apr 16, 2026
Merged

feat(develop-docs): Add instructions how to add a new client outcome reason#17347
Lms24 merged 2 commits intomasterfrom
lms/feat-dev-add-instructions-client-outcome-reasons

Conversation

@Lms24
Copy link
Copy Markdown
Member

@Lms24 Lms24 commented Apr 15, 2026

Since adding a new client outcomes reason involves quite a few steps, this PR adds a short instruction section to develop docs. We can probably build a skill from this or point clankers to these docs.

I purposefully didn't bump the changelog version since this doesn't change any spec. It just adds information.

h/t @shellmayr for calling out the missing pieces!

(ref https://linear.app/getsentry/issue/SDK-1123/add-client-report-outcome-for-dropped-spans-because-of-missing-parent)

@vercel
Copy link
Copy Markdown

vercel bot commented Apr 15, 2026

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

Project Deployment Actions Updated (UTC)
develop-docs Ready Ready Preview, Comment Apr 15, 2026 8:22am
1 Skipped Deployment
Project Deployment Actions Updated (UTC)
sentry-docs Ignored Ignored Preview Apr 15, 2026 8:22am

Request Review

@github-actions github-actions bot added the sdk-develop-docs PRs touching develop-docs/sdk label Apr 15, 2026
@linear-code
Copy link
Copy Markdown

linear-code bot commented Apr 15, 2026

@Lms24 Lms24 self-assigned this Apr 15, 2026
@Lms24 Lms24 requested review from cleptric, s1gr1d and shellmayr April 15, 2026 08:12
@shellmayr
Copy link
Copy Markdown
Member

Ahhh this is great, thank you for being thorough in documenting this 🙏


Adding a new reason involves multiple repos in Sentry but is very straight-forward:

1. Register the new reason in [snuba](https://github.com/getsentry/snuba/blob/master/rust_snuba/src/processors/outcomes.rs#L15). The list MUST be ordered alphabetically ([Example PR](https://github.com/getsentry/snuba/pull/7866)).
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.

We probably want this to point to a specific commit, otherwise it will drift over time; alternatively, just the commits/PRs are sufficient to document how it's done.

Comment thread develop-docs/sdk/telemetry/client-reports.mdx Outdated
Adding a new reason involves multiple repos in Sentry but is very straight-forward:

1. Register the new reason in [snuba](https://github.com/getsentry/snuba/blob/dd7ca91d81484455953653f59ed4ab90ecbc9719/rust_snuba/src/processors/outcomes.rs#L15). The list MUST be ordered alphabetically ([Example PR](https://github.com/getsentry/snuba/pull/7866)).
2. Add the new reason to the Sentry frontend to show it in the Usage Stats and `_admin` pages ([Example PR](https://github.com/getsentry/sentry/pull/112937)).
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.

There is a difference between _admin and stats page, as in we group certain outcomes for user consumption and do not just return the raw outcome like we do on _admin.

Copy link
Copy Markdown
Member Author

@Lms24 Lms24 Apr 16, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I checked with @shellmayr and Cursor: While true that we group and omit certain outcomes/discard reason sub categories in the user-facing page, this currently only concerns server-side outcomes. Client outcomes are all displayed at the moment. I'm gonna merge this as-is for the time being because I don't (yet) see a reason to not emit an outcome. Happy to follow up with changes if we need any.

@Lms24 Lms24 merged commit 266a5ac into master Apr 16, 2026
18 of 19 checks passed
@Lms24 Lms24 deleted the lms/feat-dev-add-instructions-client-outcome-reasons branch April 16, 2026 08:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

sdk-develop-docs PRs touching develop-docs/sdk

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants