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 platform and collection paths in safe issue intake

pulse-triage[bot]588762635e72
diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml
index e5553c3ef8..00ee19c599 100644
--- a/.github/ISSUE_TEMPLATE/bug_report.yml
+++ b/.github/ISSUE_TEMPLATE/bug_report.yml
@@ -106,6 +106,15 @@ body:
validations:
required: true
+ - type: input
+ id: environment
+ attributes:
+ label: OS / environment
+ description: Pulse server OS and, for platform-specific failures, the affected monitored platform and its release where known (for example, Proxmox VE 9.2 or TrueNAS SCALE 26 / CORE 13). Say whether the affected readings use the platform API, a Pulse agent, or both; keep this separate from the Pulse server's installation and version. Use existing settings or observations; leave blank or write "unknown" if unavailable. Do not run diagnostics, probe, restart or change a connection just to answer.
+ placeholder: Pulse on Debian 13; TrueNAS CORE 13.0-U6.1 via API, no Pulse agent
+ validations:
+ required: false
+
- type: input
id: installer_source
attributes:
diff --git a/.github/ISSUE_TEMPLATE/v6_rc_feedback.yml b/.github/ISSUE_TEMPLATE/v6_rc_feedback.yml
index 8df1e4bedd..d6020a50a5 100644
--- a/.github/ISSUE_TEMPLATE/v6_rc_feedback.yml
+++ b/.github/ISSUE_TEMPLATE/v6_rc_feedback.yml
@@ -104,10 +104,10 @@ body:
id: environment
attributes:
label: OS / environment
- description: Pulse server OS and, for platform-specific failures, the affected monitored platform and its release where known. Keep these separate from the Pulse server and agent versions; write "unknown" for unavailable details.
- placeholder: Ubuntu 24.04, Debian 12, Unraid 7, Proxmox 8, macOS 15
+ description: Pulse server OS and, for platform-specific failures, the affected monitored platform and its release where known (for example, Proxmox VE 9.2 or TrueNAS SCALE 26 / CORE 13). Say whether the affected readings use the platform API, a Pulse agent, or both; keep this separate from the Pulse server's installation and version. Use existing settings or observations; leave blank or write "unknown" if unavailable. Do not run diagnostics, probe, restart or change a connection just to answer.
+ placeholder: Pulse on Debian 13; TrueNAS CORE 13.0-U6.1 via API, no Pulse agent
validations:
- required: true
+ required: false
- type: dropdown
id: license_tier
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 40dd1e21aa..3d397c1ce2 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -46,6 +46,11 @@ and installer tooling.
give the attempted version or release asset (or say "unknown") and identify
the installer or helper when known. Include an image tag or digest only for a
running container, not for a bare-metal or LXC install.
+- Where already known, give the affected platform and release (for example,
+ TrueNAS SCALE or CORE), separately from the Pulse server OS and version.
+ Say whether its readings come through the platform API, a Pulse agent, or
+ both. Use existing settings or observations; blank or "unknown" is valid.
+ Do not run diagnostics, probe, restart or change a connection to fill this in.
- Include only evidence relevant to the symptom: a screenshot or exact redacted
error may be enough for a visual problem; existing logs or observations may
explain a connection or data failure. Diagnostics are optional, not a condition
diff --git a/docs/ISSUE_TRIAGE.md b/docs/ISSUE_TRIAGE.md
index 22ed9300d7..b7a955b406 100644
--- a/docs/ISSUE_TRIAGE.md
+++ b/docs/ISSUE_TRIAGE.md
@@ -41,6 +41,15 @@ An API-only connection can have no agent. Accept "unknown" or an omitted optiona
field, and use existing evidence; do not ask for a downgrade, restart, reinstall
or re-enrolment to obtain version context. Existing reports need no refile.
+The optional **OS / environment** field in both bug forms also distinguishes
+where readings come from: the platform API, a Pulse agent, or both. Retain the
+affected platform release, including TrueNAS SCALE versus CORE, separately from
+the Pulse and agent versions and the server OS. Different collection paths can
+supply different readings for the same target; a working agent view does not
+prove that the API view recovered. Use existing settings and observations;
+blank or "unknown" is valid. Do not request diagnostics, a probe, restart or
+connection change just to fill this context. Existing reports need no refile.
+
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
diff --git a/frontend-modern/public/docs/CONTRIBUTING.md b/frontend-modern/public/docs/CONTRIBUTING.md
index 40dd1e21aa..3d397c1ce2 100644
--- a/frontend-modern/public/docs/CONTRIBUTING.md
+++ b/frontend-modern/public/docs/CONTRIBUTING.md
@@ -46,6 +46,11 @@ and installer tooling.
give the attempted version or release asset (or say "unknown") and identify
the installer or helper when known. Include an image tag or digest only for a
running container, not for a bare-metal or LXC install.
+- Where already known, give the affected platform and release (for example,
+ TrueNAS SCALE or CORE), separately from the Pulse server OS and version.
+ Say whether its readings come through the platform API, a Pulse agent, or
+ both. Use existing settings or observations; blank or "unknown" is valid.
+ Do not run diagnostics, probe, restart or change a connection to fill this in.
- Include only evidence relevant to the symptom: a screenshot or exact redacted
error may be enough for a visual problem; existing logs or observations may
explain a connection or data failure. Diagnostics are optional, not a condition
diff --git a/frontend-modern/public/docs/ISSUE_TRIAGE.md b/frontend-modern/public/docs/ISSUE_TRIAGE.md
index 22ed9300d7..b7a955b406 100644
--- a/frontend-modern/public/docs/ISSUE_TRIAGE.md
+++ b/frontend-modern/public/docs/ISSUE_TRIAGE.md
@@ -41,6 +41,15 @@ An API-only connection can have no agent. Accept "unknown" or an omitted optiona
field, and use existing evidence; do not ask for a downgrade, restart, reinstall
or re-enrolment to obtain version context. Existing reports need no refile.
+The optional **OS / environment** field in both bug forms also distinguishes
+where readings come from: the platform API, a Pulse agent, or both. Retain the
+affected platform release, including TrueNAS SCALE versus CORE, separately from
+the Pulse and agent versions and the server OS. Different collection paths can
+supply different readings for the same target; a working agent view does not
+prove that the API view recovered. Use existing settings and observations;
+blank or "unknown" is valid. Do not request diagnostics, a probe, restart or
+connection change just to fill this context. Existing reports need no refile.
+
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
diff --git a/scripts/release_control/release_promotion_policy_test.py b/scripts/release_control/release_promotion_policy_test.py
index 6580ef0896..e3b57cf9e6 100644
--- a/scripts/release_control/release_promotion_policy_test.py
+++ b/scripts/release_control/release_promotion_policy_test.py
@@ -1774,6 +1774,41 @@ class ReleasePromotionPolicyTest(unittest.TestCase):
self.assertIn(distinction, agent["attributes"]["description"])
self.assertIn("affected monitored platform and its release", fields["environment"]["attributes"]["description"])
+ def test_report_environment_keeps_platform_and_collection_context_optional(self) -> None:
+ for name in ("bug_report.yml", "v6_rc_feedback.yml"):
+ 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"]))
+ environment = fields["environment"]
+ self.assertEqual(environment["type"], "input")
+ self.assertEqual(environment["attributes"]["label"], "OS / environment")
+ self.assertFalse(environment["validations"]["required"])
+ self.assertNotIn("render", environment["attributes"])
+ prose = normalize_ws(environment["attributes"]["description"])
+ for distinction in (
+ "Pulse server OS", "affected monitored platform and its release",
+ "TrueNAS SCALE", "CORE", "platform API, a Pulse agent, or both",
+ "separate from the Pulse server's installation and version",
+ "Use existing settings or observations", 'leave blank or write "unknown"',
+ "Do not run diagnostics, probe, restart or change a connection",
+ ):
+ self.assertIn(distinction, prose)
+ self.assertIn("via API, no Pulse agent", environment["attributes"]["placeholder"])
+ # Optional context must not relax the original report's core fields.
+ self.assertTrue(fields["pulse_version"]["validations"]["required"])
+ summary_id = "bug_description" if name == "bug_report.yml" else "summary"
+ self.assertTrue(fields[summary_id]["validations"]["required"])
+ for document in ("docs/ISSUE_TRIAGE.md", "frontend-modern/public/docs/ISSUE_TRIAGE.md"):
+ prose = normalize_ws(read(document))
+ for distinction in (
+ "optional **OS / environment**", "platform API, a Pulse agent, or both",
+ "TrueNAS SCALE versus CORE", "separately from the Pulse and agent versions",
+ "working agent view does not prove that the API view recovered",
+ 'blank or "unknown" is valid', "Existing reports need no refile",
+ ):
+ self.assertIn(distinction, prose)
+
def test_working_version_context_is_optional_and_never_requires_another_attempt(self) -> None:
for name in ("bug_report.yml", "v6_rc_feedback.yml"):
with self.subTest(form=name):