metrics-exporter-scope

Rust 度量生态系统的示波器。

简介

metrics-exporter-scope 是一个 metrics 库的导出器，旨在输出频繁变化的指标快照。其功能类似于经典示波器，应用场景也相似：该库是为了以高频率（1Hz+）采样指标而开发的，主要用于显示嵌入式系统、工业自动化控制器、机器人、网络设备等实时数据。

metrics-exporter-scope 是 RoboPLC 项目的组成部分。

使用方法

配置

使用默认设置安装导出器（绑定到 0.0.0.0:5001）

metrics_exporter_scope::ScopeBuilder::new().install().unwrap();

定义指标

该导出器仅与 Gauge 指标一起工作.

该库被设计为次要指标导出器，所有带有范围的前缀 ~ 的指标都必须使用。没有前缀的指标要么被忽略，要么由主程序导出器导出。

use metrics::gauge;

gauge!("~my_metric").set(42.0);

指标标签

指标可以有额外的标签，其中一些用于客户端程序通过 plot 标签键配置图表。

use metrics::gauge;

gauge!("~my_metric", "plot" => "plot1").set(42.0);
gauge!("~my_metric2", "plot" => "plot1").set(42.0);

上面的示例将两个指标组合到同一图表中。

指标颜色

color 标签键用作客户端程序设置与指标关联的图表线条颜色的提示。

use metrics::gauge;

gauge!("~my_metric", "color" => "blue").set(42.0);
gauge!("~my_metric2", "color" => "#99ccff").set(42.0);

客户端程序支持的颜色有：red、green、blue、yellow、cyan、magenta、orange、white、black。颜色也可以设置为 RGB，使用 #RRGGBB 或 #RGB 格式。

let primary_recorder = SomePrimaryMetricsRecorder::new();

metrics_exporter_scope::ScopeBuilder::new()
    .with_fallback(Box::new(primary_recorder))
    .install()
    .unwrap();

cargo install metrics-scope

[dependencies]
metrics-exporter-scope = { version = "0.1", default-features = false, features = ["msrv"] }