Laravel pulse and spatie-health initial integration (#648)

* add pulse and health check * chore: Add pulse and health check * feat: Add test for general health route
dfo-osdt · Jun 3, 2024 · 7ffd300 · 7ffd300
1 parent 6e63bbb
commit 7ffd300
Show file tree

Hide file tree

Showing 16 changed files with 1,965 additions and 5 deletions.
diff --git a/.phpstorm.meta.php b/.phpstorm.meta.php
diff --git a/_ide_helper.php b/_ide_helper.php
diff --git a/app/Console/Kernel.php b/app/Console/Kernel.php
@@ -4,6 +4,7 @@
 
 use Illuminate\Console\Scheduling\Schedule;
 use Illuminate\Foundation\Console\Kernel as ConsoleKernel;
+use Spatie\Health\Commands\RunHealthChecksCommand;
 
 class Kernel extends ConsoleKernel
 {
@@ -22,6 +23,10 @@ protected function schedule(Schedule $schedule)
         // backup the database
         $schedule->command('backup:clean')->daily()->at('01:00');
         $schedule->command('backup:run --only-db')->daily()->at('02:00');
+
+        // health checks
+        $schedule->command(RunHealthChecksCommand::class)->everyMinute();
+
     }
 
     /**

diff --git a/app/Providers/AppServiceProvider.php b/app/Providers/AppServiceProvider.php
@@ -3,8 +3,18 @@
 namespace App\Providers;
 
 use Illuminate\Database\Eloquent\Model;
+use Illuminate\Support\Facades\App;
+use Illuminate\Support\Facades\Gate;
 use Illuminate\Support\Facades\Schema;
 use Illuminate\Support\ServiceProvider;
+use Spatie\Health\Checks\Checks\CacheCheck;
+use Spatie\Health\Checks\Checks\DatabaseCheck;
+use Spatie\Health\Checks\Checks\DebugModeCheck;
+use Spatie\Health\Checks\Checks\HorizonCheck;
+use Spatie\Health\Checks\Checks\PingCheck;
+use Spatie\Health\Checks\Checks\RedisCheck;
+use Spatie\Health\Checks\Checks\UsedDiskSpaceCheck;
+use Spatie\Health\Facades\Health;
 
 class AppServiceProvider extends ServiceProvider
 {
@@ -26,11 +36,27 @@ public function register()
     public function boot()
     {
         // prevent lazy loading
-        Model::preventLazyLoading(! app()->isProduction());
+        Model::preventLazyLoading(! App::isProduction());
         Model::preventSilentlyDiscardingAttributes();
         Model::preventAccessingMissingAttributes();
 
         // https://spatie.be/docs/laravel-permission/v5/prerequisites#content-schema-limitation-in-mysql
         Schema::defaultStringLength(125);
+
+        // Laravel Pulse view gate
+        Gate::define('viewPulse', function ($user) {
+            return $user->can('view_pulse');
+        });
+
+        // Add Spatie Health Checks
+        Health::checks([
+            UsedDiskSpaceCheck::new()->warnWhenUsedSpaceIsAbovePercentage(60)->failWhenUsedSpaceIsAbovePercentage(80),
+            DatabaseCheck::new(),
+            CacheCheck::new(),
+            DebugModeCheck::new(),
+            HorizonCheck::new(),
+            PingCheck::new()->url('https://api.orcid.org/')->timeout(2)->name('Orcid Api'),
+            RedisCheck::new(),
+        ]);
     }
 }
diff --git a/bootstrap/app.php b/bootstrap/app.php
@@ -41,6 +41,7 @@
     App\Exceptions\Handler::class
 );
 
+
 /*
 |--------------------------------------------------------------------------
 | Return The Application

diff --git a/composer.json b/composer.json
@@ -14,6 +14,7 @@
         "laravel/horizon": "^5.24.3",
         "laravel/pail": "^1.1.2",
         "laravel/prompts": "^0.1.21",
+        "laravel/pulse": "^1.2",
         "laravel/sanctum": "^4.0.2",
         "laravel/telescope": "^5.0.4",
         "laravel/tinker": "^2.9.0",
@@ -24,6 +25,7 @@
         "saloonphp/laravel-plugin": "^3.5",
         "saloonphp/saloon": "^3.8.1",
         "spatie/laravel-backup": "^8.8",
+        "spatie/laravel-health": "^1.29",
         "spatie/laravel-medialibrary": "^11.4.7",
         "spatie/laravel-permission": "^6.7",
         "spatie/laravel-query-builder": "^5.8.0",