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.

Distinguish log display controls from backup safety pauses

pulse-triage[bot]f2a76a975039
diff --git a/docs/CONFIGURATION.md b/docs/CONFIGURATION.md
index 0653fae3d3..1080d48e90 100644
--- a/docs/CONFIGURATION.md
+++ b/docs/CONFIGURATION.md
@@ -279,11 +279,36 @@ Environment variables take precedence over `system.json`.
| Level | Description |
| ------- | ------------- |
| `error` | Only errors and critical issues |
-| `warn` | Errors + warnings (recommended for minimal logging) |
+| `warn` | Errors + warnings; suppresses info and debug records |
| `info` | Standard operational messages (startup, connections, alerts) |
| `debug` | Verbose output including per-guest/storage polling details |
-> **Tip**: If your syslog is being flooded with Pulse messages, set `LOG_LEVEL=warn` to significantly reduce log volume while still capturing important events.
+The **Log Level** control in **Settings → Support → System Logs** changes the
+server-wide logging threshold, not a browser-only filter. The saved level is
+used at startup unless your deployment sets `LOG_LEVEL`: `LOG_LEVEL` takes
+precedence at startup. `info` is the default. Choosing `warn` can reduce volume,
+but `warn` also suppresses `info` operational records; absence of a log line is
+not evidence that an event did not occur.
+
+Start with the current level and the [bounded log readers](TROUBLESHOOTING.md#inspect-notification-logs).
+Debug can produce much more output, including raw guest-filesystem responses
+and private names or paths; do not enable it just to obtain a report. If the
+interface stalls after enabling Debug, return to the previous working level
+through your deployment's existing log-level control, without repeating the
+stall. A responsive interface afterwards is not proof that the underlying
+problem is fixed; retain the original time, affected view and redacted error.
+
+**Pause Stream** and **Clear Log Output** only affect the browser display. They
+do not stop monitoring, reduce server logging or erase the server's logs. A
+**Paused** log view is not a [backup safety pause](VM_DISK_MONITORING.md#backup-safety).
+
+**Support Bundle** downloads a complete configured log file, or the retained
+server log buffer when no log file can be opened, plus configuration and
+environment information. It is not just the visible lines: pausing or clearing
+the display does not remove those records from the download. Some secrets are
+masked, but that is not a guarantee that all content is safe to publish. Keep
+the archive private and share only relevant, manually reviewed, redacted excerpts,
+not the whole bundle.
| Variable | Description | Default |
| ---------- | ------------- | --------- |
diff --git a/docs/TROUBLESHOOTING.md b/docs/TROUBLESHOOTING.md
index 99c1d7002e..679fb6cc4d 100644
--- a/docs/TROUBLESHOOTING.md
+++ b/docs/TROUBLESHOOTING.md
@@ -1112,6 +1112,13 @@ information, including details echoed in errors or notes. Do not paste a
Share only evidence relevant to the symptom; a screenshot or exact redacted
error may be enough. See [Getting Help](#-getting-help).
+The **Support Bundle** download in **System Logs** is a different export: it can
+contain a complete log file or server buffer plus configuration and environment
+information. It is not the **GitHub (review first)** diagnostics export and is
+not limited to the lines visible in the panel. Keep the archive private and
+share only relevant, manually reviewed, redacted excerpts. See the
+[log-control and export limits](CONFIGURATION.md#log-levels).
+
### Inspect Notification Logs
For notification failures, prefer **Recent delivery activity** in **Alerts →
diff --git a/docs/VM_DISK_MONITORING.md b/docs/VM_DISK_MONITORING.md
index 582e87d267..033e3868a8 100644
--- a/docs/VM_DISK_MONITORING.md
+++ b/docs/VM_DISK_MONITORING.md
@@ -22,6 +22,12 @@ is stopped.** An OK backup task or an absent VM lock
does not prove thaw succeeded. This is a temporary precaution, not a claim
that the monitoring defect is fixed.
+**Pause Stream** in **System Logs** only pauses the browser display. It does not
+stop the Pulse server, its polling or guest-agent requests. Changing the log
+level is not a monitoring pause either. Use the actual server stop procedure
+below for your deployment; a **Paused** log view is not evidence that monitoring
+has stopped.
+
Do not test freeze/thaw commands, clear backup locks, disable backup freezing
or force-reset a guest as a disk-monitoring diagnostic. Those operations can
affect workloads or backup consistency. Preserve the existing backup task and
diff --git a/frontend-modern/public/docs/CONFIGURATION.md b/frontend-modern/public/docs/CONFIGURATION.md
index 0653fae3d3..1080d48e90 100644
--- a/frontend-modern/public/docs/CONFIGURATION.md
+++ b/frontend-modern/public/docs/CONFIGURATION.md
@@ -279,11 +279,36 @@ Environment variables take precedence over `system.json`.
| Level | Description |
| ------- | ------------- |
| `error` | Only errors and critical issues |
-| `warn` | Errors + warnings (recommended for minimal logging) |
+| `warn` | Errors + warnings; suppresses info and debug records |
| `info` | Standard operational messages (startup, connections, alerts) |
| `debug` | Verbose output including per-guest/storage polling details |
-> **Tip**: If your syslog is being flooded with Pulse messages, set `LOG_LEVEL=warn` to significantly reduce log volume while still capturing important events.
+The **Log Level** control in **Settings → Support → System Logs** changes the
+server-wide logging threshold, not a browser-only filter. The saved level is
+used at startup unless your deployment sets `LOG_LEVEL`: `LOG_LEVEL` takes
+precedence at startup. `info` is the default. Choosing `warn` can reduce volume,
+but `warn` also suppresses `info` operational records; absence of a log line is
+not evidence that an event did not occur.
+
+Start with the current level and the [bounded log readers](TROUBLESHOOTING.md#inspect-notification-logs).
+Debug can produce much more output, including raw guest-filesystem responses
+and private names or paths; do not enable it just to obtain a report. If the
+interface stalls after enabling Debug, return to the previous working level
+through your deployment's existing log-level control, without repeating the
+stall. A responsive interface afterwards is not proof that the underlying
+problem is fixed; retain the original time, affected view and redacted error.
+
+**Pause Stream** and **Clear Log Output** only affect the browser display. They
+do not stop monitoring, reduce server logging or erase the server's logs. A
+**Paused** log view is not a [backup safety pause](VM_DISK_MONITORING.md#backup-safety).
+
+**Support Bundle** downloads a complete configured log file, or the retained
+server log buffer when no log file can be opened, plus configuration and
+environment information. It is not just the visible lines: pausing or clearing
+the display does not remove those records from the download. Some secrets are
+masked, but that is not a guarantee that all content is safe to publish. Keep
+the archive private and share only relevant, manually reviewed, redacted excerpts,
+not the whole bundle.
| Variable | Description | Default |
| ---------- | ------------- | --------- |
diff --git a/frontend-modern/public/docs/TROUBLESHOOTING.md b/frontend-modern/public/docs/TROUBLESHOOTING.md
index 99c1d7002e..679fb6cc4d 100644
--- a/frontend-modern/public/docs/TROUBLESHOOTING.md
+++ b/frontend-modern/public/docs/TROUBLESHOOTING.md
@@ -1112,6 +1112,13 @@ information, including details echoed in errors or notes. Do not paste a
Share only evidence relevant to the symptom; a screenshot or exact redacted
error may be enough. See [Getting Help](#-getting-help).
+The **Support Bundle** download in **System Logs** is a different export: it can
+contain a complete log file or server buffer plus configuration and environment
+information. It is not the **GitHub (review first)** diagnostics export and is
+not limited to the lines visible in the panel. Keep the archive private and
+share only relevant, manually reviewed, redacted excerpts. See the
+[log-control and export limits](CONFIGURATION.md#log-levels).
+
### Inspect Notification Logs
For notification failures, prefer **Recent delivery activity** in **Alerts →
diff --git a/frontend-modern/public/docs/VM_DISK_MONITORING.md b/frontend-modern/public/docs/VM_DISK_MONITORING.md
index 582e87d267..033e3868a8 100644
--- a/frontend-modern/public/docs/VM_DISK_MONITORING.md
+++ b/frontend-modern/public/docs/VM_DISK_MONITORING.md
@@ -22,6 +22,12 @@ is stopped.** An OK backup task or an absent VM lock
does not prove thaw succeeded. This is a temporary precaution, not a claim
that the monitoring defect is fixed.
+**Pause Stream** in **System Logs** only pauses the browser display. It does not
+stop the Pulse server, its polling or guest-agent requests. Changing the log
+level is not a monitoring pause either. Use the actual server stop procedure
+below for your deployment; a **Paused** log view is not evidence that monitoring
+has stopped.
+
Do not test freeze/thaw commands, clear backup locks, disable backup freezing
or force-reset a guest as a disk-monitoring diagnostic. Those operations can
affect workloads or backup consistency. Preserve the existing backup task and
diff --git a/scripts/tests/test_vm_disk_diagnostics.py b/scripts/tests/test_vm_disk_diagnostics.py
index 73047507aa..a5f12129af 100644
--- a/scripts/tests/test_vm_disk_diagnostics.py
+++ b/scripts/tests/test_vm_disk_diagnostics.py
@@ -513,5 +513,79 @@ class VMDiskHelpTest(unittest.TestCase):
self.assertIn(phrase, precaution)
+class ServerLogSafetyDocsTest(unittest.TestCase):
+ """Check help against existing controls, not browser or native recovery."""
+
+ def log_help(self):
+ guide = (ROOT / "docs/CONFIGURATION.md").read_text()
+ return " ".join(guide.split("#### Log Levels\n", 1)[1].split("\n| Variable |", 1)[0].split())
+
+ def contains(self, text, *phrases):
+ for phrase in phrases:
+ with self.subTest(phrase=phrase):
+ self.assertTrue(phrase in text, f"Missing safety explanation: {phrase}")
+
+ def test_log_pause_cannot_substitute_for_the_backup_server_stop(self):
+ guide = " ".join(DOC.read_text().split("### Pause Pulse", 1)[0].split())
+ self.contains(guide, "**Pause Stream**", "only pauses the browser display",
+ "does not stop the Pulse server", "guest-agent requests",
+ "actual server stop procedure")
+ state = (ROOT / "frontend-modern/src/components/Settings/useSystemLogsPanelState.ts").read_text()
+ toggle = state.split("const togglePaused = () => {", 1)[1].split("\n };", 1)[0]
+ self.assertEqual(toggle.strip(), "setIsPaused((prev) => !prev);")
+ self.assertIn("if (disposed || isPaused()) return;", state)
+ self.assertIn("toggleTitle: 'Pause Stream'", (ROOT / "frontend-modern/src/utils/systemLogsPresentation.ts").read_text())
+
+ def test_log_level_is_server_wide_not_a_browser_filter(self):
+ self.contains(self.log_help(), "server-wide logging threshold", "not a browser-only filter",
+ "`warn` also suppresses `info` operational records",
+ "absence of a log line is not evidence that an event did not occur",
+ "`LOG_LEVEL` takes precedence at startup")
+ handler = (ROOT / "internal/api/log_handlers.go").read_text().split("func (h *LogHandlers) HandleSetLevel", 1)[1]
+ self.assertIn("logging.SetGlobalLevel(level)", handler)
+ self.assertIn("settings.LogLevel = level", handler)
+ loader = (ROOT / "internal/config/config.go").read_text()
+ self.assertIn('if logLevel := os.Getenv("LOG_LEVEL"); logLevel != "" {\n\t\tcfg.LogLevel = logLevel', loader)
+
+ def test_display_controls_do_not_delete_logs_or_reduce_server_logging(self):
+ self.contains(self.log_help(), "**Pause Stream**", "**Clear Log Output**",
+ "only affect the browser display", "do not stop monitoring",
+ "reduce server logging or erase the server's logs",
+ "VM_DISK_MONITORING.md#backup-safety")
+ state = (ROOT / "frontend-modern/src/components/Settings/useSystemLogsPanelState.ts").read_text()
+ clear = state.split("const clearLogs = () => {", 1)[1].split("\n };", 1)[0]
+ self.assertEqual(clear.strip(), "setLogs([]);")
+
+ def test_bundle_scope_matches_the_real_export_not_the_visible_lines(self):
+ self.contains(self.log_help(), "complete configured log file", "retained server log buffer",
+ "configuration and environment information", "not just the visible lines",
+ "Keep the archive private", "manually reviewed, redacted excerpts",
+ "not a guarantee that all content is safe to publish")
+ handler = (ROOT / "internal/api/log_handlers.go").read_text().split("func (h *LogHandlers) HandleDownloadBundle", 1)[1].split("type SetLogLevelRequest", 1)[0]
+ for source in ('os.Open(h.config.LogFile)', 'zipWriter.Create("pulse.log")',
+ 'io.Copy(wr, f)', 'zipWriter.Create("pulse-tail.log")',
+ 'logging.GetBroadcaster().GetHistory()', 'zipWriter.Create("system-info.json")',
+ 'h.config.DeepCopy()', 'os.Environ()'):
+ self.assertIn(source, handler)
+ state = (ROOT / "frontend-modern/src/components/Settings/useSystemLogsPanelState.ts").read_text()
+ self.assertIn("window.location.href = '/api/logs/download'", state)
+ trouble = " ".join((ROOT / "docs/TROUBLESHOOTING.md").read_text().split("### Collect diagnostics safely\n", 1)[1].split("### Inspect Notification Logs", 1)[0].split())
+ self.contains(trouble, "**Support Bundle**", "different export",
+ "not the **GitHub (review first)** diagnostics export",
+ "not limited to the lines visible", "CONFIGURATION.md#log-levels")
+
+ def test_debug_guidance_preserves_working_monitoring_and_private_evidence(self):
+ self.contains(self.log_help(), "Start with the current level", "raw guest-filesystem responses",
+ "private names or paths", "do not enable it just to obtain a report",
+ "previous working level", "without repeating the stall",
+ "not proof that the underlying problem is fixed",
+ "TROUBLESHOOTING.md#inspect-notification-logs")
+ def test_safety_help_is_shipped_without_new_diagnostic_commands(self):
+ for name in ("VM_DISK_MONITORING.md", "CONFIGURATION.md", "TROUBLESHOOTING.md"):
+ self.assertEqual((ROOT / "docs" / name).read_bytes(),
+ (ROOT / "frontend-modern/public/docs" / name).read_bytes())
+ self.assertNotIn("```", self.log_help(), "reuse bounded readers, not another copied command")
+
+
if __name__ == "__main__":
unittest.main()