ref(develop/sdks): Clarify Exception Mechanism interface #14957
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR clarifies the exception
Mechanism
interface, specifically the purpose and naming conventions formechanism.type
: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.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)