rekzi/clamav-prometheus-exporter

ClamAV Prometheus Exporter

镜像概述和主要用途

ClamAV Prometheus Exporter是一款用于将ClamAV（开源病毒扫描引擎）的运行指标转换为Prometheus可采集格式的工具。通过该Exporter，用户可便捷地监控ClamAV的服务健康状态、线程资源、内存使用、队列长度等关键性能指标，结合Prometheus和Grafana等监控平台实现可视化与告警。

核心功能和特性

暴露的监控指标

当前支持导出以下ClamAV指标：

• ClamAVUp：ClamAV服务运行状态（1为正常，0为异常）
• ClamAVThreadsLive：活跃线程数
• ClamAVThreadsIdle：空闲线程数
• ClamAVThreadsMax：最大线程数
• ClamAVQueue：待处理任务队列长度
• ClamAVMemHeap：堆内存使用量（字节）
• ClamAVMemMMap：mmap内存使用量（字节）
• ClamAVMemUsed：总内存使用量（字节）
• ClamAVBuildInfo：ClamAV构建信息（含版本、病毒库版本）

指标详情示例

# HELP clamav_build_info 显示ClamAV构建信息
# TYPE clamav_build_info gauge
clamav_build_info{clamav_version="0.102.4",database_version="26091"} 1
# HELP clamav_mem_heap_bytes 显示堆内存使用量（字节）
# TYPE clamav_mem_heap_bytes gauge
clamav_mem_heap_bytes 1.090783104e+06
# HELP clamav_mem_mmap_bytes 显示mmap内存使用量（字节）
# TYPE clamav_mem_mmap_bytes gauge
clamav_mem_mmap_bytes 1.076747264e+06
# HELP clamav_mem_used_bytes 显示总内存使用量（字节）
# TYPE clamav_mem_used_bytes gauge
clamav_mem_used_bytes 1.076783104e+06
# HELP clamav_pools_total_bytes 显示签名数据库内存池分配器总内存（字节）
# TYPE clamav_pools_total_bytes gauge
clamav_pools_total_bytes 1.076783104e+06
# HELP clamav_pools_used_bytes 显示签名数据库内存池已使用内存（字节）
# TYPE clamav_pools_used_bytes gauge
clamav_pools_used_bytes 1.076747264e+06
# HELP clamav_queue_length 显示待处理任务队列长度
# TYPE clamav_queue_length gauge
clamav_queue_length 0
# HELP clamav_threads_idle 显示空闲线程数
# TYPE clamav_threads_idle gauge
clamav_threads_idle 0
# HELP clamav_threads_live 显示活跃线程数
# TYPE clamav_threads_live gauge
clamav_threads_live 1
# HELP clamav_threads_max 显示最大线程数
# TYPE clamav_threads_max gauge
clamav_threads_max 10
# HELP clamav_up 显示服务运行状态（1为正常，0为异常）
# TYPE clamav_up gauge
clamav_up 1

使用场景和适用范围

适用于所有部署ClamAV病毒扫描服务的环境，典型场景包括：

• 邮件服务器（如Postfix、Exim）集成ClamAV进行邮件病毒扫描的监控
• 文件共享服务（如Samba、Nextcloud）中ClamAV文件上传扫描的性能监控
• 终端安全管理系统中ClamAV本地扫描任务的资源占用监控
• 需要实时掌握ClamAV服务健康状态（如病毒库更新、内存泄漏）的运维场景

使用方法和配置说明

基本配置参数

支持通过环境变量或命令行参数配置，常用参数：

Docker部署示例

1. 独立容器运行

bash
docker run -d \
  --name clamav-exporter \
  -p 9726:9726 \
  -e CLAMAV_HOST=clamav-server \  # 替换为ClamAV服务IP/主机名
  -e CLAMAV_PORT=3310 \
  -e WEB_LISTEN_ADDRESS=:9726 \
  r3kzi/clamav-prometheus-exporter

2. Docker Compose集成

创建docker-compose.yml：

yaml
version: '3'
services:
  clamav:
    image: clamav/clamav
    container_name: clamav-server
    ports:
      - "3310:3310"
    volumes:
      - clamav_db:/var/lib/clamav
    restart: always

  exporter:
    image: r3kzi/clamav-prometheus-exporter
    container_name: clamav-exporter
    ports:
      - "9726:9726"
    environment:
      - CLAMAV_HOST=clamav  # 与ClamAV服务容器名一致
      - CLAMAV_PORT=3310
      - WEB_LISTEN_ADDRESS=:9726
    depends_on:
      - clamav
    restart: always

volumes:
  clamav_db:

指标采集验证

Exporter启动后，通过http://<主机IP>:9726/metrics访问指标接口，示例输出见“指标详情示例”。Prometheus配置添加如下采集任务即可接入：

yaml
scrape_configs:
  - job_name: 'clamav'
    static_configs:
      - targets: ['clamav-exporter:9726']  # 替换为Exporter容器地址