All Collections
Manage Devices
General
Gather Local Device Logs
Gather Local Device Logs

Steps to gather device logs specific to ArborXR using ADB (Android Debug Bridge).

Nathan Sales avatar
Written by Nathan Sales
Updated over a week ago

Overview

When requested by ArborXR Support as part of the troubleshooting process for any issues you report, you can gather local device logs, or logcat, from your device using ADB along with a specific build of the ArborXR Client app with logging enabled provided by the ArborXR Support team.

A logcat can be gathered in a few ways:

  • Via the third-party app, Sidequest.

  • From a command line tool (like Terminal in macOS or Windows PowerShell) using the adb (Android Debug Bridge) tool.

You will have received this guide as part of the troubleshooting process with the ArborXR Support team. If you were not provided a Client app build with logging enabled, please contact ArborXR Support via the Web Portal Messenger to request further assistance.


Gather the log file using Sidequest

💡 NOTE: Ensure you download the Sidequest Advanced Installer, not the Easy Installer. The steps below are only for the Advanced Installer version. You can download Sidequest directly from the website here.

​Additionally, you are not required to set up a Sidequest account to utilize the ADB command feature within the Sidequest desktop app.​

If you wish to generate the logcat file via the command line, you can learn more about using the logcat command by referencing Android's developer documentation here.

⚠️ IMPORTANT: The Sidequest method is not supported for log-gathering on PICO devices running PUI 5. If you are troubleshooting a PICO PUI 5 device, see the Gather the log file using the command line (ADB) section below.

  1. Open Sidequest.

  2. In the upper right corner, click the Run ADB commands button within the Sidequest app (a square button with an arrow inside of it, pointing to the right).

    Sidequest custom command icon location.

  3. Click LOGCAT.

  4. Before starting, ensure the device is connected to the computer with a USB cable, then select the desired output folder for the logcat file by clicking Pick Output Folder.



    💡When selecting a download location, it is recommended to set it to a folder (e.g. - Documents or Downloads) and not at the top level of the selected hard drive.


  5. Click Start, then, going into the headset, repeat the steps within it to replicate the issue.

  6. Once you have sufficiently replicated the issue, click Stop within Sidequest. The logcat file will save to the location you designated in Step 4 as logcat.log.

  7. Once you have located the Logcat file in your saved folder, share it with the ArborXR Support representative.


Gather the log file using the command line (ADB)

Overview

If you are comfortable with the command line and have ADB installed on a CLI (command line interface) app like PowerShell (Windows) or Terminal (macOS), the following command can be run while the trouble device is plugged into the same computer. We won't be going over the steps to install ADB in this article, but there is a good deal of resources with a quick Google search that can assist further to help with installing ADB!

Run the command and share the file

⚠️ IMPORTANT: PICO PUI 5 devices require the below command to be run first:

adb shell setprop log.tag.XRDM VERBOSE

You won't receive any feedback, so once entered, proceed forward.

Simply enter the command below, changing the /path/to/file to the desired location on your local computer, then press Enter/Return on your keyboard to begin the log capture:


adb logcat > /path/to/file/logcat.log

💡 NOTE: The ADB tool may not provide any feedback once started, but details will be gathered in the log file as activity occurs within the device. Once the reproducible event has been completed during the logcat capture, click Ctrl + C (Windows) or Cmd + C (macOS) to stop the capture. Once completed, send the saved log file to the ArborXR Support representative you are partnering with.

Did this answer your question?