issues/1597: Temperature Monitoring

api/README.md

@@ -84,6 +84,7 @@ For detailed information about specific features:
 - [Feature Flags](docs/developer/feature-flags.md) - Conditionally enabling functionality
 - [Repository Organization](docs/developer/repo-organization.md) - Codebase structure
 - [Development Workflows](docs/developer/workflows.md) - Development processes
+- [Temperature Monitoring](docs/developer/temperature.md) - Configuration and API details for temperature sensors
 
 ## License
 

api/dev/configs/api.json

@@ -5,5 +5,31 @@
   "ssoSubIds": [],
   "plugins": [
     "unraid-api-plugin-connect"
-  ]
-}
+  ],
+  "temperature": {
+    "enabled": true,
+    "polling_interval": 5000,
+    "default_unit": "celsius",
+    "history": {
+      "max_readings": 100,
+      "retention_ms": 86400000
+    },
+    "thresholds": {
+      "cpu_warning": 70,
+      "cpu_critical": 85,
+      "disk_warning": 50,
+      "disk_critical": 60
+    },
+    "sensors": {
+      "lm_sensors": {
+        "enabled": true
+      },
+      "smartctl": {
+        "enabled": true
+      },
+      "ipmi": {
+        "enabled": true
+      }
+    }
+  }
+}

api/docs/developer/temperature.md

@@ -0,0 +1,141 @@
+# Temperature Monitoring
+
+The Temperature Monitoring feature allows the Unraid API to collect and expose temperature metrics from various sensors (CPU, Disks, Motherboard, etc.).
+
+## Configuration
+
+You can configure the temperature monitoring behavior in your `api.json`.
+Nominally the `api.json` file is found at
+`/boot/config/plugins/dynamix.my.servers/configs/`.
+
+### `api.temperature` Object
+
+| Key | Type | Default | Description |
+| :--- | :--- | :--- | :--- |
+| `enabled` | `boolean` | `true` | Globally enable or disable temperature monitoring. |
+| `default_unit` | `string` | `"celsius"` | The unit to return values in. Options: `"celsius"`, `"fahrenheit"`, `"kelvin"`, `"rankine"`. |
+| `polling_interval` | `number` | `5000` | Polling interval in milliseconds for the subscription. |
+| `history.max_readings` | `number` | `1000` | (Internal) Number of historical data points to keep in memory per sensor. |
+| `history.retention_ms` | `number` | `86400000` | (Internal) Retention period for historical data in milliseconds. |
+
+### `api.temperature.sensors` Object
+
+Enable or disable specific sensor providers.
+
+| Key | Type | Default | Description |
+| :--- | :--- | :--- | :--- |
+| `lm_sensors.enabled` | `boolean` | `true` | Enable `lm-sensors` provider (requires `sensors` binary). |
+| `lm_sensors.config_path` | `string` | `null` | Optional path to a specific sensors config file (passed as `-c` to `sensors`). |
+| `smartctl.enabled` | `boolean` | `true` | Enable disk temperature monitoring via `smartctl` (via DiskService). |
+| `ipmi.enabled` | `boolean` | `true` | Enable IPMI sensor provider (requires `ipmitool`). |
+
+### `api.temperature.thresholds` Object
+
+Customize warning and critical thresholds.
+
+| Key | Type | Default | Description |
+| :--- | :--- | :--- | :--- |
+| `cpu_warning` | `number` | `70` | Warning threshold for CPU. |
+| `cpu_critical` | `number` | `85` | Critical threshold for CPU. |
+| `disk_warning` | `number` | `50` | Warning threshold for Disks. |
+| `disk_critical` | `number` | `60` | Critical threshold for Disks. |
+
+### Sample Configuration
+
+Example of an `api.json` configuration file:
+
+```json
+{
+  "version": "4.28.2+9196778e",
+  "extraOrigins": [],
+  "sandbox": true,
+  "ssoSubIds": [],
+  "plugins": [
+    "unraid-api-plugin-connect"
+  ],
+  "temperature": {
+    "enabled": true,
+    "polling_interval": 10000,
+    "default_unit": "celsius",
+    "history": {
+      "max_readings": 144,
+      "retention_ms": 86400000
+    },
+    "thresholds": {
+      "cpu_warning": 75,
+      "cpu_critical": 90,
+      "disk_warning": 50,
+      "disk_critical": 60
+    },
+    "sensors": {
+      "lm_sensors": {
+        "enabled": true,
+        "config_path": "/etc/sensors3.conf"
+      },
+      "smartctl": {
+        "enabled": true
+      },
+      "ipmi": {
+        "enabled": false
+      }
+    }
+  }
+}
+```
+
+## GraphQL API
+
+### Query: `metrics` -> `temperature`
+
+Returns a snapshot of the current temperature metrics.
+
+```graphql
+query {
+  metrics {
+    temperature {
+      id
+      summary {
+        average
+        hottest {
+          name
+          current { value unit }
+        }
+      }
+      sensors {
+        id
+        name
+        type
+        current {
+          value
+          unit
+          status
+        }
+        history {
+          value
+          timestamp
+        }
+      }
+    }
+  }
+}
+```
+
+### Subscription: `systemMetricsTemperature`
+
+Subscribes to temperature updates (pushed at `polling_interval`).
+
+```graphql
+subscription {
+  systemMetricsTemperature {
+    summary {
+      average
+    }
+    sensors {
+      name
+      current {
+        value
+      }
+    }
+  }
+}
+```

