50 lines
1.9 KiB
Markdown
50 lines
1.9 KiB
Markdown
|
# Electron Debugging
|
||
|
|
|
||
|
|
There are many different approaches to debugging issues and bugs in Electron, many of which
|
||
|
|
are platform specific.
|
||
|
|
|
||
|
|
Some of the more common approaches are outlined below.
|
||
|
|
|
||
|
|
## Generic Debugging
|
||
|
|
|
||
|
|
Chromium contains logging macros which can aid debugging by printing information to console in C++ and Objective-C++.
|
||
|
|
|
||
|
|
You might use this to print out variable values, function names, and line numbers, amonst other things.
|
||
|
|
|
||
|
|
Some examples:
|
||
|
|
|
||
|
|
```cpp
|
||
|
|
LOG(INFO) << "bitmap.width(): " << bitmap.width();
|
||
|
|
|
||
|
|
LOG(INFO, bitmap.width() > 10) << "bitmap.width() is greater than 10!";
|
||
|
|
```
|
||
|
|
|
||
|
|
There are also different levels of logging severity: `INFO`, `WARN`, and `ERROR`.
|
||
|
|
|
||
|
|
See [logging.h](https://chromium.googlesource.com/chromium/src/base/+/refs/heads/main/logging.h) in Chromium's source tree for more information and examples.
|
||
|
|
|
||
|
|
## Printing Stacktraces
|
||
|
|
|
||
|
|
Chromium contains a helper to print stack traces to console without interrrupting the program.
|
||
|
|
|
||
|
|
```cpp
|
||
|
|
#include "base/debug/stack_trace.h"
|
||
|
|
...
|
||
|
|
base::debug::StackTrace().Print();
|
||
|
|
```
|
||
|
|
|
||
|
|
This will allow you to observe call chains and identify potential issue areas.
|
||
|
|
|
||
|
|
## Platform-Specific Debugging
|
||
|
|
<!-- TODO(@codebytere): add debugging file for Linux-->
|
||
|
|
|
||
|
|
- [macOS Debugging](debugging-on-macos.md)
|
||
|
|
- [Debugging with Xcode](debugging-with-xcode.md)
|
||
|
|
- [Windows Debugging](debugging-on-windows.md)
|
||
|
|
|
||
|
|
## Debugging with the Symbol Server
|
||
|
|
|
||
|
|
Debug symbols allow you to have better debugging sessions. They have information about the functions contained in executables and dynamic libraries and provide you with information to get clean call stacks. A Symbol Server allows the debugger to load the correct symbols, binaries and sources automatically without forcing users to download large debugging files.
|
||
|
|
|
||
|
|
For more information about how to set up a symbol server for Electron, see [debugging with a symbol server](debugging-with-symbol-server.md).
|