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 report targets from the Pulse deployment

pulse-triage[bot]f58756f89fdb
diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml
index 09a684a756..3cf383ed0c 100644
--- a/.github/ISSUE_TEMPLATE/bug_report.yml
+++ b/.github/ISSUE_TEMPLATE/bug_report.yml
@@ -19,7 +19,9 @@ body:
id: bug_description
attributes:
label: Describe the bug
- description: What is broken, and what is the impact?
+ 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.
placeholder: A clear and concise description of the problem.
validations:
required: true
@@ -84,6 +86,7 @@ body:
id: install_type
attributes:
label: Installation type
+ description: How the Pulse server is installed, not the kind of workload being monitored.
options:
- Docker
- Docker Compose
diff --git a/.github/ISSUE_TEMPLATE/v6_rc_feedback.yml b/.github/ISSUE_TEMPLATE/v6_rc_feedback.yml
index 56d7d9ab7d..16c27903f3 100644
--- a/.github/ISSUE_TEMPLATE/v6_rc_feedback.yml
+++ b/.github/ISSUE_TEMPLATE/v6_rc_feedback.yml
@@ -60,6 +60,7 @@ body:
id: installation_type
attributes:
label: Installation type
+ description: How the Pulse server is installed, not the kind of workload being monitored.
options:
- Docker
- Docker Compose
@@ -108,7 +109,9 @@ body:
id: summary
attributes:
label: What happened?
- description: Describe the problem, friction, or feedback clearly and directly.
+ 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.
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
diff --git a/docs/ISSUE_TRIAGE.md b/docs/ISSUE_TRIAGE.md
index 52cb5839a9..d10d183f45 100644
--- a/docs/ISSUE_TRIAGE.md
+++ b/docs/ISSUE_TRIAGE.md
@@ -32,6 +32,21 @@ symptom: logs or sanitized diagnostics for connection and data failures, and
screenshots or exact error text for visual failures. Do not make a reporter
invent logs where none apply.
+Keep the Pulse server's installation separate from the affected target. A
+Docker-hosted Pulse server can monitor a VM, LXC or NAS; its installation type
+does not make Docker commands relevant to that target. Read later comments as
+well as the original title and screenshots before choosing diagnostics. When a
+report shifts to a different target, retain both topics rather than assuming
+the new symptom is the original defect or a duplicate.
+
+Missing readings and an unresponsive workload need different investigation and
+recovery paths. Use the reporter's existing observations of the workload's usual
+UI, not Pulse's displayed connection status, to distinguish them where possible.
+Responsiveness is not proof that every filesystem is writable or the workload
+is healthy. Accept "unknown" when it cannot safely be determined; do not ask for
+another update, backup or guest-agent probe to fill the gap. Existing reports
+need no refile: ask only for a consequential distinction not already supplied.
+
Some failures cannot safely be reproduced: an update may have changed a
container despite a failed banner, an alert storm may send more notifications,
or another run may bring down a host. Accept the original sequence, observed
diff --git a/scripts/release_control/release_promotion_policy_test.py b/scripts/release_control/release_promotion_policy_test.py
index 0b713bd5be..e09976d32b 100644
--- a/scripts/release_control/release_promotion_policy_test.py
+++ b/scripts/release_control/release_promotion_policy_test.py
@@ -1791,6 +1791,44 @@ class ReleasePromotionPolicyTest(unittest.TestCase):
self.assertEqual(evidence["attributes"]["label"], "Logs, screenshots, or diagnostics")
self.assertFalse(evidence.get("validations", {}).get("required", False))
+ def test_report_intake_distinguishes_server_install_from_affected_target(self) -> None:
+ for name, summary_id, install_id in (
+ ("bug_report.yml", "bug_description", "install_type"),
+ ("v6_rc_feedback.yml", "summary", "installation_type"),
+ ):
+ with self.subTest(form=name):
+ form = yaml.load(read(f".github/ISSUE_TEMPLATE/{name}"), Loader=UniqueKeyLoader)
+ fields = {field["id"]: field for field in form["body"] if "id" in field}
+ self.assertEqual(len(fields), sum("id" in field for field in form["body"]))
+ install = fields[install_id]
+ self.assertEqual(install["type"], "dropdown")
+ self.assertEqual(install["attributes"]["label"], "Installation type")
+ self.assertIn("Pulse server", install["attributes"]["description"])
+ self.assertIn("not the kind of workload", install["attributes"]["description"])
+ summary = fields[summary_id]
+ self.assertEqual(summary["type"], "textarea")
+ self.assertTrue(summary["validations"]["required"])
+ prose = normalize_ws(summary["attributes"]["description"])
+ for distinction in (
+ "affected target", "VM, LXC, Docker container, NAS or Pulse itself",
+ "from how the Pulse server is installed", "For missing readings",
+ "workload's usual UI", "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",
+ ):
+ self.assertIn(distinction, prose)
+ self.assertNotIn("render", summary["attributes"])
+
+ triage = normalize_ws(read("docs/ISSUE_TRIAGE.md"))
+ for precaution in (
+ "installation type does not make Docker commands relevant",
+ "Read later comments", "retain both topics",
+ "not Pulse's displayed connection status",
+ "Responsiveness is not proof that every filesystem is writable",
+ 'Accept "unknown"', "Existing reports need no refile",
+ ):
+ self.assertIn(precaution, triage)
+
def test_demo_site_copy_points_at_current_release_packet_index(self) -> None:
demo_copy = read("docs/releases/V6_RC_DEMO_SITE_COPY.md")
self.assertIn("docs/RELEASE_NOTES.md", demo_copy)