docs
cairnobs.org Demo Source
Esc

What it watches · 2 of 14

Checks

Websites, ports, DNS records, ping and mail block lists, tested from your own hosts. A check is down only when two hosts agree.

2 min read

A check is a test your agents run on a timer and send with their reports: from inside your network, from several places, so one host's bad link doesn't page anyone.

Add them under Configure › Checks, or keep them in a file (checks.yaml, below).

Kinds

Kind Tests Options
http A URL status (default 200), contains (text the page must have). Redirects are not followed
tcp host:port tls (TLS from the first byte, as on 465 or 993), contains (the greeting's first line)
dns A name type (A, AAAA, MX, TXT, CNAME or NS; default A), server (ip:port; default the host's resolver), contains
ping A host or address Three echoes. Passes on one reply, and reports loss and the average round trip
rbl An IPv4 address Is it on a mail block list? lists (DNS zones; default SpamCop, Barracuda, UCEPROTECT 1, PSBL, Mailspike), optional server. Every 30 minutes by default

Every check also takes:

Option Default
every 60s How often; at least 30s
timeout 10s
from every server The hosts that run it. Workstations run only the checks that name them
severity critical How bad it is when down: critical or warning
tls_warn_days, tls_critical_days 21, 7 For any certificate the check sees

When a check is down

A check is down only when two hosts agree, or when the only host running it says so. One host failing alone shows on the Checks page as "failing from web2 only" and doesn't alert. Results from a host that has gone silent don't count.

Certificates a check sees warn and go critical by the soonest expiry any host saw. They also go into the certificate inventory (Certificates).

Block lists

A block list that answers 127.255.255.x is refusing your resolver, not listing you. Spamhaus does this for public and hosting resolvers, and needs its own resolver or a Spamhaus key. Such an answer is noted, not counted. The check fails only when the address is listed somewhere, or when no list could be asked at all.

In a file

Set checks: /etc/obs-beacon/checks.yaml in obs-beacond.yaml and the checks live there instead; the web interface then shows them read-only. obs-beacond reads the file again when it changes. One that doesn't parse is logged, and the last good list stays.

checks:
  - id: site
    name: example.org
    http: https://example.org/
    contains: Example

  - id: imaps
    name: mail.example.org IMAP
    tcp: mail.example.org:993
    tls: true
    contains: "* OK"

  - id: mx
    name: example.org MX
    dns: example.org
    type: MX
    contains: mail.example.org
    server: "1.1.1.1:53"
    every: 5m
    severity: warning

  - id: ping-db1
    name: db1 over the private network
    ping: 10.0.0.21
    from: [web1, web2]

Export YAML under Configure › Checks writes this same file from what's in the web interface (Settings in files or in the UI).