api/src/unraid-api/cli/generated/graphql.ts

@@ -560,6 +560,17 @@ export type CpuLoad = {
   percentUser: Scalars['Float']['output'];
 };
 
+export type CpuPackages = Node & {
+  __typename?: 'CpuPackages';
+  id: Scalars['PrefixedID']['output'];
+  /** Power draw per package (W) */
+  power: Array<Scalars['Float']['output']>;
+  /** Temperature per package (°C) */
+  temp: Array<Scalars['Float']['output']>;
+  /** Total CPU package power draw (W) */
+  totalPower: Scalars['Float']['output'];
+};
+
 export type CpuUtilization = Node & {
   __typename?: 'CpuUtilization';
   /** CPU load for each core */
@@ -591,6 +602,19 @@ export type Customization = {
   theme: Theme;
 };
 
+/** Customization related mutations */
+export type CustomizationMutations = {
+  __typename?: 'CustomizationMutations';
+  /** Update the UI theme (writes dynamix.cfg) */
+  setTheme: Theme;
+};
+
+
+/** Customization related mutations */
+export type CustomizationMutationsSetThemeArgs = {
+  theme: ThemeName;
+};
+
 export type DeleteApiKeyInput = {
   ids: Array<Scalars['PrefixedID']['input']>;
 };
@@ -1065,6 +1089,7 @@ export type InfoCpu = Node & {
   manufacturer?: Maybe<Scalars['String']['output']>;
   /** CPU model */
   model?: Maybe<Scalars['String']['output']>;
+  packages: CpuPackages;
   /** Number of physical processors */
   processors?: Maybe<Scalars['Int']['output']>;
   /** CPU revision */
@@ -1081,6 +1106,8 @@ export type InfoCpu = Node & {
   stepping?: Maybe<Scalars['Int']['output']>;
   /** Number of CPU threads */
   threads?: Maybe<Scalars['Int']['output']>;
+  /** Per-package array of core/thread pairs, e.g. [[[0,1],[2,3]], [[4,5],[6,7]]] */
+  topology: Array<Array<Array<Scalars['Int']['output']>>>;
   /** CPU vendor */
   vendor?: Maybe<Scalars['String']['output']>;
   /** CPU voltage */
@@ -1422,6 +1449,7 @@ export type Mutation = {
   createDockerFolderWithItems: ResolvedOrganizerV1;
   /** Creates a new notification record */
   createNotification: Notification;
+  customization: CustomizationMutations;
   /** Deletes all archived notifications on server. */
   deleteArchivedNotifications: NotificationOverview;
   deleteDockerEntries: ResolvedOrganizerV1;
@@ -2269,6 +2297,7 @@ export type Subscription = {
   parityHistorySubscription: ParityCheck;
   serversSubscription: Server;
   systemMetricsCpu: CpuUtilization;
+  systemMetricsCpuTelemetry: CpuPackages;
   systemMetricsMemory: MemoryUtilization;
   upsUpdates: UpsDevice;
 };

api/src/unraid-api/graph/resolvers/disks/disks.module.ts

@@ -5,6 +5,6 @@ import { DisksService } from '@app/unraid-api/graph/resolvers/disks/disks.servic
 
 @Module({
     providers: [DisksResolver, DisksService],
-    exports: [DisksResolver],
+    exports: [DisksResolver, DisksService],
 })
 export class DisksModule {}