mirror of
https://github.com/outbackdingo/firezone.git
synced 2026-01-27 18:18:55 +00:00
4b6b706d46
We added this to diagnose a hang in the IPC service, #5441. That hang, to the best of our knowledge, was caused by a deadlock which we fixed in #5571. So the heartbeat task just adds a lot of noise to the stdout which is annoying for debugging and won't be used in production logs. The system uptime measuring is still useful, so we now log that just once when logging starts, next to the git version and log directives. If we see this pattern in either process' logs, we know something is suspicious: - Log file ends without a clean shutdown message - Next log file starts with a high system uptime Updates should always result in a clean shutdown message, and a sudden power loss (mains power outage, or laptop battery dying) would result in the system uptime being low for the 2nd log file.
Rust development guide
Firezone uses Rust for all data plane components. This directory contains the Linux and Windows clients, and low-level networking implementations related to STUN/TURN.
We target the last stable release of Rust using rust-toolchain.toml.
If you are using rustup, that is automatically handled for you.
Otherwise, ensure you have the latest stable version of Rust installed.
Reading Client logs
The Client logs are written as JSONL for machine-readability.
To make them more human-friendly, pipe them through jq like this:
cd path/to/logs # e.g. `$HOME/.cache/dev.firezone.client/data/logs` on Linux
cat *.log | jq -r '"\(.time) \(.severity) \(.message)"'
Resulting in, e.g.
2024-04-01T18:25:47.237661392Z INFO started log
2024-04-01T18:25:47.238193266Z INFO GIT_VERSION = 1.0.0-pre.11-35-gcc0d43531
2024-04-01T18:25:48.295243016Z INFO No token / actor_name on disk, starting in signed-out state
2024-04-01T18:25:48.295360641Z INFO null