debugging-crashes.md

 1# Debugging Crashes
 2
 3## Crashes
 4
 5When an app crashes,
 6
 7- macOS creates a `.ips` file in `~/Library/Logs/DiagnosticReports`. You can view these using the built in Console app (`cmd-space Console`) under "Crash Reports".
 8- Linux creates a core dump. See the [man pages](https://man7.org/linux/man-pages/man5/core.5.html) for pointers to how your system might be configured to manage core dumps.
 9
10If you have enabled Zed's telemetry these will be uploaded to us when you restart the app. They end up in a [Slack channel (internal only)](https://zed-industries.slack.com/archives/C04S6T1T7TQ).
11
12These crash reports are generated by the crashing binary, and contain a wealth of information; but they are hard to read for a few reasons:
13
14- They don't contain source files and line numbers
15- The symbols are [mangled](https://doc.rust-lang.org/rustc/symbol-mangling/index.html)
16- Inlined functions are elided
17
18On macOS, to get a better sense of the backtrace of a crash you can download the `.ips` file locally and run:
19
20```sh
21./script/symbolicate ~/path/zed-XXX-XXX.ips
22```
23
24This will download the correct debug symbols from our public [digital ocean bucket](https://zed-debug-symbols.nyc3.digitaloceanspaces.com), and run [symbolicate](https://crates.io/crates/symbolicate) for you.
25
26The output contains the source file and line number, and the demangled symbol information for every inlined frame.
27
28## Panics
29
30When the app panics at the rust level, Zed creates a file in `~/Library/Logs/Zed` or `$XDG_DATA_HOME/logs` with the text of the panic, and a summary of the backtrace. On boot, if you have telemetry enabled, we upload these panics so we can keep track of them.
31
32A panic is also considered a crash, and so for most panics we get both the crash report and the panic.