Wie Sie Rust-Kompilierzeiten in CI nachverfolgen

Everett Pompeii

Kompilierzeiten können einen erheblichen Teil Ihrer Buildzeit ausmachen, insbesondere in Rust. Kontinuierliches Benchmarking ist die Praxis, Benchmarks bei jedem Änderungssatz durchzuführen, um sicherzustellen, dass die Änderungen keine Leistungseinbußen verursachen. Sie können Kompilierzeiten als Benchmark behandeln und sie in der CI verfolgen, um langsame Kompilierzeiten zu erkennen. Der einfachste Weg, kontinuierliches Benchmarking für Rust-Kompilierzeiten zu implementieren, ist die Verwendung von Bencher.

Was ist Bencher?

Bencher ist eine Suite von kontinuierlichen Benchmarking-Tools. Hatten Sie jemals eine Performance Regression, die Ihre Nutzer beeinflusste? Bencher hätte das verhindern können. Bencher ermöglicht es Ihnen, Leistungsregressionen vorher zu erkennen und zu verhindern, bevor sie in die Produktion gelangen.

• Ausführen: Führen Sie Ihre Benchmarks lokal oder in CI mit Ihren bevorzugten Benchmarking-Tools aus. Das bencher CLI umfasst einfach Ihr vorhandenes Benchmark-Harness und speichert die Ergebnisse.
• Verfolgen: Verfolgen Sie die Ergebnisse Ihrer Benchmarks im Laufe der Zeit. Überwachen, abfragen und grafisch darstellen der Ergebnisse mit der Bencher Web Konsole auf Basis des Quellzweigs, Testbetts und Maßnahme.
• Auffangen: Fangen Sie Leistungsregressionen in CI ab. Bencher verwendet modernste, anpassbare Analysen, um Leistungsregressionen zu erkennen, bevor sie in die Produktion gelangen.

Aus denselben Gründen, warum Unit Tests in CI laufen, um Feature Regressionen zu verhindern, sollten Benchmarks in CI mit Bencher ausgeführt werden, um Leistungsregressionen zu verhindern. Performance-Bugs sind Fehler!

Schritte für Bencher Cloud

1. Erstellen Sie ein Bencher Cloud-Konto.
2. Erstellen Sie ein API-Token und fügen Sie es Ihrem CI als Geheimnis hinzu.
3. Erstellen Sie einen Workflow für Ihr CI, wie GitHub Actions oder GitLab CI/CD.
4. Installieren Sie die Bencher CLI in Ihrem CI-Workflow.
5. Kompilieren Sie Ihren Rust-Code mit dem bencher run-Unterbefehl in Ihrem CI-Workflow unter Verwendung des der --build-time-Flag mit dem dem json Adapter.

Schritte für die Bencher-Self-Hosted

1. Erstellen Sie eine Bencher Self-Hosted Instanz.
2. Erstellen Sie ein Konto auf Ihrer Bencher Self-Hosted Instanz.
3. Erstellen Sie ein API-Token und fügen Sie es als Geheimnis zu Ihrem CI hinzu.
4. Erstellen Sie einen Workflow für Ihr CI, wie GitHub Actions oder GitLab CI/CD.
5. Installieren Sie die Bencher-CLI in Ihrem CI-Workflow. Stellen Sie sicher, dass die CLI-Version mit der Version Ihrer Bencher Self-Hosted Instanz übereinstimmt.
6. Kompilieren Sie Ihren Rust-Code mit dem bencher run-Unterbefehl in Ihrem CI-Workflow unter Verwendung des der --build-time-Flag mit dem dem json Adapter und setzen Sie die die --host Option auf die URL Ihrer Bencher Self-Hosted-Instanz.

⏱️ Buildzeit

Der bencher run CLI-Subbefehl kann mit dem --build-time-Flag verwendet werden, um die Buildzeit (d. h. Kompilierzeit) Ihrer Auslieferungen zu verfolgen. Im Hintergrund gibt bencher run die Ergebnisse als Bencher Metric Format (BMF) JSON aus. Es ist daher gute Praxis, den JSON-Adapter explizit zu verwenden. Weitere Details finden Sie unter wie man die Buildzeit verfolgt.

Die build-time-Messung (d. h. Sekunden (s)) wird erfasst. Nur der Buildzeitwert (d. h. value) ist verfügbar. Weder lower_value noch upper_value werden erfasst. Die build-time-Messung wird nicht standardmäßig für alle Projekte erstellt. Wenn Sie jedoch das --build-time-Flag verwenden, wird diese Messung automatisch für Ihr Projekt erstellt.

bencher run --build-time --adapter json "cargo build --release"