Add gigs_all_disk_space vital collection, storage, service, and UI rendering for Linux hosts

changes/31671-gigs-all-disk-space

@@ -0,0 +1 @@
+- Add `gigs_all_disk_space` vital collection, storage, service, and UI rendering for Linux hosts

cmd/fleetctl/fleetctl/testdata/expectedHostDetailResponseJson.json

@@ -63,6 +63,7 @@
     "gigs_disk_space_available": 0,
     "percent_disk_space_available": 0,
     "gigs_total_disk_space": 0,
+    "gigs_all_disk_space": null,
     "issues": {
       "total_issues_count": 0,
       "failing_policies_count": 0

cmd/fleetctl/fleetctl/testdata/expectedHostDetailResponseYaml.yml

@@ -18,6 +18,7 @@ spec:
   fleet_desktop_version: null
   gigs_disk_space_available: 0
   gigs_total_disk_space: 0
+  gigs_all_disk_space: null
   hardware_model: ""
   hardware_serial: ""
   hardware_vendor: ""

cmd/fleetctl/fleetctl/testdata/expectedListHostsJson.json

@@ -67,6 +67,7 @@
 		"gigs_disk_space_available": 0,
 		"percent_disk_space_available": 0,
 		"gigs_total_disk_space": 0,
+		"gigs_all_disk_space": null,
 		"issues": {
 			"total_issues_count": 0,
 			"failing_policies_count": 0
@@ -136,6 +137,7 @@
 		"gigs_disk_space_available": 0,
 		"percent_disk_space_available": 0,
 		"gigs_total_disk_space": 0,
+		"gigs_all_disk_space": null,
 		"issues": {
 			"total_issues_count": 0,
 			"failing_policies_count": 0

cmd/fleetctl/fleetctl/testdata/expectedListHostsMDM.json

@@ -68,6 +68,7 @@
       "gigs_disk_space_available": 0,
       "percent_disk_space_available": 0,
       "gigs_total_disk_space": 0,
+      "gigs_all_disk_space": null,
       "issues": {
         "total_issues_count": 0,
         "failing_policies_count": 0
@@ -137,6 +138,7 @@
       "gigs_disk_space_available": 0,
       "percent_disk_space_available": 0,
       "gigs_total_disk_space": 0,
+      "gigs_all_disk_space": null,
       "issues": {
         "total_issues_count": 0,
         "failing_policies_count": 0

cmd/fleetctl/fleetctl/testdata/expectedListHostsYaml.yml

@@ -23,6 +23,7 @@ spec:
   fleet_desktop_version: null
   gigs_disk_space_available: 0
   gigs_total_disk_space: 0
+  gigs_all_disk_space: null
   hardware_model: ""
   hardware_serial: ""
   hardware_vendor: ""

docs/Contributing/product-groups/orchestration/understanding-host-vitals.md

@@ -116,9 +116,58 @@ WITH encrypted(enabled) AS (
 - Query:
 ```sql
 SELECT (blocks_available * 100 / blocks) AS percent_disk_space_available,
-       round((blocks_available * blocks_size * 10e-10),2) AS gigs_disk_space_available,
-       round((blocks           * blocks_size * 10e-10),2) AS gigs_total_disk_space
-FROM mounts WHERE path = '/' LIMIT 1;
+		       round((blocks_available * blocks_size * 10e-10),2) AS gigs_disk_space_available,
+		       round((blocks           * blocks_size * 10e-10),2) AS gigs_total_disk_space,
+					 (SELECT round(SUM(blocks * blocks_size) * 10e-10, 2) FROM mounts WHERE
+-- exclude mounts with no space
+blocks > 0
+AND blocks_size > 0
+
+-- exclude external storage
+AND path NOT LIKE '/media%' AND path NOT LIKE '/mnt%'
+
+-- exclude device drivers
+AND path NOT LIKE '/dev%' 
+
+-- exclude kernel-related mounts
+AND path NOT LIKE '/proc%'
+AND path NOT LIKE '/sys%'
+
+-- exclude process files
+AND path NOT LIKE '/run%'
+AND path NOT LIKE '/var/run%'
+
+-- exclude boot files
+AND path NOT LIKE '/boot%' 
+
+-- exclude snap packages
+AND path NOT LIKE '/snap%' AND path NOT LIKE '/var/snap%'
+
+-- exclude virtualized mounts, would double-count bare metal storage
+AND path NOT LIKE '/var/lib/docker%'
+AND path NOT LIKE '/var/lib/containers%'
+
+AND type IN (
+'ext4', 
+'ext3', 
+'ext2', 
+'xfs', 
+'btrfs', 
+'ntfs', 
+'vfat',
+'fuseblk', --seen on NTFS and exFAT volumes mounted via FUSE
+'zfs' --also valid storage
+)
+AND (
+device LIKE '/dev/sd%' 
+OR device LIKE '/dev/hd%' 
+OR device LIKE '/dev/vd%' 
+OR device LIKE '/dev/nvme%' 
+OR device LIKE '/dev/mapper%'
+OR device LIKE '/dev/md%'
+OR device LIKE '/dev/dm-%'
+)) AS gigs_all_disk_space
+		FROM mounts WHERE path = '/' LIMIT 1;
 ```
 
 ## disk_space_windows

frontend/interfaces/host.ts

@@ -65,6 +65,10 @@ export default PropTypes.shape({
   additional: PropTypes.object, // eslint-disable-line react/forbid-prop-types
   percent_disk_space_available: PropTypes.number,
   gigs_disk_space_available: PropTypes.number,
+  // On Linux hosts, `gigs_total_disk_space` only includes disk space from the "/" partition
+  gigs_total_disk_space: PropTypes.number,
+  // `gigs_all_disk_space` includes disk space from all partitions
+  gigs_all_disk_space: PropTypes.number,
   labels: PropTypes.arrayOf(labelInterface),
   packs: PropTypes.arrayOf(packInterface),
   software: PropTypes.arrayOf(softwareInterface),
@@ -280,6 +284,10 @@ export interface IHost {
   additional?: object; // eslint-disable-line @typescript-eslint/ban-types
   percent_disk_space_available: number;
   gigs_disk_space_available: number;
+  // On Linux hosts, `gigs_total_disk_space` only includes disk space from the "/" partition
+  gigs_total_disk_space?: number;
+  // `gigs_all_disk_space` includes disk space from all partitions
+  gigs_all_disk_space?: number;
   labels: ILabel[];
   packs: IPack[];
   software?: ISoftware[];

frontend/pages/hosts/ManageHostsPage/HostTableConfig.tsx

@@ -284,18 +284,25 @@ const allHostTableHeaders: IHostTableColumnConfig[] = [
         isSortedDesc={cellProps.column.isSortedDesc}
       />
     ),
-    accessor: "gigs_disk_space_available",
     id: "gigs_disk_space_available",
     Cell: (cellProps: IHostTableNumberCellProps) => {
-      const { platform, percent_disk_space_available } = cellProps.row.original;
+      const {
+        platform,
+        percent_disk_space_available,
+        gigs_disk_space_available,
+        gigs_total_disk_space,
+        gigs_all_disk_space,
+      } = cellProps.row.original;
       if (platform === "chrome") {
         return NotSupported;
       }
       return (
         <DiskSpaceIndicator
           inTableCell
-          gigsDiskSpaceAvailable={cellProps.cell.value}
+          gigsDiskSpaceAvailable={gigs_disk_space_available}
           percentDiskSpaceAvailable={percent_disk_space_available}
+          gigsTotalDiskSpace={gigs_total_disk_space}
+          gigsAllDiskSpace={gigs_all_disk_space}
           platform={platform}
         />
       );

frontend/pages/hosts/components/DiskSpaceIndicator/DiskSpaceIndicator.tests.tsx

@@ -148,4 +148,25 @@ describe("Disk space Indicator", () => {
       expect(tooltip).toBeInTheDocument();
     });
   });
+  it("renders tooltip over anchor for Linux hosts with gigs all disk space and gigs total disk space", async () => {
+    const { user } = renderWithSetup(
+      <DiskSpaceIndicator
+        gigsDiskSpaceAvailable={20}
+        percentDiskSpaceAvailable={20}
+        gigsTotalDiskSpace={100}
+        gigsAllDiskSpace={120}
+        platform="linux"
+      />
+    );
+
+    await user.hover(screen.getByText(/GB/));
+
+    await waitFor(() => {
+      const totalTip = screen.getByText(/System disk space/);
+      expect(totalTip).toBeInTheDocument();
+    });
+
+    const allTip = screen.getByText(/All partitions/);
+    expect(allTip).toBeInTheDocument();
+  });
 });

frontend/pages/hosts/components/DiskSpaceIndicator/DiskSpaceIndicator.tsx

@@ -1,18 +1,20 @@
 import React from "react";
 
-import ReactTooltip from "react-tooltip";
 import { PlacesType } from "react-tooltip-5";
 import NotSupported from "components/NotSupported";
 
 import { COLORS } from "styles/var/colors";
 
 import ProgressBar from "components/ProgressBar";
 import TooltipWrapper from "components/TooltipWrapper";
+import { isLinuxLike } from "interfaces/platform";
 
 const baseClass = "disk-space-indicator";
 interface IDiskSpaceIndicatorProps {
   gigsDiskSpaceAvailable: number | "---";
   percentDiskSpaceAvailable: number;
+  gigsTotalDiskSpace?: number;
+  gigsAllDiskSpace?: number;
   platform: string;
   inTableCell?: boolean;
   tooltipPosition?: PlacesType;
@@ -21,6 +23,8 @@ interface IDiskSpaceIndicatorProps {
 const DiskSpaceIndicator = ({
   gigsDiskSpaceAvailable,
   percentDiskSpaceAvailable,
+  gigsTotalDiskSpace,
+  gigsAllDiskSpace,
   platform,
   inTableCell = false,
   tooltipPosition = "top",
@@ -73,6 +77,31 @@ const DiskSpaceIndicator = ({
     />
   );
 
+  // get disk space tooltip content for Linux hosts
+  const totalDiskSpaceContent = gigsTotalDiskSpace ? (
+    <>
+      System disk space: {gigsTotalDiskSpace} GB
+      <br />
+    </>
+  ) : null;
+  const allPartitionsContent = gigsAllDiskSpace ? (
+    <>All partitions: {gigsAllDiskSpace} GB</>
+  ) : null;
+
+  const copyTootltipContent =
+    totalDiskSpaceContent || allPartitionsContent ? (
+      <>
+        {totalDiskSpaceContent}
+        {allPartitionsContent}
+      </>
+    ) : null;
+
+  const renderCopy = () => (
+    <>
+      {gigsDiskSpaceAvailable} GB{!inTableCell && " available"}
+    </>
+  );
+
   return (
     <span className={baseClass}>
       {diskSpaceTooltipText ? (
@@ -88,7 +117,16 @@ const DiskSpaceIndicator = ({
       ) : (
         renderBar()
       )}
-      {gigsDiskSpaceAvailable} GB{!inTableCell && " available"}
+      {copyTootltipContent && isLinuxLike(platform) ? (
+        <TooltipWrapper
+          tooltipClass="copy-tooltip-content"
+          tipContent={copyTootltipContent}
+        >
+          {renderCopy()}
+        </TooltipWrapper>
+      ) : (
+        renderCopy()
+      )}
     </span>
   );
 };

frontend/pages/hosts/components/DiskSpaceIndicator/_styles.scss

@@ -4,7 +4,7 @@
   gap: $pad-small;
   white-space: nowrap;
 
-  .react-tooltip {
+  .react-tooltip :not(.copy-tooltip-content) {
     max-width: px-to-rem(160);
     text-align: center;
     font-size: px-to-rem(13);

frontend/pages/hosts/details/cards/HostSummary/HostSummary.tsx

@@ -199,6 +199,8 @@ const HostSummary = ({
           <DiskSpaceIndicator
             gigsDiskSpaceAvailable={summaryData.gigs_disk_space_available}
             percentDiskSpaceAvailable={summaryData.percent_disk_space_available}
+            gigsTotalDiskSpace={summaryData.gigs_total_disk_space}
+            gigsAllDiskSpace={summaryData.gigs_all_disk_space}
             platform={platform}
             tooltipPosition="bottom"
           />

frontend/utilities/constants.tsx

@@ -5,6 +5,7 @@ import React from "react";
 import { IDropdownOption } from "interfaces/dropdownOption";
 import { ICampaign } from "interfaces/campaign";
 import { MdmEnrollmentStatus } from "interfaces/mdm";
+import { IHost } from "interfaces/host";
 
 const { origin } = global.window.location;
 export const BASE_URL = `${origin}${URL_PREFIX}/api`;
@@ -405,7 +406,7 @@ export const DEFAULT_EMPTY_CELL_VALUE = "---";
 
 export const DOCUMENT_TITLE_SUFFIX = "Fleet";
 
-export const HOST_SUMMARY_DATA = [
+export const HOST_SUMMARY_DATA: (keyof IHost)[] = [
   "id",
   "status",
   "issues",
@@ -416,10 +417,11 @@ export const HOST_SUMMARY_DATA = [
   "osquery_version",
   "orbit_version",
   "fleet_desktop_version",
-  "enroll_secret_name",
   "detail_updated_at",
   "percent_disk_space_available",
   "gigs_disk_space_available",
+  "gigs_total_disk_space",
+  "gigs_all_disk_space",
   "team_name",
   "disk_encryption_enabled",
   "display_name", // Not rendered on my device page

server/datastore/mysql/android.go

@@ -139,7 +139,8 @@ func (ds *Datastore) NewAndroidHost(ctx context.Context, host *fleet.AndroidHost
 			err = ds.SetOrUpdateHostDisksSpace(ctx, host.Host.ID,
 				host.Host.GigsDiskSpaceAvailable,
 				host.Host.PercentDiskSpaceAvailable,
-				host.Host.GigsTotalDiskSpace)
+				host.Host.GigsTotalDiskSpace,
+				nil)
 			if err != nil {
 				return ctxerr.Wrap(ctx, err, "setting Android host disk space")
 			}
@@ -232,7 +233,8 @@ func (ds *Datastore) UpdateAndroidHost(ctx context.Context, host *fleet.AndroidH
 			err = ds.SetOrUpdateHostDisksSpace(ctx, host.Host.ID,
 				host.Host.GigsDiskSpaceAvailable,
 				host.Host.PercentDiskSpaceAvailable,
-				host.Host.GigsTotalDiskSpace)
+				host.Host.GigsTotalDiskSpace,
+				nil)
 			if err != nil {
 				return ctxerr.Wrap(ctx, err, "updating Android host disk space")
 			}

server/datastore/mysql/hosts.go

@@ -728,6 +728,7 @@ SELECT
   COALESCE(hd.gigs_disk_space_available, 0) as gigs_disk_space_available,
   COALESCE(hd.percent_disk_space_available, 0) as percent_disk_space_available,
   COALESCE(hd.gigs_total_disk_space, 0) as gigs_total_disk_space,
+  hd.gigs_all_disk_space,
   hd.encrypted as disk_encryption_enabled,
   COALESCE(hst.seen_time, h.created_at) AS seen_time,
   t.name AS team_name,
@@ -1019,6 +1020,7 @@ func (ds *Datastore) ListHosts(ctx context.Context, filter fleet.TeamFilter, opt
     COALESCE(hd.gigs_disk_space_available, 0) as gigs_disk_space_available,
     COALESCE(hd.percent_disk_space_available, 0) as percent_disk_space_available,
     COALESCE(hd.gigs_total_disk_space, 0) as gigs_total_disk_space,
+    hd.gigs_all_disk_space,
     COALESCE(hst.seen_time, h.created_at) AS seen_time,
     t.name AS team_name,
     COALESCE(hu.software_updated_at, h.created_at) AS software_updated_at,
@@ -2981,6 +2983,7 @@ func (ds *Datastore) SearchHosts(ctx context.Context, filter fleet.TeamFilter, m
     COALESCE(hd.gigs_disk_space_available, 0) as gigs_disk_space_available,
     COALESCE(hd.percent_disk_space_available, 0) as percent_disk_space_available,
     COALESCE(hd.gigs_total_disk_space, 0) as gigs_total_disk_space,
+    hd.gigs_all_disk_space as gigs_all_disk_space,
     COALESCE(hst.seen_time, h.created_at) AS seen_time,
 	COALESCE(hu.software_updated_at, h.created_at) AS software_updated_at
 	` + hostMDMSelect + `
@@ -4332,12 +4335,12 @@ func (ds *Datastore) GetHostEmails(ctx context.Context, hostUUID string, source
 
 // SetOrUpdateHostDisksSpace sets the available gigs and percentage of the
 // disks for the specified host.
-func (ds *Datastore) SetOrUpdateHostDisksSpace(ctx context.Context, hostID uint, gigsAvailable, percentAvailable, gigsTotal float64) error {
+func (ds *Datastore) SetOrUpdateHostDisksSpace(ctx context.Context, hostID uint, gigsAvailable, percentAvailable, gigsTotal float64, gigsAll *float64) error {
 	return ds.updateOrInsert(
 		ctx,
-		`UPDATE host_disks SET gigs_disk_space_available = ?, percent_disk_space_available = ?, gigs_total_disk_space = ? WHERE host_id = ?`,
-		`INSERT INTO host_disks (gigs_disk_space_available, percent_disk_space_available, gigs_total_disk_space, host_id) VALUES (?, ?, ?, ?)`,
-		gigsAvailable, percentAvailable, gigsTotal, hostID,
+		`UPDATE host_disks SET gigs_disk_space_available = ?, percent_disk_space_available = ?, gigs_total_disk_space = ?, gigs_all_disk_space = ? WHERE host_id = ?`,
+		`INSERT INTO host_disks (gigs_disk_space_available, percent_disk_space_available, gigs_total_disk_space, gigs_all_disk_space, host_id) VALUES (?, ?, ?, ?, ?)`,
+		gigsAvailable, percentAvailable, gigsTotal, gigsAll, hostID,
 	)
 }