The site has a new content architecture. We've added the ability to select your development device to show device-specific content. Please read our blog post Oculus Developer Center Update: Device-centric Documentation Architecture for more information.
All Oculus Quest developers MUST PASS the concept review prior to gaining publishing access to the Quest Store and additional resources. Submit a concept document for review as early in your Quest application development cycle as possible. For additional information and context, please see Submitting Your App to the Oculus Quest Store.
This page describes how you can retrieve logs to troubleshoot your app and request help.
The OculusLogGatherer.exe tool is included with the Oculus app installation, and can be used when you have issues with the Oculus runtime.
Note: You must have local administrative privileges to run this tool.
To run the tool, navigate to the Oculus installation folder, and find the Support -> oculus-diagnostics folder. For example: C:\Program Files (x86)\Oculus\Support\oculus-diagnostics\OculusLogGatherer.exe. \ When you run the tool, you can select the following options:
The export, a .zip file, will be copied to the clipboard and saved to your desktop. The .zip export organizes the files by log type.
If you’re having issues with the Unity Editor, please review Unity’s How to Report Bugs page for information about reporting bugs to Unity.
The Issue Tracker has information about known issues, check to see if what you are experiencing has already been reported. If the issue is not already known, you can report the bug in the Unity Editor (Help->Report).
Using Log Files
If your issue exists with the Unity/Oculus software integration, please review the Unity Log Files page for information on how to retrieve the logs.
The log file for your unity project can be retrieved by using the command %LOCALAPPDATA%\Unity\Editor\Editor.log.
If you experience a crash, retrieve the log and search for “tombstone”, which is written and logged after the crash. If you scroll up from there, there will be a callstack, which describes the process that were occurring at the time of the crash.
Using Crash/Dump Files
When Unity or an app encounters a failed state, press ctr-alt-delete (windows only), right click on the failed process, and select “create dump file” from the menu. The dump file’s location will be displayed to you upon successful creation.
If you’re having issues with the Unreal Editor, review Unreal’s How to Report Bugs page for information about reporting bugs to Unreal.
The Unreal Engine Issues Tracker has information about known issues, check to see if what you are experiencing has already been reported. If the issue is not already known, please make a new report in the tracker.
Use Log Files
If your issue exists with the Unreal/Oculus software integration, please review the Unreal Log Files page for information on how to retrieve the logs.
The Unreal Editor can pull a log files specific to the area where you’re encountering issues. You can generate Editor Session Logs, Game Logs, Build/Cook Logs, Crash Logs, and Compile Logs.
When diagnosing specific issues it is helpful to have Editor Session Logs and Crash Logs to send to Oculus when requesting support.
The editor session log file for your Unreal project is located at Engine\Saved\Logs\UE4.log.
The crash logs file for your Unreal project can be retrieved using the command: %USERPROFILE%\AppData\Local\Microsoft\Windows.
Use Crash/Dump Files
If you experience a crash, retrieve the log and search for “tombstone”, which is written and logged after the crash. If you scroll up from there, there will be a callstack that lists the process that were occurring at the time of the crash.
The crash dump is automatically generated by Unreal in the event of a crash in your project. You can find the file titled minidump.dmp in your C:\Users\UserName\AppData\WER\ReportQueue folder.
If you’re unable to diagnose the issue yourself using the information you retrieved, there are two ways to request help.