services.example.toml

# uptime-bench services configuration
# Copy to services.toml and fill in your credentials. Never commit services.toml.
#
# Each [[services]] block declares one monitoring service instance to evaluate.
#
#   id           — unique identifier; must match what scenario TOML files list under monitors
#   type         — adapter type (see supported types below)
#   url          — API root URL; omit to use the service's default public endpoint
#   auth         — credential key=value pairs; required keys vary by type (see below)
#   enabled      — set false to skip this service without removing its config
#   capacity     — optional account/service caps used when planning parallel runs
#   probe_ranges — maps region name → list of CIDR blocks used by this service's probes
#                  in that region. Used to expand `regions` in scenario failure blocks
#                  into source IP ranges for geographic failure injection.
#
# The id is arbitrary. If you run multiple accounts of the same service, give
# each a distinct id (e.g. "pingdom-prod", "pingdom-staging") and reference
# those ids in your scenario monitor lists.
#
# Geographic failure injection:
#   When a [[failures]] block in a scenario specifies `regions = ["us-east"]`,
#   the runner aggregates probe_ranges.us-east CIDRs across all enabled services
#   and injects the failure only for connections from those source IPs. Probes
#   from other regions see a healthy response.
#
#   Use any region name you like — they are matched by string equality against
#   the `regions` field in scenario files. Publish the names you use in a comment
#   so scenario authors know what to write.

# -----------------------------------------------------------------------------
# Jetmon 1
# Required: url (no public API; point at your jetmon-bridge endpoint)
# Auth keys:
#   token      — bearer token configured in jetmon-bridge (-token flag)
#   write_mode — "true" to enable automatic monitor create/delete;
#                "false" (default) requires monitors to be pre-seeded
# Note: Jetmon is agent-based and does not have fixed probe IP ranges.
# -----------------------------------------------------------------------------
[[services]]
id      = "jetmon-v1"
type    = "jetmon-v1"
url     = "http://localhost:7400"
enabled = false
auth    = { token = "replace-with-your-token", write_mode = "false" }

[services.capacity]
unlimited                 = true
max_active_monitors       = 0
reserved_monitors         = 0
max_parallel_runs         = 0
api_rate_limit_per_minute = 0
billing_model             = "self_hosted"
source                    = "Self-hosted Jetmon v1 instance"
notes                     = "Use pre-seeded benchmark URLs or enable write_mode before large runs."

# -----------------------------------------------------------------------------
# Jetmon 2
# Required: url (Jetmon 2 internal REST API root; either server root or /api/v1)
# Auth keys:
#   token     — Jetmon API bearer token with write scope
#   bucket_no — optional bucket assigned to synthetic benchmark sites (default 0);
#               choose a bucket owned by the Jetmon v2 host under test
# Note: Jetmon is agent-based and does not have fixed probe IP ranges.
# -----------------------------------------------------------------------------
[[services]]
id      = "jetmon-v2"
type    = "jetmon-v2"
url     = "http://localhost:8081/api/v1"
enabled = false
auth    = { token = "replace-with-your-token", bucket_no = "0" }

[services.capacity]
unlimited                 = true
max_active_monitors       = 0
reserved_monitors         = 0
max_parallel_runs         = 0
api_rate_limit_per_minute = 0
billing_model             = "self_hosted"
source                    = "Self-hosted Jetmon v2 instance"
notes                     = "Practical cap is the host/operator policy rather than a SaaS monitor quota."

# -----------------------------------------------------------------------------
# Pingdom
# Default URL: https://api.pingdom.com/api/3.1
# Auth keys: token
# Probe IP list: https://my.pingdom.com/probes/ipv4 (plain text)
# -----------------------------------------------------------------------------
[[services]]
id      = "pingdom"
type    = "pingdom"
enabled = false
auth    = { token = "replace-with-your-token" }

[services.capacity]
max_active_monitors       = 10
reserved_monitors         = 0
max_parallel_runs         = 10
api_rate_limit_per_minute = 0
billing_model             = "monitor"
source                    = "Live /credits API or account plan"
notes                     = "Set to the default check limit reported by your account."

[services.probe_ranges]
# Replace these example CIDRs with current values from Pingdom's published probe list.
us-east  = ["212.84.74.0/24", "46.246.93.0/24"]
us-west  = ["69.58.176.0/24"]
eu-west  = ["94.75.228.0/24", "94.75.229.0/24"]
eu-north = ["82.196.6.0/24"]
ap-sea   = ["43.251.28.0/24"]

# -----------------------------------------------------------------------------
# UptimeRobot
# Default URL: https://api.uptimerobot.com/v2
# Auth keys:
#   api_key             — account API key
#   http_method         — "GET" for the primary website-availability lane, or
#                         "HEAD" for a HEAD-specific capability lane
#   min_check_frequency — account-plan minimum, e.g. "60s" for Solo/paid or "5m" for free
# Probe IP list: https://uptimerobot.com/inc/files/ips/IPv4andIPv6.txt
# -----------------------------------------------------------------------------
[[services]]
id      = "uptimerobot"
type    = "uptimerobot"
enabled = false
auth    = { api_key = "replace-with-your-key", http_method = "GET", min_check_frequency = "60s" }

[services.capacity]
max_active_monitors       = 50
reserved_monitors         = 1
max_parallel_runs         = 49
api_rate_limit_per_minute = 100
billing_model             = "monitor"
source                    = "Solo 50 plan: monitor cap 50; paid API rate limit is monitor limit * 2/min"
notes                     = "Canonical GET lane. If enabling the HEAD lane at the same time, keep combined UptimeRobot active monitors within the shared account cap."

