feat: Allow error event value (description) to be customised #2120
+51
−1
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
If one isn't available, the system will automatically default to one based on the domain and code.
The system default is otherwise a bit long.
This avoids the problem of localized descriptions being locale-dependent.
Merge Upstream into fork branch
lukeredpath
requested review from
philipphofmann,
brustolin,
armcknight and
indragiek
as code owners
This was referenced Sep 2, 2022
There was a problem hiding this comment.
Just one small note, apart from that LGTM. Thanks a lot, @lukeredpath 👏
And don't worry about CI. The failing jobs don't work for contributors and we didn't fix them yet.
Can you please open a PR to the docs? What you have in lukeredpath/sentry-docs#1 looks fine. I think it's worth mentioning for which SDK versions this feature will be available.
|
@lukeredpath, I can't merge because there are some conflicts that must be resolved |
|
@philipphofmann resolved! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
📜 Description
Currently errors are hardcoded to use "Code: xxx" using the error's code which make for a very unhelpful display in the Sentry error list.
To alleviate this, check for the presence of a custom description in the error's
userInfodictionary using theNSDebugDescriptionErrorKeyIf no custom description is set, the old behaviour is retained of using "Code: xxx".
💡 Motivation and Context
Makes it easier to identify errors in the error list in the Sentry dashboard.
Fixes #1442.
💚 How did you test it?
Integrated the branch into our own app and ran it, generated some errors and verified that the error was displayed correctly.
We have been running this branch in production in the Community app since I opened this PR without issue.
📝 Checklist
🔮 Next steps