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.

Keep specialist bug-report guidance optional

pulse-triage[bot]670a08be944d
diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml
index 4f7ea3eb3e..9d88529c9d 100644
--- a/.github/ISSUE_TEMPLATE/bug_report.yml
+++ b/.github/ISSUE_TEMPLATE/bug_report.yml
@@ -17,6 +17,17 @@ body:
If a credential has already been posted, revoke it with its issuer and remove the public copy; editing a post is not revocation or proof that every copy is gone. Do not repost the original evidence; use the [private security disclosure route](https://github.com/rcourtman/Pulse/security/policy) for sensitive details.
+ - type: markdown
+ attributes:
+ value: |
+ <details>
+ <summary>Several hosts or clusters: preserve which names and IDs repeat</summary>
+
+ For reports involving several hosts or clusters, say which nodes share a cluster, which belong to independent installations, whether node names or guest IDs (VMIDs) repeat, and whether they share a backup destination.
+ Use consistent aliases for private names and addresses across the description, screenshots and logs; preserve which values repeat (for example, cluster A/node 1 and standalone B/node 1). Use existing observations, or write "unknown"; do not add, rename, remove or re-enrol anything just to answer.
+
+ </details>
+
- type: textarea
id: bug_description
attributes:
@@ -24,9 +35,6 @@ body:
description: |
What is broken, where do you see it, and what is the impact? Distinguish the affected target (for example, a VM, LXC, Docker container, NAS or Pulse itself) from how the Pulse server is installed.
For missing readings, say whether the affected workload's usual UI was still responsive when the problem occurred. Use existing observations; write "unknown" if you cannot safely tell. Do not run another update, backup or guest-agent probe just to answer.
-
- For reports involving several hosts or clusters, say which nodes share a cluster, which belong to independent installations, whether node names or guest IDs (VMIDs) repeat, and whether they share a backup destination.
- Use consistent aliases for private names and addresses across the description, screenshots and logs; preserve which values repeat (for example, cluster A/node 1 and standalone B/node 1). Use existing observations, or write "unknown"; do not add, rename, remove or re-enrol anything just to answer.
placeholder: A clear and concise description of the problem.
validations:
required: true
@@ -129,14 +137,24 @@ body:
validations:
required: false
+ - type: markdown
+ attributes:
+ value: |
+ <details>
+ <summary>Failed upgrade: which attempt, stop and recovery?</summary>
+
+ For an interrupted or failed upgrade only: give the starting version, intended version or asset, route (in-app, automatic timer, manual installer or helper), original time and timezone, and last recorded updater/installer result or exit code. Distinguish Pulse stopping from the whole LXC, VM or host stopping. Say what recovery you already performed and which version and state you observed afterwards.
+ A verified download signature is not a completed upgrade; a later boot does not explain the stop. Today's running version does not establish the version at failure. Use existing observations; blank or "unknown" is valid. If already available, include only relevant, locally reviewed and redacted updater and host stop records in the evidence field, not full journals.
+ Do not rerun the update, reboot, restore, run Diagnostics or delete rollback backups just to complete this report. Keep backups private and preserve the original evidence.
+
+ </details>
+
- type: textarea
id: upgrade_context
attributes:
label: Upgrade attempt and recovery
description: |
- For an interrupted or failed upgrade only: give the starting version, intended version or asset, route (in-app, automatic timer, manual installer or helper), original time and timezone, and last recorded updater/installer result or exit code. Distinguish Pulse stopping from the whole LXC, VM or host stopping. Say what recovery you already performed and which version and state you observed afterwards.
- A verified download signature is not a completed upgrade; a later boot does not explain the stop. Today's running version does not establish the version at failure. Use existing observations; blank or "unknown" is valid. If already available, include only relevant, locally reviewed and redacted updater and host stop records in the evidence field, not full journals.
- Do not rerun the update, reboot, restore, run Diagnostics or delete rollback backups just to complete this report. Keep backups private and preserve the original evidence.
+ For failed or interrupted upgrades only. Use the original attempt, stop and recovery already observed; blank or "unknown" is valid. Do not repeat the update or delete rollback backups.
placeholder: |
Attempt: starting version → intended version; route; time and timezone
Last recorded result: error or exit code, or unknown
@@ -145,25 +163,45 @@ body:
validations:
required: false
- - type: textarea
- id: logs
+ - type: markdown
attributes:
- label: Logs, screenshots, or diagnostics
- description: |
- Add relevant redacted logs or a reviewed GitHub diagnostics export for connection and data failures; for visual failures, a screenshot or exact error may be enough. Prefer existing evidence when new collection is unsafe.
- Review files and screenshots locally; remove secrets and identifying details, including those echoed in errors, before attaching them here.
+ value: |
+ Optional context: open only the section that matches your report. Use existing observations; missing details are valid.
+
+ <details>
+ <summary>Notification delivery: Test versus ordinary alerts</summary>
For notification reports, distinguish an already-observed **Test** result from ordinary alert delivery: single, grouped/digest or resolved. Give the destination type (such as email or Telegram), built-in or custom template, original time and redacted error or missing host/resource context where known. A successful Test does not establish ordinary delivery or correct identity.
Use existing messages and queue details only; blank or "unknown" is valid. Do not send a Test, trigger an alert, retry/replay a queued message, clear the queue or change notification settings just to complete this report. Keep destination addresses, webhook URLs, chat IDs, tokens and full notification settings or payloads private.
+ </details>
+
+ <details>
+ <summary>Pulse CPU, memory or disk writes: comparable measurements</summary>
+
For CPU, memory or disk-write reports about Pulse itself, use existing readings or safe, passive observations. Say whether the reading covers the Pulse process, its container or the whole host, and give its units, measurement window and uptime. Include allocated CPUs or memory limit, fleet size, polling interval and open dashboards where relevant and known. A process-start CPU average is not a recent sampling window; database size is not a write rate.
Existing screenshots are useful; write "unavailable" when safe collection is not possible. Do not restart, create load or change polling or retention just to measure. Do not attach raw profiles, heap dumps, databases or full process command lines; summarise only relevant counters after local review.
For Pulse memory reports, distinguish a higher steady baseline from growth during one uninterrupted run. A higher baseline is worth reporting even if usage stays flat. Keep already available versions, uptime, workload and enabled collectors/features with each reading; a lower reading shortly after an upgrade is not proof of recovery compared with a days-old run. Unknown context is valid; do not restart, downgrade or change features to create a comparison.
+ </details>
+
+ <details>
+ <summary>VM or LXC memory: guest versus hypervisor readings</summary>
+
For VM or LXC memory disagreements, say where each existing reading appears (overview, History, alert, Patrol or another tool) and whether the comparison was measured inside the affected guest or on its hypervisor node. Give original times, units and memory source or sample age only if already known or displayed; use consistent private aliases and write "unknown" for missing details.
Available memory, buff/cache and a process's RSS measure different things: RSS alone is not total guest usage, and a cache-inclusive hypervisor footprint does not establish guest pressure. A Proxmox VM API connection may still obtain QEMU guest-agent (QGA) readings without a Pulse agent.
Use existing observations only. Do not run commands, Diagnostics or guest-agent probes, install an agent, change memory settings or workloads, or repeat a backup just to answer.
+
+ </details>
+
+ - type: textarea
+ id: logs
+ attributes:
+ label: Logs, screenshots, or diagnostics
+ description: |
+ Add relevant redacted logs or a reviewed GitHub diagnostics export for connection and data failures; for visual failures, a screenshot or exact error may be enough. Prefer existing evidence when new collection is unsafe.
+ Review files and screenshots locally; remove secrets and identifying details, including those echoed in errors, before attaching them here.
validations:
required: false
diff --git a/.github/ISSUE_TEMPLATE/v6_rc_feedback.yml b/.github/ISSUE_TEMPLATE/v6_rc_feedback.yml
index 78686eea52..ff8a95a9b7 100644
--- a/.github/ISSUE_TEMPLATE/v6_rc_feedback.yml
+++ b/.github/ISSUE_TEMPLATE/v6_rc_feedback.yml
@@ -102,14 +102,24 @@ body:
validations:
required: false
+ - type: markdown
+ attributes:
+ value: |
+ <details>
+ <summary>Failed upgrade: which attempt, stop and recovery?</summary>
+
+ For an interrupted or failed upgrade only: give the starting version, intended version or asset, route (in-app, automatic timer, manual installer or helper), original time and timezone, and last recorded updater/installer result or exit code. Distinguish Pulse stopping from the whole LXC, VM or host stopping. Say what recovery you already performed and which version and state you observed afterwards.
+ A verified download signature is not a completed upgrade; a later boot does not explain the stop. Today's running version does not establish the version at failure. Use existing observations; blank or "unknown" is valid. If already available, include only relevant, locally reviewed and redacted updater and host stop records in the evidence field, not full journals.
+ Do not rerun the update, reboot, restore, run Diagnostics or delete rollback backups just to complete this report. Keep backups private and preserve the original evidence.
+
+ </details>
+
- type: textarea
id: upgrade_context
attributes:
label: Upgrade attempt and recovery
description: |
- For an interrupted or failed upgrade only: give the starting version, intended version or asset, route (in-app, automatic timer, manual installer or helper), original time and timezone, and last recorded updater/installer result or exit code. Distinguish Pulse stopping from the whole LXC, VM or host stopping. Say what recovery you already performed and which version and state you observed afterwards.
- A verified download signature is not a completed upgrade; a later boot does not explain the stop. Today's running version does not establish the version at failure. Use existing observations; blank or "unknown" is valid. If already available, include only relevant, locally reviewed and redacted updater and host stop records in the evidence field, not full journals.
- Do not rerun the update, reboot, restore, run Diagnostics or delete rollback backups just to complete this report. Keep backups private and preserve the original evidence.
+ For failed or interrupted upgrades only. Use the original attempt, stop and recovery already observed; blank or "unknown" is valid. Do not repeat the update or delete rollback backups.
placeholder: |
Attempt: starting version → intended version; route; time and timezone
Last recorded result: error or exit code, or unknown
@@ -143,6 +153,17 @@ body:
validations:
required: true
+ - type: markdown
+ attributes:
+ value: |
+ <details>
+ <summary>Several hosts or clusters: preserve which names and IDs repeat</summary>
+
+ For reports involving several hosts or clusters, say which nodes share a cluster, which belong to independent installations, whether node names or guest IDs (VMIDs) repeat, and whether they share a backup destination.
+ Use consistent aliases for private names and addresses across the description, screenshots and logs; preserve which values repeat (for example, cluster A/node 1 and standalone B/node 1). Use existing observations, or write "unknown"; do not add, rename, remove or re-enrol anything just to answer.
+
+ </details>
+
- type: textarea
id: summary
attributes:
@@ -150,9 +171,6 @@ body:
description: |
Describe the problem, friction, or feedback and where you see it. Distinguish the affected target (for example, a VM, LXC, Docker container, NAS or Pulse itself) from how the Pulse server is installed.
For missing readings, say whether the affected workload's usual UI was still responsive when the problem occurred. Use existing observations; write "unknown" if you cannot safely tell. Do not run another update, backup or guest-agent probe just to answer.
-
- For reports involving several hosts or clusters, say which nodes share a cluster, which belong to independent installations, whether node names or guest IDs (VMIDs) repeat, and whether they share a backup destination.
- Use consistent aliases for private names and addresses across the description, screenshots and logs; preserve which values repeat (for example, cluster A/node 1 and standalone B/node 1). Use existing observations, or write "unknown"; do not add, rename, remove or re-enrol anything just to answer.
placeholder: Pulse upgraded cleanly, but the new storage filters are hard to understand and I could not find the previous view quickly.
validations:
required: true
@@ -187,26 +205,45 @@ body:
validations:
required: true
- - type: textarea
- id: evidence
+ - type: markdown
attributes:
- label: Logs, screenshots, or diagnostics
- description: |
- Attach screenshots or paste relevant redacted logs if useful. For connection or data failures, a reviewed GitHub diagnostics export can help; prefer existing evidence when new collection is unsafe.
- Review files and screenshots locally; remove secrets and identifying details, including those echoed in errors, before attaching them here.
+ value: |
+ Optional context: open only the section that matches your report. Use existing observations; missing details are valid.
+
+ <details>
+ <summary>Notification delivery: Test versus ordinary alerts</summary>
For notification reports, distinguish an already-observed **Test** result from ordinary alert delivery: single, grouped/digest or resolved. Give the destination type (such as email or Telegram), built-in or custom template, original time and redacted error or missing host/resource context where known. A successful Test does not establish ordinary delivery or correct identity.
Use existing messages and queue details only; blank or "unknown" is valid. Do not send a Test, trigger an alert, retry/replay a queued message, clear the queue or change notification settings just to complete this report. Keep destination addresses, webhook URLs, chat IDs, tokens and full notification settings or payloads private.
+ </details>
+
+ <details>
+ <summary>Pulse CPU, memory or disk writes: comparable measurements</summary>
+
For CPU, memory or disk-write reports about Pulse itself, use existing readings or safe, passive observations. Say whether the reading covers the Pulse process, its container or the whole host, and give its units, measurement window and uptime. Include allocated CPUs or memory limit, fleet size, polling interval and open dashboards where relevant and known. A process-start CPU average is not a recent sampling window; database size is not a write rate.
Existing screenshots are useful; write "unavailable" when safe collection is not possible. Do not restart, create load or change polling or retention just to measure. Do not attach raw profiles, heap dumps, databases or full process command lines; summarise only relevant counters after local review.
For Pulse memory reports, distinguish a higher steady baseline from growth during one uninterrupted run. A higher baseline is worth reporting even if usage stays flat. Keep already available versions, uptime, workload and enabled collectors/features with each reading; a lower reading shortly after an upgrade is not proof of recovery compared with a days-old run. Unknown context is valid; do not restart, downgrade or change features to create a comparison.
+ </details>
+
+ <details>
+ <summary>VM or LXC memory: guest versus hypervisor readings</summary>
+
For VM or LXC memory disagreements, say where each existing reading appears (overview, History, alert, Patrol or another tool) and whether the comparison was measured inside the affected guest or on its hypervisor node. Give original times, units and memory source or sample age only if already known or displayed; use consistent private aliases and write "unknown" for missing details.
Available memory, buff/cache and a process's RSS measure different things: RSS alone is not total guest usage, and a cache-inclusive hypervisor footprint does not establish guest pressure. A Proxmox VM API connection may still obtain QEMU guest-agent (QGA) readings without a Pulse agent.
Use existing observations only. Do not run commands, Diagnostics or guest-agent probes, install an agent, change memory settings or workloads, or repeat a backup just to answer.
+ </details>
+
+ - type: textarea
+ id: evidence
+ attributes:
+ label: Logs, screenshots, or diagnostics
+ description: |
+ Attach screenshots or paste relevant redacted logs if useful. For connection or data failures, a reviewed GitHub diagnostics export can help; prefer existing evidence when new collection is unsafe.
+ Review files and screenshots locally; remove secrets and identifying details, including those echoed in errors, before attaching them here.
- type: checkboxes
id: confirmations
attributes:
diff --git a/.github/scripts/issue-version-triage.test.cjs b/.github/scripts/issue-version-triage.test.cjs
index bef5eda062..d484928183 100644
--- a/.github/scripts/issue-version-triage.test.cjs
+++ b/.github/scripts/issue-version-triage.test.cjs
@@ -5,6 +5,63 @@ const path = require("node:path");
const triage = require("./issue-version-triage.cjs");
+// GitHub issue forms do not submit markdown-only guidance as report fields.
+// Detailed, optional guidance belongs immediately before the input it helps;
+// test that location rather than requiring every reader to see it expanded.
+function fieldGuidance(form, id) {
+ const blocks = form.split(/(?=^ - type: )/m).slice(1);
+ const index = blocks.findIndex(block => block.includes(` id: ${id}\n`));
+ assert.ok(index >= 0, `missing input ${id}`);
+ const preceding = blocks[index - 1] || "";
+ return (preceding.startsWith(" - type: markdown\n") ? preceding : "") + blocks[index];
+}
+
+for (const [name, summary, evidence] of [
+ ["bug_report.yml", "bug_description", "logs"],
+ ["v6_rc_feedback.yml", "summary", "evidence"],
+]) {
+ test(`specialist intake guidance stays optional and beside its input: ${name}`, () => {
+ const form = fs.readFileSync(path.resolve(__dirname, "../ISSUE_TEMPLATE", name), "utf8");
+ const blocks = form.split(/(?=^ - type: )/m).slice(1);
+ const disclosures = [];
+ for (const block of blocks) {
+ if (!block.includes("<details")) continue;
+ assert.ok(block.startsWith(" - type: markdown\n"), "details must not be input descriptions");
+ assert.doesNotMatch(block, /<details\s+[^>]*\bopen\b/);
+ const groups = [...block.matchAll(/<details>\s*<summary>([^<]+)<\/summary>([\s\S]*?)<\/details>/g)];
+ assert.equal(groups.length, (block.match(/<details/g) || []).length, "each disclosure must close");
+ for (const [, title, content] of groups) {
+ assert.ok(title.trim(), "keyboard focus needs a meaningful summary");
+ assert.ok(content.trim(), "a disclosure must retain its guidance");
+ disclosures.push(title);
+ }
+ }
+ assert.deepEqual(disclosures.sort(), [
+ "Failed upgrade: which attempt, stop and recovery?",
+ "Several hosts or clusters: preserve which names and IDs repeat",
+ "Notification delivery: Test versus ordinary alerts",
+ "Pulse CPU, memory or disk writes: comparable measurements",
+ "VM or LXC memory: guest versus hypervisor readings",
+ ].sort());
+ for (const [id, titles] of [
+ ["upgrade_context", ["Failed upgrade:"]],
+ [summary, ["Several hosts or clusters:"]],
+ [evidence, ["Notification delivery:", "Pulse CPU, memory or disk writes:", "VM or LXC memory:"]],
+ ]) {
+ const guidance = fieldGuidance(form, id);
+ for (const title of titles) assert.ok(guidance.includes(`<summary>${title}`), `${id}: ${title}`);
+ }
+ // Collection and public-disclosure warnings are never hidden in a disclosure.
+ const introduction = blocks[0];
+ assert.doesNotMatch(introduction, /<details/);
+ assert.match(introduction, /do not run it during backups, freeze\/thaw or an unresponsive-host incident/);
+ assert.match(introduction, /Anything you attach here is public/);
+ const attachment = blocks.find(block => block.includes(` id: ${evidence}\n`));
+ assert.match(attachment, /Review files and screenshots locally/);
+ assert.doesNotMatch(attachment, /<details|For notification reports|For CPU, memory or disk-write reports/);
+ });
+}
+
function createGithub({
latestVersion = "6.0.1",
existingLabels = new Set(),
@@ -503,7 +560,7 @@ test("bug and pre-release forms accept truthful evidence for installs that never
test("both bug forms keep an optional failed-upgrade timeline without unsafe collection", () => {
for (const name of ["bug_report.yml", "v6_rc_feedback.yml"]) {
const form = fs.readFileSync(path.resolve(__dirname, "../ISSUE_TEMPLATE", name), "utf8");
- const timeline = form.split(" id: upgrade_context\n")[1]?.split(" - type: ")[0];
+ const timeline = fieldGuidance(form, "upgrade_context");
assert.ok(timeline, name);
assert.match(timeline, /label: Upgrade attempt and recovery/);
assert.match(timeline, /required: false/);
@@ -601,7 +658,7 @@ for (const [name, field] of [
]) {
const evidenceField = () => {
const form = fs.readFileSync(path.resolve(__dirname, "../ISSUE_TEMPLATE", name), "utf8");
- return form.split(` id: ${field}\n`)[1].split(" - type: ")[0];
+ return fieldGuidance(form, field);
};
test(`performance report measurement context stays optional: ${name}`, () => {