Fastrace 使用教程

Fastrace 使用教程

fastrace A tracing library 10~100x faster than others. 项目地址: https://gitcode.com/gh_mirrors/fa/fastrace

1. 项目介绍

Fastrace 是一个由 CSDN 公司开发的 Rust 语言编写的开源跟踪库，它比其他跟踪库快 10 到 100 倍。Fastrace 提供了丰富的日志功能，并且与 Jaeger、Datadog 和 OpenTelemetry 等工具兼容。其设计专注于性能，特别适合在库级别进行跟踪，能够在不激活时做到零开销，这使得 Fastrace 成为性能敏感型应用的理想选择。

2. 项目快速启动

安装

首先，确保你的系统安装了 Rust 和 Cargo。然后将 Fastrace 添加到你的 Cargo.toml 文件中作为依赖项。

[dependencies]
fastrace = "0.7"

基础使用

在你的 Rust 函数上添加 #[fastrace::trace] 属性，这样每次调用该函数时，都会收集一个 SpanRecord，前提是调用者已经设置了跟踪上下文。

#[fastrace::trace]
pub fn send_request(req: HttpRequest) -> Result<(), Error> {
    // ...
}

如果你希望为库创建一个独立的跟踪上下文，可以使用 Span::root() 来启动新的跟踪，并使用 `Span::set_local_parent()来为当前线程设置本地上下文。

use fastrace::prelude::*;

pub fn send_request(req: HttpRequest) -> Result<(), Error> {
    let root = Span::root(func_path!(), SpanContext::random());
    let _guard = root.set_local_parent();
    // ...
}

应用初始化

在应用程序中，你应该在程序运行早期初始化一个 Reporter 实现。在程序终止前，调用 flush() 确保所有收集的跟踪记录都已报告。

use fastrace::collector::Config;
use fastrace::collector::ConsoleReporter;
use fastrace::prelude::*;

fn main() {
    fastrace::set_reporter(ConsoleReporter, Config::default());
    loop {
        let root = Span::root("worker-loop", SpanContext::random());
        let _guard = root.set_local_parent();
        handle_request();
    }
    fastrace::flush();
}

3. 应用案例和最佳实践

• 性能敏感型应用: 由于 Fastrace 的高性能，它特别适用于那些对性能要求极高的应用场景。
• 库级跟踪: 在库级别使用 Fastrace 可以实现无感知的性能跟踪，而不影响库的用户。
• 分布式跟踪: 集成 Jaeger、Datadog 或 OpenTelemetry 实现分布式跟踪，帮助诊断复杂系统的性能问题。

4. 典型生态项目

以下是一些使用 Fastrace 的典型开源项目：

• Conductor: 一个开源的 GraphQL 网关。
• Apache OpenDAL: 一个支持多种存储的数据访问层。
• Databend: 一种具有 Snowflake 代替品的成本效益解决方案。
• Foyer: 一种混合内存和磁盘缓存的 Rust 库。
• Sail: 与 Apache Spark 兼容的统一流、批和 AI 工作负载处理框架。

fastrace A tracing library 10~100x faster than others. 项目地址: https://gitcode.com/gh_mirrors/fa/fastrace