Health page (pelican-dev#469)

* add spatie health * change slug for health page * add check for panel version * only check for debug mode if env isn't local * add check for node versions * improve short summary * fix outdated check * run pint * fix health checks during tests * add count to ok message * fix typo * temp fix for phpstan job * fix pint... * improve "outdated" count Co-authored-by: MartinOscar <[email protected]> * run pint * skip node versions check if no nodes are created * auto run health checks if they didn't run before * small refactor * update navigation Co-authored-by: Charles <[email protected]> * fix errors if tests didn't run yet * fix disk usage check * remove plugin and use own page * use health status indicator from spatie * fix after merge * update icon * update color classes * fix after merge * add back imports oops... * wrong import oops²... * update spatie/laravel-health to latest * move Health page to correct namespace * update NodeVersionsCheck * use style instead of tailwind classes workaround until we have vite * cleanup custom checks --------- Co-authored-by: MartinOscar <[email protected]> Co-authored-by: Charles <[email protected]>
stantabcorp · Dec 24, 2024 · 00644c2 · 00644c2
1 parent 02a0c5c
commit 00644c2
Show file tree

Hide file tree

Showing 10 changed files with 669 additions and 3 deletions.
diff --git a/app/Checks/NodeVersionsCheck.php b/app/Checks/NodeVersionsCheck.php
@@ -0,0 +1,43 @@
+<?php
+
+namespace App\Checks;
+
+use App\Models\Node;
+use App\Services\Helpers\SoftwareVersionService;
+use Spatie\Health\Checks\Check;
+use Spatie\Health\Checks\Result;
+use Spatie\Health\Enums\Status;
+
+class NodeVersionsCheck extends Check
+{
+    public function __construct(private SoftwareVersionService $versionService) {}
+
+    public function run(): Result
+    {
+        $all = Node::query()->count();
+
+        if ($all === 0) {
+            $result = Result::make()->notificationMessage('No Nodes created')->shortSummary('No Nodes');
+            $result->status = Status::skipped();
+
+            return $result;
+        }
+
+        $latestVersion = $this->versionService->latestWingsVersion();
+
+        $outdated = Node::query()->get()
+            ->filter(fn (Node $node) => !isset($node->systemInformation()['exception']) && $node->systemInformation()['version'] !== $latestVersion)
+            ->count();
+
+        $result = Result::make()
+            ->meta([
+                'all' => $all,
+                'outdated' => $outdated,
+            ])
+            ->shortSummary($outdated === 0 ? 'All up-to-date' : "{$outdated}/{$all} outdated");
+
+        return $outdated === 0
+            ? $result->ok('All Nodes are up-to-date.')
+            : $result->failed(':outdated/:all Nodes are outdated.');
+    }
+}
diff --git a/app/Checks/PanelVersionCheck.php b/app/Checks/PanelVersionCheck.php
@@ -0,0 +1,31 @@
+<?php
+
+namespace App\Checks;
+
+use App\Services\Helpers\SoftwareVersionService;
+use Spatie\Health\Checks\Check;
+use Spatie\Health\Checks\Result;
+
+class PanelVersionCheck extends Check
+{
+    public function __construct(private SoftwareVersionService $versionService) {}
+
+    public function run(): Result
+    {
+        $isLatest = $this->versionService->isLatestPanel();
+        $currentVersion = $this->versionService->currentPanelVersion();
+        $latestVersion = $this->versionService->latestPanelVersion();
+
+        $result = Result::make()
+            ->meta([
+                'isLatest' => $isLatest,
+                'currentVersion' => $currentVersion,
+                'latestVersion' => $latestVersion,
+            ])
+            ->shortSummary($isLatest ? 'up-to-date' : 'outdated');
+
+        return $isLatest
+            ? $result->ok('Panel is up-to-date.')
+            : $result->failed('Installed version is `:currentVersion` but latest is `:latestVersion`.');
+    }
+}
diff --git a/app/Checks/UsedDiskSpaceCheck.php b/app/Checks/UsedDiskSpaceCheck.php
@@ -0,0 +1,16 @@
+<?php
+
+namespace App\Checks;
+
+use Spatie\Health\Checks\Checks\UsedDiskSpaceCheck as BaseCheck;
+
+class UsedDiskSpaceCheck extends BaseCheck
+{
+    protected function getDiskUsagePercentage(): int
+    {
+        $freeSpace = disk_free_space($this->filesystemName ?? '/');
+        $totalSpace = disk_total_space($this->filesystemName ?? '/');
+
+        return 100 - ($freeSpace * 100 / $totalSpace);
+    }
+}
diff --git a/app/Console/Kernel.php b/app/Console/Kernel.php
@@ -13,6 +13,8 @@
 use Illuminate\Console\Scheduling\Schedule;
 use Illuminate\Database\Console\PruneCommand;
 use Illuminate\Foundation\Console\Kernel as ConsoleKernel;
+use Spatie\Health\Commands\RunHealthChecksCommand;
+use Spatie\Health\Commands\ScheduleCheckHeartbeatCommand;
 
 class Kernel extends ConsoleKernel
 {
@@ -53,5 +55,8 @@ protected function schedule(Schedule $schedule): void
         if (config('panel.webhook.prune_days')) {
             $schedule->command(PruneCommand::class, ['--model' => [Webhook::class]])->daily();
         }
+
+        $schedule->command(ScheduleCheckHeartbeatCommand::class)->everyMinute();
+        $schedule->command(RunHealthChecksCommand::class)->everyFiveMinutes();
     }
 }
