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.

Make memory FAQ preserve history before diagnosis

pulse-triage[bot]949559ac1d91
diff --git a/docs/FAQ.md b/docs/FAQ.md
index e5d221ca21..017e0030d4 100644
--- a/docs/FAQ.md
+++ b/docs/FAQ.md
@@ -149,7 +149,16 @@ Yes. Pulse supports **OIDC** and **SAML** SSO providers, with multi-provider sup
Pulse defaults to same-origin only. If you access the API from a different domain, set **Settings → System → Network → Allowed Origins** or use `ALLOWED_ORIGINS` (single origin, or `*` if you explicitly want all origins).
### High memory usage?
-If you are storing long history windows, reduce metrics retention (see [METRICS_HISTORY.md](METRICS_HISTORY.md)). Also confirm your polling intervals match your environment size.
+First distinguish container usage from Pulse's resident memory (RSS); a high
+LXC or Docker chart alone does not establish a leak. Use the
+[read-only memory checks](TROUBLESHOOTING.md#memory-use-keeps-growing) for your
+deployment while it is responsive.
+
+Do not shorten retention, slow polling, restart Pulse or drop caches just to
+lower the reading. Shorter retention removes history, and slower polling can
+delay monitoring; neither establishes the cause. If the container is near its
+memory limit or the host is unresponsive, stop sampling and prioritise safe
+recovery.
### Can Pulse monitor 50 or more Proxmox hosts?
diff --git a/frontend-modern/public/docs/FAQ.md b/frontend-modern/public/docs/FAQ.md
index e5d221ca21..017e0030d4 100644
--- a/frontend-modern/public/docs/FAQ.md
+++ b/frontend-modern/public/docs/FAQ.md
@@ -149,7 +149,16 @@ Yes. Pulse supports **OIDC** and **SAML** SSO providers, with multi-provider sup
Pulse defaults to same-origin only. If you access the API from a different domain, set **Settings → System → Network → Allowed Origins** or use `ALLOWED_ORIGINS` (single origin, or `*` if you explicitly want all origins).
### High memory usage?
-If you are storing long history windows, reduce metrics retention (see [METRICS_HISTORY.md](METRICS_HISTORY.md)). Also confirm your polling intervals match your environment size.
+First distinguish container usage from Pulse's resident memory (RSS); a high
+LXC or Docker chart alone does not establish a leak. Use the
+[read-only memory checks](TROUBLESHOOTING.md#memory-use-keeps-growing) for your
+deployment while it is responsive.
+
+Do not shorten retention, slow polling, restart Pulse or drop caches just to
+lower the reading. Shorter retention removes history, and slower polling can
+delay monitoring; neither establishes the cause. If the container is near its
+memory limit or the host is unresponsive, stop sampling and prioritise safe
+recovery.
### Can Pulse monitor 50 or more Proxmox hosts?
diff --git a/frontend-modern/src/utils/__tests__/docsLinks.test.ts b/frontend-modern/src/utils/__tests__/docsLinks.test.ts
index 0ccae13f89..3f0b56c079 100644
--- a/frontend-modern/src/utils/__tests__/docsLinks.test.ts
+++ b/frontend-modern/src/utils/__tests__/docsLinks.test.ts
@@ -22,6 +22,7 @@ import securityOverviewPanelSource from '@/components/Settings/SecurityOverviewP
import selfHostedCommercialRecoverySectionSource from '@/components/Settings/SelfHostedCommercialRecoverySection.tsx?raw';
import securityWarningSource from '@/components/SecurityWarning.tsx?raw';
import { DIAGNOSTICS_PANEL_COPY } from '@/utils/diagnosticsPresentation';
+import { renderDocMarkdown } from '@/features/docs/docMarkdown';
const __filename = fileURLToPath(import.meta.url);
const __dirname = path.dirname(__filename);
@@ -62,6 +63,49 @@ function getRuntimeSourceFiles(dir: string): string[] {
}
describe('docsLinks', () => {
+ const memoryFAQ = () => {
+ const faq = readFileSync(path.join(repoRoot, 'docs', 'FAQ.md'), 'utf8');
+ const article = document.createElement('article');
+ article.innerHTML = renderDocMarkdown(
+ faq.split('### High memory usage?')[1].split('\n### ')[0],
+ 'FAQ',
+ );
+ return article;
+ };
+
+ it('makes the resident-memory FAQ lead to the shipped passive recipe', () => {
+ const link = memoryFAQ().querySelector(
+ 'a[href="/docs/TROUBLESHOOTING#memory-use-keeps-growing"]',
+ );
+ expect(link?.textContent).toBe('read-only memory checks');
+ const source = readFileSync(path.join(repoRoot, 'docs', 'TROUBLESHOOTING.md'), 'utf8');
+ expect(readFileSync(path.join(frontendRoot, 'public/docs/TROUBLESHOOTING.md'), 'utf8')).toBe(
+ source,
+ );
+ const guide = document.createElement('article');
+ guide.innerHTML = renderDocMarkdown(source, 'TROUBLESHOOTING');
+ expect(guide.querySelector('#memory-use-keeps-growing')?.textContent).toBe(
+ 'Memory use keeps growing',
+ );
+ expect(guide.textContent).toContain('Pulse resident-memory sample');
+ });
+
+ it('keeps the resident-memory FAQ from sacrificing history or claiming a leak', () => {
+ const article = memoryFAQ();
+ const text = article.textContent?.replace(/\s+/g, ' ');
+ expect(text).toContain("container usage from Pulse's resident memory (RSS)");
+ expect(text).toContain('a high LXC or Docker chart alone does not establish a leak');
+ expect(text).toContain('Do not shorten retention, slow polling, restart Pulse or drop caches');
+ expect(text).toContain('Shorter retention removes history');
+ expect(text).toContain('slower polling can delay monitoring');
+ expect(text).toContain('neither establishes the cause');
+ expect(text).toContain('stop sampling and prioritise safe recovery');
+ expect(article.querySelector('pre')).toBeNull();
+ expect(readFileSync(path.join(frontendRoot, 'public/docs/FAQ.md'), 'utf8')).toBe(
+ readFileSync(path.join(repoRoot, 'docs/FAQ.md'), 'utf8'),
+ );
+ });
+
it('keeps report collection precautions usable without unpublished documentation links', () => {
for (const form of ['bug_report.yml', 'v6_rc_feedback.yml']) {
const source = readFileSync(path.join(repoRoot, '.github', 'ISSUE_TEMPLATE', form), 'utf8');