Actix-web-prom 项目启动和配置教程

Actix-web-prom 项目启动和配置教程

actix-web-prom Actix-web middleware to expose Prometheus metrics 项目地址: https://gitcode.com/gh_mirrors/ac/actix-web-prom

1. 项目目录结构及介绍

Actix-web-prom 是一个用于 Actix-web 框架的 Prometheus 指标暴露中间件。以下是项目的目录结构及其简要介绍：

actix-web-prom/
├── examples/               # 示例代码目录
├── src/                    # 源代码目录
│   ├── bin/                # 可执行文件目录
│   └── lib/                # 库文件目录
├── .gitignore              # Git 忽略文件
├── Cargo.toml              # Rust 项目配置文件
├── CHANGELOG.md            # 更改日志
├── LICENSE                 # 许可证文件
├── README.md               # 项目说明文件
└── README.tpl              # 模板文件

2. 项目的启动文件介绍

项目的启动主要通过 main.rs 文件进行，通常位于 src/bin 目录下。以下是启动文件的基本结构和说明：

// 引入必要的库
use actix_web::{web, App, HttpResponse, HttpServer};
use actix_web_prom::{PrometheusMetrics, PrometheusMetricsBuilder};

#[actix_web::main] // 标记为主函数
async fn main() -> std::io::Result<()> {
    // 初始化 Prometheus 指标
    let prometheus = PrometheusMetricsBuilder::new("api")
        .endpoint("/metrics")
        .build()
        .unwrap();

    // 创建 HttpServer 实例
    HttpServer::new(move || {
        App::new()
            .wrap(prometheus.clone()) // 添加 Prometheus 中间件
            .service(
                web::resource("/health") // 定义健康检查路由
                    .to(|| HttpResponse::Ok().finish()),
            )
    })
    .bind("127.0.0.1:8080")? // 绑定到指定地址和端口
    .run() // 运行服务器
    .await
}

在上述代码中，我们创建了一个 Prometheus 指标收集器，定义了一个 /health 路由用于健康检查，并将 Prometheus 中间件添加到应用中。然后启动 HTTP 服务器监听 127.0.0.1:8080。

3. 项目的配置文件介绍

Actix-web-prom 的配置主要通过 Cargo.toml 文件进行，这是 Rust 项目的标准配置文件。以下是配置文件的基本结构和说明：

[package]
name = "actix-web-prom"
version = "0.10.0"
edition = "2021"

[dependencies]
actix-web = "4.0"

在 Cargo.toml 文件中，我们定义了项目名称、版本和使用的 Rust 版本。在 [dependencies] 部分，我们添加了 Actix-web 作为依赖项，这是运行 Actix-web-prom 所必需的。

此外，项目可能会使用环境变量或其他配置文件来进一步配置，但这些都是根据实际需求来定的。在 examples 目录中通常可以找到更多配置和启动的示例代码。

actix-web-prom Actix-web middleware to expose Prometheus metrics 项目地址: https://gitcode.com/gh_mirrors/ac/actix-web-prom