When do I need to enable debug logging?
You may be asked to enable debug logging when contacting RealVNC's Support team. This means increasing the log level to include much more information, recreating the problem, and then sending the log file to us so that we can help you find a solution.
How do I enable debug logging?
You can enable debug logging quickly and easily in the Options/Preferences area of RealVNC Viewer and RealVNC Server. Here's how:
RealVNC Server
- Locate the RealVNC Server icon
This is in the bottom right, by the clock, on Windows, or in the top right for macOS/Linux. You may need to click the arrow to reveal additional icons if the RealVNC Server icon is not visible. - Right click on the RealVNC Server icon and click Options
- Click Yes on the UAC Prompt (Windows) or enter your Administrator Credentials (macOS/Linux)
- Click Troubleshooting, then select Create a debug log file
- Click OK
- Restart RealVNC Server
- Re-create the issue
- Send the log files to RealVNC Support. To access the log files, see Where do I find the log files (Windows/macOS/Linux)?
RealVNC Viewer (Windows/macOS/Linux)
- Open RealVNC Viewer
- Click File (Windows/Linux) or VNC Viewer (macOS)
- Click Preferences
- Click Troubleshooting, then select Create a debug log file
- Click OK
- Restart RealVNC Viewer
- Re-create the issue
- Send the log files to RealVNC Support. To access the log files, see Where do I find the log files (Windows/macOS/Linux)?
RealVNC Viewer (Android/iOS)
- Open the RealVNC Viewer app
- Tap the Menu button
- Tap Settings
- Tap Diagnostics
- Enable Logging
- Re-create the issue
- Tap the Menu button again
- Tap Send feedback
- Tap Email Technical Support
- Tap Yes to attach the debug log to the email
- You will then be taken to your device's email app to send the email. Please include your ticket reference in the email subject.
RealVNC Server (Android/iOS)
- Open the RealVNC Server app
- Tap the Menu button
- Tap Email support
- Tap Yes / Attach all logs
- You will then be taken to your device's email app to send the email. Please include your ticket reference in the email subject.
Where do I find the log files (Windows/macOS/Linux)?
Using the GUI
To open the folder that contains the debug log files, click the 'Show in Folder' button. This can be found in the same area where you enabled debug logging, above.
Using the command line / file explorer
RealVNC Server
If you do not have access to the RealVNC Server GUI, the log files can be found in the following locations instead:
Windows
C:\ProgramData\RealVNC-Service\vncserver.log
C:\ProgramData\RealVNC-Service\vncserver.log.bak
Mac
/Library/Logs/vncserver.log
/Library/Logs/vncserver.log.bak
Linux
/var/log/vncserver-x11.log
/var/log/vncserver-x11.log.bak
Comments
Article is closed for comments.