cloudflare-exporter

cloudflare-exporter

A Prometheus exporter for Cloudflare /cdn-cgi/trace endpoint and Load Balancers

Requirements

• Go
• Cloudflare Load Balancing subscription

API Access

For Cloudflare API, it is strongly recommended to create a dedicated Account API token or User API token. Ensure the following permission is granted to the token:

• Account - Load Balancing: Monitors And Pools (Read)

Installation

Linux

$ docker buildx build .

# Port number (required)
export PORT=8080

# TLS certificate and private key (optional; if not specified, exporter is served over HTTP)
export TLS_CERT=/path/to/tls/cert
export TLS_KEY=/path/to/tls/key

# Cloudflare API Token (recommended, optional; either CF_API_TOKEN, or the combination of CF_API_KEY and CF_API_EMAIL is required)
export CF_API_TOKEN=

# Cloudflare API Key and API email (optional; either CF_API_TOKEN, or the combination of CF_API_KEY and CF_API_EMAIL is required)
export CF_API_KEY=
export CF_API_EMAIL=

# Cloudflare Account ID (optional)
export CF_ACCOUNT_ID=

Windows

> docker build --file=Dockerfile.windows .

# Port number (required)
$Env:PORT = 8080

# TLS certificate and private key (optional; if not specified, exporter is served over HTTP)
$Env:TLS_CERT = "\path\to\tls\cert"
$Env:TLS_KEY = "\path\to\tls\key"

# Cloudflare API Token (recommended, optional; either CF_API_TOKEN, or the combination of CF_API_KEY and CF_API_EMAIL is required)
$Env:CF_API_TOKEN = ""

# Cloudflare API Key and API email (optional; either CF_API_TOKEN, or the combination of CF_API_KEY and CF_API_EMAIL is required)
$Env:CF_API_KEY = ""
$Env:CF_API_EMAIL = ""

# Cloudflare Account ID (optional)
$Env:CF_ACCOUNT_ID = ""

Usage

Linux

$ ./cloudflare-exporter

Windows

> .\cloudflare-exporter.exe

Prometheus Configuration

/cdn-cgi/ endpoint

The cloudflare exporter needs the URL of /cdn-cgi/ endpoint to be passed which can be configured by relabelling in a similar way to the blackbox exporter.

Example config:

scrape_configs:
  - job_name: cloudflare-cdn-cgi
    metrics_path: /probe
    static_configs:
      - targets:
        - https://one.one.one.one # The base URL of the /cdn-cgi/ endpoint to check for.
    relabel_configs:
      - source_labels: [__address__]
        target_label: __param_target
      - source_labels: [__param_target]
        target_label: instance
      - target_label: __address__
        replacement: 127.0.0.1:8080 # The cloudflare exporter's real hostname:port.

Example result:

# HELP cloudflare_trace_info Result of /cdn-cgi/trace endpoint
# TYPE cloudflare_trace_info gauge
cloudflare_trace_info{colo="NRT",h="one.one.one.one"} 1
# HELP cloudflare_trace_timestamp Timestamp of /cdn-cgi/trace endpoint
# TYPE cloudflare_trace_timestamp gauge
cloudflare_trace_timestamp{colo="NRT",h="one.one.one.one"} 1.756297842e+09

Load Balancers

The Cloudflare exporter needs the name of pools to be passed which can be configured by relabelling in a similar way to the blackbox exporter.

Example config:

scrape_configs:
  - job_name: cloudflare-loadbalancers
    static_configs:
      - targets:
        - pool01 # Name of Cloudflare pool to check for.
    relabel_configs:
      - source_labels: [__address__]
        target_label: __param_target
      - source_labels: [__param_target]
        target_label: instance
      - target_label: __address__
        replacement: 127.0.0.1:8080 # The cloudflare exporter's real hostname:port.

Example result:

# HELP cloudflare_origin_health Result of health check
# TYPE cloudflare_origin_health gauge
cloudflare_origin_health{code="200",health_region="NEAS",origin_address="www01.example.com",pool_name="pool01"} 1
cloudflare_origin_health{code="503",health_region="NEAS",origin_address="www02.example.com",pool_name="pool01"} 0
# HELP cloudflare_origin_rtt_seconds RTT to the pool origin
# TYPE cloudflare_origin_rtt_seconds gauge
cloudflare_origin_rtt_seconds{code="200",health_region="NEAS",origin_address="www01.example.com",pool_name="pool01"} 0.0653
cloudflare_origin_rtt_seconds{code="503",health_region="NEAS",origin_address="www02.example.com",pool_name="pool01"} 0

Spec