metered-rs

为 Rust 提供快速、高效的度量！

Metered 帮助您在生产环境中测量程序的性能。受 Coda Hale 的 Java 度量库的启发，Metered 通过提供声明式和过程宏来测量程序，而不改变您的逻辑，使得实时测量变得简单。

Metered 的构建基于以下原则

• 高易用性但无魔法：度量代码只需注释代码即可。Metered 允许您从裸度量构建自己的度量注册表，或使用过程宏生成一个。它不使用共享的全局变量或静态变量。

• 恒定、非常低的开销：好的易用性不应带来开销；唯一的开销是由实际的度量后端本身（例如，计数器、仪表、直方图）所施加的，而 Metered 提供的这些后端在初始化后不会分配。Metered 将度量注册表生成为常规 Rust struct，因此查找度量时没有涉及查找。Metered 提供了无同步和线程安全的度量后端，以便单线程或无共享架构无需为同步付费。尽可能使用 Metered 提供的线程安全的度量后端，这些后端使用无锁数据结构。

• 可扩展：度量只是实现了具有特定行为的 Metric 特质的常规类型。Metered 的宏允许您引用任何 Rust 类型，从而产生用户可扩展的属性！

许多指标只有在获得精确统计时才有意义。在低延迟、高范围直方图方面，没有比Gil Tene的动态范围直方图更好的了，而Metered默认使用官方的Rust端口为其直方图。

变更日志

• 0.9.0:
  • 使用包装int指标代替下溢/上溢
  • 提供方法以递增或递减int指标超过1，这对于批处理计算很有用
  • 添加了对Clear的泛型实现（由@plankton6贡献）
  • 向HdrHistogram添加了len方法（由@plankton6贡献）
  • 代码质量修复和依赖更新
• 0.8.0:
  • 通过OnResultMut而不是OnResult更新指标，以支持需要可变访问结果指标的指标 - 例如消费一个Stream（由@w4贡献）
• 0.7.0:
  • 公开内部指标后端类型Throughput（修复了问题#30）
  • 为所有顶级指标实现Deref
  • 公开内部指标后端类型Throughput
  • 向error_count属性添加skip_cleared选项（由@w4贡献）
    • 引入一个新的Clearable特质，该特质公开了实现Clear的指标的行为（为了向后兼容）。目前仅在计数器上实现。
    • 可以通过构建时的功能来控制默认行为，error-count-skip-cleared-by-default
• 0.6.0:
  • 扩展error_count宏，允许报告嵌套枚举错误变体，为嵌套错误提供零成本的错误跟踪（由@w4贡献）
• 0.5.0:
  • 使内部指标公开（由@nemosupremo贡献）
  • 提供error_count宏来为错误枚举生成定制的ErrorCount指标计数变体（由@w4贡献）
  • 使用Drop自动触发不依赖于结果值的指标（影响InFlight、ResponseTime、Throughput）
• 0.4.0:
  • 向生成的结构体添加allow(missing_docs)（这允许在Rust代码中使用带有lint级别warn(missing_docs)或甚至deny(missing_docs)的metered结构体）（由@reyk贡献）
  • 为生成的注册表实现Clear（由@eliaslevy贡献）
  • 为RefCell<HdrHistogram>实现Histogram和Clear（由@eliaslevy贡献）
  • 引入一个具有微秒精度的Instant（由@eliaslevy贡献）
    • API破坏性更改：Instant.elapsed_millis重命名为elapsed_time，并引入了一个新的关联常量，ONE_SEC，用于指定一秒的瞬时单位。
  • 通过重新导出使AtomicTxPerSec和TxPerSec可见（由@eliaslevy贡献）
  • 将StdInstant作为TxPerSec中T: Instant的默认类型参数（由@eliaslevy贡献）
  • 修改HdrHistogram以与serde_prometheus一起工作（由@w4贡献）
    • 请与 serde_prometheus 以及任何 HTTP 服务器一起使用。
  • 依赖项更新
    • indexmap: 1.1 -> 1.3
    • hdrhistogram: 6.3 -> 7.1
    • parking_lot: 0.9 -> 0.10
• 0.3.0:
  • 修复了在 async 测量方法中保留 span 的问题。
  • 更新了夜间构建样本以支持新语法和 Tokio 0.2-alpha（使用 std futures，需要 Rust >= 1.39，nightly 或非 nightly）
  • 更新了依赖项以使用 syn，proc-macro2 和 quote 1.0
• 0.2.2:
  • 在 #measured 方法中的异步支持不再依赖于异步闭包，因此客户端代码不需要 async_closure 功能门。
  • 更新了依赖项版本
• 0.2.1:
  • 在特定情况下，Serde 会为 PhantomData 标记中的 ResponseTime 和 Throughput 指标序列化 "nulls"。现在它们被明确排除。
• 0.2.0:
  • 支持 .await 语法用户（不再需要 await!()）
• 0.1.3:
  • 修复了在 #[measure]’ed 方法中的早期返回问题
  • 移除了对 crate AtomicRefCell 的使用，它有时会引发恐慌。
  • 支持自定义注册表可见性。
  • 支持 async + await!() 宏用户。

use metered::{metered, Throughput, HitCount};

#[derive(Default, Debug, serde::Serialize)]
pub struct Biz {
    metrics: BizMetrics,
}

#[metered(registry = BizMetrics)]
impl Biz {
    #[measure([HitCount, Throughput])]
    pub fn biz(&self) {        
        let delay = std::time::Duration::from_millis(rand::random::<u64>() % 200);
        std::thread::sleep(delay);
    }   
}

use std::thread;
use std::sync::Arc;

fn test_biz() {
    let biz = Arc::new(Biz::default());
    let mut threads = Vec::new();
    for _ in 0..5 {
        let biz = Arc::clone(&biz);
        let t = thread::spawn(move || {
            for _ in 0..200 {
                biz.biz();
            }
        });
        threads.push(t);
    }
    for t in threads {
        t.join().unwrap();
    }
    // Print the results!
    let serialized = serde_yaml::to_string(&*biz).unwrap();
    println!("{}", serialized);
}

metrics:
  biz:
    hit_count: 1000
    throughput:
      - samples: 20
        min: 35
        max: 58
        mean: 49.75
        stdev: 5.146600819958742
        90%ile: 55
        95%ile: 55
        99%ile: 58
        99.9%ile: 58
        99.99%ile: 58
      - ~