Configuring Metrics

Configuration Page

Navigate to Metrics > Config to manage your monitoring setup. The config page has two editing modes:

  • Form view – Visual editor with protocol sections and input fields
  • YAML view – Edit the raw configuration directly with real-time validation

Both modes edit the same underlying configuration. Switch freely between them using the toggle button.

Adding an Endpoint

Each endpoint you add becomes a metric – a check that runs at a set interval from distributed nodes.

Common Fields (All Protocols)

Field Description Example
Endpoint URL, hostname, or IP to monitor https://api.example.com
Frequency How often to run checks 30s, 1m, 5m, 15m
Name Optional label for display Production API
Prefix Optional Prometheus metric prefix prod_api

HTTP-Specific Fields

Field Description
Method GET, POST, PUT, PATCH, DELETE, HEAD, OPTIONS
Headers Custom request headers (key-value pairs)
Body Request body for POST/PUT/PATCH
Regex Pattern to validate in the response

DNS-Specific Fields

Field Description
Lookup Type IP, MX, SOA, NS, TXT, SRV, or TLSA

HLS-Specific Fields

Field Description
Headers Custom headers (e.g., auth tokens for protected streams)

ICMP

No additional fields beyond the common configuration.

Network Criteria

Optionally restrict where checks run from to match your user demographics:

Filter Description Example
Continent AF, AN, AS, EU, NA, OC, SA EU
Country ISO 3166-1 alpha-3 code USA, GBR, DEU
ISP Regex Pattern match on ISP name Comcast|Verizon
Node ID Pin to a specific node UUID
Mobile Mobile node policy allowed, denied, required
Proxy Proxy node policy allowed, denied, required
Residential Residential node policy allowed, denied, required

YAML Configuration Example

metrics:
  - type: http
    endpoint: https://api.example.com/health
    frequency: 1m
    name: API Health
    http:
      method: GET
      headers:
        Authorization: Bearer token123
  - type: dns
    endpoint: example.com
    frequency: 5m
    name: DNS Resolution
    dns:
      lookup_type: IP
    network_criteria:
      continent_code: EU
      residential: required
  - type: icmp
    endpoint: 8.8.8.8
    frequency: 1m
    name: Google DNS Ping
  - type: hls
    endpoint: https://stream.example.com/live/master.m3u8
    frequency: 5m
    name: Live Stream
    hls:
      headers:
        Authorization: Bearer stream-token

Saving Configuration

Click Save to apply your changes. The instance will update without downtime – existing metrics continue collecting while new endpoints are added.