Autometrics-rs 项目使用教程

Autometrics-rs 项目使用教程

autometrics-rsEasily add metrics to your code that actually help you spot and debug issues in production. Built on Prometheus and OpenTelemetry.项目地址:https://gitcode.com/gh_mirrors/au/autometrics-rs

1. 项目的目录结构及介绍

Autometrics-rs 项目的目录结构如下：

autometrics-rs/
├── Cargo.toml
├── LICENSE-APACHE
├── LICENSE-MIT
├── README.md
├── src/
│   ├── lib.rs
│   ├── macros.rs
│   ├── metrics.rs
│   ├── otel.rs
│   └── prometheus.rs
└── examples/
    └── axum_example.rs

目录结构介绍

• Cargo.toml: 项目的依赖和元数据配置文件。
• LICENSE-APACHE 和 LICENSE-MIT: 项目的开源许可证文件。
• README.md: 项目介绍和使用说明。
• src/: 项目的主要代码目录。
  • lib.rs: 库的入口文件。
  • macros.rs: 宏定义文件。
  • metrics.rs: 指标相关的代码。
  • otel.rs: OpenTelemetry 相关的代码。
  • prometheus.rs: Prometheus 相关的代码。
• examples/: 示例代码目录。
  • axum_example.rs: 使用 Axum 框架的示例代码。

2. 项目的启动文件介绍

项目的启动文件是 src/lib.rs，它是整个库的入口点。在这个文件中，定义了库的主要功能和模块的导出。

// src/lib.rs

pub mod macros;
pub mod metrics;
pub mod otel;
pub mod prometheus;

// 其他初始化代码和导出

3. 项目的配置文件介绍

项目的配置文件是 Cargo.toml，它包含了项目的依赖、版本信息和其他元数据。

[package]
name = "autometrics"
version = "2.0.0"
edition = "2021"

[dependencies]
autometrics-macros = "2.0.0"
http = "1.0.0"
linkme = "0.3"
metrics = "0.21"
metrics-exporter-prometheus = "0.12"
once_cell = "1.17"
opentelemetry = "0.24"
opentelemetry-otlp = "0.17"
opentelemetry-prometheus = "0.17"
opentelemetry-sdk = "0.24.1"
prometheus = "0.13"
prometheus-client = "0.22"
spez = "0.1.2"
thiserror = "1.0"
tracing = "0.1"
tracing-opentelemetry = "0.25"
tracing-subscriber = "0.3"
async-trait = "0.1.74"

[features]
default = ["prometheus-exporter"]

配置文件介绍

• [package]: 定义了项目的名称、版本和使用的 Rust 版本。
• [dependencies]: 列出了项目依赖的所有库及其版本。
• [features]: 定义了项目的特性，例如默认启用的 prometheus-exporter 特性。

通过以上介绍，您可以更好地理解和使用 Autometrics-rs 项目。

autometrics-rsEasily add metrics to your code that actually help you spot and debug issues in production. Built on Prometheus and OpenTelemetry.项目地址:https://gitcode.com/gh_mirrors/au/autometrics-rs