diff --git a/ext/oboe_metal/README.md b/ext/oboe_metal/README.md index b31f3b4..1973a9e 100644 --- a/ext/oboe_metal/README.md +++ b/ext/oboe_metal/README.md @@ -82,29 +82,29 @@ For example, `(core dumped)` indicate the crash file is dumped ## Prepare -### 1. Install solarwinds_apm with debug symbol on - -```console -export OBOE_DEBUG=true # enable debug flag when compiling; and also download *.debug into lib/ when create the gem for ease of use -export OBOE_DEV=true # optional: if you want to install the nightly build liboboe - -gem install solarwinds_apm -``` - -Reproduce the crash using this version of solarwinds_apm which provides extended debug information in the coredump. - -### 2. Check the core dump size is not constrained +### 1. Check the core dump size is not constrained ```console ulimit -c unlimited # have to set this for unlimited core dump file size without trimmed error message ``` -### 3. Check if the crash report program is configured correctly +### 2. Check if the crash report program is configured correctly Ubuntu use [apport](https://wiki.ubuntu.com/Apport); Debian use [kdump](https://mudongliang.github.io/2018/07/02/debian-enable-kernel-dump.html) In ubuntu, if apport is disabled via `service apport stop`, the core dump file will be stored in the current directory and named `core`. If apport is enabled, find the crash file (typically under `/var/crash`) and extract the CoreDump file from it using `apport-unpack .crash `. +### 3. Install solarwinds_apm with debug symbol on + +```console +export OBOE_DEBUG=true # enable debug flag when compiling; and also download *.debug into lib/ when create the gem for ease of use +export OBOE_DEV=true # optional: if you want to install the nightly build liboboe + +gem install solarwinds_apm +``` + +Reproduce the crash using this version of solarwinds_apm which provides extended debug information in the coredump. + ### 4. Gather the `*.debug` file for oboe symbol Assume the gem has following file structure