Viewing logs

Firezone maintains diagnostic log files in various locations depending on the component and operating system. Logs are scrubbed for sensitive and personally-identifiable information before being written to disk.

Diagnostic logs are used primarily by the Firezone team for troubleshooting connectivity and other issues, but they may also be useful for diagnosing issues by advanced users and admins.

Log directory locations

ComponentLog directory
macOS Client~/Library/Group Containers/
iOS ClientN/A
Android/ChromeOS Client/data/data/
Linux ClientSet by the user via the LOG_DIR environment variable, otherwise STDOUT
Windows Client%APPDATA%\Local\dev.firezone.client\data\logs
GatewayLogs are written to STDOUT by default and viewable either by docker logs firezone-gateway or journalctl -u firezone-gateway

Exporting Client logs

Log files can be conveniently exported from the macOS, iOS, Android/ChromeOS, and Windows Clients from the "Diagnostic Logs" tab of the Settings screen. This will bundle the logs from the log directory listed above into an archive file that can be easily shared.

Exporting Gateway logs

To export logs from the Gateway Docker container, use the docker logs command and redirect the output to a file:

docker logs firezone-gateway > firezone-gateway.log

See the Docker documentation for a full list of log drivers and options available.

Clearing logs

Simply delete the files in the log directories listed above.

For macOS, iOS, Android/ChromeOS, and Windows Clients, log directories can be cleared in the "Diagnostic Logs" tab in the Settings screen.

Last updated: June 20, 2024