thej6s/mailcow-exporter

mailcow exporter

镜像概述

mailcow exporter是一个Prometheus导出器，用于收集https://github.com/mailcow/mailcow-dockerized%E9%82%AE%E4%BB%B6%E6%9C%8D%E5%8A%A1%E5%99%A8%E5%AE%9E%E4%BE%8B%E7%9A%84%E5%90%84%E7%B1%BB%E7%9B%91%E6%8E%A7%E6%8C%87%E6%A0%87%EF%BC%8C%E5%B9%B6%E9%80%9A%E8%BF%87%E6%A0%87%E5%87%86%E7%9A%84Prometheus /metrics端点提供数据，便于集成到Prometheus监控系统中。

核心功能与特性

• 全面的指标收集：支持监控***状态（最后登录时间、邮件数量、配额使用）、邮件队列长度、隔离区邮件（年龄、评分、数量）、API响应性能、容器运行状态及Rspamd统计数据等
• Prometheus兼容：提供符合Prometheus规范的metrics端点，支持直接被Prometheus抓取
• 灵活配置：支持通过URL参数指定mailcow实例地址、API密钥及访问协议（HTTP/HTTPS）
• 容器化部署：可通过Docker容器快速部署，也支持原生运行

使用场景

• 监控mailcow邮件服务器的运行状态和性能
• 跟踪***使用情况、配额消耗及活跃度
• 监控邮件队列长度和隔离区邮件状态
• 集成到监控告警系统，及时发现服务异常

使用方法

部署方式

Docker容器部署

bash
docker run -p '9099:9099' thej6s/mailcow-exporter

原生部署

bash
./mailcow-exporter

访问Metrics端点

/metrics端点需要以下URL参数：

• host：mailcow实例的主机名（必需）
• apiKey：mailcow的只读API密钥（必需），可通过mailcow管理界面的"Access > API"生成
• scheme：访问协议，默认为https，若无需TLS加密可设为http（可选）

Prometheus配置示例

在Prometheus配置中添加以下抓取配置，以传递必要参数：

yaml
scrape_configs:
  - job_name: 'mailcow'
    static_configs:
      - targets: [ 'mailcow_exporter:9099' ]  # exporter的地址和端口
    params:
      host: [ 'mail.example.com' ]  # 替换为实际的mailcow主机名
      apiKey: [ 'YOUR-APIKEY-HERE' ]  # 替换为实际的API密钥
      scheme: [ 'https' ]  # 可选，默认为https

示例指标

以下是部分关键指标示例：

***指标

# 邮箱最后登录时间
mailcow_mailbox_last_login{host="mail.example.com",mailbox="foo@bar.com"} 1.599255303e+09

# 邮箱邮件数量
mailcow_mailbox_messages{host="mail.example.com",mailbox="foo@bar.com"} 23476

# 邮箱配额允许值（字节）
mailcow_mailbox_quota_allowed{host="mail.example.com",mailbox="foo@bar.com"} 3.221225472e+09

# 邮箱配额使用值（字节）
mailcow_mailbox_quota_used{host="mail.example.com",mailbox="foo@bar.com"} 1.919023167e+09

邮件队列指标

# 邮件队列长度
mailcow_mailq{host="mail.example.com",queue="deferred",sender="foo@bar.com"} 2

隔离区指标

# 隔离区邮件数量
mailcow_quarantine_count{host="mail.example.com",is_virus="0",recipient="foo@bar.com"} 147

# 隔离区邮件年龄分布
mailcow_quarantine_age_bucket{host="mail.example.com",recipient="foo@bar.com",le="259200"} 3

容器状态指标

# 容器运行状态（1=运行中，0=未运行）
mailcow_container_running{container="dovecot-mailcow",host="mail.example.com",image="mailcow/dovecot:1.130"} 1

# 容器启动时间戳
mailcow_container_start{container="postfix-mailcow",host="mail.example.com",image="mailcow/postfix:1.51"} 1.599247354e+09

Rspamd统计指标

# Rspamd处理动作统计
mailcow_rspamd_action{action="reject",host="mail.example.com"} 701

# Rspamd分类统计
mailcow_rspamd_classification{classification="spam",host="mail.example.com"} 888