If you have the debuggable library files (also known as debug symbol files) for your Meta Quest app, you can upload them to see symbolicated stack traces in the Crash Analytics dashboard.

Where are the debug symbol files?

Debug symbol files are saved in your project folders when you build your APK files. They typically match the filename pattern *.so, *.sym.so, or *.dbg.so, and these are the files we use in Crash Analytics to symbolicate stack traces. For example, if the library your project creates is called libunity.so, the symbolicated version of it might have the same name, libunity.so, or it might be named libunity.sym.so or libunity.dbg.so.

Engine	Location of debug symbol files
Native	projectFolder/obj/local/arm64-v8a/
Unity	After building with Create symbols.zip enabled, `arm64-v8a` folder inside the generated `buildFolder\\buildName-buildVersion-buildCode.symbols.zip` file (unzip it first)
Unreal	projectFolder\Binaries\Android\projectName_Symbols_v1\projectName-arm64

Warning:

Don't change the name of the debug symbol files. Crash analytics uses filename matching to match the library name in your app with the matching debug symbol file ending in .so, .sym.so, or .dbg.so. These are the only allowable filename extensions for debug symbol files.

If these debug symbol files have been deleted since the last time you built the project, it is sometimes possible to rebuild them, provided that you have changed absolutely nothing in the project since the time you uploaded the app into a release channel. Even a small difference can create a mismatch between an uploaded app binary and the rebuilt debug symbol files, which can result in missing symbols in stack traces.

Uploading debug symbol files for new builds

You can upload debug symbols at the same time as you upload a new binary build using Meta Quest Developer Hub, or the Oculus Platform Command Line Utility.

Meta Quest Developer Hub: debug symbols for new builds

APK files can be uploaded to a release channel in Meta Quest Developer Hub, by navigating into the App Distribution tab, and clicking the Upload button next to the desired release channel. After selecting an APK, the Upload Build menu will display a series of optional settings. Point to the folder containing your build’s symbolicated libraries in the Debug Symbols field, and optionally set a pattern in the Debug Symbols Pattern field.

Meta Quest Developer Hub upload with Symbol Directory Path

Oculus platform command line utility: debug symbols for new builds

The syntax is the same as uploading a new app to a channel by itself, but you also append the following two parameters to specify the debug symbol file path and filename pattern:

--debug_symbols_dir <dirpath>: Specifies the path of the directory that contains the debug symbol file or files.

--debug-symbols-pattern <filenamePattern>: Specifies a file name pattern that matches the filenames of all the debug symbol files. You may use an asterisk to indicate a wildcard, for example: \*.sym.so

Example

ovr-platform-util upload-quest-build --app_id 12345678901234 --token ABCDEF1234567890abcdef1234567890  --apk c:\myproject\app\build\outputs\apk\myApp.apk --channel store --debug_symbols_dir c:\myproject\obj\local\armeabi-v7a\ --debug-symbols-pattern *.sym.so

Uploading debug symbol files for an existing build

You can attach debug symbol files to an app build previously uploaded to a release channel. This is useful if this is the first time you’ve had the opportunity to upload debug symbol files for your app but you don’t want to force all your users to update to a new app version just so that you can get symbolicated crash analytics.

You will need the Build ID of the APK to which you want to attach the debug symbol files.

To obtain the build ID:

Go to the app’s Overview page from the Developer Dashboard.

From the Recently Uploaded Builds list, find the specific build you want to attach symbols to, and then click its version number. The Build Details page appears.

From the Details tab, copy the Build ID of this binary for later use.

Unity: Debug symbols for existing builds

Open the OVR Platform tool in Unity as if you were going to upload a new APK.

Select Upload Debug Symbols.

If your project uses Mono scripting, replace the Symbol Directory Path with the Mono version.

Select the Upload Debug Symbols Only.

Enter the Build ID to attach the debug symbols to.

Click Upload.

Unreal: Debug symbols for existing builds

Open the Oculus Platform Window in Unreal Engine as if to upload a new APK.

Select Upload Debug Symbols.

Select the Upload Debug Symbols Only.

Enter the Build ID to attach the debug symbols to.

Click Upload.

Oculus platform command line utility: debug symbols for existing builds

ovr-platform-util upload-debug-symbols --parent <buildId> --app_id <Id> --app_secret <app-secret> --debug_symbols_dir <dirPath> --debug-symbols-patternfilenamePattern

--parent <buildID> Specifies the build ID of the binary to attach the debug symbol files.

--debug_symbols_dir <dirPath> Specifies the path of the directory that contains the debug symbol file or files.

--debug-symbols-pattern <filenamePattern> Specifies a file name pattern that matches the filenames of all the debug symbol files. You may use an asterisk to indicate a wildcard, for example: *.sym.so