Document the Technitium DNS integration
README and INTEGRATIONS: what it reads, the config and token (15.0 or later), the DNS test, the alerts and metrics, that its API has no CPU, memory or disk figures, and how it differs from the Technitium DNS provider. ROLES: the page. DATABASE: technitium_state, migrations to 0081, 91 tables. MONITORING: the five alerts. PROMETHEUS-GRAFANA: the homelab_technitium_* metrics. Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
This commit is contained in:
1 parent
312093d3f7
commit
a2ff0f7daa
6 files changed
+64
-4
No files matched your search
+23
-2
@@ -23,8 +23,8 @@ what the app actually creates.
|
|||||||
|---|---|
|
|---|---|
|
||||||
| **File** | `DATABASE_PATH`, default `../data/homelab-manager.sqlite` (relative to `server/`; `/app/data/...` in Docker). The folder is created if missing. |
|
| **File** | `DATABASE_PATH`, default `../data/homelab-manager.sqlite` (relative to `server/`; `/app/data/...` in Docker). The folder is created if missing. |
|
||||||
| **Foreign keys** | Switched on for every connection (`PRAGMA foreign_keys = ON`), so the `ON DELETE` rules below are enforced. |
|
| **Foreign keys** | Switched on for every connection (`PRAGMA foreign_keys = ON`), so the `ON DELETE` rules below are enforced. |
|
||||||
| **Migrations** | SQL files in [`server/drizzle/`](server/drizzle) (`0000` … `0080`), applied automatically when the server starts. Which ones have run is recorded in the table `__drizzle_migrations`. |
|
| **Migrations** | SQL files in [`server/drizzle/`](server/drizzle) (`0000` … `0081`), applied automatically when the server starts. Which ones have run is recorded in the table `__drizzle_migrations`. |
|
||||||
| **Tables** | 90 application tables, plus drizzle's own `__drizzle_migrations`. |
|
| **Tables** | 91 application tables, plus drizzle's own `__drizzle_migrations`. |
|
||||||
|
|
||||||
**Not in the database, but beside it in the data folder:** the backups of the database itself (`backups/homelab-manager-….sqlite`, taken daily and on request; see [BACKUP.md](BACKUP.md)), and, only while a restore is waiting or has just happened, `restore-pending.sqlite` / `restore-pending.json` and `restore-result.json`.
|
**Not in the database, but beside it in the data folder:** the backups of the database itself (`backups/homelab-manager-….sqlite`, taken daily and on request; see [BACKUP.md](BACKUP.md)), and, only while a restore is waiting or has just happened, `restore-pending.sqlite` / `restore-pending.json` and `restore-result.json`.
|
||||||
|
|
||||||
@@ -78,6 +78,7 @@ erDiagram
|
|||||||
integrations ||--o| fragnet_state : "cascade"
|
integrations ||--o| fragnet_state : "cascade"
|
||||||
integrations ||--o| arr_state : "cascade"
|
integrations ||--o| arr_state : "cascade"
|
||||||
integrations ||--o| adguard_state : "cascade"
|
integrations ||--o| adguard_state : "cascade"
|
||||||
|
integrations ||--o| technitium_state : "cascade"
|
||||||
integrations ||--o| grafana_state : "cascade"
|
integrations ||--o| grafana_state : "cascade"
|
||||||
integrations ||--o{ speedtest_results : "cascade"
|
integrations ||--o{ speedtest_results : "cascade"
|
||||||
integrations ||--o| netbox_state : "cascade"
|
integrations ||--o| netbox_state : "cascade"
|
||||||
@@ -1059,6 +1060,26 @@ How an AdGuard Home (an integration of type `adguard`) is right now, one row eac
|
|||||||
|
|
||||||
How the last read went is kept in `settings`, key `_internal:adguardSync`.
|
How the last read went is kept in `settings`, key `_internal:adguardSync`.
|
||||||
|
|
||||||
|
#### `technitium_state`
|
||||||
|
|
||||||
|
How a Technitium DNS Server (an integration of type `technitium`) is right now, one row each, replaced at every read (every two minutes). `integration_id` is the primary key and a foreign key with **cascade**. No history: what is stored is the last good read, plus two clocks only this app can keep.
|
||||||
|
|
||||||
|
| Column | Type | Notes |
|
||||||
|
|---|---|---|
|
||||||
|
| `integration_id` | integer PK | |
|
||||||
|
| `version` | text | |
|
||||||
|
| `started_at` | text | ISO: when the DNS server last started (from its `uptimestamp`); null when it did not say. |
|
||||||
|
| `dns_port` | integer NOT NULL, default 53 | The port of its first listening endpoint. |
|
||||||
|
| `blocking_enabled` | integer NOT NULL, default 1 | Whether blocking is on. |
|
||||||
|
| `blocking_off_since` | text | ISO: the first read that showed blocking off; null while it is on. |
|
||||||
|
| `settings` | text NOT NULL | JSON: `{ blockLists: { count, intervalHours, nextUpdate }, cacheMaximumEntries, recursion, dnssecValidation }`. |
|
||||||
|
| `stats`, `zones`, `dhcp` | text | JSON: the last day's statistics (queries and how they ended, counts, the clients and names asked about most) · `{ total, disabled, issues: [{ name, problem }] }` · `{ scopes, enabledScopes, leases }`. **Null when they could not be read** (`dhcp` also when there is no DHCP server). |
|
||||||
|
| `probe` | text | JSON: the real DNS question — `{ ok, ms, error, name, host }`. |
|
||||||
|
| `probe_fail_since` | text | ISO: the first read in which the question went unanswered; null while it is answered. |
|
||||||
|
| `updated_at` | text NOT NULL | ISO. |
|
||||||
|
|
||||||
|
How the last read went is kept in `settings`, key `_internal:technitiumSync`.
|
||||||
|
|
||||||
#### `grafana_state`
|
#### `grafana_state`
|
||||||
|
|
||||||
How a Grafana (an integration of type `grafana`) is right now, one row each, replaced at every read (every five minutes). `integration_id` is the primary key and a foreign key with **cascade**. No history.
|
How a Grafana (an integration of type `grafana`) is right now, one row each, replaced at every read (every five minutes). `integration_id` is the primary key and a foreign key with **cascade**. No history.
|
||||||
|
|||||||
+13
-1
@@ -15,7 +15,7 @@ the dashboard views themselves load fine. (UniFi, Nginx Proxy Manager, Home Assi
|
|||||||
|
|
||||||
### Checking what an integration can read
|
### Checking what an integration can read
|
||||||
|
|
||||||
On the Integrations page an administrator has an **Inspect** button on each integration that reads through the shared HTTP helper (Authentik, Immich, Jellyfin, NetBox, Nextcloud, Paperless-ngx, Prometheus, Hetzner Cloud, Speedtest Tracker, Fragnet, Sonarr, Radarr, Prowlarr, Lidarr, Readarr, AdGuard Home and Grafana). It runs the integration's reader once and shows:
|
On the Integrations page an administrator has an **Inspect** button on each integration that reads through the shared HTTP helper (Authentik, Immich, Jellyfin, NetBox, Nextcloud, Paperless-ngx, Prometheus, Hetzner Cloud, Speedtest Tracker, Fragnet, Sonarr, Radarr, Prowlarr, Lidarr, Readarr, AdGuard Home, Technitium DNS and Grafana). It runs the integration's reader once and shows:
|
||||||
|
|
||||||
- **what was asked** — each request, its path (with the *names* of the query parameters, not their values), the status, how long it took and how many bytes;
|
- **what was asked** — each request, its path (with the *names* of the query parameters, not their values), the status, how long it took and how many bytes;
|
||||||
- **what came back** — the *shape* of each JSON answer to three levels: the names of the fields and the kind of each (`string`, `number`, `array(12) of { … }`), with a `?` on a field that only some items of a list have. Never a value, never a token, so the report can be copied into a message;
|
- **what came back** — the *shape* of each JSON answer to three levels: the names of the fields and the kind of each (`string`, `number`, `array(12) of { … }`), with a `?` on a field that only some items of a list have. Never a value, never a token, so the report can be copied into a message;
|
||||||
@@ -446,6 +446,17 @@ osTicket's API cannot close a ticket, so this is the one place in the app that *
|
|||||||
- `/metrics` has `homelab_adguard_running`, `homelab_adguard_protection_enabled`, `homelab_adguard_dns_up`, `homelab_adguard_dns_probe_seconds`, `homelab_adguard_queries`, `homelab_adguard_blocked` and `homelab_adguard_avg_processing_seconds`.
|
- `/metrics` has `homelab_adguard_running`, `homelab_adguard_protection_enabled`, `homelab_adguard_dns_up`, `homelab_adguard_dns_probe_seconds`, `homelab_adguard_queries`, `homelab_adguard_blocked` and `homelab_adguard_avg_processing_seconds`.
|
||||||
- **Not verified against a live install** — the endpoints and fields are as AdGuard Home's published OpenAPI file has them (`ServerStatus`, `Stats`, `FilterStatus`), and the reader (and the DNS question, against a pretend DNS server) is tried against pretend ones. The statistics are over AdGuard Home's own period (a day unless set otherwise). A DNS question is asked of the host in the URL: with a proxy in front, set *DNS server address*.
|
- **Not verified against a live install** — the endpoints and fields are as AdGuard Home's published OpenAPI file has them (`ServerStatus`, `Stats`, `FilterStatus`), and the reader (and the DNS question, against a pretend DNS server) is tried against pretend ones. The statistics are over AdGuard Home's own period (a day unless set otherwise). A DNS question is asked of the host in the URL: with a proxy in front, set *DNS server address*.
|
||||||
|
|
||||||
|
### Technitium DNS
|
||||||
|
|
||||||
|
- **Config fields:** the **URL** of its web console (`http://dns.example.lan:5380`) and an **API token** — a non-expiring one, made under Administration → Sessions → *Create Token*; stored encrypted — of a user who may **view** the dashboard, the settings and the zones (and the DHCP server, for the DHCP counts). Optional: the **DNS server address** (the host of the URL unless told — fill it in if a reverse proxy sits in front of the console), the **name to test DNS with** (`example.com`) and *Allow self-signed certificate*. Zones and records are connected separately, as a **DNS provider** on the DNS page, with a token of its own; this integration only says how the server is doing.
|
||||||
|
- **Required access:** the console reachable from the app over HTTP(S) and — for the DNS test — the DNS port (the first of the server's listening endpoints, usually 53) reachable from the app **over UDP**. The token goes in an `Authorization: Bearer` header, which Technitium **15.0 and later** require; an older server answers "token not accepted". If the app sits where UDP 53 to it is blocked, the test says so (no answer) and DNS is reported down; allow it or set the DNS server address to one the app can reach.
|
||||||
|
- **What it does:** every **two minutes** it reads `GET /api/settings/get` (version, when it started, whether blocking is on, the block lists and when they are next updated, the cache limit, recursion, DNSSEC, the DNS port), `GET /api/dashboard/stats/get?type=LastDay` (the last day's queries and how each ended, clients, cache entries, zone and list counts, the clients and names asked about and blocked most), `GET /api/zones/list` (which secondary zones have expired or cannot sync; the server's own internal zones and switched-off zones are not judged) and `GET /api/dhcp/scopes/list` and `…/leases/list` (scopes and lease counts) — and puts **one DNS question** to its DNS server, as for AdGuard Home. **Network → Technitium DNS** shows it all. Nothing is changed: blocking is never switched, no block list refreshed, no zone touched.
|
||||||
|
- **Alerts** (source *Technitium DNS*; held back by maintenance on the integration): the test question **unanswered in every read for ten minutes** (critical — one lost packet is not an outage); a **secondary zone that has expired** (critical — it no longer answers), or zones that **cannot sync** (warning), one alert for all the zones; **blocking switched off for an hour** while block lists are set up (warning — with none, off is how it is); **block lists whose update was due more than six hours ago** (warning). See [MONITORING.md](docs/MONITORING.md#technitium-dns).
|
||||||
|
- If it cannot be read for ten minutes its alerts are neither raised nor cleared, the Alerts page says it could not check, and the integration is raised as failing like any other. A part that could not be read (the statistics, the zones, DHCP) is shown as *could not be read*, never as none; the settings are the one part that must work, since they say it is there and the token is accepted.
|
||||||
|
- `/metrics` has `homelab_technitium_dns_up`, `homelab_technitium_dns_probe_seconds`, `homelab_technitium_blocking_enabled`, `homelab_technitium_uptime_seconds`, `homelab_technitium_block_lists_overdue`, `homelab_technitium_queries`, `homelab_technitium_blocked`, `homelab_technitium_cached`, `homelab_technitium_recursive`, `homelab_technitium_server_failures`, `homelab_technitium_clients`, `homelab_technitium_cache_entries`, `homelab_technitium_zones`, `homelab_technitium_zone_problems` and `homelab_technitium_dhcp_leases`.
|
||||||
|
- **No CPU, memory or disk.** Technitium's API has no figures for the machine it runs on (its "resource" numbers are the DNS server's own: queries, cache, zones). Put a **server agent** on that machine for those.
|
||||||
|
- **Not verified against a live install** — the endpoints and fields are as Technitium's own API documentation (`APIDOCS.md`) has them, and the reader (and the DNS question, against a pretend DNS server) is tried against pretend ones. The statistics are over the **last day**; the zones are read up to 1000 at a time; the page shows the share of failed queries in yellow from 20% (with at least 200 queries), which is not an alert. A DNS question is asked of the host in the URL: with a proxy in front, set *DNS server address*. Cluster state and the version-behind comparison of the Versions page are not read.
|
||||||
|
|
||||||
### Grafana
|
### Grafana
|
||||||
|
|
||||||
- **Config fields:** the **URL** and a **service account token** (Administration → Users and access → Service accounts → add a service account with the *Viewer* role → add a token; shown once; stored encrypted), and *Allow self-signed certificate*. To also test the data sources the service account needs permission to read and query them (the Viewer role usually has it); without it they are shown as *could not be listed* and the rules still work.
|
- **Config fields:** the **URL** and a **service account token** (Administration → Users and access → Service accounts → add a service account with the *Viewer* role → add a token; shown once; stored encrypted), and *Allow self-signed certificate*. To also test the data sources the service account needs permission to read and query them (the Viewer role usually has it); without it they are shown as *could not be listed* and the rules still work.
|
||||||
@@ -589,3 +600,4 @@ osTicket's API cannot close a ticket, so this is the one place in the app that *
|
|||||||
- **Auth:** Bearer token
|
- **Auth:** Bearer token
|
||||||
- **Actions used:** list zones, read zone records, add/delete records (an "update" is implemented as delete + add)
|
- **Actions used:** list zones, read zone records, add/delete records (an "update" is implemented as delete + add)
|
||||||
- **Required access:** A token tied to a Technitium user account with **Zones: View + Modify** permission — view-only will fail on record changes since updates are add/delete calls under the hood.
|
- **Required access:** A token tied to a Technitium user account with **Zones: View + Modify** permission — view-only will fail on record changes since updates are add/delete calls under the hood.
|
||||||
|
- **This is the DNS provider** (zones and records, on the DNS page). How the *server* is doing — queries, blocking, zone health, a real DNS test, alerts — is a separate integration with its own token: see [Technitium DNS](#technitium-dns) under the integrations above.
|
||||||
@@ -545,6 +545,8 @@ The page also shows the users, the files and the app updates waiting. Whether it
|
|||||||
|
|
||||||
**AdGuard Home** (Network → AdGuard Home). Add its address (and sign-in, if it has one) and the app reads it every two minutes — and each time asks its DNS server a real question over UDP, because the web interface can be up while DNS is not. It shows whether DNS answers (and how fast), whether protection is on, the queries and how many were blocked, the names blocked most and the clients asking most, and its filter lists with when each was updated. It raises **DNS that has stopped answering** (ten minutes of it, critical), **a DNS server that is not running** (critical), **protection left off for an hour** and **filter lists that have not updated for a week**. Nothing is changed. See INTEGRATIONS.md and docs/MONITORING.md.
|
**AdGuard Home** (Network → AdGuard Home). Add its address (and sign-in, if it has one) and the app reads it every two minutes — and each time asks its DNS server a real question over UDP, because the web interface can be up while DNS is not. It shows whether DNS answers (and how fast), whether protection is on, the queries and how many were blocked, the names blocked most and the clients asking most, and its filter lists with when each was updated. It raises **DNS that has stopped answering** (ten minutes of it, critical), **a DNS server that is not running** (critical), **protection left off for an hour** and **filter lists that have not updated for a week**. Nothing is changed. See INTEGRATIONS.md and docs/MONITORING.md.
|
||||||
|
|
||||||
|
**Technitium DNS** (Network → Technitium DNS). Add the address of its web console and an API token (a non-expiring one, made under Administration → Sessions) and the app reads it every two minutes — and, like AdGuard Home, asks its DNS server a real question over UDP each time, because the console can be up while DNS is not. It shows whether DNS answers (and how fast), whether blocking is on, how long the server has run, the last day's queries and how they ended (from the cache, resolved, from its own zones, blocked, dropped, failed), the clients and names asked about most and blocked most, the cache against its limit, its block lists and when they are next updated, how its zones are (an expired or unsynced secondary zone is named) and its DHCP leases. It raises **DNS that has stopped answering** (ten minutes of it, critical), **a secondary zone that has expired** (critical) or **cannot sync** (warning), **blocking left off for an hour** and **block lists that are overdue for an update**. Nothing is changed. Technitium's API has no figures for the machine's CPU, memory or disk — a server agent on that machine reports those. Zones and records are connected separately, as a DNS provider. See INTEGRATIONS.md and docs/MONITORING.md.
|
||||||
|
|
||||||
**Grafana** (Monitoring → Grafana). Add its address and a service account token (the Viewer role is enough) and the app shows which alert rules are firing or pending, which cannot be evaluated, and which data sources fail Grafana's own health check. It raises **a rule that is firing** (critical when it is labelled critical or page), **a rule that cannot be evaluated** and **a data source that fails its check**. Nothing is silenced or changed. See INTEGRATIONS.md and docs/MONITORING.md.
|
**Grafana** (Monitoring → Grafana). Add its address and a service account token (the Viewer role is enough) and the app shows which alert rules are firing or pending, which cannot be evaluated, and which data sources fail Grafana's own health check. It raises **a rule that is firing** (critical when it is labelled critical or page), **a rule that cannot be evaluated** and **a data source that fails its check**. Nothing is silenced or changed. See INTEGRATIONS.md and docs/MONITORING.md.
|
||||||
|
|
||||||
**App versions** (Operations → App versions). The version each connected application runs — as its integration last read it — against the newest release of it, with how far behind it is (a patch, a minor update, a major version) and how long the newer release has been out. It looks the newest releases up on GitHub once a day, and **that is the only thing this app asks of an address that is not yours, so it is switched off until an administrator switches it on**. A number of days (0 = never) makes a newer release that has been out that long a warning. Sonarr, Radarr, Prowlarr, Lidarr, Readarr, AdGuard Home, Grafana, Jellyfin, Immich, Paperless-ngx, Nextcloud, NetBox, Authentik and Prometheus are compared. See docs/MONITORING.md.
|
**App versions** (Operations → App versions). The version each connected application runs — as its integration last read it — against the newest release of it, with how far behind it is (a patch, a minor update, a major version) and how long the newer release has been out. It looks the newest releases up on GitHub once a day, and **that is the only thing this app asks of an address that is not yours, so it is switched off until an administrator switches it on**. A number of days (0 = never) makes a newer release that has been out that long a warning. Sonarr, Radarr, Prowlarr, Lidarr, Readarr, AdGuard Home, Grafana, Jellyfin, Immich, Paperless-ngx, Nextcloud, NetBox, Authentik and Prometheus are compared. See docs/MONITORING.md.
|
||||||
|
|||||||
@@ -34,6 +34,7 @@ page's own top-level link.
|
|||||||
| Jellyfin | `/jellyfin` | ✅ | ✅ | ✅ |
|
| Jellyfin | `/jellyfin` | ✅ | ✅ | ✅ |
|
||||||
| Media managers | `/media` | ✅ | ✅ | ✅ |
|
| Media managers | `/media` | ✅ | ✅ | ✅ |
|
||||||
| AdGuard Home | `/adguard` | ✅ | ✅ | ✅ |
|
| AdGuard Home | `/adguard` | ✅ | ✅ | ✅ |
|
||||||
|
| Technitium DNS | `/technitium` | ✅ | ✅ | ✅ |
|
||||||
| Grafana | `/grafana` | ✅ | ✅ | ✅ |
|
| Grafana | `/grafana` | ✅ | ✅ | ✅ |
|
||||||
| Immich | `/immich` | ✅ | ✅ | ✅ |
|
| Immich | `/immich` | ✅ | ✅ | ✅ |
|
||||||
| Paperless-ngx | `/paperless` | ✅ | ✅ | ✅ |
|
| Paperless-ngx | `/paperless` | ✅ | ✅ | ✅ |
|
||||||
@@ -170,7 +171,7 @@ even further, to admin only:
|
|||||||
- **App versions** (Operations → App versions): everyone signed in sees what each application runs against the newest release; switching the lookup of releases on and off, and the number of days after which a newer release is a warning, are an administrator's.
|
- **App versions** (Operations → App versions): everyone signed in sees what each application runs against the newest release; switching the lookup of releases on and off, and the number of days after which a newer release is a warning, are an administrator's.
|
||||||
- **Inspecting an integration** (Integrations → Inspect): administrators only — it makes the integration's requests, here and now (and says what came back, as shapes without values); each one is in the audit log.
|
- **Inspecting an integration** (Integrations → Inspect): administrators only — it makes the integration's requests, here and now (and says what came back, as shapes without values); each one is in the audit log.
|
||||||
- **Grouping the alerts** is each person's own view, remembered in their browser; it needs no role.
|
- **Grouping the alerts** is each person's own view, remembered in their browser; it needs no role.
|
||||||
- **AdGuard Home** (Network → AdGuard Home) and **Grafana** (Monitoring → Grafana): everyone signed in sees what each says is wrong, the statistics, lists, rules and data sources; adding one (its sign-in or token) is an administrator's job, like any integration. Nothing on the pages changes anything in them.
|
- **AdGuard Home** (Network → AdGuard Home), **Technitium DNS** (Network → Technitium DNS) and **Grafana** (Monitoring → Grafana): everyone signed in sees what each says is wrong, the statistics, lists, zones, rules and data sources; adding one (its sign-in or token) is an administrator's job, like any integration. Nothing on the pages changes anything in them.
|
||||||
- **Arranging a server's page**: folding the cards of a server's overview and putting them in order is each person's own (kept on their account, the same for every server) — it needs no role.
|
- **Arranging a server's page**: folding the cards of a server's overview and putting them in order is each person's own (kept on their account, the same for every server) — it needs no role.
|
||||||
- **Duplicati** (Backups → Duplicati): everyone signed in sees every backup and how it went; setting how often one is expected, muting it and forgetting it need operator; adding a machine (which makes an address that can write to this app) and removing one are administrators'. Reports arrive on a secret address with no sign-in: the token is the access.
|
- **Duplicati** (Backups → Duplicati): everyone signed in sees every backup and how it went; setting how often one is expected, muting it and forgetting it need operator; adding a machine (which makes an address that can write to this app) and removing one are administrators'. Reports arrive on a secret address with no sign-in: the token is the access.
|
||||||
- **Restore tests**: everyone sees them on the Backup coverage page; recording one needs operator; removing one is administrator-only.
|
- **Restore tests**: everyone sees them on the Backup coverage page; recording one needs operator; removing one is administrator-only.
|
||||||
|
|||||||
@@ -19,6 +19,7 @@ This page explains what Homelab Manager watches, how often, how a problem become
|
|||||||
- [Media managers](#media-managers-sonarr-radarr-prowlarr)
|
- [Media managers](#media-managers-sonarr-radarr-prowlarr)
|
||||||
- [App versions](#app-versions)
|
- [App versions](#app-versions)
|
||||||
- [AdGuard Home](#adguard-home)
|
- [AdGuard Home](#adguard-home)
|
||||||
|
- [Technitium DNS](#technitium-dns)
|
||||||
- [Grafana](#grafana)
|
- [Grafana](#grafana)
|
||||||
- [Speedtest](#speedtest)
|
- [Speedtest](#speedtest)
|
||||||
- [NetBox](#netbox)
|
- [NetBox](#netbox)
|
||||||
@@ -148,6 +149,7 @@ Every threshold here is a default; where it can be changed, the place is named.
|
|||||||
| **Hetzner server off / traffic / rescue / backup** | A Hetzner Cloud server that was running is off, is stuck migrating or rebuilding, has used 80% of its month's traffic (critical at 100%), has rescue mode left on, or has backups enabled but none recent | on, with the integration | Hetzner page; [below](#hetzner-cloud) |
|
| **Hetzner server off / traffic / rescue / backup** | A Hetzner Cloud server that was running is off, is stuck migrating or rebuilding, has used 80% of its month's traffic (critical at 100%), has rescue mode left on, or has backups enabled but none recent | on, with the integration | Hetzner page; [below](#hetzner-cloud) |
|
||||||
| **Sonarr / Radarr / Prowlarr** | An application reports a health warning or error, has downloads stuck for two hours, or a disk under 10% free | on, with the integration | Media managers page; [below](#media-managers-sonarr-radarr-prowlarr) |
|
| **Sonarr / Radarr / Prowlarr** | An application reports a health warning or error, has downloads stuck for two hours, or a disk under 10% free | on, with the integration | Media managers page; [below](#media-managers-sonarr-radarr-prowlarr) |
|
||||||
| **AdGuard Home** | DNS has not answered for ten minutes, or its DNS server is not running (critical); protection left off for an hour, or filter lists not updated for a week | on, with the integration | AdGuard Home page; [below](#adguard-home) |
|
| **AdGuard Home** | DNS has not answered for ten minutes, or its DNS server is not running (critical); protection left off for an hour, or filter lists not updated for a week | on, with the integration | AdGuard Home page; [below](#adguard-home) |
|
||||||
|
| **Technitium DNS** | DNS has not answered for ten minutes, or a secondary zone has expired (critical); a zone cannot sync, blocking left off for an hour, or block lists overdue for an update (warning) | on, with the integration | Technitium DNS page; [below](#technitium-dns) |
|
||||||
| **Grafana** | An alert rule is firing (critical when labelled critical or page), a rule cannot be evaluated, or a data source fails its health check | on, with the integration | Grafana page; [below](#grafana) |
|
| **Grafana** | An alert rule is firing (critical when labelled critical or page), a rule cannot be evaluated, or a data source fails its health check | on, with the integration | Grafana page; [below](#grafana) |
|
||||||
| **Game server backup / disk / memory** | A Fragnet game server's newest backup is older than the limit (7 days) or none, its disk is over 90% of the plan (critical from 98%), or its memory is over 90% while it runs | on, with the integration | Game servers page; [below](#game-servers-fragnet) |
|
| **Game server backup / disk / memory** | A Fragnet game server's newest backup is older than the limit (7 days) or none, its disk is over 90% of the plan (critical from 98%), or its memory is over 90% while it runs | on, with the integration | Game servers page; [below](#game-servers-fragnet) |
|
||||||
| **Internet slow / speed tests failing** | The middle of the last three speed tests is under the share you set of what the line is sold at (only with those numbers given), or the last three tests all failed | on, with the integration | Speedtest page; [below](#speedtest) |
|
| **Internet slow / speed tests failing** | The middle of the last three speed tests is under the share you set of what the line is sold at (only with those numbers given), or the last three tests all failed | on, with the integration | Speedtest page; [below](#speedtest) |
|
||||||
@@ -325,6 +327,20 @@ An integration of type *AdGuard Home* ([INTEGRATIONS.md](../INTEGRATIONS.md#adgu
|
|||||||
|
|
||||||
"Since when" is **when the app first saw it** in a read. Maintenance on the integration holds the alerts; a reading older than ten minutes is not believed (they are neither raised nor cleared, and the Alerts page says it could not check). `/metrics` has whether it runs, protects and answers, how long an answer took, and the queries and blocked counts.
|
"Since when" is **when the app first saw it** in a read. Maintenance on the integration holds the alerts; a reading older than ten minutes is not believed (they are neither raised nor cleared, and the Alerts page says it could not check). `/metrics` has whether it runs, protects and answers, how long an answer took, and the queries and blocked counts.
|
||||||
|
|
||||||
|
## Technitium DNS
|
||||||
|
|
||||||
|
An integration of type *Technitium DNS* ([INTEGRATIONS.md](../INTEGRATIONS.md#technitium-dns)) is read every two minutes, and **Network → Technitium DNS** shows whether DNS answers (a real question over UDP, with how long it took), whether blocking is on, how long the server has run, the last day's queries and how they ended, the clients and names asked about and blocked most, the cache against its limit, the block lists and when they are next updated, the zones that have a problem and the DHCP leases. Nothing is changed. It does not report the CPU, memory or disk of the machine it runs on — Technitium's API has none; a server agent does.
|
||||||
|
|
||||||
|
| Alert | When | Severity |
|
||||||
|
|---|---|---|
|
||||||
|
| **DNS not answering** | The test question has gone unanswered (or been answered with a server failure or a refusal) in every read for **ten minutes**. "No such name" counts as an answer | critical |
|
||||||
|
| **Zone expired** | A secondary zone has expired — it no longer answers. One alert for all the zones with a problem; it is critical if any of them has expired | critical |
|
||||||
|
| **Zone cannot sync** | Secondary zones that cannot sync with their primary and are going stale (none has expired yet) | warning |
|
||||||
|
| **Blocking off** | Blocking has been switched off for **an hour** while block lists are set up — someone paused it and forgot; nothing is being blocked. With no block lists, off is how it is and nothing is said | warning |
|
||||||
|
| **Block lists overdue** | The block lists' next update was due more than **six hours** ago and has not happened | warning |
|
||||||
|
|
||||||
|
The server's own internal zones and zones that are switched off are not judged. "Since when" is **when the app first saw it** in a read. Maintenance on the integration holds the alerts; a reading older than ten minutes is not believed (they are neither raised nor cleared, and the Alerts page says it could not check). `/metrics` has whether it answers and how long an answer took, whether blocking is on, how long it has run, the last day's counts, the cache, the zones with a problem and the DHCP leases.
|
||||||
|
|
||||||
## Grafana
|
## Grafana
|
||||||
|
|
||||||
An integration of type *Grafana* ([INTEGRATIONS.md](../INTEGRATIONS.md#grafana)) is read every five minutes, and **Monitoring → Grafana** shows which alert rules are firing, pending or cannot be evaluated, and how each data source tests. Nothing is silenced or changed.
|
An integration of type *Grafana* ([INTEGRATIONS.md](../INTEGRATIONS.md#grafana)) is read every five minutes, and **Monitoring → Grafana** shows which alert rules are firing, pending or cannot be evaluated, and how each data source tests. Nothing is silenced or changed.
|
||||||
|
|||||||
@@ -317,6 +317,14 @@ All gauges. The same table is checked by a test against what `/metrics` really s
|
|||||||
| `homelab_adguard_running`, `homelab_adguard_protection_enabled`, `homelab_adguard_dns_up` | `name` | 1 if AdGuard Home's DNS server runs, if its protection is on, and if it answered the app's test DNS question; else 0. |
|
| `homelab_adguard_running`, `homelab_adguard_protection_enabled`, `homelab_adguard_dns_up` | `name` | 1 if AdGuard Home's DNS server runs, if its protection is on, and if it answered the app's test DNS question; else 0. |
|
||||||
| `homelab_adguard_dns_probe_seconds` | `name` | How long it took to answer that question; left out when it did not. |
|
| `homelab_adguard_dns_probe_seconds` | `name` | How long it took to answer that question; left out when it did not. |
|
||||||
| `homelab_adguard_queries`, `homelab_adguard_blocked`, `homelab_adguard_avg_processing_seconds` | `name` | The queries it answered in its statistics period, how many it blocked, and its average processing time. |
|
| `homelab_adguard_queries`, `homelab_adguard_blocked`, `homelab_adguard_avg_processing_seconds` | `name` | The queries it answered in its statistics period, how many it blocked, and its average processing time. |
|
||||||
|
| `homelab_technitium_dns_up`, `homelab_technitium_blocking_enabled` | `name` | 1 if Technitium's DNS server answered the app's test DNS question, and if its blocking is on; else 0. |
|
||||||
|
| `homelab_technitium_dns_probe_seconds` | `name` | How long it took to answer that question; left out when it did not. |
|
||||||
|
| `homelab_technitium_uptime_seconds` | `name` | How long the DNS server has run, since it last started; left out when it did not say. |
|
||||||
|
| `homelab_technitium_block_lists_overdue` | `name` | 1 if the block lists' update was due more than six hours ago, else 0. Only where block lists are set up. |
|
||||||
|
| `homelab_technitium_queries`, `homelab_technitium_blocked`, `homelab_technitium_cached`, `homelab_technitium_recursive`, `homelab_technitium_server_failures`, `homelab_technitium_clients` | `name` | The last day's queries, how many were blocked, answered from the cache, resolved by the server and ended in a server failure, and how many different clients asked. Gauges over a rolling day, not counters. |
|
||||||
|
| `homelab_technitium_cache_entries` | `name` | Entries in its DNS cache now. |
|
||||||
|
| `homelab_technitium_zones`, `homelab_technitium_zone_problems` | `name` | The zones it holds (its internal ones not counted), and how many have expired or cannot sync. |
|
||||||
|
| `homelab_technitium_dhcp_leases` | `name` | The DHCP leases it holds. Left out when it has no DHCP server. |
|
||||||
| `homelab_grafana_rules`, `homelab_grafana_rules_firing`, `homelab_grafana_rules_error` | `name` | How many alert rules Grafana has, how many are firing and how many cannot be evaluated. |
|
| `homelab_grafana_rules`, `homelab_grafana_rules_firing`, `homelab_grafana_rules_error` | `name` | How many alert rules Grafana has, how many are firing and how many cannot be evaluated. |
|
||||||
| `homelab_grafana_datasources_failing` | `name` | How many of Grafana's data sources fail its health check. |
|
| `homelab_grafana_datasources_failing` | `name` | How many of Grafana's data sources fail its health check. |
|
||||||
| `homelab_fragnet_server_running` | `account`, `server`, `game` | 1 if the Fragnet game server is running, else 0. |
|
| `homelab_fragnet_server_running` | `account`, `server`, `game` | 1 if the Fragnet game server is running, else 0. |
|
||||||
|
|||||||
Reference in new issue
Block a user