热门搜索:
chatwork/sendgrid-stats-exporter
chatwork
用于从SendGrid Stats API(v3)收集每日指标的Prometheus exporter Docker镜像，可将SendGrid邮件发送相关统计数据导出为Prometheus可抓取的格式，支持多种配置参数和健康检查。
1 次收藏下载次数: 0状态：社区镜像维护者：chatwork仓库类型：镜像最近更新：4 年前
让 AI 帮你使用轩辕镜像？ · 展开查看说明
如果你使用 DeepSeek、元宝 AI、Copilot、ChatGPT 等 AI 工具，协助配置轩辕镜像、编写 docker pull 命令、修改 Docker Compose 镜像地址、配置镜像加速、排查镜像拉取失败、分析报错日志等问题，请先让 AI 阅读并遵守轩辕镜像的规则文档。
只需在 AI 对话中先发送下面这句话即可：
请先完整阅读并严格遵守以下文档中的全部规则与要求：
https://xuanyuan.cloud/agents.md
在未充分阅读并理解该文档前，不要生成任何命令、配置、修改建议、故障排查方案或技术回答。后续所有输出都必须严格以该文档中的规范为最高优先级执行。查看 agents.md 用法指南与完整示范。国内用户首推 元宝 AI、DeepSeek 的深度思考模式，不推荐豆包 AI；Cursor 等编辑器可在对话 @ 该链接，或加入 User Rules。 若 AI 无法访问外链，可 打开说明文档 复制全文粘贴。文档会随站点更新，复制内容可能过期，建议定期检查。
sendgrid-stats-exporter
镜像概述和主要用途
sendgrid-stats-exporter是一个Prometheus exporter，用于从SendGrid Stats API(v3)收集每日指标。它通过调用SendGrid Stats API获取邮件发送相关统计数据，并将其转换为Prometheus可抓取的格式，以便进行监控和分析。
数据流向如下：
+---------------------------+ +------------+ +--------------+ | SendGrid Stats API (v3) |---(收集 /v3/stats)--->| exporter |<---(抓取 /metrics)---| Prometheus | +---------------------------+ +------------+ +--------------+
核心功能和特性
- 支持从SendGrid Stats API(v3)收集多种邮件发送指标
- 提供Prometheus兼容的
/metrics端点，便于数据抓取 - 内置健康检查端点
/-/healthy，支持服务状态监控 - 可配置监听地址和端口，适应不同部署环境
- 支持排除exporter自身 metrics（如promhttp_、process_、go_*）
- 提供多维度配置：用户名标签、时区设置、时间偏移、月度累积指标等
- 可通过日志级别和格式控制输出，便于问题排查
使用场景和适用范围
- 需要监控SendGrid邮件发送状态的团队
- 希望通过Prometheus+Grafana构建邮件统计监控面板的用户
- 需要对邮件发送量、退信率、打开率等指标进行趋势分析的场景
- 多SendGrid账户环境下需要区分不同用户指标的场景
- 需要监控月度邮件发送限额使用情况的场景
使用方法和配置说明
配置参数
| 参数 | 描述 | 是否必填 |
|---|---|---|
--web.listen-address | Web界面和遥测监听地址，默认值：:9154 | 否 |
--web.disable-exporter-metrics | 排除exporter自身metrics | 否 |
--sendgrid.api-key | SendGrid API密钥 | 是 |
--sendgrid.username | 作为指标标签的SendGrid用户名，用于区分多用户指标 | 否 |
--sendgrid.location | 时区名称（如'Asia/Tokyo'），默认UTC | 否 |
--sendgrid.time-offset | 相对于UTC的时间偏移（秒），需与location同时设置（如'32400'） | 否 |
--sendgrid.accumulated-metrics | 是否按月累积指标以计算月度邮件限额，默认：False | 否 |
--log.level | 日志级别，可选值：debug、info、warn、error，默认：info | 否 |
--log.format | 日志输出格式，可选值：logfmt、json，默认：logfmt | 否 |
--version | 显示应用版本 | 否 |
端点说明
| 名称 | 描述 |
|---|---|
/metrics | 获取Prometheus格式的指标数据 |
/-/healthy | 健康检查端点 |
指标说明
| 指标名称 | 描述 |
|---|---|
| blocks | 被ISP拒绝传递的邮件数量 |
| bounce_drops | 因退信而被丢弃的邮件数量 |
| bounces | 退信的邮件数量 |
| deferred | 暂时无法传递的邮件数量 |
| delivered | SendGrid确认成功送达的邮件数量 |
| invalid_emails | 无效***地址的数量（格式错误或邮件提供商报告无效） |
| processed | SendGrid处理的邮件请求数量（通过SMTP Relay或API） |
| requests | 请求发送的邮件数量 |
| spam_report_drops | 因收件人之前将邮件标记为垃圾邮件而被丢弃的邮件数量 |
| spam_reports | 将邮件标记为垃圾邮件的收件人数量 |
| unique_clicks | 点击邮件中链接的唯一收件人数量 |
| unique_opens | 打开邮件的唯一收件人数量 |
| unsubscribe_drops | 因收件人取消订阅而被丢弃的邮件数量 |
| unsubscribes | 取消订阅的收件人数量 |
Docker部署示例
直接运行Docker容器
bashdocker run -d -p 9154:9154 \ -e SENDGRID_API_KEY='your_sendgrid_api_key' \ chatwork/sendgrid-stats-exporter
使用docker-compose部署
- 复制环境变量示例文件
bashcp .env.example .env
-
编辑.env文件，设置必要参数（如SENDGRID_API_KEY）
-
启动服务
bashdocker-compose up -d
服务启动后，可通过访问Prometheus（默认地址：[***]
使用Helm部署
Helm chart可参考：https://github.com/chatwork/sendgrid-stats-exporter/tree/main/charts
Grafana仪表板
基于这些指标的示例仪表板已发布：[***]
构建方法
本地构建
bashmake
使用Docker构建
bashdocker build -t sendgrid-stats-exporter .
镜像拉取方式
您可以使用以下命令拉取该镜像。请将 <标签> 替换为具体的标签版本。如需查看所有可用标签版本，请访问 标签列表页面。
轩辕镜像加速拉取命令点我查看更多 sendgrid-stats-exporter 镜像标签
docker pull docker.xuanyuan.run/chatwork/sendgrid-stats-exporter:<标签>
DockerHub 原生拉取命令
docker pull chatwork/sendgrid-stats-exporter:<标签>
镜像拉取常见问题
功能
错误码
用户好评
来自真实用户的反馈，见证轩辕镜像的优质服务
oldzhang
运维工程师
Linux服务器
5
"Docker访问体验非常流畅，大镜像也能快速完成下载。"