feat: Initial commit for health monitoring widget with graphs (Work in Progress)

Author: SeDemal

packages/api/src/router/widgets/health-monitoring.ts

@@ -1,43 +1,52 @@
 import { observable } from "@trpc/server/observable";
 
+import type { Modify } from "@homarr/common/types";
+import type { Integration } from "@homarr/db/schema/sqlite";
+import type { IntegrationKindByCategory } from "@homarr/definitions";
 import { getIntegrationKindsByCategory } from "@homarr/definitions";
 import type { HealthMonitoring } from "@homarr/integrations";
 import { systemInfoRequestHandler } from "@homarr/request-handler/health-monitoring";
+import { z } from "@homarr/validation";
 
 import { createManyIntegrationMiddleware } from "../../middlewares/integration";
 import { createTRPCRouter, publicProcedure } from "../../trpc";
 
 export const healthMonitoringRouter = createTRPCRouter({
   getHealthStatus: publicProcedure
+    .input(z.object({ pointCount: z.number().optional(), maxElements: z.number().optional() }))
     .unstable_concat(createManyIntegrationMiddleware("query", ...getIntegrationKindsByCategory("healthMonitoring")))
-    .query(async ({ ctx }) => {
+    .query(async ({ input: { pointCount = 1, maxElements = 32 }, ctx }) => {
       return await Promise.all(
-        ctx.integrations.map(async (integration) => {
-          const innerHandler = systemInfoRequestHandler.handler(integration, {});
-          const { data, timestamp } = await innerHandler.getCachedOrUpdatedDataAsync({ forceUpdate: false });
+        ctx.integrations.map(async (integrationWithSecrets) => {
+          const innerHandler = systemInfoRequestHandler.handler(integrationWithSecrets, { maxElements, pointCount });
+          const healthInfo = await innerHandler.getCachedOrUpdatedDataAsync({ forceUpdate: false });
+
+          const { decryptedSecrets: _, ...integration } = integrationWithSecrets;
 
           return {
-            integrationId: integration.id,
-            integrationName: integration.name,
-            healthInfo: data,
-            updatedAt: timestamp,
+            integration,
+            healthInfo,
           };
         }),
       );
     }),
 
   subscribeHealthStatus: publicProcedure
+    .input(z.object({ maxElements: z.number().optional() }))
     .unstable_concat(createManyIntegrationMiddleware("query", ...getIntegrationKindsByCategory("healthMonitoring")))
-    .subscription(({ ctx }) => {
-      return observable<{ integrationId: string; healthInfo: HealthMonitoring; timestamp: Date }>((emit) => {
+    .subscription(({ ctx, input: { maxElements = 32 } }) => {
+      return observable<{
+        integration: Modify<Integration, { kind: IntegrationKindByCategory<"healthMonitoring"> }>;
+        healthInfo: { data: HealthMonitoring; timestamp: Date };
+      }>((emit) => {
         const unsubscribes: (() => void)[] = [];
-        for (const integration of ctx.integrations) {
-          const innerHandler = systemInfoRequestHandler.handler(integration, {});
-          const unsubscribe = innerHandler.subscribe((healthInfo) => {
+        for (const integrationWithSecrets of ctx.integrations) {
+          const innerHandler = systemInfoRequestHandler.handler(integrationWithSecrets, { maxElements, pointCount: 1 });
+          const { decryptedSecrets: _, ...integration } = integrationWithSecrets;
+          const unsubscribe = innerHandler.subscribe((data) => {
             emit.next({
-              integrationId: integration.id,
-              healthInfo,
-              timestamp: new Date(),
+              integration,
+              healthInfo: { data, timestamp: new Date() },
             });
           });
           unsubscribes.push(unsubscribe);

packages/cron-jobs/src/jobs/integrations/health-monitoring.ts

@@ -8,7 +8,7 @@ export const healthMonitoringJob = createCronJob("healthMonitoring", EVERY_5_SEC
   createRequestIntegrationJobHandler(systemInfoRequestHandler.handler, {
     widgetKinds: ["healthMonitoring"],
     getInput: {
-      healthMonitoring: () => ({}),
+      healthMonitoring: (options) => ({ maxElements: Number(options.pointDensity), pointCount: 1 }),
     },
   }),
 );

packages/definitions/src/docs/homarr-docs-sitemap.ts

@@ -41,11 +41,13 @@ export type HomarrDocumentationPath =
   | "/docs/tags/advanced"
   | "/docs/tags/analytics"
   | "/docs/tags/api"
+  | "/docs/tags/apps"
   | "/docs/tags/banner"
   | "/docs/tags/blocking"
   | "/docs/tags/board"
   | "/docs/tags/boards"
   | "/docs/tags/bookmark"
+  | "/docs/tags/bookmarks"
   | "/docs/tags/caddy"
   | "/docs/tags/checklist"
   | "/docs/tags/code"
@@ -91,6 +93,7 @@ export type HomarrDocumentationPath =
   | "/docs/tags/overseerr"
   | "/docs/tags/permissions"
   | "/docs/tags/pi-hole"
+  | "/docs/tags/ping"
   | "/docs/tags/preferences"
   | "/docs/tags/programming"
   | "/docs/tags/proxmox"
@@ -128,24 +131,26 @@ export type HomarrDocumentationPath =
   | "/docs/advanced/customizations/user-preferences"
   | "/docs/advanced/sso"
   | "/docs/category/advanced"
+  | "/docs/category/developer-guide"
   | "/docs/category/getting-started"
   | "/docs/category/installation"
   | "/docs/category/installation-1"
   | "/docs/category/integrations"
   | "/docs/category/management"
   | "/docs/category/more"
   | "/docs/category/widgets"
-  | "/docs/community/developer-guides"
   | "/docs/community/donate"
   | "/docs/community/faq"
   | "/docs/community/get-in-touch"
   | "/docs/community/license"
   | "/docs/community/translations"
+  | "/docs/development/getting-started"
   | "/docs/getting-started"
   | "/docs/getting-started/after-the-installation"
   | "/docs/getting-started/glossary"
   | "/docs/getting-started/installation/docker"
   | "/docs/getting-started/installation/easy-panel"
+  | "/docs/getting-started/installation/helm"
   | "/docs/getting-started/installation/home-assistant"
   | "/docs/getting-started/installation/kubernetes"
   | "/docs/getting-started/installation/portainer"
@@ -164,6 +169,7 @@ export type HomarrDocumentationPath =
   | "/docs/integrations/torrent"
   | "/docs/integrations/usenet"
   | "/docs/management/api"
+  | "/docs/management/apps"
   | "/docs/management/boards"
   | "/docs/management/integrations"
   | "/docs/management/search-engines"

packages/definitions/src/integration.ts

@@ -141,7 +141,7 @@ export const integrationDefs = {
     name: "OpenMediaVault",
     secretKinds: [["username", "password"]],
     iconUrl: "https://cdn.jsdelivr.net/gh/walkxcode/dashboard-icons@master/png/openmediavault.png",
-    category: ["healthMonitoring"],
+    category: ["tempNone"],
     supportsSearch: false,
   },
   dashDot: {
@@ -217,4 +217,5 @@ export type IntegrationCategory =
   | "torrent"
   | "smartHomeServer"
   | "indexerManager"
-  | "healthMonitoring";
+  | "healthMonitoring"
+  | "tempNone";

packages/integrations/src/base/creator.ts

@@ -4,12 +4,12 @@ import type { Integration as DbIntegration } from "@homarr/db/schema/sqlite";
 import type { IntegrationKind, IntegrationSecretKind } from "@homarr/definitions";
 
 import { AdGuardHomeIntegration } from "../adguard-home/adguard-home-integration";
-import { DashDotIntegration } from "../dashdot/dashdot-integration";
 import { DelugeIntegration } from "../download-client/deluge/deluge-integration";
 import { NzbGetIntegration } from "../download-client/nzbget/nzbget-integration";
 import { QBitTorrentIntegration } from "../download-client/qbittorrent/qbittorrent-integration";
 import { SabnzbdIntegration } from "../download-client/sabnzbd/sabnzbd-integration";
 import { TransmissionIntegration } from "../download-client/transmission/transmission-integration";
+import { DashDotIntegration } from "../health-monitoring/dashdot/dashdot-integration";
 import { HomeAssistantIntegration } from "../homeassistant/homeassistant-integration";
 import { JellyfinIntegration } from "../jellyfin/jellyfin-integration";
 import { JellyseerrIntegration } from "../jellyseerr/jellyseerr-integration";

packages/integrations/src/dashdot/dashdot-integration.ts

@@ -0,0 +1,79 @@
+import type { z, ZodType } from "@homarr/validation";
+
+import type { HealthMonitoring } from "../../interfaces/health-monitoring/healt-monitoring-data";
+import { HealthMonitoringIntegration } from "../../interfaces/health-monitoring/health-monitoring-interface";
+import {
+  configSchema,
+  cpuLoadSchema,
+  memoryLoadSchema,
+  networkLoadSchema,
+  serverInfoSchema,
+  storageLoadSchema,
+} from "./dashdot-schema";
+
+export class DashDotIntegration extends HealthMonitoringIntegration {
+  public async testConnectionAsync(): Promise<void> {
+    const response = await fetch(this.url("/info"));
+    await response.json();
+  }
+
+  public async getSystemInfoAsync(): Promise<HealthMonitoring> {
+    const { config } = await this.dashDotApiCallAsync("/config", configSchema);
+    const info = await this.dashDotApiCallAsync("/info", serverInfoSchema);
+    const cpuLoad = await this.dashDotApiCallAsync("/load/cpu", cpuLoadSchema);
+    const memoryLoad = await this.dashDotApiCallAsync("/load/ram", memoryLoadSchema);
+    const storageLoad = await this.dashDotApiCallAsync("/load/storage", storageLoadSchema);
+    const networkLoad = await this.dashDotApiCallAsync("/load/network", networkLoadSchema);
+    return {
+      system: {
+        name: config.override.os ?? info.os.distro,
+        type: "single",
+        version: info.os.release,
+        uptime: info.os.uptime * 1000,
+      },
+      cpu: cpuLoad.map((cpu) => {
+        return {
+          id: `${cpu.core}`,
+          name: `${cpu.core}`,
+          temp: cpu.temp ? (config.use_imperial ? (cpu.temp - 32) / 1.8 : cpu.temp) : undefined,
+          maxValue: 100,
+        };
+      }),
+      memory: [
+        {
+          id: "unique",
+          name: `${config.override.ram_brand ?? info.ram.layout[0].brand} - ${config.override.ram_type ?? info.ram.layout[0].type}`,
+          maxValue: config.override.ram_size ?? info.ram.size,
+        },
+      ],
+      storage: info.storage.map((storage, index) => {
+        return {
+          name: storage.disks.map((disk) => config.override.storage_brands?.[disk.brand] ?? disk.brand).join(", "),
+          used: storageLoad[index] ?? -1,
+          size: storage.size,
+        };
+      }),
+      network: [
+        {
+          id: "unique",
+          name: config.use_network_interface,
+          maxValue: ((config.override.network_interface_speed ?? info.network.interfaceSpeed) * 1000 ** 3) / 8,
+        },
+      ],
+      history: [
+        {
+          timestamp: Date.now(),
+          cpu: cpuLoad.map(({ core, load }) => ({ id: `${core}`, value: load })),
+          memory: [{ id: "unique", value: memoryLoad.load }],
+          networkUp: [{ id: "unique", value: Math.round(networkLoad.up) }],
+          networkDown: [{ id: "unique", value: Math.round(networkLoad.down) }],
+        },
+      ],
+    };
+  }
+
+  private async dashDotApiCallAsync<T extends ZodType>(path: `/${string}`, schema: T): Promise<z.infer<T>> {
+    const response = await fetch(this.url(path));
+    return schema.parseAsync(await response.json()) as Promise<z.infer<T>>;
+  }
+}