mirror of
https://github.com/outbackdingo/firezone.git
synced 2026-01-27 10:18:54 +00:00
9067c2604a
Bumps [divan](https://github.com/nvzqz/divan) from 0.1.14 to 0.1.17. <details> <summary>Changelog</summary> <p><em>Sourced from <a href="https://github.com/nvzqz/divan/blob/main/CHANGELOG.md">divan's changelog</a>.</em></p> <blockquote> <h2>[0.1.17] - 2024-12-04</h2> <h3>Changed</h3> <ul> <li> <p>Set [MSRV] to 1.80 for [<code>LazyLock</code>] and new <code>size_of</code> prelude import.</p> </li> <li> <p>Reduced thread pool memory usage by many kilobytes by using rendezvous channels instead of array-based channels.</p> </li> </ul> <h2>[0.1.16] - 2024-11-25</h2> <h3>Added</h3> <ul> <li> <p>Thread pool for reusing threads across multi-threaded benchmarks. The result is that when running Divan benchmarks under a sampling profiler, the profiler's output will be cleaner and easier to understand. (<a href="https://redirect.github.com/nvzqz/divan/issues/37">#37</a>)</p> </li> <li> <p>Track the maximum number of allocations during a benchmark.</p> </li> </ul> <h3>Changed</h3> <ul> <li> <p>Make private <code>Arg::get</code> trait method not take <code>self</code>, so that text editors don't recommend using it. (<a href="https://redirect.github.com/nvzqz/divan/issues/59">#59</a>)</p> </li> <li> <p>Cache <code>BenchOptions</code> using <code>LazyLock</code> instead of <code>OnceLock</code>, saving space and simplifying the implementation.</p> </li> </ul> <h2>[0.1.15] - 2024-10-31</h2> <h3>Added</h3> <ul> <li> <p>[<code>CyclesCount</code>] counter to display cycle throughput as Hertz.</p> </li> <li> <p>Track the maximum number of bytes allocated during a benchmark.</p> </li> </ul> <h3>Removed</h3> <ul> <li>Remove <code>has_cpuid</code> polyfill due to it no longer being planned for Rust, since CPUID is assumed to be available on all old x86 Rust targets.</li> </ul> <h3>Fixed</h3> <ul> <li> <p>List generic benchmark type parameter <code>A<4></code> before <code>A<32></code>. (<a href="https://redirect.github.com/nvzqz/divan/issues/64">#64</a>)</p> </li> <li> <p>Improve precision by using <code>f64</code> when calculating allocation count and sizes for the median samples.</p> </li> <li> <p>Multi-thread allocation counting in <code>sum_alloc_tallies</code> on macOS was loading a null pointer instead of the pointer initialized by <code>sync_threads</code>.</p> </li> </ul> <!-- raw HTML omitted --> </blockquote> <p>... (truncated)</p> </details> <details> <summary>Commits</summary> <ul> <li><a href="899cd5ec69"><code>899cd5e</code></a> Release v0.1.17</li> <li><a href="d450e6de4f"><code>d450e6d</code></a> Set MSRV to 1.80</li> <li><a href="f5ff95b031"><code>f5ff95b</code></a> Use <code>size_of</code> from the prelude</li> <li><a href="d214f882e2"><code>d214f88</code></a> Allow <code>needless_lifetimes</code> Clippy lint</li> <li><a href="5499bc3058"><code>5499bc3</code></a> Reduce thread pool memory usage</li> <li><a href="823b16001f"><code>823b160</code></a> Add internal benchmark for <code>ThreadPool::broadcast</code></li> <li><a href="414ace96ad"><code>414ace9</code></a> Use more consistent wording in thread pool docs</li> <li><a href="99a329b1d4"><code>99a329b</code></a> add default for BenchArgs</li> <li><a href="9800477791"><code>9800477</code></a> Release v0.1.16</li> <li><a href="11a44b8c98"><code>11a44b8</code></a> Use <code>mach2</code> crate for <code>mach_thread_self</code> example</li> <li>Additional commits viewable in <a href="https://github.com/nvzqz/divan/compare/v0.1.14...v0.1.17">compare view</a></li> </ul> </details> <br /> [](https://docs.github.com/en/github/managing-security-vulnerabilities/about-dependabot-security-updates#about-compatibility-scores) Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting `@dependabot rebase`. [//]: # (dependabot-automerge-start) [//]: # (dependabot-automerge-end) --- <details> <summary>Dependabot commands and options</summary> <br /> You can trigger Dependabot actions by commenting on this PR: - `@dependabot rebase` will rebase this PR - `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it - `@dependabot merge` will merge this PR after your CI passes on it - `@dependabot squash and merge` will squash and merge this PR after your CI passes on it - `@dependabot cancel merge` will cancel a previously requested merge and block automerging - `@dependabot reopen` will reopen this PR if it is closed - `@dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually - `@dependabot show <dependency name> ignore conditions` will show all of the ignore conditions of the specified dependency - `@dependabot ignore this major version` will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this minor version` will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this dependency` will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself) </details> Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Thomas Eizinger <thomas@eizinger.io>
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.