Skip to content

Conversation

Lms24
Copy link
Member

@Lms24 Lms24 commented Sep 17, 2025

This PR clarifies the exception Mechanism interface, specifically the purpose and naming conventions for mechanism.type:

  • it now explicitly states that type should be used to indicate the "origin" or callsite of the exception, so that we can distinguish where an exception was captured. For instance, user vs. SDK but in case of the latter, type should be specific enough to know which instrumentation/integration within the SDK.
  • it suggests to use Trace Origin-esque naming for SDK-captured events with the main motivation of this being an already established naming scheme that works well enough for this use case.

To be clear, SDKs don't have to change anything right now, but should they want to (like we did in JS), this reworked doc should provide more clarity than the short descriptions previously.

(I have another PR coming up with some refactors changes all over this doc but wanted to get this reviewed and accepted first since it actually changes content)

closes getsentry/sentry-javascript#17266
closes getsentry/sentry-javascript#17212 (finally)

Copy link

vercel bot commented Sep 17, 2025

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

Project Deployment Preview Comments Updated (UTC)
develop-docs Ready Ready Preview Comment Sep 19, 2025 10:07am
1 Skipped Deployment
Project Deployment Preview Comments Updated (UTC)
sentry-docs Ignored Ignored Preview Sep 19, 2025 10:07am

@Lms24 Lms24 changed the title ref(sdks): Clarify Event Mechanism interface ref(develop/sdks): Clarify Exception Mechanism interface Sep 17, 2025
@Lms24 Lms24 self-assigned this Sep 17, 2025
Copy link
Contributor

@coolguyzone coolguyzone left a comment

Choose a reason for hiding this comment

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

Thanks for updating, LGTM.

@Lms24 Lms24 enabled auto-merge (squash) September 19, 2025 10:02
@Lms24 Lms24 merged commit 4a60a6d into master Sep 19, 2025
12 checks passed
@Lms24 Lms24 deleted the lms/ref-develop-mechansim branch September 19, 2025 10:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Improve develop docs mechanism documentation Ensure SDK-captured error events have a proper mechanism
3 participants