Starting with version 1.3, the DeepFactor Portal provides additional stack trace information in alerts. This stack trace information is obtained by inspecting debug build artifacts (e.g., build output with debugging symbols present).
Symbolic stack trace information, including source file name and line number, is often useful when tracking down problems and identifying which commit/change caused an alert.
Build artifacts must currently be installed on the DeepFactor Portal with the following steps:
1. First, scp (secure copy) your build executable artifact to the portal VM, typically, using the dfadmin account.
2. Log in to the portal via ssh (typically using the dfadmin user).
3. Use the following command to compute the symbol hash of the debug binary. Note that 'debug_binary' is the name of the file copied in step 1:
/opt/deepfactor/bin/symbolsvc -gethash debug_binary
4. Using the output from Step 3 (a SHA256 hash), copy the debug binary to the following location with 'HASH' as the output from Step 3:
sudo cp debug_binary /opt/deepfactor/symbols/customer/hv1/HASH
Note: if /opt/deepfactor/symbols/customer/hv1 does not exist, use the following command to create it:
sudo mkdir -p /opt/deepfactor/symbols/customer/hv1
5. Instrument debug_binary via 'dfctl run' as usual. Any alerts generated that include stack trace information will now have additional information such as line numbers, file names, etc. Alerts generated before the debug binary was uploaded to the portal will not be updated.