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)

FieldDescriptionExample
EndpointURL, hostname, or IP to monitorhttps://api.example.com
FrequencyHow often to run checks30s, 1m, 5m, 15m
NameOptional label for displayProduction API
PrefixOptional Prometheus metric prefixprod_api

HTTP-Specific Fields

FieldDescription
MethodGET, POST, PUT, PATCH, DELETE, HEAD, OPTIONS
HeadersCustom request headers (key-value pairs)
BodyRequest body for POST/PUT/PATCH
RegexPattern to validate in the response

DNS-Specific Fields

FieldDescription
Lookup TypeIP, MX, SOA, NS, TXT, SRV, or TLSA

HLS-Specific Fields

FieldDescription
HeadersCustom 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:

FilterDescriptionExample
ContinentAF, AN, AS, EU, NA, OC, SAEU
CountryISO 3166-1 alpha-3 codeUSA, GBR, DEU
ISP RegexPattern match on ISP nameComcast|Verizon
Node IDPin to a specific nodeUUID
MobileMobile node policyallowed, denied, required
ProxyProxy node policyallowed, denied, required
ResidentialResidential node policyallowed, 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.

© 2026 Bitping Pty. Ltd.