Flags

Flags

Command Line Flags

Occasionally, Roon Support will need more detailed logs about an issue you're experiencing. In these cases, they may ask you to enable additional logging using something called a command-line flag when you launch Roon.

This flag will generate additional information about your specific issue, which will appear in your logs to help our support team diagnose the problem. In most cases, you'll want to look at the machine running your server, although sometimes Roon Support will ask you to send logs from a remote installation as well.

Remember to ALWAYS shut down Roon on whatever device you're getting logs from before copying, moving, or accessing your Roon database. 

Capturing logs using a command-line flag

To create logs with a particular flag, follow these steps:
  1. Start Roon with the appropriate flag, as detailed below
  2. Run Roon until the problem you are experiencing occurs
  3. Stop Roon
  4. Collect and upload logs as shown here: logs
  5.  If your system is running Windows or Linux, remember to go back and remove the flag from the shortcut or startup script

Starting Roon with a command-line flag

Follow the instructions below for the operating system on which Roon Support has asked for logs.

Windows

  1. Right-click the Roon icon and select “properties” from the drop-down menu
  2. You will see a field titled “target”. Place '-storagetrace' or whatever other flag has been requested at the end of the “target’ input field
  3. Make sure the “start in” input field ends with “application folder” and nothing else
  4. Start Roon by double-clicking on the shortcut
  5. After uploading the logs for Roon Support, remember to go back and remove the flag from your shortcut
Here's an example image:


Mac

  1. Launch the "Terminal"
    1. Click the "Magnifying Glass" icon in the top right-hand corner of the screen top open the search function, then type in "Terminal"
    2. Double click on the "Terminal" top hit, highlighted in blue here: 


      2. Once launched, the terminal will appear to be blank (excluding your username) and this is where you will want to enter the following command:

/Applications/Roon.app/Contents/MacOS/Roon -storagetrace` Replace `-storagetrace with whatever flag Roon Support has requested

Linux

  1.  Find and open the RoonAppliance startup script. This file is /opt/RoonServer/Appliance/RoonAppliance by default, but individual Linux installations may vary
  2. Add the flag to the end of the last line in the script, giving something like exec "$HARDLINK" --debug --gc=sgen --server "$SCRIPT.exe" "$@" -storagetrace
  3. Restart RoonServer. To do this, open a terminal and type `sudo pkill start.sh` You will be prompted for your password, type it in and then press enter, then wait for RoonServer to be restarted.
  4. After uploading the logs for Roon Support, remember to go back and remove the flag from the script and restart RoonServer again.

ROCK

  1. Find the ROCK network folder by following the instructions in the "Method #2: Importing To Network Folder" section here
  2. Create a text file in that directory with the following name (all one word, no caps, no extension): roonserverargs 
  3. Inside that file, add one line with only the flags requested by Roon Support, separated by spaces. For example: -storagetrace -watchertrace
  4. Restart RoonServer in the ROCK web interface: type "ROCK" into the address bar in any web browser, then click the "restart" button under "Roon Server Software"
  5. After uploading the logs for Roon Support, remember to go back and delete the roonserverargs file.