a6796fe8b2
We are currently in the process of transitioning the Firezone Clients away from always hashing the ID before sending it to the portal. This will make lookups and correlation of data between our systems much easier. The way we are performing this migration is that new installations of Firezone will directly generate a 64 char hex-string as the Firezone ID. If the ID looks like a UUID (which is the old format), we still hash it and send it to the portal, otherwise we send it as-is. Presently, the telemetry integration with Sentry and PostHog do the opposite. They always sets the Firezone ID as-is and includes an `external_id` that is the hashed form if it detects that it is a UUID (or in the case of PostHog, create an alias). It is much better to flip this around and always set the hex-string as the user id. That way, we can simply always filter by the `user.id` attribute in Sentry and always refer to the ID that we are seeing in the portal.
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
Benchmarking on Linux
The recommended way for benchmarking any of the Rust components is Linux' perf utility.
For example, to attach to a running application, do:
- Ensure the binary you are profiling is compiled with the
releaseprofile. sudo perf record -g --freq 10000 --pid $(pgrep <your-binary>).- Run the speed test or whatever load-inducing task you want to measure.
sudo perf script > profile.perf- Open profiler.firefox.com and load
profile.perf
Instead of attaching to a process with --pid, you can also specify the path to executable directly.
That is useful if you want to capture perf data for a test or a micro-benchmark.