Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add PGO information #18369

Merged
merged 2 commits into from
Aug 24, 2023
Merged

docs: add PGO information #18369

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
18eddab
docs: add PGO information
zamazan4ik Aug 24, 2023
4cf4b20
Apply suggestions from code review
zamazan4ik Aug 24, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .github/actions/spelling/allow.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,7 @@ Enot
Evercoss
Explay
FAQs
FDO
FQDNs
Fabro
Figma
Expand Down
4 changes: 4 additions & 0 deletions .../content/en/docs/administration/tuning.md → ...t/en/docs/administration/tuning/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,7 @@ tags: ["tuning", "rust", "performance"]
Vector is written in [Rust] and therefore doesn't include a runtime or a virtual machine. There are no special service-level steps you need to undertake to improve performance as Vector takes full advantage of all system resources by default and without any adjustments.

[rust]: https://rust-lang.org

## Pages

{{< pages >}}
31 changes: 31 additions & 0 deletions website/content/en/docs/administration/tuning/pgo.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
---
title: Profile-Guided Optimization
description: How to optimize Vector performance with Profile-Guided Optimization
short: PGO
weight: 3
tags: ["pgo", "tuning", "rust", "performance"]
---

Profile-Guided Optimization (PGO) is a compiler optimization technique where a program is optimized based on the runtime profile.

According to the [tests], we see improvements of up to 15% more processed log events per second on some Vector workloads. The performance benefits depend on your typical workload - you can get better or worse results.

More information about PGO in Vector you can read in the corresponding GitHub [issue].

### How to build Vector with PGO?

There are two major kinds of PGO: Instrumentation and Sampling (also known as AutoFDO). In this guide, is described the Instrumentation PGO with Vector. In this guide we use [cargo-pgo] for building Vector with PGO.

* Install [cargo-pgo].
* Check out the Vector repository.
* Go to the Vector source directory and run `cargo pgo build`. It will build the instrumented Vector version.
* Run instrumented Vector on your test load like `cargo pgo run -- -- -c vector.toml` and wait for some time to collect enough information from your workload. Usually, waiting several minutes is enough (but your case can be different).
* Stop Vector instance. The profile data will be generated in the `target/pgo-profiles` directory.
* Run `cargo pgo optimize`. It will build Vector with PGO optimization.

A more detailed guide on how to apply PGO is in the Rust [documentation].

[tests]: https://github.com/vectordotdev/vector/issues/15631#issue-1502073978
[issue]: https://github.com/vectordotdev/vector/issues/15631
[documentation]: https://doc.rust-lang.org/rustc/profile-guided-optimization.html
[cargo-pgo]: https://github.com/Kobzol/cargo-pgo