lablabs/cloudflare_exporter

Cloudflare Prometheus导出器

概述

Prometheus导出器，用于暴露Cloudflare分析仪表板数据（按区域划分），还能够按数据中心位置（https://www.cloudflare.com/network/%EF%BC%89%E6%94%B6%E9%9B%86%E5%8C%BA%E5%9F%9F%E6%8C%87%E6%A0%87%E3%80%82

Grafana仪表板

!仪表板

公共仪表板可在 https://grafana.com/grafana/dashboards/*** 获取。

Helm图表仓库

如需将导出器部署到Kubernetes，建议使用我们的Helm仓库：

bash
helm repo add cloudflare-exporter https://lablabs.github.io/cloudflare-exporter/
helm install cloudflare-exporter/cloudflare-exporter

配置

导出器可通过环境变量进行配置

其他配置选项为命令行参数，与环境变量名称相同但为小写，不支持通过参数设置区域，查看帮助：./cloudflare_exporter --help

bash
  -cf_api_email="": Cloudflare API邮箱，需与api_key参数一起使用
  -cf_api_key="": Cloudflare API密钥，需与api_email参数一起使用
  -cf_api_token="": Cloudflare API认证令牌（推荐）
  -cf_zones="": 要导出的Cloudflare区域，逗号分隔的列表
  -listen=":8080": 监听地址:端口（默认:8080），省略地址则监听所有接口
  -metrics_path="/metrics": 指标路径，默认/metrics
  -scrape_delay=300: 收集延迟（秒），默认300

0.0.5+版本变更

认证

从0.0.5版本开始，支持使用Bearer令牌进行认证。使用API密钥和***的认证方式在后续版本中仍可使用。推荐使用令牌认证方式。

区域过滤

原通过环境变量ZONE_<name>设置区域过滤的方法已弃用。现在可通过CF_ZONES环境变量设置，值为逗号分隔的区域列表（如CF_ZONES=zone1,zone2,zone3）。

可用指标列表

# HELP cloudflare_zone_bandwidth_cached 每个区域的缓存带宽，单位字节
# HELP cloudflare_zone_bandwidth_content_type 每个区域按内容类型的带宽
# HELP cloudflare_zone_bandwidth_country 每个区域按国家/地区的带宽
# HELP cloudflare_zone_bandwidth_ssl_encrypted 每个区域的加密带宽，单位字节
# HELP cloudflare_zone_bandwidth_total 每个区域的总带宽，单位字节
# HELP cloudflare_zone_colocation_edge_response_bytes 每个数据中心位置的边缘响应字节数
# HELP cloudflare_zone_colocation_visits 每个数据中心位置的总访问量
# HELP cloudflare_zone_pageviews_total 每个区域的页面浏览量
# HELP cloudflare_zone_requests_cached 区域的缓存请求数
# HELP cloudflare_zone_requests_content_type 区域按内容类型的请求数
# HELP cloudflare_zone_requests_country 区域按国家/地区的请求数
# HELP cloudflare_zone_requests_origin_status_country_host 区域按源站HTTP状态、国家/地区和主机的非缓存请求数
# HELP cloudflare_zone_requests_ssl_encrypted 区域的加密请求数
# HELP cloudflare_zone_requests_status 区域按HTTP状态的请求数
# HELP cloudflare_zone_requests_status_country_host 区域按边缘HTTP状态、国家/地区和主机的请求数
# HELP cloudflare_zone_requests_total 区域的总请求数
# HELP cloudflare_zone_threats_country 每个区域按国家/地区的威胁数
# HELP cloudflare_zone_threats_total 每个区域的威胁总数
# HELP cloudflare_zone_uniques_total 每个区域的独立访客数

Docker

构建

镜像可在https://hub.docker.com/r/lablabs/cloudflare_exporter%E8%8E%B7%E5%8F%96

bash
docker build -t lablabs/cloudflare_exporter .

运行

bash
# 使用API密钥和邮箱
docker run --rm -p 8080:8080 -e CF_API_KEY=${CF_API_KEY} -e CF_API_EMAIL=${CF_API_EMAIL} docker.xuanyuan.run/lablabs/cloudflare_exporter

# 使用API令牌（推荐）
docker run --rm -p 8080:8080 -e CF_API_TOKEN=${CF_API_TOKEN} docker.xuanyuan.run/lablabs/cloudflare_exporter

# 指定区域和监听端口
docker run --rm -p 8080:8081 -e CF_API_TOKEN=${CF_API_TOKEN} -e CF_ZONES=zoneid1,zoneid2,zoneid3 -e LISTEN=:8081 docker.xuanyuan.run/lablabs/cloudflare_exporter

# 查看帮助
docker run --rm -p 8080:8080 -i docker.xuanyuan.run/lablabs/cloudflare_exporter --help

贡献和问题反馈

如有问题、建议或功能需求，欢迎在本仓库创建issue。

许可

https://img.shields.io/badge/License-Apache%202.0-blue.svg](https://opensource.org/licenses/Apache-2.0)

详见LICENSE文件。

版权所有（c）Apache软件基金会（ASF）及其他贡献者。
根据Apache许可证2.0版（"许可证"）授权；
除非遵守许可证，否则您不得使用此文件。
您可以在以下地址获取许可证副本：

  https://www.apache.org/licenses/LICENSE-2.0

除非适用***要求或书面同意，软件
根据许可证分发的软件按"原样"分发，
不附带任何明示或暗示的担保或条件。
有关许可证下权利和限制的具体语言，请参阅许可证。