DiskUsage Check

src/Checks/Filesystem/DiskSpace.php

@@ -3,10 +3,13 @@
 
 use Health\Checks\BaseCheck;
 use Health\Checks\HealthCheckInterface;
+use Health\Checks\Traits\FormatTrait;
 
 class DiskSpace extends BaseCheck implements HealthCheckInterface
 {
 
+    use FormatTrait;
+
     /**
      * Default disk space threshold of 100 MB
      *
@@ -48,29 +51,4 @@ public function call()
 
         return $builder->build();
     }
-
-    /**
-     * Format bytes to kb, mb, gb, tb
-     *
-     * @param integer $size
-     * @param integer $precision
-     * @return string
-     */
-    private function formatBytes($size, $precision = 2)
-    {
-        $size = (int) $size;
-        $base = $size > 0 ? log($size) / log(1024) : 0;
-
-        $suffixes = [
-            ' bytes',
-            ' KB',
-            ' MB',
-            ' TB',
-            ' GB'
-        ];
-
-        $value = $size > 0 ? round(pow(1024, $base - floor($base)), $precision) : 0;
-
-        return $value . $suffixes[floor($base)];
-    }
 }

src/Checks/Filesystem/DiskUsage.php

@@ -0,0 +1,63 @@
+<?php
+namespace Health\Checks\Filesystem;
+
+use Health\Checks\BaseCheck;
+use Health\Checks\HealthCheckInterface;
+use Health\Checks\Traits\FormatTrait;
+
+class DiskUsage extends BaseCheck implements HealthCheckInterface
+{
+
+    use FormatTrait;
+
+    /**
+     * Default disk usage threshold of 1 %
+     *
+     * @var integer
+     */
+    const DEFAULT_THRESHOLD = 1;
+
+    /**
+     * Default Path
+     *
+     * @var string
+     */
+    const DEFAULT_PATH = '/';
+
+    /**
+     *
+     * {@inheritdoc}
+     * @see \Health\Checks\HealthCheckInterface::call()
+     */
+    public function call()
+    {
+        $builder = $this->getBuilder();
+
+        $path = $this->getParam('path', self::DEFAULT_PATH);
+        $threshold = $this->getParam('threshold', self::DEFAULT_THRESHOLD);
+
+        if ($threshold > 100 || $threshold < 0) {
+            return $builder->down()->withData('error', 'Invalid Threshold - ' . $threshold);
+        }
+
+        $free = disk_free_space($path);
+        $total = disk_total_space($path);
+        $usage = $total - $free;
+        $percentage = ($usage / $total) * 100;
+
+        if ($percentage >= $threshold) {
+            $builder->up();
+        } else {
+            $builder->down();
+        }
+
+        $builder->withData('free_bytes', $free)
+            ->withData('free_human', $this->formatBytes($free))
+            ->withData('usage', $usage)
+            ->withData('usage_human', $this->formatBytes($usage))
+            ->withData('path', $path)
+            ->withData('threshold', $threshold);
+
+        return $builder->build();
+    }
+}

src/Checks/Traits/FormatTrait.php

@@ -0,0 +1,31 @@
+<?php
+namespace Health\Checks\Traits;
+
+trait FormatTrait
+{
+
+    /**
+     * Format bytes to kb, mb, gb, tb
+     *
+     * @param integer $size
+     * @param integer $precision
+     * @return string
+     */
+    public function formatBytes($size, $precision = 2)
+    {
+        $size = (int) $size;
+        $base = $size > 0 ? log($size) / log(1024) : 0;
+
+        $suffixes = [
+            ' bytes',
+            ' KB',
+            ' MB',
+            ' TB',
+            ' GB'
+        ];
+
+        $value = $size > 0 ? round(pow(1024, $base - floor($base)), $precision) : 0;
+
+        return $value . $suffixes[floor($base)];
+    }
+}

tests/Checks/CheckTestCase.php

@@ -9,6 +9,7 @@ class CheckTestCase extends \Orchestra\Testbench\TestCase
     protected function assertCheck($health, string $state = 'UP')
     {
         // dump($health);
+
         $this->assertInstanceOf(HealthCheck::class, $health);
         $this->assertNotEmpty($health->getName());
         $this->assertEquals($state, $health->getState());

tests/Checks/DiskUsageTest.php

@@ -0,0 +1,21 @@
+<?php
+namespace Tests\Checks;
+
+use Health\Checks\Filesystem\DiskUsage;
+
+class DiskUsageTest extends CheckTestCase
+{
+
+    public function testCheckUp()
+    {
+        $this->assertCheck($this->runCheck(DiskUsage::class, [
+            'path' => '/',
+            'threshold' => 1
+        ]), 'UP');
+
+        $this->assertCheck($this->runCheck(DiskUsage::class, [
+            'path' => '/',
+            'threshold' => 100
+        ]), 'DOWN');
+    }
+}