Merge branch 'release/1.2.0'

Author: sanderpotjer

CHANGELOG.md

@@ -2,6 +2,10 @@
 
 Oh Dear Application Health checker for Craft CMS.
 
+## 1.2.0 – 2025-09-17
+### Added
+- Add disk usage check and config options
+
 ## 1.1.3 – 2025-07-15
 ### Changed
 - Update default warning for oldest update to 40 days

README.md

@@ -2,19 +2,19 @@
 
 <h1 align="center">Oh Dear Application Health checker for Craft CMS</h1>
 
-This plugin provides a [Oh Dear](https://ohdear.app) Application Health checker [Craft CMS](https://craftcms.com/).
+This plugin provides an [Oh Dear](https://ohdear.app) Application Health checker for [Craft CMS](https://craftcms.com/).
 
 ## 🚦 Health Checks Overview
 
-This plugin performs the following health checks and provides a JSON feed on yourwebsite.com/application-health.json for Oh Dear. 
+This plugin performs the following health checks and provides a JSON feed at `/application-health.json` for Oh Dear.
 
-The response is cached for 5 minutes. 
+The response is cached for 5 minutes.
 
 ### ✅ Updates
-Checks if updates are available for Craft CMS and installed plugins.
+Checks if updates are available for Craft CMS and installed plugins, including critical ones.
 
 ### ✅ Queue Status
-Monitors the number of jobs in the queue and detects any failed jobs.
+Monitors the number of jobs in the queue and detects failed, reserved, or delayed jobs using configurable thresholds.
 
 ### ✅ Pending Migrations
 Verifies if there are any unapplied database migrations.
@@ -32,11 +32,15 @@ Fetches site headers and verifies the presence of key security headers (e.g., CS
 Confirms if the project configuration is fully synchronized.
 
 ### ✅ PHP Version
-Reports the active PHP version running on the server and verifies against a minimum required version.
+Reports the active PHP version running on the server and verifies it against a minimum required version.
 
 ### ✅ Admin Users
 Lists all admin users and flags users who haven’t logged in for a configurable period.
 
+### ✅ Disk Usage
+Monitors disk space usage and flags if usage exceeds a configurable threshold.  
+*(Disabled by default to avoid noise on shared servers.)*
+
 ## Requirements
 
 This plugin requires Craft CMS 4.0.0+ or 5.0.0+.
@@ -54,13 +58,13 @@ Go to the Plugin Store in your project’s Control Panel and search for “Oh De
 Open your terminal and run the following commands:
 
 ```bash
-# go to the project directory
+# Go to the project directory
 cd /path/to/my-project.test
 
-# tell Composer to load the plugin
+# Tell Composer to load the plugin
 composer require perfectwebteam/craft-ohdear-application-health
 
-# tell Craft to install the plugin
+# Tell Craft to install the plugin
 ./craft plugin/install ohdear-application-health
 ```
 
@@ -89,6 +93,7 @@ return [
         'addSecurityHeadersCheck' => true,
         'addPhpVersionCheck' => true,
         'addAdminUsersCheck' => true,
+        'addDiskUsageCheck' => false,
     ],
     'oldestUpdateWarningDays' => 30,
     'minimumPhpVersion' => '8.1.0',
@@ -103,7 +108,9 @@ return [
     'inactiveAdminThreshold' => '-1 year',
     'gitRepoPath' => '@root',
     'queueTotalThreshold' => 10,
-    'queueFailedThreshold' => 2
+    'queueFailedThreshold' => 2,
+    'diskUsagePath' => '/',
+	'diskUsageThreshold' => 90,
 ];
 ```
 

src/services/HealthCheckService.php

@@ -36,9 +36,12 @@ public function runChecks(): CheckResults
                 'addGitChangesCheck',
                 'addSecurityHeadersCheck',
                 'addPhpVersionCheck',
-                'addAdminUsersCheck'
+                'addAdminUsersCheck',
+                'addDiskUsageCheck'
             ] as $check) {
-            if (($enabledChecks[$check] ?? true) === true) {
+            $defaultEnabled = ($check === 'addDiskUsageCheck') ? false : true;
+
+            if (($enabledChecks[$check] ?? $defaultEnabled) === true) {
                 $this->$check($results);
             }
         }
@@ -447,4 +450,58 @@ private function addAdminUsersCheck(CheckResults $checkResults): void
             meta: $adminMeta
         ));
     }
+
+    private function addDiskUsageCheck(CheckResults $checkResults): void
+    {
+        $path = $this->config['diskUsagePath'] ?? '/';
+        $threshold = $this->config['diskUsageThreshold'] ?? 90;
+
+        $meta = [];
+        $status = CheckResult::STATUS_OK;
+
+        try {
+            $totalSpace = disk_total_space($path);
+            $freeSpace = disk_free_space($path);
+
+            if ($totalSpace === false || $freeSpace === false || $totalSpace === 0) {
+                throw new \Exception("Unable to retrieve disk space for path: {$path}");
+            }
+
+            $usedSpace = $totalSpace - $freeSpace;
+            $usedPercentage = round(($usedSpace / $totalSpace) * 100, 2);
+
+            $meta = [
+                'Path' => $path,
+                'Total space (GB)' => round($totalSpace / (1024 ** 3), 2),
+                'Used space (GB)' => round($usedSpace / (1024 ** 3), 2),
+                'Free space (GB)' => round($freeSpace / (1024 ** 3), 2),
+                'Used (%)' => "{$usedPercentage}%",
+            ];
+
+            if ($usedPercentage >= $threshold) {
+                $status = CheckResult::STATUS_FAILED;
+                $message = "Disk usage at {$usedPercentage}% exceeds threshold ({$threshold}%)";
+            } else {
+                $message = "Disk usage is at {$usedPercentage}%";
+            }
+
+            $checkResults->addCheckResult(new CheckResult(
+                name: 'DiskUsage',
+                label: 'Disk Usage Check',
+                notificationMessage: $message,
+                shortSummary: "{$usedPercentage}%",
+                status: $status,
+                meta: $meta
+            ));
+        } catch (\Exception $e) {
+            $checkResults->addCheckResult(new CheckResult(
+                name: 'DiskUsage',
+                label: 'Disk Usage Check',
+                notificationMessage: 'Error checking disk usage.',
+                shortSummary: 'Disk usage check failed',
+                status: CheckResult::STATUS_FAILED,
+                meta: ['Error' => $e->getMessage()]
+            ));
+        }
+    }
 }