Skip to content

Troubleshooting for developers

Jump to bottom
Matthieu Bucchianeri edited this page Oct 13, 2022 · 4 revisions

When communicating with the Windows Mixed Reality team to troubleshoot issues with OpenXR, the following tips are handy!

PRIVACY NOTICE: THE TRACE FILES CREATED THROUGH THE STEPS BELOW MAY COLLECT PERSONAL INFORMATION (SUCH AS WINDOWS USER NAME). DO NOT EVER UPLOAD THE TRACE FILE PUBLICLY ONLINE. ONLY SEND THE TRACE FILE PRIVATELY TO YOUR CONTACT AT MICROSOFT. YOUR DATA WILL NOT BE USED FOR ANY PURPOSE OTHER THAN PROVIDING SUPPORT. YOUR DATA WILL NOT BE SHARED OUTSIDE MICROSOFT.

Capture a diagnostics trace from the command line

NOTE: These instructions are applicable to Windows Mixed Reality immersive headsets only.

Before starting, please close any OpenXR application, and close the Mixed Reality Portal. This is to ensure that the trace to capture will start from a fresh state.

  1. Download the tracing profile (WinXR.wprp)
  2. Open an elevated command line prompt or PowerShell prompt
  3. Use the following command: wpr -start path\to\WinXR.wprp -filemode
  4. Open your OpenXR application and reproduce the issue
  5. Return to the command line prompt, and use the following command: wpr -stop WinXR.etl
  6. A new file, WinXR.etl, is created in the current working folder

Please compress the ETL trace (eg: ZIP archive) before sending it to the Windows Mixed Reality team. ETL files achieve a very high ratio of compression.

Capture a diagnostics trace from the Device Portal

NOTE: These instructions are applicable to HoloLens 2 and Windows Mixed Reality immersive headsets.

Before starting, please close any OpenXR application, and close the Mixed Reality Portal. This is to ensure that the trace to capture will start from a fresh state.

  1. Enable the Device Portal
  2. Download the tracing profile (WinXR.wprp)
  3. Open the Device Portal
  4. From the menu on the left, navigate to Performance tracing (on HoloLens 2, this might be under a Performance submenu)
  5. Under Select a profile, choose Custom profiles, then Choose File
  6. Navigate to the location of the WinXR.wprp file downloaded in step 2)
  7. Click Start Trace, and wait for the label "Performance trace is in progress" to appear
  8. Open your OpenXR application and reproduce the issue
  9. Return to the Device Portal, and click Stop Trace
  10. After a few seconds, go to the Traces section further down the page, and download the corresponding ETL trace

Please compress the ETL trace (eg: ZIP archive) before sending it to the Windows Mixed Reality team. ETL files achieve a very high ratio of compression.

Clone this wiki locally