mnadeem/volume_exporter

Volume Exporter

镜像概述和主要用途

Volume Exporter 是一款用于监控磁盘、卷及PV（持久卷）存储的工具。它主要解决以下场景中的存储监控问题：

• 主机路径无法挂载到容器或DaemonSet
• 云提供商无法收集PV信息（如Red Hat相关bug所述）

在企业环境中，多项目可能运行在相同或不同节点上，出于安全考虑，主机路径挂载权限通常不被授予，且节点抓取需要集群角色，而项目团队往往无法获得该权限。此时，Volume Exporter 可作为节点导出器的补充，专注于节点导出器无法部署的场景，填补监控空白。

核心功能和特性

• 专注独特场景：与现有导出器不重复，专注于节点导出器无法部署的环境
• 多卷监控：支持同时监控多个卷，通过参数指定卷名称和路径
• 关键指标暴露：提供卷总容量、可用容量、已用容量及使用率百分比等核心指标
• 灵活部署：支持本地运行、Docker运行及作为边车容器部署在云环境中

使用场景和适用范围

适用于以下场景：

• 无法部署节点导出器的Kubernetes集群
• 需要监控特定PV或卷但无法获取主机路径挂载权限的环境
• 多项目/命名空间共享集群，且无法授予集群角色进行节点级监控的场景
• 云环境中PV信息收集受限的情况

使用方法和配置说明

本地命令行运行

bash
go run main.go --volume-dir=practices:E:\practices

使用参数说明：

Usage of main.exe:
  -volume-dir value
        要监控的卷，格式为volumeName:VolumeDir；例如：logs:/app/logs；可多次使用以指定多个卷
  -web.listen-address string
        Web界面和遥测数据的监听地址（默认 ":9888"）
  -web.telemetry-path string
        暴露指标的路径（默认 "/metrics"）

Docker本地运行

bash
docker run --rm -p 9889:9888 -it mnadeem/volume_exporter --volume-dir=bin:/bin

云环境部署（作为边车容器）

yaml
- name: volume-exporter
  image: mnadeem/volume_exporter
  imagePullPolicy: "Always"
  args:
    - --volume-dir=prometheus:/prometheus
  ports:
  - name: metrics-volume
    containerPort: 9888
  volumeMounts:
  - mountPath: /prometheus
    name: prometheus-data
    readOnly: true

配置参数说明

导出的指标

指标示例

运行以下命令后暴露的指标示例：

bash
docker run --rm -p 9888:9888 -it mnadeem/volume_exporter -volume-dir=bin:/bin -volume-dir=etc:/etc

输出示例：

# HELP volume_bytes_free Free size of the volume/disk
# TYPE volume_bytes_free gauge
volume_bytes_free{volume_name="bin",volume_path="/bin"} 4.341569536e+10
volume_bytes_free{volume_name="etc",volume_path="/etc"} 4.341569536e+10
# HELP volume_bytes_total Total size of the volume/disk
# TYPE volume_bytes_total gauge
volume_bytes_total{volume_name="bin",volume_path="/bin"} 6.391887872e+10
volume_bytes_total{volume_name="etc",volume_path="/etc"} 6.391887872e+10
# HELP volume_bytes_used Used size of volume/disk
# TYPE volume_bytes_used gauge
volume_bytes_used{volume_name="bin",volume_path="/bin"} 2.050318336e+10
volume_bytes_used{volume_name="etc",volume_path="/etc"} 2.050318336e+10
# HELP volume_exporter_build_info A metric with a constant '1' value labeled by version, revision, branch, and goversion from which volume_exporter was built.
# TYPE volume_exporter_build_info gauge
volume_exporter_build_info{branch="",goversion="go1.15",revision="",version=""} 1
# HELP volume_percentage_used Percentage of volume/disk Utilization
# TYPE volume_percentage_used gauge
volume_percentage_used{volume_name="bin",volume_path="/bin"} 32.07688208958619
volume_percentage_used{volume_name="etc",volume_path="/etc"} 32.07688208958619

支持与贡献

• 支持：如需使用帮助，可发送邮件或在GitHub创建issue（推荐）
• 贡献：欢迎提供建议/反馈/issue、提交新功能的PR或为项目点赞

项目详情请参考https://github.com/mnadeem/volume_exporter/wiki%E3%80%82