Rust

使用我们先进的 Rust Profiler 优化您的 Rust 应用程序。与 Pyroscope 合作，它提供了实时性能分析功能，揭示了 Rust 代码库的复杂性。对于寻求增强性能、减少资源使用并在 Rust 应用程序中实现高效代码执行的开发人员来说，此集成非常宝贵。

注意
请参阅可用的性能分析类型，了解 Rust 支持的配置文件类型列表。

开始之前

要捕获和分析性能分析数据，您需要一个托管的 Pyroscope OSS 服务器或一个托管的具有 Grafana Cloud Profiles 的 Pyroscope 实例（需要一个免费的 Grafana Cloud 帐户）。

Pyroscope 服务器可以是用于开发的本地服务器，也可以是用于生产用途的远程服务器。

将 Rust 性能分析添加到您的应用程序

将 pyroscope 和 pyroscope_pprofrs 箱添加到您的 Cargo.toml

cargo add pyroscope
cargo add pyroscope_pprofrs

配置 Rust 客户端

至少，您需要提供 Pyroscope 服务器的 URL 和应用程序的名称。您还需要配置一个性能分析后端。对于 Rust，您可以使用 pprof-rs。

// Configure profiling backend
let pprof_config = PprofConfig::new().sample_rate(100);
let backend_impl = pprof_backend(pprof_config);

// Configure Pyroscope Agent
let agent = PyroscopeAgent::builder("https://127.0.0.1:4040", "myapp")
    .backend(backend_impl)
    .build()?;

使用安全后端的用户需要提供身份验证详细信息。Grafana Cloud 使用基本身份验证。您的用户名是一个数字值，您可以从 grafana.com 上您堆栈的 Pyroscope 的“详细信息页面”中获取。在此同一页面上，创建一个令牌并将其用作基本身份验证密码。然后配置将类似于

fn  main() ->  Result<()> {
std::env::set_var("RUST_LOG", "debug");
pretty_env_logger::init_timed();
let user = std::env::var("USER").unwrap();
let password = std::env::var("PASSWORD").unwrap();
let url = std::env::var("PYROSCOPE_URL").unwrap();
let samplerate = std::env::var("SAMPLE_RATE").unwrap().to_string().parse().unwrap();
let application_name = "example.basic";

let agent = PyroscopeAgent::builder(url, application_name.to_string())
    .basic_auth(user, password).backend(pprof_backend(PprofConfig::new().sample_rate(samplerate)))
    .tags([("app", "Rust"), ("TagB", "ValueB")].to_vec())
    .build()?;

您可以通过调用以下代码开始性能分析

let agent_running = agent.start().unwrap();

代理可以在任何时候停止，它会向服务器发送最后一个报告。代理可以在稍后重新启动。

let agent_ready = agent.stop().unwrap();

建议在退出应用程序之前关闭代理。如果代理未正确关闭，则可能会错过对服务器的最后一个请求。

agent_ready.shutdown();

向 Rust 应用程序添加性能分析标签

代理启动后，可以添加或删除标签。从 0.5.0 版本开始，Pyroscope 代理支持在线程内添加标签。有关详细用法，请查看标签和多线程示例。

代理启动后，tag_wrapper 函数变为可用。tag_wrapper 返回一个函数元组，用于跨线程边界向代理添加和删除标签。只要代理正在运行，此函数就可用，并且可以多次调用。

// Start Profiling
let agent_running = agent.start().unwrap();

// Generate Tag Wrapper functions
let (add_tag, remove_tag) = agent_running.tag_wrapper();

// Profiled code (with no tags)

// Add tags to the agent
add_tag("key".to_string(), "value".to_string());

// This portion will be profiled with the specified tag.

// Remove tags from the agent
remove_tag("key".to_string(), "value".to_string());

// Stop the agent
let agent_ready = running_agent.stop();

Rust 客户端配置选项

代理接受其他初始参数

后端：性能分析后端。对于 Rust，它是 pprof-rs
采样率：采样频率，单位赫兹。默认值为 100。
标签：初始标签。

// Configure Profiling backend
let pprof_config = PprofConfig::new().sample_rate(100);
let pprof_backend = Pprof::new(pprof_config);

// Configure Pyroscope Agent
let agent =
PyroscopeAgent::builder("https://127.0.0.1:4040", "myapp")
// Profiling backend
.backend(pprof_backend)
// Sample rate
.sample_rate(100)
// Tags
.tags(vec![("env", "dev")])
// Create the agent
.build()?;

技术细节

后端：Pyroscope 代理使用 pprof-rs 作为后端。因此，pprof-rs 的限制也适用。从 0.5.0 版本开始，Pyroscope 代理支持在线程内添加标签。有关用法，请查看标签和多线程示例。
计时器：需要 epoll（对于 Linux）和 kqueue（对于 macOS）才能获得更精确的计时器。
关闭：Pyroscope 代理可能需要一些时间（通常少于 10 秒）才能正确关闭并丢弃其线程。为了正确关闭，建议您在丢弃代理之前运行 shutdown 函数。
相关链接