[services.probe_ranges]
# Replace these example CIDRs with current values from UptimeRobot's published IP list.
us-east  = ["216.144.248.0/24"]
us-west  = ["208.115.199.0/24"]
eu-west  = ["178.63.112.0/24"]
ap-sea   = ["103.253.145.0/24"]

[[services]]
id      = "uptimerobot-head"
type    = "uptimerobot"
enabled = false
auth    = { api_key = "replace-with-your-key", http_method = "HEAD", min_check_frequency = "60s" }

[services.capacity]
max_active_monitors       = 50
reserved_monitors         = 1
max_parallel_runs         = 24
api_rate_limit_per_minute = 100
billing_model             = "monitor"
source                    = "Solo 50 plan: monitor cap 50; paid API rate limit is monitor limit * 2/min"
notes                     = "Secondary HEAD capability lane. Keep disabled for primary GET-scored comparisons unless explicitly testing HEAD behavior."

[services.probe_ranges]
# Same UptimeRobot probe pool as the GET lane.
us-east  = ["216.144.248.0/24"]
us-west  = ["208.115.199.0/24"]
eu-west  = ["178.63.112.0/24"]
ap-sea   = ["103.253.145.0/24"]

# -----------------------------------------------------------------------------
# Datadog Synthetics
# Default URL: https://api.datadoghq.com
# Auth keys:
#   api_key, app_key
#   http_method — optional, "GET" or "HEAD" for HTTP API tests; keyword
#                 assertions require GET because HEAD has no response body
# Probe IP list: https://ip-ranges.datadoghq.com/ (JSON, "synthetics" key)
# -----------------------------------------------------------------------------
[[services]]
id      = "datadog-synthetics"
type    = "datadog-synthetics"
enabled = false
auth    = { api_key = "replace-with-your-key", app_key = "replace-with-your-key", http_method = "GET" }

[services.capacity]
max_active_monitors       = 0
reserved_monitors         = 0
max_parallel_runs         = 50
api_rate_limit_per_minute = 0
billing_model             = "test_run"
source                    = "Account policy and live API rate-limit headers"
notes                     = "No fixed monitor cap may be exposed; choose a parallel limit from budget."

[services.probe_ranges]
# Replace these example CIDRs with current values from Datadog's ip-ranges endpoint.
us-east  = ["3.87.113.0/24", "34.206.179.0/24"]
us-west  = ["52.52.131.0/24"]
eu-west  = ["176.34.247.0/24"]
eu-central = ["52.29.178.0/24"]
ap-sea   = ["13.228.142.0/24"]

# -----------------------------------------------------------------------------
# Better Uptime
# Default URL: https://uptime.betterstack.com/api/v2
# Auth keys:
#   token
#   http_method — optional, "GET" or "HEAD" for status monitors; keyword
#                 and keyword_absence monitors require GET because HEAD has no response body
# Probe IP list: https://betterstack.com/docs/uptime/frequently-asked-questions/
# -----------------------------------------------------------------------------
[[services]]
id      = "better-uptime"
type    = "better-uptime"
enabled = false
auth    = { token = "replace-with-your-token", http_method = "GET" }

[services.capacity]
max_active_monitors       = 10
reserved_monitors         = 0
max_parallel_runs         = 10
api_rate_limit_per_minute = 60
billing_model             = "monitor"
source                    = "Account plan or operator policy"
notes                     = "Provider API may not expose quota; set this from the account UI."

[services.probe_ranges]
# Replace these example CIDRs with current values from Better Stack's documentation.
us-east  = ["23.88.96.0/24"]
eu-west  = ["65.108.79.0/24"]
ap-sea   = ["43.134.8.0/24"]

# -----------------------------------------------------------------------------
# Gatus
# Required: url (uptime-bench Gatus bridge endpoint, not the Gatus UI/API port)
# Auth keys:
#   token       — bearer token configured in the bridge BRIDGE_TOKEN
#   http_method — optional, "GET" or "HEAD"; keyword checks require GET
# Note: Self-hosted single-origin monitor. No fixed probe IP ranges.
# -----------------------------------------------------------------------------
[[services]]
id      = "gatus"
type    = "gatus"
url     = "http://localhost:8081"
enabled = false
auth    = { token = "replace-with-your-token", http_method = "GET" }

[services.capacity]
unlimited                 = true
max_active_monitors       = 0
reserved_monitors         = 0
max_parallel_runs         = 0
api_rate_limit_per_minute = 0
billing_model             = "self_hosted"
source                    = "Self-hosted Gatus instance via uptime-bench bridge"
notes                     = "Single-origin checks. Practical cap is host/operator policy rather than a SaaS monitor quota."

# -----------------------------------------------------------------------------
# Uptime Kuma
# Required: url (uptime-bench Uptime Kuma bridge endpoint, not the Uptime Kuma UI port)
# Auth keys:
#   token       — bearer token configured in the bridge BRIDGE_TOKEN
#   http_method — optional, "GET" or "HEAD"; keyword checks require GET
# Note: Self-hosted single-origin monitor. No fixed probe IP ranges.
# -----------------------------------------------------------------------------
[[services]]
id      = "uptime-kuma"
type    = "uptime-kuma"
url     = "http://localhost:3002"
enabled = false
auth    = { token = "replace-with-your-token", http_method = "GET" }

[services.capacity]
unlimited                 = true
max_active_monitors       = 0
reserved_monitors         = 0
max_parallel_runs         = 0
api_rate_limit_per_minute = 0
billing_model             = "self_hosted"
source                    = "Self-hosted Uptime Kuma instance via uptime-bench bridge"
notes                     = "Single-origin checks. Uptime Kuma bridge pins the upstream version because direct automation uses an internal Socket.IO surface."