iKuai Exporter

一个用于获取采集爱快路由的统计数据，并导出为 Prometheus 格式的 Exporter。

版本

版本	爱快版本	描述
>= v0.3.0	4.0+	支持 iKuai 4.0 版本，不保证兼容 3.0 版本
v0.2.x	3.x	支持 iKuai 3.0 版本

部署

部署下面的容器，配置容器环境变量，设置爱快地址和登录密码。

docker pull ghcr.io/jakeslee/ikuai-exporter:latest
# or
docker pull docker.io/jakes/ikuai-exporter:latest

使用 docker-compose 部署：

services:
    ikuai-exporter:
        image: ghcr.io/jakeslee/ikuai-exporter:latest
        restart: always
        environment:
            IKUAI_URL: "http://10.0.1.253"
            IKUAI_USERNAME: "test"
            IKUAI_PASSWORD: "test123"
        ports:
            - "9090:9090"

部署完成后，访问 http://IP:9090/metrics 验证运行情况。

接下来将 exporter 的采集地址 IP 配置到 Prometheus 的 scrape_configs 中就可开始使用。

详细配置和 Grafana 配置示例可以参考使用样例，最新的演示 Dashboard 在这里。

参数说明

登录的帐号密码建议创建一个只读用户使用。

Run metrics endpoint

Usage:
i kuai-exporter server [flags]

Flags:
    -h, --help                  help for server
        --insecure-skip         Skip iKuai certificate verification (default true)
    -l, --level string          Log level (default "info")
        --modules strings       The modules to be collected. (default [sysStat,lanDevice,interfaceInfo])
    -p, --password string       The password for the user on iKuai (default "test123")
        --timeout int           The timeout (seconds) for a request to iKuai API.  (default 2)
        --url string            iKuai URL (default "http://10.0.1.253")
    -u, --username string       iKuai username (default "test")

变量名	说明	默认值
modules	采集模块	sysStat,lanDevice,interfaceInfo
insecure-skip	跳过证书验证	true
timeout	请求超时时间（单位：秒）	2

从 v0.2.1 开始，可以使用环境变量来设置上面的参数，格式为 IKUAI_XXX，如 IKUAI_URL=http://10.0.1.253 或 IKUAI_USERNAME=test。

下面的方式依然支持，但将在以后版本中弃用。

变量名	说明
IK_URL	爱快地址
IK_USER	爱快登录用户
IK_PWD	爱快登录密码