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 the boundary between alert Off and Patrol findings

pulse-triage[bot]3c8fb29af815
diff --git a/docs/FAQ.md b/docs/FAQ.md
index 803289ea31..0a63961e8c 100644
--- a/docs/FAQ.md
+++ b/docs/FAQ.md
@@ -148,7 +148,32 @@ navigation was retired during the v6 prerelease cycle. See the
older release candidate.
### Can I disable alerts for specific metrics?
-Yes. Go to **Alerts → Thresholds** and use the On/Off toggle next to any metric while editing, or set the value to `-1`. You can do this globally or per-resource (VM/Node).
+
+Yes, for the controls offered in **Alerts → Thresholds**. Edit the relevant
+default or resource row, use its **On/Off** toggle, save, then reopen the editor
+to check the saved setting. The available resource overrides differ by platform;
+not every default has a per-resource control. Use the editor rather than treating
+`-1` as a universal value or hand-editing `alerts.json`.
+
+**Off applies to that alert check, not all monitoring:**
+
+- A metric's Off toggle does not hide its readings, stop collection or disable
+ unrelated checks. Memory alerts, connectivity alerts and backup-age alerts
+ are separate controls. Check warning and critical levels separately too.
+- Check both the default and any override on the affected resource. A resource's
+ explicit threshold can remain active even when its default is Off.
+- Disabling a notification destination is different from disabling alert
+ evaluation. Already queued notifications can reflect earlier settings; a
+ message alone does not prove a new alert was evaluated after the save.
+- **Patrol findings are separate from threshold alerts.** For CPU, memory,
+ guest-disk and storage usage, Patrol currently uses its built-in threshold
+ when the corresponding alert default is Off. Turning these alerts Off does
+ not suppress a Patrol finding. See [how Patrol works](AI.md#how-patrol-works).
+
+Use the existing alert entry or Patrol finding to identify which path produced
+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.
### How do I monitor temperature?
diff --git a/frontend-modern/browser-tests/faq-alert-off-help.cjs b/frontend-modern/browser-tests/faq-alert-off-help.cjs
new file mode 100644
index 0000000000..f68f5758f6
--- /dev/null
+++ b/frontend-modern/browser-tests/faq-alert-off-help.cjs
@@ -0,0 +1,94 @@
+// Exact own-parent comparison using the production Docs page/router/Markdown/CSS.
+// No settings mutation, alert generation, queue replay or backend request.
+const assert = require('node:assert/strict');
+const fs = require('node:fs');
+const path = require('node:path');
+const { createHash } = require('node:crypto');
+const { chromium, webkit } = require('playwright');
+
+(async () => {
+ const root = path.resolve('frontend-modern');
+ const artifacts = path.join(root, 'node_modules/faq-alert-off-browser');
+ const parent = fs.readFileSync(path.join(artifacts, 'parent.md'), 'utf8');
+ const final = fs.readFileSync(path.join(root, 'public/docs/FAQ.md'), 'utf8');
+ const hash = (value) => createHash('sha256').update(value).digest('hex');
+ process.chdir(root);
+ const { createServer } = await import(path.join(root, 'node_modules/vite/dist/node/index.js'));
+ const server = await createServer({ root, configFile: path.join(root, 'vite.config.ts'),
+ cacheDir: path.join(artifacts, 'vite-cache'),
+ server: { host: '127.0.0.1', port: 5259, strictPort: true },
+ optimizeDeps: { noDiscovery: true, include: [] } });
+ const results = [];
+ let browser;
+ try {
+ await server.listen();
+ for (const [engine, width, tone] of [['chromium', 1280, 'light'], ['webkit', 390, 'dark']]) {
+ browser = await { chromium, webkit }[engine].launch(engine === 'chromium'
+ ? { headless: true, channel: 'chromium', args: ['--no-sandbox'] } : { headless: true });
+ const context = await browser.newContext({ viewport: { width, height: 1000 },
+ ...(engine === 'webkit' ? { isMobile: true, hasTouch: true } : {}) });
+ const captures = [];
+ for (const [label, content] of [['parent', parent], ['final', final]]) {
+ const page = await context.newPage();
+ const errors = [], backendRequests = [];
+ page.on('pageerror', (error) => errors.push(error.message));
+ page.on('request', (request) => { if (new URL(request.url()).pathname.startsWith('/api/')) backendRequests.push(request.url()); });
+ await page.route('**/docs/FAQ.md', (route) => route.fulfill({ status: 200,
+ contentType: 'text/markdown; charset=utf-8', body: content }));
+ await page.goto('http://127.0.0.1:5259/browser-tests/docs-fragment-navigation.html',
+ { waitUntil: 'domcontentloaded', timeout: 30_000 });
+ if (tone === 'dark') await page.evaluate(() => document.documentElement.classList.add('dark'));
+ await page.getByRole('link', { name: '← All documentation' }).click();
+ await page.locator('a[data-doc-link][href="/docs/FAQ"]').first().focus();
+ await page.keyboard.press('Enter');
+ const heading = page.getByRole('heading', { name: 'Can I disable alerts for specific metrics?', exact: true });
+ await heading.waitFor();
+ const text = (await page.locator('article').innerText()).replace(/\s+/g, ' ');
+ if (label === 'parent') {
+ assert.ok(text.includes('toggle next to any metric'));
+ assert.ok(!text.includes('Patrol findings are separate from threshold alerts'));
+ } else {
+ for (const phrase of ['not every default has a per-resource control',
+ 'explicit threshold can remain active', 'Already queued notifications',
+ 'Patrol findings are separate from threshold alerts',
+ 'does not hide its readings, stop collection', 'Do not induce an alert']) assert.ok(text.includes(phrase), phrase);
+ }
+ await heading.evaluate((element) => { element.scrollIntoView({ block: 'start' }); window.scrollBy(0, -20); });
+ assert.ok(await page.evaluate(() => document.documentElement.scrollWidth <= innerWidth + 1));
+ const capture = `${engine}-${label}.jpg`;
+ await page.screenshot({ path: path.join(artifacts, capture), type: 'jpeg', quality: 70 });
+ captures.push(capture);
+ if (label === 'final') {
+ for (const [name, target, title] of [
+ ['how Patrol works', '/docs/AI#how-patrol-works', 'How Patrol Works'],
+ ['ordinary notification checks', '/docs/TROUBLESHOOTING#test-succeeds-but-real-alerts-are-missing', 'Test succeeds but real alerts are missing'],
+ ]) {
+ await page.getByRole('link', { name, exact: true }).focus();
+ await page.keyboard.press('Enter');
+ await page.getByRole('heading', { name: title, exact: true }).waitFor();
+ assert.ok(page.url().endsWith(target));
+ await page.goBack();
+ await heading.waitFor();
+ }
+ }
+ assert.deepEqual(errors, []);
+ assert.deepEqual(backendRequests, []);
+ await page.close();
+ }
+ results.push({ engine, version: browser.version(), width, tone, captures,
+ parentGapReproduced: true, finalGuidanceRendered: true, keyboardLinks: 2,
+ noPageOverflow: true, backendRequests: [], errors: [] });
+ await context.close();
+ await browser.close();
+ browser = undefined;
+ }
+ const result = { result: 'passed', playwright: require('playwright/package.json').version,
+ parentSha256: hash(parent), finalSha256: hash(final), results,
+ scope: 'help rendering/navigation, not installed alert or Patrol suppression' };
+ fs.writeFileSync(path.join(artifacts, 'result.json'), JSON.stringify(result, null, 2) + '\n');
+ console.log(JSON.stringify(result));
+ } finally {
+ if (browser) await browser.close();
+ await server.close();
+ }
+})().catch((error) => { console.error(error); process.exitCode = 1; });
diff --git a/frontend-modern/public/docs/FAQ.md b/frontend-modern/public/docs/FAQ.md
index 803289ea31..0a63961e8c 100644
--- a/frontend-modern/public/docs/FAQ.md
+++ b/frontend-modern/public/docs/FAQ.md
@@ -148,7 +148,32 @@ navigation was retired during the v6 prerelease cycle. See the
older release candidate.
### Can I disable alerts for specific metrics?
-Yes. Go to **Alerts → Thresholds** and use the On/Off toggle next to any metric while editing, or set the value to `-1`. You can do this globally or per-resource (VM/Node).
+
+Yes, for the controls offered in **Alerts → Thresholds**. Edit the relevant
+default or resource row, use its **On/Off** toggle, save, then reopen the editor
+to check the saved setting. The available resource overrides differ by platform;
+not every default has a per-resource control. Use the editor rather than treating
+`-1` as a universal value or hand-editing `alerts.json`.
+
+**Off applies to that alert check, not all monitoring:**
+
+- A metric's Off toggle does not hide its readings, stop collection or disable
+ unrelated checks. Memory alerts, connectivity alerts and backup-age alerts
+ are separate controls. Check warning and critical levels separately too.
+- Check both the default and any override on the affected resource. A resource's
+ explicit threshold can remain active even when its default is Off.
+- Disabling a notification destination is different from disabling alert
+ evaluation. Already queued notifications can reflect earlier settings; a
+ message alone does not prove a new alert was evaluated after the save.
+- **Patrol findings are separate from threshold alerts.** For CPU, memory,
+ guest-disk and storage usage, Patrol currently uses its built-in threshold
+ when the corresponding alert default is Off. Turning these alerts Off does
+ not suppress a Patrol finding. See [how Patrol works](AI.md#how-patrol-works).
+
+Use the existing alert entry or Patrol finding to identify which path produced
+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.
### How do I monitor temperature?
diff --git a/frontend-modern/src/features/docs/__tests__/alertOffFAQ.test.ts b/frontend-modern/src/features/docs/__tests__/alertOffFAQ.test.ts
new file mode 100644
index 0000000000..75c24c7492
--- /dev/null
+++ b/frontend-modern/src/features/docs/__tests__/alertOffFAQ.test.ts
@@ -0,0 +1,53 @@
+import { readFileSync } from 'node:fs';
+import path from 'node:path';
+import { fileURLToPath } from 'node:url';
+import { describe, expect, it } from 'vitest';
+import { renderDocMarkdown } from '../docMarkdown';
+
+const root = path.resolve(path.dirname(fileURLToPath(import.meta.url)), '../../../../..');
+const guide = (name: string): string => readFileSync(path.join(root, 'frontend-modern/public/docs', `${name}.md`), 'utf8');
+const article = (name: string): HTMLElement => {
+ const element = document.createElement('article');
+ element.innerHTML = renderDocMarkdown(guide(name), name);
+ return element;
+};
+const section = (): HTMLElement => {
+ const heading = article('FAQ').querySelector('#can-i-disable-alerts-for-specific-metrics');
+ expect(heading).not.toBeNull();
+ const element = document.createElement('section');
+ for (let next = heading!.nextElementSibling; next && !/^H[1-6]$/.test(next.tagName); next = next.nextElementSibling) {
+ element.appendChild(next.cloneNode(true));
+ }
+ return element;
+};
+
+describe('shipped alert Off FAQ', () => {
+ it('separates the alert check, resource overrides, notification queue and Patrol', () => {
+ const element = section();
+ const text = element.textContent!.replace(/\s+/g, ' ');
+ expect(text).toContain('not every default has a per-resource control');
+ expect(text).toContain('save, then reopen the editor');
+ expect(element.querySelectorAll('li')).toHaveLength(4);
+ for (const phrase of ['does not hide its readings, stop collection',
+ 'explicit threshold can remain active', 'Already queued notifications',
+ 'Patrol findings are separate from threshold alerts',
+ 'when the corresponding alert default is Off',
+ 'Do not induce an alert, send another Test or retry the queue']) {
+ expect(text).toContain(phrase);
+ }
+ expect(element.querySelector('pre')).toBeNull();
+ expect(guide('FAQ')).toBe(readFileSync(path.join(root, 'docs/FAQ.md'), 'utf8'));
+ });
+
+ it('routes the two independent warning paths to real shipped headings', () => {
+ const links = [...section().querySelectorAll('a')];
+ expect(links).toHaveLength(2);
+ expect(links.map((link) => link.textContent)).toEqual(['how Patrol works', 'ordinary notification checks']);
+ for (const link of links) {
+ const [name, fragment] = link.getAttribute('href')!.replace('/docs/', '').split('#');
+ expect(article(name).querySelector(`#${fragment}`)).not.toBeNull();
+ expect(link.hasAttribute('data-doc-link')).toBe(true);
+ expect(link.hasAttribute('target')).toBe(false);
+ }
+ });
+});
diff --git a/scripts/tests/test_faq_deployment_docs.py b/scripts/tests/test_faq_deployment_docs.py
index ad8dfd01e6..d58c2bd8fd 100644
--- a/scripts/tests/test_faq_deployment_docs.py
+++ b/scripts/tests/test_faq_deployment_docs.py
@@ -20,6 +20,38 @@ def answer(heading):
class FAQDeploymentDocsTest(unittest.TestCase):
+ def test_alert_off_is_scoped_and_does_not_promise_universal_overrides(self):
+ text = answer("Can I disable alerts for specific metrics?")
+ for phrase in ("controls offered in **Alerts → Thresholds**", "save, then reopen",
+ "not every default has a per-resource control",
+ "rather than treating `-1` as a universal value",
+ "does not hide its readings, stop collection",
+ "Check both the default and any override",
+ "explicit threshold can remain active",
+ "warning and critical levels separately"):
+ with self.subTest(phrase=phrase):
+ self.assertIn(phrase, text)
+ runtime = (ROOT / "internal/alerts/config_runtime.go").read_text()
+ self.assertIn("if override.Memory != nil", runtime)
+ self.assertIn("result.Memory = ensureHysteresisThreshold(cloneThreshold(override.Memory))", runtime)
+
+ def test_alert_off_does_not_promise_patrol_or_queue_suppression(self):
+ text = answer("Can I disable alerts for specific metrics?")
+ for phrase in ("Patrol findings are separate from threshold alerts",
+ "CPU, memory, guest-disk and storage usage",
+ "built-in threshold when the corresponding alert default is Off",
+ "Disabling a notification destination is different",
+ "Already queued notifications can reflect earlier settings",
+ "Do not induce an alert, send another Test or retry the queue"):
+ with self.subTest(phrase=phrase):
+ self.assertIn(phrase, text)
+ adapter = (ROOT / "internal/ai/alert_threshold_adapter.go").read_text()
+ self.assertIn("ok && trigger > 0", adapter)
+ self.assertIn("return defaultVal", adapter)
+ for method in ("GetNodeCPUThreshold", "GetNodeMemoryThreshold", "GetGuestMemoryThreshold",
+ "GetGuestDiskThreshold", "GetStorageThreshold"):
+ self.assertIn(f"func (a *AlertThresholdAdapter) {method}", adapter)
+
def test_ports_distinguish_listener_mapping_and_server_host(self):
text = answer("How do I change the port?")
for phrase in ("`FRONTEND_PORT`", "default **7655**", "`PULSE_AGENT_INGEST_PORT`",