PMM-13860: finalize HA Overview dashboard - #5691
Conversation
Codecov Report❌ Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #5691 +/- ##
==========================================
+ Coverage 43.59% 45.29% +1.69%
==========================================
Files 415 548 +133
Lines 43134 45760 +2626
Branches 0 591 +591
==========================================
+ Hits 18804 20725 +1921
- Misses 22454 23072 +618
- Partials 1876 1963 +87
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
fabio-silva
added
the
auto-update-branch
There was a problem hiding this comment.
Pull request overview
Updates PMM’s High Availability navigation and documentation to reflect the finalized PMM HA Overview Grafana dashboard (PMM-13860), making it the default HA landing page and aligning dashboard naming across UI and docs.
Changes:
- Point the top-level PMM HA menu entry to the PMM HA Overview Grafana dashboard and add an explicit Overview child entry.
- Rename dashboard references from “PMM HA Health Overview” to “PMM HA Overview” in docs and plugin dashboard metadata.
- Refresh the dashboard reference documentation to describe the updated panels/semantics (alive vs expected, leaders/primaries, etc.).
Reviewed changes
Copilot reviewed 6 out of 7 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| ui/apps/pmm/src/contexts/navigation/navigation.utils.tsx | Adds the Overview item into the HA menu’s dynamically-built children list. |
| ui/apps/pmm/src/contexts/navigation/navigation.constants.ts | Makes the HA landing URL the new Grafana dashboard and introduces NAV_HIGH_AVAILABILITY_OVERVIEW. |
| documentation/docs/reference/dashboards/dashboard-ha-health-overview.md | Renames and rewrites the HA dashboard reference content to match the finalized “PMM HA Overview” dashboard. |
| documentation/docs/install-pmm/install-HA-clustered.md | Updates installation docs to reference the new dashboard name and where to find it in the UI. |
| dashboards/pmm-app/src/plugin.json | Updates the dashboard display name to “PMM HA Overview” while keeping the existing JSON path. |
| dashboards/dashboards/AGENTS.md | Updates the dashboards folder description list to use the new dashboard name. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Screenshots — PMM HA OverviewOverview (with PMM HA sidebar navigation)PMM HA Overview - with resource usage Resources, storage & service availabilityResources, storage and availability Pod status tablesPMM, PostgreSQL and ClickHouse pods ClickHouse and VictoriaMetrics pods Kiosk view (clean panels) |
Render
Destroyed
| url: `${PMM_NEW_NAV_GRAFANA_PATH}/d/pmm-ha-health-overview/pmm-ha-health-overview`, | ||
| }; | ||
|
|
||
| export const NAV_HIGH_AVAILABILITY_LEADER: NavItem = { |
There was a problem hiding this comment.
What's the reason for removing the leader information? In the initial design (not sure if still applies) - https://www.figma.com/design/pWEsw8pSWBFDiXIfCFaFkd/PMM-High-Availability-Groundwork?node-id=100-1716&m=dev - the dashboard link and leader info coexist.
There was a problem hiding this comment.
@matejkubinec yes, it was in the initial design.
However, we discussed this subject and decided to remove it for now, given the dashboard is now immediately accessible from the sidebar and tells users the leader right away.
The element with the leader didn't seem a good fit on the sidebar, so for now we will make this way.
| // Status of HA mode: "Enabled" or "Disabled". | ||
| string status = 1; | ||
| // Kubernetes namespace this instance is running in. Empty if unknown | ||
| // (e.g. non-Kubernetes installs). |
There was a problem hiding this comment.
is HA supposed to be running in non-Kubernetes env?
| return detectNamespaceAt(serviceAccountNamespaceFile, l) | ||
| } | ||
|
|
||
| func detectNamespaceAt(path string, l *logrus.Entry) string { |
There was a problem hiding this comment.
why extra func is needed here?
Ticket number: PMM-13860