started working on disk size warning on controller level (#2662)

* started working on disk size warning on controller level

- closes #2432

* generate notification if not enough disk space left

* added the actual notification in io-pack + readme

* update import after esm port

* execute df -k on root dir to get correct disk space in all cases for linux and macos

* try to fix redis install macos

Author: foxriver76

.github/workflows/ci-tests.yml

@@ -61,9 +61,8 @@ jobs:
         run: |
           brew update
           # temporary ignore brew problems
-          brew install redis || true
-          ln -sfv /usr/local/opt/redis/*.plist ~/Library/LaunchAgents
-          launchctl load ~/Library/LaunchAgents/homebrew.mxcl.redis.plist
+          brew install redis
+          brew services start redis
 
       - name: Prepare installation (Windows)
         if: ${{ matrix.os == 'windows-latest' }}

README.md

@@ -71,6 +71,30 @@ or
 The main configuration is stored in `iobroker-data/iobroker.json`. Normally, there is no need to edit this file because the ioBroker CLI commands can control most of the settings.
 
 ## Feature Overview
+- [Admin UI](#admin-ui)
+- [Automatic adapter upgrade](#automatic-adapter-upgrade)
+- [Command Line Interface](#command-line-interface)
+- [Adapter Upgrade with Webserver](#adapter-upgrade-with-webserver)
+- [Controller UI Upgrade](#controller-ui-upgrade)
+- [Per host adapter objects](#per-host-adapter-objects)
+- [Operating system package management](#operating-system-package-management)
+- [Hostname](#hostname)
+- [Adapter process memory limitation](#adapter-process-memory-limitation)
+- [Directly executing TypeScript adapters](#directly-executing-typescript-adapters)
+- [Statistics](#statistics)
+- [Error Reporting via ioBroker Sentry](#error-reporting-via-iobroker-sentry)
+- [Notification System](#notification-system)
+- [Disk space warnings](#disk-space-warnings)
+- [Controlling and monitoring of adapter processes](#controlling-and-monitoring-of-adapter-processes)
+- [Multihost](#multihost)
+- [TIERS: Start instances in an ordered manner](#tiers-start-instances-in-an-ordered-manner)
+- [Custom Node.js process arguments](#custom-nodejs-process-arguments)
+- [IPv6 DNS resolution support](#ipv6-dns-resolution-support)
+- [Object and State Aliases](#object-and-state-aliases)
+- [State and objects databases and files](#state-and-objects-databases-and-files)
+- [Certificate Handling](#certificate-handling)
+- [js-controller Host Messages](#js-controller-host-messages)
+- [Adapter Development](#adapter-development)
 
 ### Admin UI
 **Feature status:** stable
@@ -349,7 +373,7 @@ All of this helps me to provide an error-free smart home system that basically n
 If you want to disable the error reporting, you can do this by setting the state "system.host.NAME.plugins.sentry.enabled" to false. You should see a log message stating that sentry was disabled. After disabling the plugin no crashes from your system are reported and so cannot be fixed without reporting them by yourself manually!
 
 ### Notification System
-**Feature status:** Technology preview since js-controller 3.2.0
+**Feature status:** Stable since js-controller 5.0.0
 
 The notification system in ioBroker allows setting, detecting and storing notifications per Host and allows querying the details.
 
@@ -471,6 +495,12 @@ The message needs to take the following parameters in the message object:
 
 All three are optional and can be a string or null/undefined if ommited.
 
+### Disk space warnings
+**Feature status:** New in 6.0.0
+
+The js-controller will generate a notification of in the scope `system` and the category `diskSpaceIssues` on warning level, if your free disk space falls under a specified threshold. 
+By default, this threshold is 5 % of disk space. Via the state `system.host.<hostname>.diskWarning` you can override this level to any level between `0` and `100`. 
+
 ### Logging
 #### Log levels
 **Feature status:** stable
@@ -995,8 +1025,6 @@ With such a setup, ioBroker will connect to one of these sentinel processes to g
 ##### Using Password for Redis Databases
 **Feature status:** Stable
 
-
-
 ### Certificate Handling
 ... CLI
 ... Files vs PEM content

packages/common/src/lib/common/tools.ts

@@ -1816,96 +1816,64 @@ export interface GetDiskInfoResponse {
 
 /**
  * Read disk free space
- *
- * @param platform result of os.platform() (win32 => Windows, darwin => OSX)
- * @param callback return result
- *        <pre><code>
- *            function (err, infos) {
- *              adapter.log.debug('Disks sizes is: ' + info['Disk size'] + ' - ' + info['Disk free']);
- *            }
- *        </code></pre>
  */
-export function getDiskInfo(
-    platform: NodeJS.Platform,
-    callback: (err?: Error | null, infos?: null | GetDiskInfoResponse) => void
-): void {
-    platform = platform || os.platform();
+export async function getDiskInfo(): Promise<GetDiskInfoResponse | null> {
+    const platform = process.platform;
     if (diskusage) {
         try {
             const path = platform === 'win32' ? thisDir.substring(0, 2) : '/';
             const info = diskusage.checkSync(path);
-            return callback && callback(null, { 'Disk size': info.total, 'Disk free': info.free });
-        } catch (err) {
-            console.log(err);
+            return { 'Disk size': info.total, 'Disk free': info.free };
+        } catch (e) {
+            console.log(e.message);
         }
     } else {
-        try {
-            if (platform === 'win32') {
-                // Caption  FreeSpace     Size
-                // A:
-                // C:       66993807360   214640357376
-                // D:
-                // Y:       116649795584  148368257024
-                // Z:       116649795584  148368257024
-                const disk = thisDir.substring(0, 2).toUpperCase();
-
-                exec(
-                    'wmic logicaldisk get size,freespace,caption',
-                    {
-                        encoding: 'utf8',
-                        windowsHide: true
-                    },
-                    (error, stdout) => {
-                        //, stderr) {
-                        if (stdout) {
-                            const lines = stdout.split('\n');
-                            const line = lines.find(line => {
-                                const parts = line.split(/\s+/);
-                                return parts[0].toUpperCase() === disk;
-                            });
-                            if (line) {
-                                const parts = line.split(/\s+/);
-                                return (
-                                    callback &&
-                                    callback(error, {
-                                        'Disk size': parseInt(parts[2]),
-                                        'Disk free': parseInt(parts[1])
-                                    })
-                                );
-                            }
-                        }
-                        callback && callback(error, null);
-                    }
-                );
-            } else {
-                exec('df -k /', { encoding: 'utf8', windowsHide: true }, (error, stdout) => {
-                    //, stderr) {
-                    // Filesystem            1K-blocks    Used Available Use% Mounted on
-                    // /dev/mapper/vg00-lv01 162544556 9966192 145767152   7% /
-                    try {
-                        if (stdout) {
-                            const parts = stdout.split('\n')[1].split(/\s+/);
-                            return (
-                                callback &&
-                                callback(error, {
-                                    'Disk size': parseInt(parts[1]) * 1024,
-                                    'Disk free': parseInt(parts[3]) * 1024
-                                })
-                            );
-                        }
-                    } catch {
-                        // continue regardless of error
-                    }
-                    callback && callback(error, null);
+        if (platform === 'win32') {
+            // Caption  FreeSpace     Size
+            // A:
+            // C:       66993807360   214640357376
+            // D:
+            // Y:       116649795584  148368257024
+            // Z:       116649795584  148368257024
+            const disk = thisDir.substring(0, 2).toUpperCase();
+
+            const { stdout } = await execAsync('wmic logicaldisk get size,freespace,caption');
+
+            if (typeof stdout === 'string') {
+                const lines = stdout.split('\n');
+                const line = lines.find(line => {
+                    const parts = line.split(/\s+/);
+                    return parts[0].toUpperCase() === disk;
                 });
+                if (line) {
+                    const parts = line.split(/\s+/);
+                    return {
+                        'Disk size': parseInt(parts[2]),
+                        'Disk free': parseInt(parts[1])
+                    };
+                }
+            }
+        } else {
+            const { stdout } = await execAsync(`df -k ${getRootDir()}`);
+            //, stderr) {
+            // Filesystem            1K-blocks    Used Available Use% Mounted on
+            // /dev/mapper/vg00-lv01 162544556 9966192 145767152   7% /
+            try {
+                if (typeof stdout === 'string') {
+                    const parts = stdout.split('\n')[1].split(/\s+/);
+                    return {
+                        'Disk size': parseInt(parts[1]) * 1024,
+                        'Disk free': parseInt(parts[3]) * 1024
+                    };
+                }
+            } catch {
+                // continue regardless of error
             }
-        } catch (e) {
-            callback && callback(e, null);
         }
     }
-}
 
-const getDiskInfoAsync = promisify(getDiskInfo);
+    return null;
+}
 
 export interface CertificateInfo {
     certificateFilename: string | null;
@@ -2164,7 +2132,7 @@ export async function getHostInfo(objects: any): Promise<HostInfo> {
     }
 
     try {
-        const info = await getDiskInfoAsync(data.Platform);
+        const info = await getDiskInfo();
         if (info) {
             Object.assign(data, info);
         }

packages/controller/io-package.json

@@ -702,6 +702,38 @@
         "zh-cn": "这些通知由ioBroker系统收集，并指出您应检查并修复的问题"
       },
       "categories": [
+        {
+          "category": "diskSpaceIssues",
+          "name": {
+            "en": "Issues with insufficient disk space",
+            "de": "Probleme mit unzureichendem Speicherplatz",
+            "ru": "Проблемы с недостаточным дисковым пространством",
+            "pt": "Problemas com espaço insuficiente no disco",
+            "nl": "Problemen met onvoldoende schijfruimte",
+            "fr": "Problèmes liés à un espace disque insuffisant",
+            "it": "Problemi di spazio su disco insufficiente",
+            "es": "Problemas de espacio insuficiente en disco",
+            "pl": "Problemy z niewystarczającą ilością miejsca na dysku",
+            "uk": "Проблеми з нестачею місця на диску",
+            "zh-cn": "磁盘空间不足的问题"
+          },
+          "severity": "alert",
+          "description": {
+            "en": "Your system is running out of disk space. Please free space on the disk to avoid problems.",
+            "de": "Ihr System verfügt nicht mehr über genügend Speicherplatz. Bitte geben Sie Speicherplatz auf der Festplatte frei, um Probleme zu vermeiden.",
+            "ru": "В вашей системе не хватает места на диске. Во избежание проблем освободите место на диске.",
+            "pt": "O seu sistema está a ficar sem espaço no disco. Liberte espaço no disco para evitar problemas.",
+            "nl": "Je systeem heeft bijna geen schijfruimte meer. Maak ruimte vrij op de schijf om problemen te voorkomen.",
+            "fr": "Votre système manque d'espace disque. Veuillez libérer de l'espace sur le disque pour éviter tout problème.",
+            "it": "Il sistema sta esaurendo lo spazio su disco. Liberare spazio sul disco per evitare problemi.",
+            "es": "Su sistema se está quedando sin espacio en disco. Por favor, libere espacio en el disco para evitar problemas.",
+            "pl": "W systemie zaczyna brakować miejsca na dysku. Aby uniknąć problemów, zwolnij miejsce na dysku.",
+            "uk": "У вашій системі закінчується місце на диску. Будь ласка, звільніть місце на диску, щоб уникнути проблем.",
+            "zh-cn": "您的系统正在耗尽磁盘空间。请释放磁盘空间，以免出现问题。"
+          },
+          "regex": [],
+          "limit": 1
+        },
         {
           "category": "memIssues",
           "name": {

packages/controller/src/lib/objects.ts

@@ -1,4 +1,5 @@
 import fs from 'fs-extra';
+import { DEFAULT_DISK_WARNING_LEVEL } from '@/lib/utils.js';
 
 interface GetHostOptions {
     /** The host base id */
@@ -383,11 +384,11 @@ export function getHostObjects(options: GetHostOptions): TaskObject[] {
             type: 'state',
             common: {
                 name: `${hostname} - disk warning level`,
-                desc: 'Show warning in admin if the free disk space is below this value',
+                desc: 'Generate a warning if the free disk space is below this value',
                 type: 'number',
                 read: true,
                 write: true,
-                def: 5,
+                def: DEFAULT_DISK_WARNING_LEVEL,
                 role: 'level',
                 unit: '%'
             },

packages/controller/src/lib/utils.ts

@@ -0,0 +1,17 @@
+/**
+ * Get disk warning level from state
+ *
+ * @param state disk warning state, normally with value of type number in %
+ * @returns The new disk warning level in %
+ */
+export function getDiskWarningLevel(state: ioBroker.State): number {
+    let warningLevel = 0;
+    if (typeof state.val === 'number' && state.val <= 100 && state.val >= 0) {
+        warningLevel = state.val;
+    }
+
+    return warningLevel;
+}
+
+/** Default value for disk warning level */
+export const DEFAULT_DISK_WARNING_LEVEL = 5;