Documentation: guides in docs/, and the reference docs brought up to date
- New docs/ folder: SSO, API, Prometheus and Grafana, webhooks, heartbeats and calendar, how monitoring works, and an index; the old root API.md is split across them - Read API: alerts carry snoozedUntil - DATABASE.md: table and migration counts, indexes, relations, integration config, settings and internal flags, delete rules, retention - ROLES.md: the sidebar table rebuilt from the menu - NOTIFICATIONS.md, INTEGRATIONS.md, BACKUP.md, AGENT_UPDATE.md: what had drifted - README: links to the guides; accounts cannot be deleted in the app Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
This commit is contained in:
1 parent
24ae8db380
commit
c2e76262ca
17 files changed
+1773
-334
No files matched your search
+9
-5
@@ -219,10 +219,11 @@ what it would say right now and *Send it now* sends it at once (through the chan
|
||||
|
||||
**Operations → Alerts** (the *Now* view; *History* lists every incident that has come and gone) shows what these notifications are about — the problems that exist *right now* — as a list you can look at, filter, and
|
||||
export. It uses the same checks as the notifications above, so a problem appears there for exactly the reason it would be notified, but it differs
|
||||
in three ways:
|
||||
in a few ways:
|
||||
|
||||
- It ignores the "Notify on" toggles. Turning a notification off doesn't hide the problem from the page.
|
||||
- Problems under a **maintenance window** are kept on the list, marked *silenced* and counted separately, instead of being dropped.
|
||||
- Problems under a **maintenance window** are kept on the list, marked *silenced* and counted separately, instead of being dropped. So are **snoozed** ones, marked with when they come back.
|
||||
- It also lists what is on the Alerts page only: forecasts, operating systems out of support, a restore test that failed or is overdue — and, at the top, what could not be checked.
|
||||
- It also lists things nothing notifies about: Uptime Kuma monitors that are down, osTicket tickets that are overdue, and any integration that's
|
||||
failing its last few calls (before the threshold that triggers an "integration down" notification).
|
||||
|
||||
@@ -254,12 +255,15 @@ on the settings page use the saved settings.
|
||||
|
||||
## What does *not* send a notification
|
||||
|
||||
- **Storage forecasts** (a Proxmox storage or Synology volume that will be full in a few days) are on the Alerts page, in the weekly digest and in /metrics, but are not sent as they happen — like the forecast for a
|
||||
server's disk.
|
||||
|
||||
Worth calling out explicitly, since it's easy to assume everything in
|
||||
the app alerts on something:
|
||||
|
||||
- **Forecasts** — a server's disk, a Proxmox storage or a Synology volume that will be full within the forecast window — are on the Alerts page, in the weekly digest and in /metrics,
|
||||
but are not sent as they happen.
|
||||
- **Operating-system support** — a server whose OS has passed, or is about to pass, its end of support — is on the Alerts page (a warning once it has ended, a note while it is coming), not sent.
|
||||
- **A snoozed alert**: its raise and recovery messages from the health and automation checks are held until the snooze ends (then one "Snooze ended" message, if it is still there). The summaries
|
||||
other checks send — stale backups, expiring secrets, Docker updates — are not held.
|
||||
|
||||
- **osTicket's own tickets** — the integration lists open tickets, but
|
||||
there is no notification for it (e.g. nothing pings you about a
|
||||
newly-overdue ticket); the page and the Alerts page show them. (The
|
||||
|
||||
Reference in new issue
Block a user