Skip to content

armgit / Pulse

Public Imported from GitHub
0

Real-time monitoring dashboard for Proxmox VE, PBS, Docker, Kubernetes, TrueNAS and vSphere. Self-hosted, with alerts for failed backups, full disks, unhealthy containers and offline nodes.

Explain Docker runtime and container alert scopes

pulse-triage[bot]e7809c6c6231
diff --git a/docs/DOCKER.md b/docs/DOCKER.md
index e21b1dfde8..12a9e33a92 100644
--- a/docs/DOCKER.md
+++ b/docs/DOCKER.md
@@ -143,6 +143,42 @@ is worth reporting, even when memory no longer grows.
---
+## Runtime and container alert scopes
+
+In **Alerts → Thresholds → Docker**, a container runtime (Docker or Podman),
+its containers and the machine running it are different alert resources.
+Turning off one check is not a blanket mute for everything on that machine.
+
+- **Runtime Offline Alerts** controls that runtime's connectivity alert. It
+ does **not** turn off alerts for its containers. The runtime row's general
+ **Alerts** switch is not a runtime-and-children control; do not rely on it
+ to mute the containers below it.
+- **One container's Alerts → Off** disables that container's threshold alerts,
+ including state, health and resource checks. Find the container under the
+ intended runtime/host group, not by name alone, then save the settings and
+ check the saved row. Other containers and the machine keep their own rules.
+ Turning off only the container's **Offline Alerts** leaves its other checks
+ enabled. Neither setting stops collection or hides readings.
+- **Machine maintenance** has a different scope. A window covering the machine
+ and its descendants also suppresses wanted machine alerts, not just Docker
+ alerts. It is not equivalent to muting one runtime and its containers while
+ keeping the machine monitored. Global or platform-wide Off controls also
+ affect more than one runtime; do not use them for that narrower job.
+
+There is no single inherited runtime-and-containers Off control here. For an
+on-demand lab, the existing alternative is to disable each unwanted container's
+alerts separately and, if wanted, the runtime's Offline Alerts. This does not
+automatically cover containers added later; review their own settings too.
+Keep wanted machine and other-runtime alerts enabled.
+
+Use existing alert details to distinguish the runtime, container and machine;
+do not stop a workload, induce an alert or send another Test to check a mute.
+Already queued messages can reflect earlier settings: changing a rule is not
+queue cancellation or proof of recovery. For those messages, use
+[ordinary notification checks](TROUBLESHOOTING.md#test-succeeds-but-real-alerts-are-missing).
+Patrol findings are separate from threshold alerts; see
+[metric Off and Patrol](FAQ.md#can-i-disable-alerts-for-specific-metrics).
+
## Container CPU readings
Pulse shows container CPU as a share of the **Docker/Podman host's total CPU
diff --git a/docs/FAQ.md b/docs/FAQ.md
index dc2a7fe2c6..4b4bda0301 100644
--- a/docs/FAQ.md
+++ b/docs/FAQ.md
@@ -190,6 +190,10 @@ the warning. For missing messages, use the
[ordinary notification checks](TROUBLESHOOTING.md#test-succeeds-but-real-alerts-are-missing).
Do not induce an alert, send another Test or retry the queue merely to check Off.
+For Docker or Podman, [runtime, container and machine alert scopes](DOCKER.md#runtime-and-container-alert-scopes)
+are separate: runtime Offline Alerts does not mute its containers, and machine
+maintenance is not a container-only mute.
+
### How do I monitor temperature?
Check the affected host's active agent version, sensor and observation time
diff --git a/frontend-modern/public/docs/DOCKER.md b/frontend-modern/public/docs/DOCKER.md
index e21b1dfde8..12a9e33a92 100644
--- a/frontend-modern/public/docs/DOCKER.md
+++ b/frontend-modern/public/docs/DOCKER.md
@@ -143,6 +143,42 @@ is worth reporting, even when memory no longer grows.
---
+## Runtime and container alert scopes
+
+In **Alerts → Thresholds → Docker**, a container runtime (Docker or Podman),
+its containers and the machine running it are different alert resources.
+Turning off one check is not a blanket mute for everything on that machine.
+
+- **Runtime Offline Alerts** controls that runtime's connectivity alert. It
+ does **not** turn off alerts for its containers. The runtime row's general
+ **Alerts** switch is not a runtime-and-children control; do not rely on it
+ to mute the containers below it.
+- **One container's Alerts → Off** disables that container's threshold alerts,
+ including state, health and resource checks. Find the container under the
+ intended runtime/host group, not by name alone, then save the settings and
+ check the saved row. Other containers and the machine keep their own rules.
+ Turning off only the container's **Offline Alerts** leaves its other checks
+ enabled. Neither setting stops collection or hides readings.
+- **Machine maintenance** has a different scope. A window covering the machine
+ and its descendants also suppresses wanted machine alerts, not just Docker
+ alerts. It is not equivalent to muting one runtime and its containers while
+ keeping the machine monitored. Global or platform-wide Off controls also
+ affect more than one runtime; do not use them for that narrower job.
+
+There is no single inherited runtime-and-containers Off control here. For an
+on-demand lab, the existing alternative is to disable each unwanted container's
+alerts separately and, if wanted, the runtime's Offline Alerts. This does not
+automatically cover containers added later; review their own settings too.
+Keep wanted machine and other-runtime alerts enabled.
+
+Use existing alert details to distinguish the runtime, container and machine;
+do not stop a workload, induce an alert or send another Test to check a mute.
+Already queued messages can reflect earlier settings: changing a rule is not
+queue cancellation or proof of recovery. For those messages, use
+[ordinary notification checks](TROUBLESHOOTING.md#test-succeeds-but-real-alerts-are-missing).
+Patrol findings are separate from threshold alerts; see
+[metric Off and Patrol](FAQ.md#can-i-disable-alerts-for-specific-metrics).
+
## Container CPU readings
Pulse shows container CPU as a share of the **Docker/Podman host's total CPU
diff --git a/frontend-modern/public/docs/FAQ.md b/frontend-modern/public/docs/FAQ.md
index dc2a7fe2c6..4b4bda0301 100644
--- a/frontend-modern/public/docs/FAQ.md
+++ b/frontend-modern/public/docs/FAQ.md
@@ -190,6 +190,10 @@ the warning. For missing messages, use the
[ordinary notification checks](TROUBLESHOOTING.md#test-succeeds-but-real-alerts-are-missing).
Do not induce an alert, send another Test or retry the queue merely to check Off.
+For Docker or Podman, [runtime, container and machine alert scopes](DOCKER.md#runtime-and-container-alert-scopes)
+are separate: runtime Offline Alerts does not mute its containers, and machine
+maintenance is not a container-only mute.
+
### How do I monitor temperature?
Check the affected host's active agent version, sensor and observation time
diff --git a/frontend-modern/src/features/docs/__tests__/dockerAlertScopesGuide.test.ts b/frontend-modern/src/features/docs/__tests__/dockerAlertScopesGuide.test.ts
new file mode 100644
index 0000000000..857896eb2f
--- /dev/null
+++ b/frontend-modern/src/features/docs/__tests__/dockerAlertScopesGuide.test.ts
@@ -0,0 +1,78 @@
+import { readFileSync } from 'node:fs';
+import path from 'node:path';
+import { fileURLToPath } from 'node:url';
+import { describe, expect, it } from 'vitest';
+import { renderDocMarkdown, stripLeadingTitle } from '../docMarkdown';
+
+const repoRoot = path.resolve(path.dirname(fileURLToPath(import.meta.url)), '../../../../..');
+
+function guide(name: string): HTMLElement {
+ const source = readFileSync(path.join(repoRoot, `docs/${name}.md`), 'utf8');
+ const shipped = readFileSync(
+ path.join(repoRoot, `frontend-modern/public/docs/${name}.md`),
+ 'utf8',
+ );
+ expect(shipped).toBe(source);
+ const article = document.createElement('article');
+ article.innerHTML = renderDocMarkdown(stripLeadingTitle(shipped), name);
+ return article;
+}
+
+function scopeSection(): HTMLElement {
+ const article = guide('DOCKER');
+ const heading = article.querySelector('#runtime-and-container-alert-scopes');
+ expect(heading?.tagName).toBe('H2');
+ const section = document.createElement('section');
+ for (let next = heading!.nextElementSibling; next && next.tagName !== 'H2';) {
+ const following = next.nextElementSibling;
+ section.appendChild(next);
+ next = following;
+ }
+ return section;
+}
+
+const prose = (element: Element): string => element.textContent!.replace(/\s+/g, ' ').trim();
+
+describe('shipped Docker alert scope guidance', () => {
+ it('routes the existing metric FAQ to the real Docker scope heading', () => {
+ const link = guide('FAQ').querySelector(
+ 'a[href="/docs/DOCKER#runtime-and-container-alert-scopes"]',
+ );
+ expect(link?.hasAttribute('data-doc-link')).toBe(true);
+ expect(link?.hasAttribute('target')).toBe(false);
+ expect(guide('DOCKER').querySelector('#runtime-and-container-alert-scopes')).not.toBeNull();
+ });
+
+ it('keeps runtime connectivity, one-container Off and machine maintenance distinct', () => {
+ const section = scopeSection();
+ const rows = [...section.querySelectorAll('li')].map(prose);
+ expect(rows).toHaveLength(3);
+ expect(rows[0]).toContain('does not turn off alerts for its containers');
+ expect(rows[0]).toContain('not a runtime-and-children control');
+ expect(rows[1]).toContain('intended runtime/host group, not by name alone');
+ expect(rows[1]).toContain('Other containers and the machine keep their own rules');
+ expect(rows[1]).toContain('Offline Alerts leaves its other checks enabled');
+ expect(rows[2]).toContain('also suppresses wanted machine alerts');
+ expect(prose(section)).toContain('does not automatically cover containers added later');
+ // This explanation must not require an unsafe command or a new diagnostics run.
+ expect(section.querySelector('pre, form, input, button')).toBeNull();
+ expect(prose(section)).toContain(
+ 'do not stop a workload, induce an alert or send another Test',
+ );
+ expect(prose(section)).toContain('not queue cancellation or proof of recovery');
+ });
+
+ it('keeps notification and Patrol follow-through in the shipped viewer', () => {
+ const section = scopeSection();
+ for (const [name, id] of [
+ ['TROUBLESHOOTING', 'test-succeeds-but-real-alerts-are-missing'],
+ ['FAQ', 'can-i-disable-alerts-for-specific-metrics'],
+ ]) {
+ const link = section.querySelector(`a[href="/docs/${name}#${id}"]`);
+ expect(link, name).not.toBeNull();
+ expect(link?.hasAttribute('data-doc-link'), name).toBe(true);
+ expect(link?.hasAttribute('target'), name).toBe(false);
+ expect(guide(name).querySelector(`[id="${id}"]`), name).not.toBeNull();
+ }
+ });
+});