mirror of
https://github.com/outbackdingo/firezone.git
synced 2026-01-27 18:18:55 +00:00
7642f37d56
Most of `connlib-shared` exists only for historical reasons. The `Tunnel` has since been decoupled from the `Callbacks` and most error variants on `ConnlibError` are not actually used. This allows us to move a few things around and trim down `ConnlibError` to just the variants that actually cause a call to `on_disconnect`. Moving everything related to `proptest`s to `firezone-tunnel` also requires us to delete the specialisation for printing IDs in a shorter format during the tests. That is a bit unfortunate but was always kind of a hack. I'd rather make progress on getting rid of `connlib-shared` though and perhaps re-introduce that feature once the messages are fully moved into the tunnel. Related: #4470.
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