Regroup the sidebar: Monitoring was 16 links, now 7
New Apps group (Home Assistant, Jellyfin, Immich, Paperless, Nextcloud, Authentik). Hetzner Cloud moves to Infrastructure, NetBox to Network and n8n to Automation. Docs now name the new locations. Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
This commit is contained in:
1 parent
24b708abbe
commit
0e26696b79
5 files changed
+48
-40
No files matched your search
+8
-8
@@ -321,7 +321,7 @@ osTicket's API cannot close a ticket, so this is the one place in the app that *
|
||||
- **Config fields:** Home Assistant's address (with the port, usually 8123), a long-lived access token, and a checkbox to allow a self-signed certificate.
|
||||
- **Required access:** read only. Make the token on a user's profile page (*Security → Long-lived access tokens*); the user needs no more rights than a viewer's. Only `GET /api/` and `GET /api/states` are used —
|
||||
**nothing is ever sent** to Home Assistant.
|
||||
- **What it does:** you choose which entities to watch on **Monitoring → Home Assistant** (search by name, then *Watch*; at most 60 per Home Assistant). Every five minutes (and on **Read now**) Home Assistant's
|
||||
- **What it does:** you choose which entities to watch on **Apps → Home Assistant** (search by name, then *Watch*; at most 60 per Home Assistant). Every five minutes (and on **Read now**) Home Assistant's
|
||||
entities are read in one call and the watched ones are kept: their state, and for a number a reading for the chart (one at most every two minutes, kept 35 days).
|
||||
- An entity that has been *unavailable* or *unknown* — or has disappeared from Home Assistant — for 15 minutes is an alert. A number past a limit you set (*alert when under / over*) is an alert. Both are in the
|
||||
*Monitoring* category, link to the page and can be silenced with maintenance on the integration.
|
||||
@@ -354,7 +354,7 @@ osTicket's API cannot close a ticket, so this is the one place in the app that *
|
||||
- **Config fields:** the **address** of Jellyfin (`http://host:8096`), an **API key** (Jellyfin → Dashboard → API Keys → add one; stored encrypted) and, for an https address with a certificate you made yourself, *insecure*.
|
||||
- **Required access:** read only. The API key is Jellyfin's own, which is administrator-level in Jellyfin; this app only ever sends GET requests for the server's information, its sessions, its scheduled tasks, the item counts and the activity log. **Nothing is ever changed or played.**
|
||||
- **What it does:** every **two minutes** Jellyfin is read and stored — its version, whether it **wants a restart** or has an update, **who is streaming what** and whether it is being **transcoded**, how its **scheduled tasks** (a library scan) last ended, how many films, series, episodes and songs there are, and how many
|
||||
**sign-ins failed** in the last day. **Monitoring → Jellyfin** shows it, with a chart of the most that were streaming at once (readings kept 35 days).
|
||||
**sign-ins failed** in the last day. **Apps → Jellyfin** shows it, with a chart of the most that were streaming at once (readings kept 35 days).
|
||||
- **Alerts** (category *Monitoring*, source *Jellyfin*; held back by maintenance on the integration): **waiting to be restarted** (warning), **a scheduled task failed** (warning; the task's name and error), **10 or more sign-ins failed in a day** (warning).
|
||||
- **Somebody is watching.** If the Jellyfin runs on a server this app knows (the Jellyfin's address is that server's address or host name), then **before an update run restarts that machine** the update drawer says who is streaming and asks again, and the server answers `409 watching` to a run started without saying it should go ahead anyway.
|
||||
A **patch plan** that comes to that server while people are streaming **waits for them, up to two hours**, then goes ahead and says so in its message; the server's row in the run reads *Waiting: 2 people are streaming from Cinema (Ann: Dune, …)*. Only a reading from the last ten minutes counts: if Jellyfin cannot be read, nobody is assumed to be watching.
|
||||
@@ -369,7 +369,7 @@ osTicket's API cannot close a ticket, so this is the one place in the app that *
|
||||
- **Required access:** read only. Give the key just these permissions: `server.about`, `server.storage`, `server.statistics` and `job.read` (`queue.read` on newer versions) — statistics and jobs need an administrator's key. This app only ever sends GET requests; **nothing is changed, and no job is started, paused or cleared**.
|
||||
If one of those is refused, that part is left out and the rest still works.
|
||||
- **What it does:** every **five minutes** Immich is read and stored — its version (and whether a newer one is out), how full the **disk under the library** is, how many **photos and videos** there are and what they take, and the **background job queues** with how many jobs **failed** in each.
|
||||
**Monitoring → Immich** shows it.
|
||||
**Apps → Immich** shows it.
|
||||
- **Alerts** (source *Immich*; held back by maintenance on the integration): **the disk under the library is 90 % full** (warning; **95 %**, critical) and **10 or more background jobs have failed**, all queues together (warning; the worst queues are named — thumbnails or metadata that were never made.
|
||||
Failed jobs stay counted until you run them again or clear them in Immich, so the alert stays until you do).
|
||||
- If Immich cannot be read for 20 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 asked is *unknown*, never *none*.
|
||||
@@ -383,7 +383,7 @@ osTicket's API cannot close a ticket, so this is the one place in the app that *
|
||||
yourself, *insecure*.
|
||||
- **Required access:** read only. Without a login only `/status.php` is read, which Nextcloud answers to anyone. With one, the *Monitoring* app (`serverinfo`, installed by default) is also asked, which needs an **administrator**; if it is refused or the app is off, the status is still read and the page says so. This
|
||||
app only ever sends GET requests, and **nothing is changed**.
|
||||
- **What it does:** every **five minutes** Nextcloud is read and stored — its version, whether it is in **maintenance mode**, whether it **needs its database upgrading**, and (with the login) the **room left where the data is kept**, the users, the files, who was active in the last day and how many **app updates** wait. **Monitoring → Nextcloud** shows it.
|
||||
- **What it does:** every **five minutes** Nextcloud is read and stored — its version, whether it is in **maintenance mode**, whether it **needs its database upgrading**, and (with the login) the **room left where the data is kept**, the users, the files, who was active in the last day and how many **app updates** wait. **Apps → Nextcloud** shows it.
|
||||
- **Alerts** (source *Nextcloud*; held back by maintenance on the integration): **the database needs upgrading** (critical — nobody can use it until `occ upgrade`), **maintenance mode is on** (warning — nobody can sign in), and **less than 20 GB is left for the data** (warning; under **5 GB**, critical), **the background jobs are not running** (warning — Nextcloud's own *Cron last run* check says error, which it does when the last run was more than an hour ago; see below) and **Nextcloud's own checks report an error** (warning; one alert naming them).
|
||||
- If Nextcloud cannot be read for 20 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.
|
||||
- `/metrics` has `homelab_nextcloud_maintenance_mode`, `homelab_nextcloud_free_bytes`, `homelab_nextcloud_active_users_24h` and `homelab_nextcloud_app_updates` for each Nextcloud that was read lately.
|
||||
@@ -406,7 +406,7 @@ osTicket's API cannot close a ticket, so this is the one place in the app that *
|
||||
- **Config fields:** the **address** of NetBox (`https://netbox.example.lan`), an **API token** (your profile → API Tokens; stored encrypted; **write enabled off** is enough — both the older `Token` tokens and NetBox 4.5's `nbt_…` tokens work) and, for an https address with a certificate you made yourself, *insecure*.
|
||||
- **Required access:** read only. `/api/status/`, and the counts and addresses of devices, virtual machines, prefixes and IP addresses. This app only ever sends GET requests; **nothing is changed**.
|
||||
- **What it does:** every **five minutes** NetBox is read and stored — its version, **how many background workers are running** (they run its webhooks, scripts, jobs and reports; in the Docker image they are a separate container that can be down while the pages still load), how many devices, VMs, prefixes and addresses it holds, and the addresses
|
||||
themselves (up to 5000). **Monitoring → NetBox** shows it.
|
||||
themselves (up to 5000). **Network → NetBox** shows it.
|
||||
- **Alert** (source *NetBox*; held back by maintenance on the integration): **no background worker is running** (warning).
|
||||
- **Not in NetBox**: the page lists the servers this app manages **none of whose addresses are in NetBox** (an address that is the same on every host, like Docker's bridge, is left out as on the Consistency page; loopback and link-local addresses say nothing). That is a **list, not an alert** — documentation that is behind is not an outage. If NetBox
|
||||
holds more than 5000 addresses the page says what is missing may be in the part that was not read.
|
||||
@@ -418,7 +418,7 @@ osTicket's API cannot close a ticket, so this is the one place in the app that *
|
||||
|
||||
- **Config fields:** the **address** of n8n (`http://host:5678`), an **API key** (Settings → n8n API → *Create an API key*; stored encrypted) and, for an https address with a certificate you made yourself, *insecure*.
|
||||
- **Required access:** read only. `GET /api/v1/workflows` and `GET /api/v1/executions` — the public API has to be switched on (it is on by default in current versions). This app only ever sends GET requests: **no workflow is started, changed or switched off**.
|
||||
- **What it does:** every **five minutes** n8n is read and stored — the workflows and whether each is switched on, and, from the **newest 250 runs**, each workflow's **last outcome** and how many of its runs failed in the last day. **Monitoring → n8n** shows it.
|
||||
- **What it does:** every **five minutes** n8n is read and stored — the workflows and whether each is switched on, and, from the **newest 250 runs**, each workflow's **last outcome** and how many of its runs failed in the last day. **Automation → n8n** shows it.
|
||||
- **Alert** (source *n8n*, category *Automation*; held back by maintenance on the integration): **a workflow that is switched on failed on its last run** (warning; one alert for each workflow, saying when and, if more than one run failed, how many in the last day). It **clears by itself** when the workflow next succeeds. A workflow that is switched off, or
|
||||
whose failure is more than a week old, is not raised.
|
||||
- If n8n cannot be read for 20 minutes its alerts are neither raised nor cleared, and the Alerts page says it could not check. If the runs could not be read (but the workflows could), the last outcomes are *unknown* and nothing is claimed.
|
||||
@@ -431,7 +431,7 @@ osTicket's API cannot close a ticket, so this is the one place in the app that *
|
||||
- **Required access:** read only, and a **superuser's token** is best: the system status (the worker, Redis, the index, the disk) is only given to a superuser. With an ordinary user's token the document counts and the failed imports are still read, and the page says the status is unknown. This app only ever sends GET
|
||||
requests; **nothing is changed, and no failed task is dismissed**.
|
||||
- **What it does:** every **five minutes** Paperless is read and stored — its version (and whether a newer one is out), the status of the **database, Redis, the worker that consumes documents, the search index, the classifier and the sanity check**, the **disk**, the **document and inbox counts** and the **imports that failed**
|
||||
in the last week and that nobody has dismissed. **Monitoring → Paperless** shows it.
|
||||
in the last week and that nobody has dismissed. **Apps → Paperless** shows it.
|
||||
- **Alerts** (source *Paperless-ngx*; held back by maintenance on the integration): **the database, Redis or the worker in error** (critical — nothing can be consumed or found), **the index or the classifier in error** (warning), **the sanity check found problems** (warning), **documents failed to import** (warning; the files are named and the
|
||||
latest error shown — it clears when you dismiss them in Paperless, or after a week), and **the disk under the documents is 90 % full** (warning; **95 %**, critical). A classifier that simply has not been trained yet (Paperless's *warning*) is not an alert.
|
||||
- If Paperless cannot be read for 20 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 asked is *unknown*, never *none*.
|
||||
@@ -456,7 +456,7 @@ osTicket's API cannot close a ticket, so this is the one place in the app that *
|
||||
- **Required access:** read only. This app only ever sends GET requests: the version, the workers, the outposts and their health, the certificates, the tokens and the events log. **Nothing is ever changed.** Give the token a user with just enough to read these (an administrator, or a user in a role that may view them);
|
||||
if one of the lists is refused, that part is left out and the rest still works.
|
||||
- **What it does:** every **five minutes** Authentik is read and stored — its version (and whether a newer one is out), whether a **worker** is connected, each **outpost** (the proxy outpost that guards your apps, an LDAP one) with how many instances reported in during the last five minutes and whether they run the right version, the
|
||||
**certificates** (those Authentik does not renew by itself) with their expiry, the **API tokens and app passwords** that expire, and how many **sign-ins failed** and **configuration errors** happened in the last day. **Monitoring → Authentik** shows it, with what runs out soonest first.
|
||||
**certificates** (those Authentik does not renew by itself) with their expiry, the **API tokens and app passwords** that expire, and how many **sign-ins failed** and **configuration errors** happened in the last day. **Apps → Authentik** shows it, with what runs out soonest first.
|
||||
- **Alerts** (source *Authentik*; held back by maintenance on the integration): **an outpost that serves applications has not reported in** (critical — the apps behind it stop letting anyone in; an outpost with no applications is left alone), **an outpost runs another version** (warning),
|
||||
**a certificate runs out** (warning within 14 days, critical within 3 and once it has), **an API token or app password runs out** (warning within 7 days, critical within 2 — the token this app uses to read Authentik is among them), **no worker is connected** (warning; mail, outpost changes and scheduled tasks stop),
|
||||
**20 or more sign-ins failed in a day** (warning; shown as "100 or more" when the log's page is full) and **3 or more configuration errors in a day** (warning; a flow or stage that is set up wrongly, with the newest message).
|
||||
|
||||
Reference in new issue
Block a user