diff --git a/app/Filament/Admin/Pages/Health.php b/app/Filament/Admin/Pages/Health.php
@@ -0,0 +1,120 @@
+<?php
+
+namespace App\Filament\Admin\Pages;
+
+use Carbon\Carbon;
+use Filament\Actions\Action;
+use Filament\Notifications\Notification;
+use Filament\Pages\Page;
+use Illuminate\Support\Facades\Artisan;
+use Spatie\Health\Commands\RunHealthChecksCommand;
+use Spatie\Health\ResultStores\ResultStore;
+
+class Health extends Page
+{
+    protected static ?string $navigationIcon = 'tabler-heart';
+
+    protected static ?string $navigationGroup = 'Advanced';
+
+    protected static string $view = 'filament.pages.health';
+
+    // @phpstan-ignore-next-line
+    protected $listeners = [
+        'refresh-component' => '$refresh',
+    ];
+
+    protected function getActions(): array
+    {
+        return [
+            Action::make('refresh')
+                ->button()
+                ->action('refresh'),
+        ];
+    }
+
+    protected function getViewData(): array
+    {
+        // @phpstan-ignore-next-line
+        $checkResults = app(ResultStore::class)->latestResults();
+
+        if ($checkResults === null) {
+            Artisan::call(RunHealthChecksCommand::class);
+
+            $this->dispatch('refresh-component');
+        }
+
+        return [
+            'lastRanAt' => new Carbon($checkResults?->finishedAt),
+            'checkResults' => $checkResults,
+        ];
+    }
+
+    public function refresh(): void
+    {
+        Artisan::call(RunHealthChecksCommand::class);
+
+        $this->dispatch('refresh-component');
+
+        Notification::make()
+            ->title('Health check results refreshed')
+            ->success()
+            ->send();
+    }
+
+    public static function getNavigationBadge(): ?string
+    {
+        // @phpstan-ignore-next-line
+        $results = app(ResultStore::class)->latestResults();
+
+        if ($results === null) {
+            return null;
+        }
+
+        $results = json_decode($results->toJson(), true);
+
+        $failed = array_reduce($results['checkResults'], function ($numFailed, $result) {
+            return $numFailed + ($result['status'] === 'failed' ? 1 : 0);
+        }, 0);
+
+        return $failed === 0 ? null : (string) $failed;
+    }
+
+    public static function getNavigationBadgeColor(): string
+    {
+        return self::getNavigationBadge() > null ? 'danger' : '';
+    }
+
+    public static function getNavigationBadgeTooltip(): ?string
+    {
+        // @phpstan-ignore-next-line
+        $results = app(ResultStore::class)->latestResults();
+
+        if ($results === null) {
+            return null;
+        }
+
+        $results = json_decode($results->toJson(), true);
+
+        $failedNames = array_reduce($results['checkResults'], function ($carry, $result) {
+            if ($result['status'] === 'failed') {
+                $carry[] = $result['name'];
+            }
+
+            return $carry;
+        }, []);
+
+        return 'Failed: ' . implode(', ', $failedNames);
+    }
+
+    public static function getNavigationIcon(): string
+    {
+        // @phpstan-ignore-next-line
+        $results = app(ResultStore::class)->latestResults();
+
+        if ($results === null) {
+            return 'tabler-heart-question';
+        }
+
+        return $results->containsFailingCheck() ? 'tabler-heart-exclamation' : 'tabler-heart-check';
+    }
+}
diff --git a/app/Providers/AppServiceProvider.php b/app/Providers/AppServiceProvider.php
@@ -2,6 +2,9 @@
 
 namespace App\Providers;
 
+use App\Checks\NodeVersionsCheck;
+use App\Checks\PanelVersionCheck;
+use App\Checks\UsedDiskSpaceCheck;
 use App\Filament\Server\Pages\Console;
 use App\Models;
 use App\Models\ApiKey;
@@ -26,6 +29,12 @@
 use Illuminate\Support\Str;
 use Laravel\Sanctum\Sanctum;
 use SocialiteProviders\Manager\SocialiteWasCalled;
+use Spatie\Health\Checks\Checks\CacheCheck;
+use Spatie\Health\Checks\Checks\DatabaseCheck;
+use Spatie\Health\Checks\Checks\DebugModeCheck;
+use Spatie\Health\Checks\Checks\EnvironmentCheck;
+use Spatie\Health\Checks\Checks\ScheduleCheck;
+use Spatie\Health\Facades\Health;
 
 class AppServiceProvider extends ServiceProvider
 {
@@ -103,6 +112,20 @@ public function boot(Application $app, SoftwareVersionService $versionService):
             scopes: Console::class,
         );
 
+        // Don't run any health checks during tests
+        if (!$app->runningUnitTests()) {
+            Health::checks([
+                DebugModeCheck::new()->if($app->isProduction()),
+                EnvironmentCheck::new(),
+                CacheCheck::new(),
+                DatabaseCheck::new(),
+                ScheduleCheck::new(),
+                UsedDiskSpaceCheck::new(),
+                PanelVersionCheck::new(),
+                NodeVersionsCheck::new(),
+            ]);
+        }
+
         Gate::before(function (User $user, $ability) {
             return $user->isRootAdmin() ? true : null;
         });

diff --git a/composer.json b/composer.json
@@ -35,6 +35,7 @@
         "socialiteproviders/discord": "^4.2",
         "socialiteproviders/steam": "^4.2",
         "spatie/laravel-fractal": "^6.2",
+        "spatie/laravel-health": "^1.30",
         "spatie/laravel-permission": "^6.9",
         "spatie/laravel-query-builder": "^5.8.1",
         "spatie/temporary-directory": "^2.2",
@@ -92,4 +93,4 @@
     },
     "minimum-stability": "stable",
     "prefer-stable": true
-}
+}