feat: Capture async stack traces #998
Merged
Conversation
This file contains 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
libdispatch on Apple has its own introspection support. However in order to use that, the user has to actually load the introspection capable version of the library, which is the case when doing debugging in XCode, but is not the case for normal runtime. See https://github.com/apple/swift-corelibs-libdispatch/blob/main/dispatch/introspection.h Instead, we rely on https://github.com/facebook/fishhook to replace the async libdispatch functions with our own wrappers, similar to how https://github.com/tiantianbobo/XBAsyncStackTrace works.
bauerlumb
approved these changes
Mar 16, 2021
Testing sessionMac OS
Objective-C Sample
iOS-Swift
tvOS-Swift
|
Codecov Report
@@ Coverage Diff @@
## master #998 +/- ##
==========================================
+ Coverage 95.08% 95.23% +0.14%
==========================================
Files 88 88
Lines 3787 3795 +8
==========================================
+ Hits 3601 3614 +13
+ Misses 186 181 -5
Continue to review full report at Codecov.
|
|
The crash on 14.5 beta seems to be an upstream problem: facebook/fishhook#82 |
|
iPad Air (4th gen) iOS 14.5 beta 4: seems to work fine now |
Swatinem
changed the title
Swatinem
added a commit
to getsentry/sentry
that referenced
this pull request
Mar 22, 2021
This feature will soon land as part of getsentry/sentry-cocoa#998 and the way it wraps async calls creates a few well-known stackframes which we want to classify as not in-app.
Testing sessionMac OS
Objective-C Sample
iOS-Swift
tvOS-Swift
|
Swatinem
added a commit
to getsentry/sentry
that referenced
this pull request
Mar 23, 2021
This feature will soon land as part of getsentry/sentry-cocoa#998 and the way it wraps async calls creates a few well-known stackframes which we want to classify as not in-app.
bruno-garcia
approved these changes
Mar 25, 2021
Sources/SentryCrash/Recording/Tools/SentryCrashStackCursor_MachineContext.c
Show resolved
Hide resolved
Swatinem
force-pushed
the
feat/async-stacktrace
branch
from
54459fc to
8af9aff
Compare
Testing sessionMac OS
Objective-C Sample
iOS-Swift
tvOS-Swift
I had two cases where the device context was missing, but I'm not sure if this is related to this PR. |
philipphofmann
approved these changes
Mar 26, 2021
ahmedetefy
pushed a commit
to getsentry/sentry
that referenced
this pull request
Mar 26, 2021
This feature will soon land as part of getsentry/sentry-cocoa#998 and the way it wraps async calls creates a few well-known stackframes which we want to classify as not in-app.
flub
approved these changes
Mar 31, 2021
| if (!bt) { | ||
| return; | ||
| } | ||
| __atomic_fetch_add(&bt->refcount, 1, __ATOMIC_SEQ_CST); |
There was a problem hiding this comment.
i suspect SEQ_CST is overkill, but this is hard so probably fine to leave it until this is actually a perf bottleneck
There was a problem hiding this comment.
We use basically the same all over the native SDK. Getting the memory orderings right is quite difficult, so IMO there is nothing wrong with being too conservative.
BTW, there is a nice series on these patterns on LWN which I’m reading these days: https://lwn.net/Articles/844224/
This was referenced Apr 27, 2021
Closed
7 tasks
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
libdispatch on Apple has its own introspection support. However in order to use that, the user has to actually load the introspection capable version of the library, which is the case when doing debugging in XCode, but is not the case for normal runtime.
See https://github.com/apple/swift-corelibs-libdispatch/blob/main/dispatch/introspection.h
Instead, we rely on https://github.com/facebook/fishhook to replace the async libdispatch functions with our own wrappers, similar to how https://github.com/tiantianbobo/XBAsyncStackTrace works.
Creating the async stack traces is based on these hooks. We capture a stacktrace in the caller, and pass that trace into the async context via an async closure (block). There, we save it in a hashtable keyed by the thread id.
We use that "thread-local" to chain multiple async calls together, and also to attach the async caller to any thread that is being captured by SentryCrash.
When SentryCrash is walking (serializing) the stacktrace, we chain those async callers together.
💡 Motivation and Context
When done, this will allow us to capture the chained stacktrace of async dispatched blocks/functions.
💚 How did you test it?
📝 Checklist
🔮 Next steps
fixes #852