Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DOCS-8873] Guide about deobfuscating stack traces in RUM #25351

Merged
merged 5 commits into from
Oct 1, 2024

Conversation

cswatt
Copy link
Contributor

@cswatt cswatt commented Sep 19, 2024

What does this PR do? What is the motivation?

Adds a guide and some mentions of it.

Merge instructions

  • Please merge after reviewing

Additional notes

@cswatt cswatt requested review from a team as code owners September 19, 2024 23:14
@github-actions github-actions bot added Images Images are added/removed with this PR Guide Content impacting a guide labels Sep 19, 2024
Copy link
Contributor

Preview links (active after the build_preview check completes)

New or renamed files

Modified Files

Copy link
Contributor

@MaelNamNam MaelNamNam left a comment

Choose a reason for hiding this comment

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

Just some changes to be made for the wording to be consistent with the different platforms

Copy link
Contributor

@MaelNamNam MaelNamNam left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link
Contributor

@alai97 alai97 left a comment

Choose a reason for hiding this comment

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

Looks good, one suggestion for consistency!

@@ -84,6 +84,10 @@ private class YourCustomDelegateURLSessionDelegate: NSObject, URLSessionTaskDele
* implement `URLSessionDataDelegate` and forward:
* [`urlSession(_:dataTask:didReceive:)`][6]

## "Deobfuscation failed" warning

A warning appears when symbolication fails for a stack trace. If the stack trace is not symbolicated to begin with, you can ignore this warning. Otherwise, use the [RUM Debug Symbols page][7] to view all your uploaded dSYMs. See [Investigate Obfuscated Stack Traces with RUM Debug Symbols][8].
Copy link
Contributor

Choose a reason for hiding this comment

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

Just confirming that we are intentionally using symbolication instead of deobfuscation here, feel free to disregard the comment if we are!

Suggested change
A warning appears when symbolication fails for a stack trace. If the stack trace is not symbolicated to begin with, you can ignore this warning. Otherwise, use the [RUM Debug Symbols page][7] to view all your uploaded dSYMs. See [Investigate Obfuscated Stack Traces with RUM Debug Symbols][8].
A warning appears when deobfuscation fails for a stack trace. If the stack trace is not deobfuscation to begin with, you can ignore this warning. Otherwise, use the [RUM Debug Symbols page][7] to view all your uploaded dSYMs. See [Investigate Obfuscated Stack Traces with RUM Debug Symbols][8].

Copy link
Contributor

@rtrieu rtrieu Oct 1, 2024

Choose a reason for hiding this comment

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

They mean the same thing, but "deobfuscation" term is more closely associated with Android, while "symbolication" is with iOS. Will refine the suggestion here.

@rtrieu rtrieu merged commit b91c296 into master Oct 1, 2024
13 of 14 checks passed
@rtrieu rtrieu deleted the cswatt/debug-symbols-guide branch October 1, 2024 20:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Guide Content impacting a guide Images Images are added/removed with this PR
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants